Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 5.33 KB

google-adwords.md

File metadata and controls

70 lines (44 loc) · 5.33 KB
Raw

Google Adwords

{% hint style="warning" %} If you don't already have a developer token from Google Ads, make sure you follow the instructions so your request doesn't get denied. {% endhint %}

Overview

The Adwords source supports Full Refresh syncs. That is, every time a sync is run, Airbyte will copy all rows in the tables and columns you set up for replication into the destination in a new table.

This Adwords source wraps the Singer Adwords Tap.

Output schema

Several output streams are available from this source (accounts, campaigns, ads, etc.) For a comprehensive output schema look at the Singer tap schema files.

Features

Feature Supported?
Full Refresh Sync Yes
Incremental Sync Coming soon
Replicate Incremental Deletes Coming soon
SSL connection Yes
Namespaces No

Performance considerations

This source is constrained by whatever API limits are set for the Google Adwords Manager that is used. You can read more about those limits in the google developer docs.

Getting started

Requirements

  • Google Adwords Manager Account with an approved Developer Token (note: In order to get API access to Google Adwords, you must have a "manager" account. This must be created separately from your standard account. You can find more information about this distinction in the google ads docs.)

Setup guide

This guide will provide information as if starting from scratch. Please skip over any steps you have already completed.

  • Create an Adwords Account. Here are Google's instruction on how to create one.
  • Create an Adwords MANAGER Account. Here are Google's instruction on how to create one.
  • You should now have two Google Ads accounts: a normal account and a manager account. Link the Manager account to the normal account following Google's documentation.
  • Apply for a developer token (make sure you follow our instructions) on your Manager account. This token allows you to access your data from the Google Ads API. Here are Google's instructions. The docs are a little unclear on this point, but you will not be able to access your data via the Google Ads API until this token is approved. You cannot use a test developer token, it has to be at least a basic developer token. It usually takes Google 24 hours to respond to these applications. This developer token is the value you will use in the developer_token field.
  • Fetch your client_id, client_secret, and refresh_token. Google provides instructions on how to do this.
  • Select your customer_ids. The customer_ids refer to the id of each of your Google Ads accounts. This is the 10 digit number in the top corner of the page when you are in google ads ui. The source will only pull data from the accounts for which you provide an id. If you are having trouble finding it, check out Google's instructions.

Wow! That was a lot of steps. We are working on making the OAuth flow for all of our connectors simpler (allowing you to skip needing to get a developer_token and a refresh_token which are the most painful / time-consuming steps in this walkthrough).

How to apply for the developer token

Google is very picky about which software and which use case can get access to a developer token. The Airbyte team has worked with the Google Ads team to whitelist Airbyte and make sure you can get one (see issue 1981 for more information).

When you apply for a token, you need to mention:

  • Why you need the token (eg: want to run some internal analytics...)
  • That you will be using the Airbyte Open Source project
  • That you have full access to the code base (because we're open source)
  • That you have full access to the server running the code (because you're self-hosting Airbyte)

If for any reason the request gets denied, let us know and we will be able to unblock you.

Tokens issued after April 28, 2021 are only given access to the Google Ads API as the AdWords API is no longer available for new users. Thus, this source can only be used if you already have a token issued previously. A new source using the Google Ads API is being built (see issue 3457 for more information).

Changelog

Version Date Pull Request Subject
0.1.2 2021-06-25 4205 Set up CDK SAT tests. Incremental tests are disabled due to unsupported state structure in current tests: required structure: {stream_name: cursor_value} given {‘bookmarks’: {stream_name: cursor_value}}