The tap-googleads Meltano extractor pulls data from Google Ads that can then be sent to a destination using a loader.
Other Available Variants
- matatika (default)
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 test
meltano add extractor tap-googleads
meltano config tap-googleads set --interactive
meltano test tap-googleads
Next 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-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
- about
- 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:
oauth_credentials.client_id
oauth_credentials.client_secret
oauth_credentials.refresh_token
developer_token
customer_id
start_date
end_date
oauth_credentials.authorization_url
oauth_credentials.scope
oauth_credentials.access_token
oauth_credentials.refresh_proxy_url
oauth_credentials.refresh_proxy_url_auth
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.
Client ID (oauth_credentials.client_id)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CREDENTIALS_CLIENT_ID
OAuth Client ID (Required) - Obtain your credentials
Client Secret (oauth_credentials.client_secret)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CREDENTIALS_CLIENT_SECRET
OAuth Client Secret (Required) - Obtain your credentials
Refresh Token (oauth_credentials.refresh_token)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CREDENTIALS_REFRESH_TOKEN
OAuth Refresh Token (Required) - Obtain your credentials
Developer Token (developer_token)
-
Environment variable:
TAP_GOOGLEADS_DEVELOPER_TOKEN
Developer Token (Required) - Obtain your developer token
Customer ID (customer_id)
-
Environment variable:
TAP_GOOGLEADS_CUSTOMER_ID
Customer ID (Required) of the google ads account you want to sync data from.
Start Date (start_date)
-
Environment variable:
TAP_GOOGLEADS_START_DATE
Optional date to start sycning data from.
End Date (end_date)
-
Environment variable:
TAP_GOOGLEADS_END_DATE
Optional date to sync data until.
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CREDENTIALS_AUTHORIZATION_URL
-
Default Value:
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.
OAuth Credentials Scope (oauth_credentials.scope)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CREDENTIALS_SCOPE
-
Default Value:
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.
OAuth Credentials Access Token (oauth_credentials.access_token)
-
Environment variable:
TAP_GOOGLEADS_OAUTH_CREDENTIALS_ACCESS_TOKEN
This setting only matters if you plan on doing proxy OAuth.
OAuth Credentials Refresh Proxy URL (oauth_credentials.refresh_proxy_url)
-
Environment variable:
TAP_GOOGLEADS_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
OAuth Credentials Refresh Proxy URL Auth (oauth_credentials.refresh_proxy_url_auth)
-
Environment variable:
TAP_GOOGLEADS_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
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
channel.
Install
meltano add extractor tap-googleads
Homepage
Maintenance Status
Keywords