tap-adwords - Meltano Hub

Google Ads

tap-adwords (meltano variant)🥉

Advertising Platform

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

This plugin is deprecated and not recommended for use. Please use another variant.

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
```
:

meltano add extractor tap-adwords --variant meltano

Configure the tap-adwords settings using

meltano config

:

meltano config tap-adwords set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-adwords test

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 for tap-adwords 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:

discover
properties
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:

conversion_window_days
customer_ids
developer_token
end_date
oauth_client_id
oauth_client_secret
primary_keys
refresh_token
start_date
user_agent

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-adwords 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_ADWORDS_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-adwords set conversion_window_days [value]

Account ID(s) (customer_ids)

Environment variable: TAP_ADWORDS_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-adwords set customer_ids [value]

Developer Token (developer_token)

Environment variable: TAP_ADWORDS_DEVELOPER_TOKEN

Your Developer Token for Google AdWord Application

Configure this setting directly using the following Meltano command:

meltano config tap-adwords set developer_token [value]

(end_date)

Environment variable: TAP_ADWORDS_END_DATE

Date up to when historical data will be extracted.

Configure this setting directly using the following Meltano command:

meltano config tap-adwords set end_date [value]

OAuth Client ID (oauth_client_id)

Environment variable: TAP_ADWORDS_OAUTH_CLIENT_ID

Your Google OAuth Client ID

Configure this setting directly using the following Meltano command:

meltano config tap-adwords set oauth_client_id [value]

OAuth Client Secret (oauth_client_secret)

Environment variable: TAP_ADWORDS_OAUTH_CLIENT_SECRET

Your Google OAuth Client Secret

Configure this setting directly using the following Meltano command:

meltano config tap-adwords set oauth_client_secret [value]

Primary Keys (primary_keys)

Environment variable: TAP_ADWORDS_PRIMARY_KEYS
Default Value: {"AD_PERFORMANCE_REPORT":["customerID","campaignID","adGroupID","adID","day","network","device"],"KEYWORDS_PERFORMANCE_REPORT":["customerID","campaignID","adGroupID","keywordID","day","network","device"]}

Primary Keys for the selected Entities (Streams)

Configure this setting directly using the following Meltano command:

meltano config tap-adwords set primary_keys [value]

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

Configure this setting directly using the following Meltano command:

meltano config tap-adwords set refresh_token [value]

(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.

Configure this setting directly using the following Meltano command:

meltano config tap-adwords set start_date [value]

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)

Configure this setting directly using the following Meltano command:

meltano config tap-adwords set user_agent [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

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

Install

meltano add extractor tap-adwords --variant meltano

Maintenance Status

Repo

https://gitlab.com/meltano/tap-adwords

Maintainer

Keywords