Google Ads¶

Google Ads, formerly known as Google Adwords, is an online advertising platform developed by Google, where advertisers bid to display brief advertisements, service offerings, product listings, and videos to web users. It can place ads in the results of search engines like Google Search (the Google Search Network), mobile apps, videos, and on non-search websites.

URI format¶

Google Ads supports two authentication methods: service account and OAuth2. Both require a developer token.

Service Account¶

googleads://<customer_id>?credentials_path=/path/to/service-account.json&dev_token=<dev_token>

OAuth2¶

googleads://<customer_id>?client_id=<client_id>&client_secret=<client_secret>&refresh_token=<refresh_token>&dev_token=<dev_token>

URI parameters:

customer_id: Customer ID of the Google Ads account to use. You can specify multiple customer IDs separated by commas (e.g., 1234567890,0987654321,1122334455).
dev_token: developer token to use for accessing the account.
credentials_path: path to the service account JSON file (service account auth).
client_id: OAuth2 client ID (OAuth2 auth).
client_secret: OAuth2 client secret (OAuth2 auth).
refresh_token: OAuth2 refresh token (OAuth2 auth).
login_customer_id (optional): The Manager Account (MCC) ID to use when accessing client accounts. Required when your service account has access to an MCC and you want to pull data from a client account under that MCC. See Google Ads API docs for more details.

[!NOTE] For service account auth, you may specify credentials using credentials_base64 instead of credentials_path. The value of this parameter is the base64 encoded contents of the service account json file. However, we don’t recommend using this parameter, unless you’re integrating omniload into another system.

Setting up a Google Ads integration¶

Prerequisites¶

A Google Ads developer token
A Google Ads account
Either a Google Cloud service account or OAuth2 credentials (client ID, client secret, and refresh token)

Obtaining necessary credentials¶

Option 1: Service Account¶

You can use the Google Cloud IAM Console to create a service account for ingesting data from Google Ads. Make sure to enable Google Ads API in your console.

Next, you need to add your service account user to your Google Ads account. See Google Developers Docs for exact steps.

Option 2: OAuth2¶

Create OAuth2 credentials in the Google Cloud Console and enable the Google Ads API in the same project. You will need the client_id, client_secret, and a refresh_token obtained through the OAuth2 flow. See Google Ads API docs for more details.

Developer Token & Customer ID¶

For both methods, you need to obtain a Google Ads Developer Token. Developer token lets your app connect to the Google Ads API. Each developer token is assigned an API access level which controls the number of API calls you can make per day with as well as the environment to which you can make calls. See Google Ads docs for more information on how to obtain this token.

You also need the 10-digit customer id of the account you’re making API calls to. This is displayed in the Google Ads web interface in the form 123-456-7890. In this case, your customer id would be 1234567890

Examples¶

Service Account¶

Let’s say we want to ingest information about campaigns (on a daily interval) and save them to a table public.campaigns in duckdb database called adverts.db.

For this example, we’ll assume that:

The service account JSON file is located in the current directory and is named svc_account.json
customer id is 1234567890
the developer token is dev-token-spec-1

You can run the following to achieve this:

omniload ingest \
  --source-uri "googleads://12345678?credentials_path=./svc_account.json&dev_token=dev-token-spec-1" \
  --source-table "campaign_report_daily" \
  --dest-uri "duckdb://./adverts.db" \
  --dest-table "public.campaigns"

OAuth2¶

Using OAuth2 credentials instead of a service account:

omniload ingest \
  --source-uri "googleads://1234567890?client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&refresh_token=YOUR_REFRESH_TOKEN&dev_token=dev-token-spec-1" \
  --source-table "campaign_report_daily" \
  --dest-uri "duckdb://./adverts.db" \
  --dest-table "public.campaigns"

Using a Manager Account (MCC)¶

If your service account has access to a Manager Account (MCC) and you want to pull data from a client account under that MCC, you need to specify the login_customer_id parameter:

omniload ingest \
  --source-uri "googleads://CLIENT_ID?credentials_path=./svc_account.json&dev_token=dev-token-spec-1&login_customer_id=MCC_ID" \
  --source-table "campaign_report_daily" \
  --dest-uri "duckdb://./adverts.db" \
  --dest-table "public.campaigns"

Where:

CLIENT_ID is the customer ID of the client account you want to pull data from
MCC_ID is the customer ID of the Manager Account that has access to the client account

Multiple Customer IDs¶

You can ingest data from multiple Google Ads accounts in a single command by specifying comma-separated customer IDs:

omniload ingest \
  --source-uri "googleads://1234567890,0987654321,1122334455?credentials_path=./svc_account.json&dev_token=dev-token-spec-1" \
  --source-table "campaign_report_daily" \
  --dest-uri "duckdb://./adverts.db" \
  --dest-table "public.campaigns"

When using multiple customer IDs, each row in the output will include a customer_id field to identify which account the data came from.

Overriding Customer IDs per Table¶

You can override the customer IDs from the URI by appending :customer_ids to the table name:

omniload ingest \
  --source-uri "googleads://default_customer?credentials_path=./svc_account.json&dev_token=dev-token-spec-1" \
  --source-table "campaign_report_daily:1234567890,0987654321" \
  --dest-uri "duckdb://./adverts.db" \
  --dest-table "public.campaigns"

This will use 1234567890 and 0987654321 instead of default_customer from the URI.

Tables¶

