Skip to main content

AdWords API Reporting in Python

Project description

AdWords API Reporting in Python

An AdWords API large scale reporting tool written in Python. Reports are downloaded as plaintext files but connectivity with a database engine such as MySQL, PostgreSQL, or MongoDB can be implemented upon request.

Overview

pyaw-reporting is an open-source Python package suitable for large scale AdWords API reporting. Output reports are comma-separated values (CSV) plaintext files. By default, the package uses 10 threads to download reports simultaneously from different accounts. The number of threads used can be modified using the -n parameter. It has been successfully tested using +100 threads making it useful for heavy load AdWords Manager Accounts.

Supported AdWords API version

The latest API version supported by this package is v201809 with googleads 17.0.0. Older versions of the API are not supported, nor the newer Google Ads API.

Quick Start

Prerequisites

You will need Python 2.7 or 3.5+; this package will install googleads as a dependency. Using a virtual environment is recommended to avoid running the package with sudo.

An access token YAML file with the corresponding AdWords credentials is also necessary. By default, the package will look for ~/googleads.yaml unless a different path is passed. The optional parameter client_customer_id must be included in this YAML file, you should enter your AdWords Manager Account id (formerly known as MCC id). This way, all accounts linked to the Manager Account will be retrieved. The sample file example.yaml shows how your token should look like.

AWQL queries could be either passed in the command line with the -a/--awql parameter or stored in a plaintext file and passed via the -q/--query parameter. There is a sample query in the file query.txt which will retrieve clicks and impressions per ad for the last 7 days. Refer to Report Types and The AdWords Query Language (AWQL) for more information about these queries.

Installation

$ pip install pyaw-reporting

Usage

Command line

usage: awreporting [-h] (-a AWQL | -q QUERY_FILE) [-t TOKEN] [-o OUTPUT]
                   [-n NUM_THREAD] [-v]

AwReporting - Large scale AdWords reporting tool in Python

optional arguments:
  -h, --help                              show this help message and exit
  -t TOKEN, --token TOKEN                 specify AdWords YAML token path
  -o OUTPUT, --output OUTPUT              define output file name
  -n NUM_THREAD, --num-thread NUM_THREAD  set number of threads
  -v, --verbose                           display activity

required arguments:
  -a AWQL, --awql AWQL                    pass AWQL query
  -q QUERY_FILE, --query-file QUERY_FILE  ...or use a query file

For example:

$ awreporting -t example.yaml -a \
  "SELECT ExternalCustomerId, CampaignId, AdGroupId, Id, Date, Clicks, Impressions \
  FROM AD_PERFORMANCE_REPORT WHERE Impressions > 0 DURING LAST_7_DAYS" \
  -o adperformance.csv -n 100

Or, with a query file:

$ awreporting -t example.yaml -q query.txt -o adperformance.csv -n 100

If you experience problems downloading reports, check the resulting logs in awreporting.log or use the -v/--verbose parameter to verify if something is wrong with your token or AWQL query.

Code

If you prefer embedding this package in your own code, you could do like so:

from awreporting import get_report

query = (
    "SELECT ExternalCustomerId, CampaignId, AdGroupId, Id, Date, Clicks, Impressions "
    "FROM AD_PERFORMANCE_REPORT "
    "WHERE Impressions > 0 "
    "DURING LAST_7_DAYS"
)
get_report('example.yaml', query, 'adperformance.csv', 100)

About the YAML token

The example token file provided example.yaml is not valid. Refer to this guide if you are using the AdWords API for the first time.

Disclaimer

This is neither an official AdWords API repository nor a clone of AwReporting. Consider using AwReporting if you are a Java developer. This framework is both compatible with Python 2.7 and Python 3.5+ but future releases will support Python 3.5+ only.

Troubleshooting

We recommend that you try the app with a small number of threads first (the default is 10) and increase the number accordingly. The AdWords server may complain when many API calls are made at the same time but those exceptions are handled by the app. We have successfully obtained huge reports using 200 threads.

When using this tool it might be necessary to enable a DNS cache in your system, such as nscd. This should eliminate DNS lookup problems when repeatedly calling the AdWords API server. For example, if you find many URLError: <urlopen error [Errno -2] Name or service not known> in your logs, enable the DNS cache.

In some Linux systems nscd is not enabled by default but it can be started with:

# systemctl start nscd

Useful links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyaw-reporting, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size pyaw_reporting-0.0.3-py2-none-any.whl (15.5 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size pyaw_reporting-0.0.3-py3-none-any.whl (15.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pyaw-reporting-0.0.3.tar.gz (8.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page