Skip to main content
Tool name list_campaigns
Read-only · Idempotent
Lists a workspace’s individual GAM campaigns (orders), one per row, with each campaign’s lifetime delivery — impressions, CTR, and active status — filtered by a name/id search, active/inactive status, and Permutive-targeting, and ordered by name, dates, impressions, or CTR. Returns one page of named campaigns at a time.

Example prompt

Show me the active Permutive-targeted campaigns across my workspaces, sorted by impressions.

Parameters

string
Restrict to campaigns whose targeting included this cohort (by short id). When set, impressions and ctr become the cohort’s own targeted figures within each campaign rather than the campaign’s lifetime totals.
string
Case-insensitive substring matched against each campaign’s name and campaign id. Omit to match all campaigns.
string
Opaque token from a previous response’s next_page_token, to fetch the next page.
boolean
When true (the default), only campaigns that use Permutive targeting; when false, all campaigns in the workspace.
enum
Field to order the listing by. Omit for the default order — active campaigns first, then soonest end date. one of: name, start_date, end_date, impressions, ctr.
enum
Order direction. Defaults to ascending. Ignored when sort_by is omitted (the default order is fixed). one of: asc, desc.
enum
Restrict to active or inactive campaigns. A campaign is active when its end date is in the future. Omit for both. one of: active, inactive.
string[]
required
Workspaces whose GAM campaigns (orders) are aggregated into a single flat list. min 1 item.

Returns

CampaignListItem[]
A page of campaigns matching the query, in the requested order.
string
Pass as page_token to fetch the next page. Absent on the last page. Expires shortly after the first page.
integer (int32)
required
Total campaigns matching the filters across all pages, before pagination.