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

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 #

Using the Command Line Interface #

  1. Add the tap-googleads extractor to your project using meltano add : 

    meltano add extractor tap-googleads
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

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

Capabilities #

Settings #

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.

Client ID (oauth_credentials.client_id) #

OAuth Client ID (Required) - Obtain your credentials

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set oauth_credentials.client_id <oauth_credentials.client_id>

export TAP_GOOGLEADS_OAUTH_CREDENTIALS.CLIENT_ID=<oauth_credentials.client_id>

Client Secret (oauth_credentials.client_secret) #

OAuth Client Secret (Required) - Obtain your credentials

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set oauth_credentials.client_secret <oauth_credentials.client_secret>

export TAP_GOOGLEADS_OAUTH_CREDENTIALS.CLIENT_SECRET=<oauth_credentials.client_secret>

Refresh Token (oauth_credentials.refresh_token) #

OAuth Refresh Token (Required) - Obtain your credentials

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set oauth_credentials.refresh_token <oauth_credentials.refresh_token>

export TAP_GOOGLEADS_OAUTH_CREDENTIALS.REFRESH_TOKEN=<oauth_credentials.refresh_token>

Developer Token (developer_token) #

Developer Token (Required) - Obtain your developer token

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set developer_token <developer_token>

export TAP_GOOGLEADS_DEVELOPER_TOKEN=<developer_token>

Customer ID (customer_id) #

Customer ID (Required) of the google ads account you want to sync data from.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set customer_id <customer_id>

export TAP_GOOGLEADS_CUSTOMER_ID=<customer_id>

Start Date (start_date) #

Optional date to start sycning data from.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_GOOGLEADS_START_DATE=YYYY-MM-DDTHH:MM:SSZ

End Date (end_date) #

Optional date to sync data until.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set end_date YYYY-MM-DDTHH:MM:SSZ

export TAP_GOOGLEADS_END_DATE=YYYY-MM-DDTHH:MM:SSZ

OAuth Credentials Authorization URL (oauth_credentials.authorization_url) #

  • Environment variable: TAP_GOOGLEADS_OAUTH_CREDENTIALS.AUTHORIZATION_URL
  • Default: https://oauth2.googleapis.com/token

This setting only matters if you plan on doing proxy OAuth. OAuth identity provider authorization endpoint used create and refresh tokens.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set oauth_credentials.authorization_url <oauth_credentials.authorization_url>

export TAP_GOOGLEADS_OAUTH_CREDENTIALS.AUTHORIZATION_URL=<oauth_credentials.authorization_url>

OAuth Credentials Scope (oauth_credentials.scope) #

  • Environment variable: TAP_GOOGLEADS_OAUTH_CREDENTIALS.SCOPE
  • Default: https://www.googleapis.com/auth/adwords

This setting only matters if you plan on doing proxy OAuth. OAuth scopes we need to request access to.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set oauth_credentials.scope <oauth_credentials.scope>

export TAP_GOOGLEADS_OAUTH_CREDENTIALS.SCOPE=<oauth_credentials.scope>

OAuth Credentials Access Token (oauth_credentials.access_token) #

This setting only matters if you plan on doing proxy OAuth.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set oauth_credentials.access_token <oauth_credentials.access_token>

export TAP_GOOGLEADS_OAUTH_CREDENTIALS.ACCESS_TOKEN=<oauth_credentials.access_token>

OAuth Credentials Refresh Proxy URL (oauth_credentials.refresh_proxy_url) #

This setting only matters if you plan on doing proxy OAuth. Will be called with ‘oauth_credentials.refresh_token’ to refresh the access token

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set oauth_credentials.refresh_proxy_url <oauth_credentials.refresh_proxy_url>

export TAP_GOOGLEADS_OAUTH_CREDENTIALS.REFRESH_PROXY_URL=<oauth_credentials.refresh_proxy_url>

OAuth Credentials Refresh Proxy URL Auth (oauth_credentials.refresh_proxy_url_auth) #

This setting only matters if you plan on doing proxy OAuth. Sets Authorization header on ‘oauth_credentials.refresh_url’ request

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-googleads set oauth_credentials.refresh_proxy_url_auth <oauth_credentials.refresh_proxy_url_auth>

export TAP_GOOGLEADS_OAUTH_CREDENTIALS.REFRESH_PROXY_URL_AUTH=<oauth_credentials.refresh_proxy_url_auth>

Looking for help? #

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

Found an issue on this page? #

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