zr
AdWords reporting tools
To install: pip install zr
Overview
The zr package provides a suite of tools designed to facilitate the reporting and analysis of Google AdWords campaigns. It includes functionality to handle AdWords client interactions, report downloading, and data transformation into user-friendly formats such as pandas DataFrames.
Features
- Client Management: Easily manage AdWords client configurations and authenticate sessions.
- Report Downloading: Download various types of AdWords performance reports using flexible query options.
- Data Processing: Convert raw report data into structured pandas DataFrames, making it easier to analyze and visualize campaign performance.
Installation
Install the package using pip:
pip install zr
Usage
Getting Started with Client Configuration
To interact with Google AdWords, you need to configure and authenticate a client. Here's how you can do it:
from zr import get_client
client = get_client(clientCustomerId='your_customer_id')
Downloading Reports
You can download reports by specifying the type of report and the format you need. Here's an example of downloading a search query performance report:
from zr import get_report_downloader, download_report
# Get a report downloader instance
report_downloader = get_report_downloader(client='your_client_id')
# Define your report query
report_query_str = """
SELECT Query, Impressions, Clicks, Cost
FROM SEARCH_QUERY_PERFORMANCE_REPORT
WHERE CampaignStatus = ENABLED
DURING LAST_30_DAYS
"""
# Download the report as a DataFrame
df = download_report(
report_downloader=report_downloader,
report_query_str=report_query_str,
download_format='df'
)
Converting Reports to DataFrames
After downloading the report, you can convert it into a pandas DataFrame for easier manipulation and analysis:
from zr import report_to_df
# Assuming 'report' is the raw data fetched from AdWords
df = report_to_df(report)
Documentation
Each function in the zr package is documented with docstrings, providing a detailed description of its purpose, parameters, and return values. This allows users to understand and utilize the functionalities effectively without diving deep into the source code.
Key Functions
get_client(): Configure and return a Google AdWords client.get_report_downloader(): Get a downloader object that can be used to fetch reports based on the client configuration.download_report(): Download AdWords reports using AWQL (AdWords Query Language).report_to_df(): Convert the raw report data into a pandas DataFrame.
Contributing
Contributions to the zr package are welcome! If you have suggestions for improvements or bug fixes, please feel free to fork the repository and submit a pull request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Metadata
Release files for zr 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| zr-0.0.5.tar.gz | 21.3 kB | Without provenance | Details for zr-0.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| zr-0.0.5-py3-none-any.whl | Python 3 | none | any | Details for zr-0.0.5-py3-none-any.whl |
Total release size: 41.4 kB
Release files / zr-0.0.5.tar.gz
| Download URL | zr-0.0.5.tar.gz |
|---|---|
| Size | 21.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cc5985fb8416faa2b461e0ccbcc143c0b37ef2ef3440432c7a94b23961e24113
|
|
BLAKE2b-256 checksum How to use checksums |
b59e864b7360d485d9a4bf7ff0c6423b240def78ba7fac92fa1958259427ab29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.13
|
Release files / zr-0.0.5-py3-none-any.whl
| Download URL | zr-0.0.5-py3-none-any.whl |
|---|---|
| Size | 20.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7837d02e47a714527e0a5473a18ade964ba398e08f40a68866e7aafca979f87c
|
|
BLAKE2b-256 checksum How to use checksums |
e2ba30053fd00a3178a0f6fd2c6c203d70c483b6cb7b4696b2889d33b0c6f3b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.13
|
Security for zr 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.