Campaign Manager 360

garf for Campaign Manager 360 API

Interacts with Campaign Manager 360 API.

Install

Install garf-campaign-manager library

pipuv

pip install garf-executors garf-campaign-manager

uv pip install garf-executors garf-campaign-manager

Usage

Prerequisites

Campaign Manager 360 API enabled.
Credentials configured, can be exposed as GARF_CAMPAIGN_MANAGER_360_CREDENTIALS_FILE ENV variable

clipython

echo """
SELECT
  dimensions.advertiser AS advertiser,
  advertiserId AS advertiser_id,
  metric.clicks AS clicks
FROM standard
WHERE
  dateRange IN (2025-01-01, 2025-12-31)
" > query.sql
garf query.sql --source campaign-manager \
  --output csv --campaign-manager.profile-id=<PROFILE_ID>

import os

from garf.io import writer
from garf.community.google.campaign_manager import CampaignManager360ApiReportFetcher

query = """
SELECT
  dimensions.advertiser AS advertiser,
  advertiserId AS advertiser_id,
  metric.clicks AS clicks
FROM standard
WHERE
  dateRange IN (2025-01-01, 2025-12-31)
"""

fetched_report = (
  CampaignManager360ApiReportFetcher(
    credentials_file=os.getenv('GARF_CAMPAIGN_MANAGER_360_CREDENTIALS_FILE'),
    profile_id=<PROFILE_ID>,
  )
  .fetch(query)
)

csv_writer = writer.create_writer('csv')
csv_writer.write(fetched_report, 'query')

Available source parameters

name	values	comments
`profile_id`	Id of CM360 profile
`credentials_file`	File with Oauth or service account credentials	You can expose `credentials_file` as `GARF_CAMPAIGN_MANAGER_360_CREDENTIALS_FILE` ENV variable
`auth_mode`	Type of authentication: `oauth` or `service_account`	`oauth` is the default mode

Query syntax

garf-campaign-manager uses simplified syntax for writing queries.

To differentiate between metrics and dimension add dimensions. or metrics. prefix before corresponding dimension / metric name. If prefix is omitted the name is treated as a dimension.