 | Google Ads
Advertising Platform |
The tap-adwords Meltano extractor pulls data from Google Ads that can then be sent to a destination using a loader.
Other Available Variants
- georgiyolovski
- meltano
- singer-io (default)
- meltano (default)
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-adwords extractor to your project
using
:meltano add -
Configure the tap-adwords settings using
:meltano config -
Test that extractor settings are valid using
:meltano test
meltano add extractor tap-adwords --variant meltanomeltano config tap-adwords set --interactivemeltano test tap-adwordsNext 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 fortap-adwordsThis 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:
developer_tokenoauth_client_idoauth_client_secretrefresh_tokencustomer_idsstart_dateend_dateuser_agentconversion_window_daysprimary_keys
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:
{"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)
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-generalInstall
meltano add extractor tap-adwords --variant meltano
Maintenance Status
-brightgreen){kind=icon}
Maintainer
Meltano Stats
Keywords
