The tap-googleads extractor pulls data from Google Ads that can then be sent to a destination using a loader.
Alternate Implementations
-
Airbyte
🥉
- Matatika (default)
-
Stitch Data
🥈
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-googleadsmeltano 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:
- about
- batch
- catalog
- discover
- schema-flattening
- state
- stream-maps
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:
customer_idcustomer_idsdeveloper_tokenenable_click_view_report_streamend_datelogin_customer_idoauth_credentials.client_idoauth_credentials.client_secretoauth_credentials.refresh_tokenstart_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.
Customer ID (customer_id)
-
Environment variable:
TAP_GOOGLEADS_CUSTOMER_ID
DEPRECATED: use customer_ids
Get data for a customer by the provided ID. Defaults to all customers accessible to the authenticated principal.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set customer_id [value]Customer IDs (customer_ids)
-
Environment variable:
TAP_GOOGLEADS_CUSTOMER_IDS
Get data for customers by the provided IDs. Defaults to all customers accessible to the authenticated principal.
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
Developer Token (Required) - Obtain your developer token
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set developer_token [value]Enable Click View Report Stream (enable_click_view_report_stream)
-
Environment variable:
TAP_GOOGLEADS_ENABLE_CLICK_VIEW_REPORT_STREAM -
Default Value:
false
Enable the click view report stream. Default to false. This requires certain
permissions to be set for your Google Ads account(s).
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set enable_click_view_report_stream [value]End Date (end_date)
-
Environment variable:
TAP_GOOGLEADS_END_DATE
Date to sync data up to (ISO8601). Defaults to the current day.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set end_date [value]Login Customer ID (login_customer_id)
-
Environment variable:
TAP_GOOGLEADS_LOGIN_CUSTOMER_ID
If authenticated as a manager account, login_customer_id should be set to the
customer ID of the manager account. Read about the login customer ID concept
for more info.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set login_customer_id [value]OAuth Credentials Client ID (oauth_credentials.client_id)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CREDENTIALS_CLIENT_ID
OAuth Client ID (Required) - Obtain your credentials
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set oauth_credentials client_id [value]OAuth Credentials Client Secret (oauth_credentials.client_secret)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CREDENTIALS_CLIENT_SECRET
OAuth Client Secret (Required) - Obtain your credentials
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set oauth_credentials client_secret [value]OAuth Credentials Refresh Token (oauth_credentials.refresh_token)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CREDENTIALS_REFRESH_TOKEN
OAuth Refresh Token (Required) - Obtain your credentials
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set oauth_credentials refresh_token [value]Start Date (start_date)
-
Environment variable:
TAP_GOOGLEADS_START_DATE
Date to sync data from (ISO8601). Defaults to 90 days before the current day.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set start_date [value]Expand To Show SDK Settings
Batch Config Encoding Compression (batch_config.encoding.compression)
-
Environment variable:
TAP_GOOGLEADS_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set batch_config encoding.compression [value]Batch Config Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_GOOGLEADS_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set batch_config encoding.format [value]Batch Config Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_GOOGLEADS_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set batch_config storage.prefix [value]Batch Config Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_GOOGLEADS_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set batch_config storage.root [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_GOOGLEADS_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_GOOGLEADS_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_GOOGLEADS_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_GOOGLEADS_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-googleads set stream_maps [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}
-3,221-c0c0c4){kind=icon}
-142-c0c0c4){kind=icon}
