Google Ads

tap-adwords from singer-io

Advertising Platform

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

Available Variants

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-adwords extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-adwords
  3. Configure the tap-adwords settings using
    meltano config
    :
  4. meltano config tap-adwords set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-adwords test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-adwords may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • properties
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-adwords settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Developer Token (developer_token)

  • Environment variable: TAP_ADWORDS_DEVELOPER_TOKEN

Your Developer Token for Google AdWord Application

OAuth Client ID (oauth_client_id)

  • Environment variable: TAP_ADWORDS_OAUTH_CLIENT_ID

Your Google OAuth Client ID

OAuth Client Secret (oauth_client_secret)

  • Environment variable: TAP_ADWORDS_OAUTH_CLIENT_SECRET

Your Google OAuth Client Secret

Access Token (refresh_token)

  • Environment variable: TAP_ADWORDS_REFRESH_TOKEN

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

Account ID(s) (customer_ids)

  • Environment variable: TAP_ADWORDS_CUSTOMER_IDS

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

(start_date)

  • Environment variable: TAP_ADWORDS_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)

  • Environment variable: TAP_ADWORDS_END_DATE

Date up to when historical data will be extracted.

User Agent for your OAuth Client (user_agent)

  • Environment variable: TAP_ADWORDS_USER_AGENT
  • Default Value: 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)

  • Environment variable: TAP_ADWORDS_CONVERSION_WINDOW_DAYS
  • Default Value: 0

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

Primary Keys (primary_keys)

  • Environment variable: TAP_ADWORDS_PRIMARY_KEYS
  • Default Value: {"AD_PERFORMANCE_REPORT":["customerID","campaignID","adGroupID","adID","day","network","device"],"KEYWORDS_PERFORMANCE_REPORT":["customerID","campaignID","adGroupID","keywordID","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.

Screenshot of account selector

  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"]'

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-adwords extractor 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.

Install

meltano add extractor tap-adwords

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • api