Google Ads

tap-googleads (airbyte variant)🥉

Google Advertising Platform

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

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

Container-based connectors can introduce deployment challenges including the potential need to run Docker-in-Docker (not currently supported by services like AWS ECS, Meltano Cloud, etc. see FAQ and Airbyte's ECS deployment docs for more details). Before using this variant we recommend considering if/how you will be able to deploy container-based connectors to production.

For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-googleads extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-googleads --variant airbyte
  3. Configure the tap-googleads settings using
    meltano config
    :
  4. meltano config tap-googleads set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-googleads test

Next steps

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
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening

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:

You can also list these settings using

meltano config
with the list 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.

Airbyte Spec Image (airbyte_spec.image)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-google-ads

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_GOOGLEADS_DOCKER_MOUNTS

Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set docker_mounts [value]

Airbyte Config Credentials Developer Token (airbyte_config.credentials.developer_token)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_CREDENTIALS_DEVELOPER_TOKEN

Developer token granted by Google to use their APIs. More instruction on how to find this value in our docs


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config credentials.developer_token [value]

Airbyte Config Credentials Client Id (airbyte_config.credentials.client_id)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_CREDENTIALS_CLIENT_ID

The Client ID of your Google Ads developer application. More instruction on how to find this value in our docs


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config credentials.client_id [value]

Airbyte Config Credentials Client Secret (airbyte_config.credentials.client_secret)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_CREDENTIALS_CLIENT_SECRET

The Client Secret of your Google Ads developer application. More instruction on how to find this value in our docs


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config credentials.client_secret [value]

Airbyte Config Credentials Refresh Token (airbyte_config.credentials.refresh_token)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_CREDENTIALS_REFRESH_TOKEN

The token for obtaining a new access token. More instruction on how to find this value in our docs


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config credentials.refresh_token [value]

Airbyte Config Credentials Access Token (airbyte_config.credentials.access_token)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_CREDENTIALS_ACCESS_TOKEN

Access Token for making authenticated requests. More instruction on how to find this value in our docs


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config credentials.access_token [value]

Airbyte Config Customer Id (airbyte_config.customer_id)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_CUSTOMER_ID

Comma separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. More instruction on how to find this value in our docs. Metrics streams like AdGroupAdReport cannot be requested for a manager account.


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config customer_id [value]

Airbyte Config Start Date (airbyte_config.start_date)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_START_DATE

UTC date and time in the format 2017-01-25. Any data before this date will not be replicated.


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config start_date [value]

Airbyte Config End Date (airbyte_config.end_date)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_END_DATE

UTC date and time in the format 2017-01-25. Any data after this date will not be replicated.


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config end_date [value]

Airbyte Config Custom Queries (airbyte_config.custom_queries)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_CUSTOM_QUERIES
[No description provided.]

Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config custom_queries [value]

Airbyte Config Login Customer Id (airbyte_config.login_customer_id)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_LOGIN_CUSTOMER_ID

If your access to the customer account is through a manager account, this field is required and must be set to the customer ID of the manager account (10-digit number without dashes). More information about this field you can see here


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config login_customer_id [value]

Airbyte Config Conversion Window Days (airbyte_config.conversion_window_days)

  • Environment variable: TAP_GOOGLEADS_AIRBYTE_CONFIG_CONVERSION_WINDOW_DAYS

A conversion window is the period of time after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see Google's documentation.


Configure this setting directly using the following Meltano command:

meltano config tap-googleads set airbyte_config conversion_window_days [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]

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]

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]

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-googleads extractor to work, read the Airbyte connector FAQ, look for an existing issue in the Airbyte 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-googleads --variant airbyte

Maintenance Status

  • Maintenance Status
  • Based on an Airbyte Connector

Repo

https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-google-ads
  • License

Maintainer

  • Airbyte

Keywords

  • airbyte_protocol