Google Ads

garf for Google Ads & Search Ads 360 API

Interacts with Google Ads API and Search Ads 360 API.

Install

Install garf-google-ads library

pipuv

pip install garf-executors garf-google-ads

uv pip install garf-executors garf-google-ads

Google Ads

Prerequisites

• Google Ads API enabled.
• google-ads.yaml file

clipython

echo """
SELECT
  campaign.id,
  metrics.clicks AS clicks
FROM campaign
WHERE segments.date DURING LAST_7_DAYS
  " > query.sql
garf query.sql --source google-ads \
  --output console

import os

from garf.io import writer
from garf.community.google.ads import GoogleAdsApiReportFetcher

query = """
SELECT
  campaign.id,
  metrics.clicks AS clicks
FROM campaign
WHERE segments.date DURING LAST_7_DAYS
"""

fetched_report = (
  GoogleAdsApiReportFetcher(
    path_to_config=os.getenv('GOOGLE_ADS_CONFIGURATION_FILE_PATH')
  )
  .fetch(query, account=os.getenv('GOOGLE_ADS_ACCOUNT'))
)

console_writer = writer.create_writer('console')
console_writer.write(fetched_report, 'query')

Available source parameters

name	values	comments
account	Account(s) to get data from	Can be MCC(s) as well
path-to-config	Path to google-ads.yaml file	~/google-ads.yaml is a default location
expand-mcc	Whether to force account expansion if MCC is provided	False by default
customer-ids-query	Optional query to find account satisfying specific condition
version	Version of Google Ads API

Search Ads 360

Note

Install extra dependency to work with Search Ads 360 API

pip install garf-google-ads[search-ads-360]

Prerequisites

• Search Ads 360 API enabled.
• search-ads-360.yaml file.

clipython

echo """
SELECT
  campaign.id,
  metrics.clicks AS clicks
FROM campaign
WHERE segments.date DURING LAST_7_DAYS
  " > query.sql
garf query.sql --source search-ads-360 \
  --output console

import os

from garf.io import writer
from garf.community.google.ads import SearchAds360ApiReportFetcher

query = """
SELECT
  campaign.id,
  metrics.clicks AS clicks
FROM campaign
WHERE segments.date DURING LAST_7_DAYS
"""

fetched_report = (
  SearchAds360ApiReportFetcher(
    path_to_config=os.getenv('SEARCH_ADS_360_CONFIGURATION_FILE_PATH')
  )
  .fetch(query, account=os.getenv('SEARCH_ADS_360_ACCOUNT'))
)

console_writer = writer.create_writer('console')
console_writer.write(fetched_report, 'query')

Available source parameters

name	values	comments
account	Account(s) to get data from	Can be MCC(s) as well
path-to-config	Path to search-ads-360.yaml file	~/search-ads-360.yaml is a default location
expand-mcc	Whether to force account expansion if MCC is provided	False by default
customer-ids-query	Optional query to find account satisfying specific condition