The tap-googleads extractor pulls data from Google Ads that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-googleads extractor to your
project using
:meltano add -
Configure the tap-googleads
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-googleads --variant singer-iomeltano config tap-googleads set --interactivemeltano config tap-googleads testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-googleads
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:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-googleads 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:
conversion_window_dayscustomer_idsdeveloper_tokenend_datelogin_customer_idsoauth_client_idoauth_client_secretrefresh_tokenrequest_timeoutstart_date
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-googleads 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.
Conversion Window Days (conversion_window_days)
-
Environment variable:
TAP_GOOGLEADS_CONVERSION_WINDOW_DAYS -
Default Value:
0
How many Days before the Start Date to fetch data for Performance Reports
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set conversion_window_days [value]Account ID(s) (customer_ids)
-
Environment variable:
TAP_GOOGLEADS_CUSTOMER_IDS
A comma-separated list of Ad Account IDs to replicate data from
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set customer_ids [value]Developer Token (developer_token)
-
Environment variable:
TAP_GOOGLEADS_DEVELOPER_TOKEN
Your Developer Token for Google AdWord Application
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set developer_token [value] (end_date)
-
Environment variable:
TAP_GOOGLEADS_END_DATE
Date up to when historical data will be extracted.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set end_date [value]Account ID(s) (login_customer_ids)
-
Environment variable:
TAP_GOOGLEADS_LOGIN_CUSTOMER_IDS
A list of dicts containing account IDs to replicate data from.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set login_customer_ids [value]OAuth Client ID (oauth_client_id)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CLIENT_ID
Your Google OAuth Client ID
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set oauth_client_id [value]OAuth Client Secret (oauth_client_secret)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CLIENT_SECRET
Your Google OAuth Client Secret
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set oauth_client_secret [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_GOOGLEADS_REFRESH_TOKEN
The Refresh Token generated through the OAuth flow run using your OAuth Client and your Developer Token
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set refresh_token [value]Request Timeout (s) (request_timeout)
-
Environment variable:
TAP_GOOGLEADS_REQUEST_TIMEOUT -
Default Value:
900
The request timeout in seconds.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set request_timeout [value] (start_date)
-
Environment variable:
TAP_GOOGLEADS_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.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set start_date [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-23-c0c0c4){kind=icon}
-1-c0c0c4){kind=icon}
