Google Ads

The tap-adwords Singer tap pulls data from Google Ads that can then be sent to a destination using a Singer target.

• 
• Repository: https://github.com/singer-io/tap-adwords
• 
• 
• 
• 
• 
• 
• 
• Maintainer: Stitch
• Meltano Stats:
• 
• 

Alternative variants #

Multiple variants of tap-adwords are available. This document describes the default singer-io variant, which is recommended for new users.

Alternative variants are:

• georgiyolovski
• meltano

Standalone usage #

Install the package using pip:

pip install git+https://github.com/singer-io/tap-adwords.git

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific tap-adwords instructions to learn more.

Capabilities #

• properties
• discover
• state

Settings #

tap-adwords requires the configuration of the following settings:

• developer_token
• oauth_client_id
• oauth_client_secret
• refresh_token
• user_agent
• customer_ids
• start_date

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Developer Token (developer_token) #

Your Developer Token for Google AdWord Application

OAuth Client ID (oauth_client_id) #

Your Google OAuth Client ID

OAuth Client Secret (oauth_client_secret) #

Your Google OAuth Client Secret

Access Token (refresh_token) #

The Refresh Token generated through the OAuth flow run using your OAuth Client and your Developer Token

Account ID(s) (customer_ids) #

A comma-separated list of Ad Account IDs to replicate data from

start_date #

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

end_date #

Date up to when historical data will be extracted.

User Agent for your OAuth Client (user_agent) #

• Default: tap-adwords via Meltano

The User Agent for your OAuth Client (used in requests made to the AdWords API)

Conversion Window Days (conversion_window_days) #

• Default: 0

How many Days before the Start Date to fetch data for Performance Reports

Primary Keys (primary_keys) #

• Default: {"KEYWORDS_PERFORMANCE_REPORT"=>["customerID", "campaignID", "adGroupID", "keywordID", "day", "network", "device"], "AD_PERFORMANCE_REPORT"=>["customerID", "campaignID", "adGroupID", "adID", "day", "network", "device"]}

Primary Keys for the selected Entities (Streams)

Additional Setup Instructions #

How to get your Customer ID(s) #

Customer ID(s) are also known as Account ID(s).

To get your Account ID(s):

1. Visit the Google Ads management interface: https://ads.google.com/
2. Log in if you haven’t already.
3. Make sure the correct account is selected in the top left corner.

1. You will see the Account ID displayed inside the selector to the right of the account name, with added dashes for readability.

Remove the dashes before you enter the ID in Meltano: 205-667-8813 becomes 2056678813.

If you want to extract data from multiple Ad Accounts, repeat the steps above to find the IDs (without dashes), and enter them in Meltano separated by commas (,).

For example:

• One Account ID: 1234567890
• Multiple Account IDs: 1234567890,1234567891,1234567892

How to use Primary Keys #

Manage this setting directly in your meltano.yml project file:

plugins:
  extractors:
  - name: tap-adwords
    variant: singer-io
    config:
      primary_keys:
        <REPORT_NAME>: [<key1>, <key2>]
        # ...

Alternatively, manage this setting using meltano config or an environment variable:

meltano config tap-adwords set primary_keys <REPORT_NAME> '["<key>", ...]'

export TAP_ADWORDS_PRIMARY_KEYS='{"<REPORT_NAME>": ["<key>", ...], ...}'

# Once primary keys have been set in `meltano.yml`, environment variables can be used
# to override specific nested properties:
export TAP_ADWORDS_PRIMARY_KEYS_<REPORT_NAME>=='["<key>", ...]'

# For example:
meltano config tap-adwords set primary_keys KEYWORDS_PERFORMANCE_REPORT '["customerID"]'

export TAP_ADWORDS_PRIMARY_KEYS_KEYWORDS_PERFORMANCE_REPORT='["customerID"]'

Looking for help? #

If you're having trouble getting the tap-adwords tap to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!