Name	Description
`account_report_daily`	Provides daily metrics aggregated at the account level.
`campaign_report_daily`	Provides daily metrics aggregated at the campaign level.
`ad_group_report_daily`	Provides daily metrics aggregated at the ad group level.
`ad_report_daily`	Provides daily metrics aggregated at the ad level.
`audience_report_daily`	Provides daily metrics aggregated at the audience level.
`keyword_report_daily`	Provides daily metrics aggregated at the keyword level.
`click_report_daily`	Provides daily metrics on clicks.
`landing_page_report_daily`	Provides daily metrics on landing page performance.
`search_keyword_report_daily`	Provides daily metrics on search keywords.
`search_term_report_daily`	Provides daily metrics on search terms.
`lead_form_submission_data_report_daily`	Provides daily metrics on lead form submissions.
`local_services_lead_report_daily`	Provides daily metrics on local services leads.
`local_services_lead_conversations_report_daily`	Provides daily metrics on local services lead conversations.

Custom Reports¶

googleads source supports custom reports. You can pass a custom report definition to --source-table and it will dynamically create a report for you. These reports are aggregated at a daily interval.

The format of a custom report looks like the following:

daily:{resource_name}:{dimensions}:{metrics}:{customer_ids}

Where:

{resource_name} is a Google Ads Resource.
{dimensions} is a comma separated list of the Resource’s attribute fields, or fields of attributed resources.
{metrics} is a comma separated list of the Resource’s metrics. Note that the metrics. prefix is optional.
{customer_ids} (optional) is a comma separated list of customer IDs to use for this report. If not provided, the customer IDs from the URI will be used.

Notes:

{dimensions} and {metrics} are required.
segments are currently not supported as dimensions.
segments.date is automatically added to all custom reports.

Custom Report Example¶

For this example, we will ingest data from ad_group_ad_asset_view. We want to obtain the following info: dimensions

ad_group.id
campagin.id
customer.id metrics
metrics.clicks
metrics.conversions
metrics.impressions

To achieve this, we pass a daily report specification to omniload source table as follows:

omniload ingest \
  --source-uri "googleads://12345678?credentials_path=./svc_account.json&dev_token=dev-token-spec-1" \
  --source-table "daily:ad_group_ad_asset_view:ad_group.id,campaign.id,customer.id:clicks,conversions,impressions" \
  --dest-uri "duckdb:///custom.db" \
  --dest-table "public.report"

Notice the lack of metrics. prefix in the metrics segment. Please note that --dest-table is mandatory when creating a custom report.

With Custom Customer IDs

You can specify customer IDs directly in the custom report definition. This overrides the customer IDs from the URI:

omniload ingest \
  --source-uri "googleads://default_customer?credentials_path=./svc_account.json&dev_token=dev-token-spec-1" \
  --source-table "daily:ad_group_ad_asset_view:ad_group.id,campaign.id,customer.id:clicks,conversions,impressions:1234567890,0987654321" \
  --dest-uri "duckdb:///custom.db" \
  --dest-table "public.report"

In this example, 1234567890 and 0987654321 will be used instead of default_customer from the URI.

GAQL Queries¶

In addition to predefined tables and custom reports, you can execute raw Google Ads Query Language (GAQL) queries directly. This gives you full flexibility to query any resource with any combination of fields, segments, and metrics.

GAQL Query Format¶

To run a GAQL query, use the gaql_query: prefix followed by your query:

omniload ingest \
  --source-uri "googleads://CUSTOMER_ID?credentials_path=./svc_account.json&dev_token=dev-token-spec-1&login_customer_id=MCC_ID" \
  --source-table "gaql_query:SELECT campaign.id, campaign.name, campaign.status FROM campaign LIMIT 10" \
  --dest-uri "duckdb://./adverts.db" \
  --dest-table "public.campaigns"

Date Filtering with Placeholders¶

GAQL queries support special placeholders for date filtering that integrate with omniload’s --interval-start and --interval-end parameters:

:interval_start - Replaced with the value of --interval-start (defaults to 1970-01-01 if not provided)
:interval_end - Replaced with the value of --interval-end (defaults to today’s date if not provided)

Example with date range:

omniload ingest \
  --source-uri "googleads://CUSTOMER_ID?credentials_path=./svc_account.json&dev_token=dev-token-spec-1&login_customer_id=MCC_ID" \
  --source-table "gaql_query:SELECT campaign.id, campaign.name, metrics.impressions, metrics.clicks, segments.date FROM campaign WHERE segments.date BETWEEN :interval_start AND :interval_end" \
  --dest-uri "duckdb://./adverts.db" \
  --dest-table "public.campaign_metrics" \
  --interval-start "2024-01-01" \
  --interval-end "2024-01-31"

GAQL Query Examples¶

Get all campaigns with their status:

--source-table "gaql_query:SELECT campaign.id, campaign.name, campaign.status, campaign.advertising_channel_type FROM campaign"

Get ad group performance metrics:

--source-table "gaql_query:SELECT ad_group.id, ad_group.name, campaign.name, metrics.impressions, metrics.clicks, metrics.cost_micros, segments.date FROM ad_group WHERE segments.date DURING LAST_30_DAYS"

Get keyword performance:

--source-table "gaql_query:SELECT ad_group_criterion.keyword.text, ad_group_criterion.keyword.match_type, metrics.impressions, metrics.clicks, metrics.conversions, segments.date FROM keyword_view WHERE segments.date DURING LAST_7_DAYS"

Get search terms report:

--source-table "gaql_query:SELECT search_term_view.search_term, campaign.name, ad_group.name, metrics.impressions, metrics.clicks, metrics.cost_micros FROM search_term_view WHERE segments.date DURING LAST_30_DAYS ORDER BY metrics.impressions DESC LIMIT 100"

[!NOTE] GAQL queries use append write disposition by default. Each row includes a customer_id field to identify which account the data came from.

[!TIP] Use the Google Ads Query Builder to construct and validate your GAQL queries before using them with omniload.