Tool reference
These are the tools your AI can call through Ads Bridge. You do not call them yourself: you ask in plain words, and the AI picks the tool. Tools marked Changes only ever draft a change for your approval.
145 tools.
Core4
confirm_and_applyExecute a previously previewed change.ChangesCan remove- plan_idstring, required
- The plan_id returned by a prior draft_*, update_*, add_*, pause/enable/remove or other preview tool call. An unknown or expired plan_id returns an error.
- dry_runboolean, optional
- True (default) validates without changing anything; false applies the change for real.
health_checkTest AdLoop connectivity: checks OAuth token, GA4 API, Google Ads API, and (when configured) the Reddit Ads and Microsoft Advertising APIs.ReadsNo inputs. Your AI calls it as it is.
list_uploadsList the files the user uploaded to AdLoop that have not expired.ReadsNo inputs. Your AI calls it as it is.
upload_imagesLet the user upload images (PNG, JPEG, GIF up to 5 MB) for ad assets.ReadsNo inputs. Your AI calls it as it is.
Google Ads89
add_ad_scheduleDraft ad schedule windows for a campaign: returns a PREVIEW.Changes- campaign_idstring, required
- Numeric ID of the campaign.
- scheduleobject[], required
- Windows to add, each {day_of_week: MONDAY..SUNDAY, start_hour: 0-23, end_hour: 0-24, start_minute/end_minute: 0, 15, 30 or 45 (default 0)}. Whole numbers only. Hours are in the account time zone.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
add_negative_keywordsDraft negative keyword additions: returns a PREVIEW.Changes- campaign_idstring, required
- Numeric ID of the campaign that gets the negatives.
- keywordsstring[], required
- Negative keyword texts; at least one is required. All share the same match_type.
- customer_idstring, optional
- Google Ads customer ID (digits, e.g. "1234567890"). Empty uses the configured default account.
- match_typestring, optional
- "EXACT" (default), "PHRASE", or "BROAD".
add_negative_locationsDraft negative geo location additions: returns a PREVIEW.Changes- campaign_idstring, required
- Numeric ID of the campaign to add the location exclusions to.
- geo_target_idsstring[], required
- Numeric Google geo target constant IDs to exclude (e.g. "1001773"). Duplicates are collapsed; non-numeric IDs are rejected.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
add_to_brand_listAppend brands to an EXISTING brand list: returns a PREVIEW.Changes- shared_set_idstring, required
- Numeric list ID from get_brand_lists.
- brand_idsstring[], required
- Commercial Knowledge Graph MIDs from suggest_brands.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
add_to_negative_keyword_listAppend keywords to an EXISTING shared negative keyword list: returns a PREVIEW.Changes- shared_set_idstring, required
- Numeric ID of the list (shared_set.id from get_negative_keyword_lists).
- keywordsstring[], required
- Keyword strings to append. Blank entries are dropped and duplicates in the input list are collapsed (case-insensitive).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
- match_typestring, optional
- Match type applied to every keyword: "EXACT" (default), "PHRASE", or "BROAD" (case-insensitive).
attach_brand_list_to_campaignsAttach an existing brand list to one or more campaigns: returns a PREVIEW.Changes- shared_set_idstring, required
- Numeric list ID from get_brand_lists.
- campaign_idsstring[], required
- Numeric campaign IDs to attach the list to.
- negativeboolean, optional
- True (default) excludes the brands from those campaigns; False restricts targeting to them instead.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
attach_shared_set_to_campaignsAttach an existing shared set to one or more campaigns: returns a PREVIEW.Changes- shared_set_idstring, required
- Numeric ID of the shared set (from get_negative_keyword_lists).
- campaign_idsstring[], required
- Numeric campaign IDs to attach the set to (at least one). Blank entries are dropped and duplicates collapsed.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
check_brand_namesCheck a list of brand names against Google's brand knowledge graph.Reads- brand_namesstring[], required
- The names to triage, at most 25 per call: the API resolves one prefix per request, so longer lists take several calls.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
detach_brand_list_from_campaignsDetach a brand list from one or more campaigns: returns a PREVIEW.ChangesCan remove- shared_set_idstring, required
- Numeric list ID from get_brand_lists.
- campaign_idsstring[], required
- Numeric campaign IDs to detach the list from. Campaigns that do not carry the list are reported as `not_attached` in the apply result instead of failing the batch.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
detach_shared_set_from_campaignsDetach a shared set from one or more campaigns: returns a PREVIEW.Changes- shared_set_idstring, required
- Numeric ID of the shared set (from get_negative_keyword_lists).
- campaign_idsstring[], required
- Numeric campaign IDs to detach the set from (at least one). Blank entries are dropped and duplicates collapsed.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
discover_keywordsDiscover new keyword ideas using Google Ads Keyword Planner.Reads- seed_keywordsstring[], optional
- Seed terms, e.g. ["running shoes", "trail running"].
- urlstring, optional
- A landing page or site URL to extract ideas from, e.g. "https://example.com/products".
- geo_target_idstring, optional
- Geo target constant ID (2276=Germany, 2840=USA, 2826=UK). Defaults to 2276.
- language_idstring, optional
- Language constant ID (1000=English, 1001=German, 1002=French). Defaults to 1000.
- page_sizeinteger, optional
- Max keyword ideas to return (default 50, clamped to 1-1000).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes allowed). Defaults to the configured account.
- include_monthly_volumesboolean, optional
- true adds per-month search history (last 24 months, top-20 ideas) plus a seasonality insight: relevant to questions about demand trends, seasonality, or "when should I ramp budget".
draft_ad_groupDraft a new ad group within an existing campaign: returns a PREVIEW, does NOT create.Changes- campaign_idstring, required
- The campaign to add the ad group to (numeric ID as returned by get_campaign_performance).
- ad_group_namestring, required
- Name for the new ad group.
- keywordsobject[], optional
- Optional list of {"text": "keyword", "match_type": "EXACT|PHRASE|BROAD"}.
- customer_idstring, optional
- Google Ads customer ID (digits, e.g. "1234567890"). Empty uses the configured default account.
- cpc_bid_microsinteger, optional
- Optional ad group CPC bid in micros (1,000,000 = one unit of the account's currency); only used by MANUAL_CPC campaigns. 0 means no ad-group bid; must not be negative.
draft_ai_max_settingsDraft AI Max controls for a Search campaign: returns a PREVIEW.Changes- campaign_idstring, required
- Numeric ID of the Search campaign to prepare.
- enable_ai_maxboolean, optional
- Value for campaign.ai_max_setting.enable_ai_max. When omitted, it stays untouched.
- disable_search_term_matchingboolean, optional
- Value for ad_group.ai_max_ad_group_setting.disable_search_term_matching on the selected ad groups. When omitted, they stay untouched.
- ad_group_idsstring[], optional
- Explicit ad group IDs. Empty means every non-removed ad group of the campaign.
- include_paused_ad_groupsboolean, optional
- Default true: paused groups are set as well, so re-enabling one later cannot silently restore search term matching. REMOVED ad groups are never touched.
- text_asset_automationstring, optional
- OPTED_IN, OPTED_OUT or UNCHANGED (default) for TEXT_ASSET_AUTOMATION.
- final_url_expansionstring, optional
- OPTED_IN, OPTED_OUT or UNCHANGED (default) for FINAL_URL_EXPANSION_TEXT_ASSET_AUTOMATION (the v25 field name for final URL expansion).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_asset_group_assetsDraft adding and/or removing assets of a Performance Max asset group: returns a PREVIEW.Changes- asset_group_idstring, required
- Numeric asset group id (from get_pmax_performance or get_pmax_assets).
- headlinesstring[], optional
- Headlines to add, at most 30 characters each (up to 15 in the group).
- long_headlinesstring[], optional
- Long headlines to add, at most 90 characters (up to 5).
- descriptionsstring[], optional
- Descriptions to add, at most 90 characters (up to 5).
- business_namestring, optional
- Business name to add, at most 25 characters (one per group).
- imagesobject[], optional
- Images to add, each {"url": "..."} or {"upload_id": "up_..."} with an optional "role": "marketing" (default; landscape 1.91:1, square 1:1 or portrait 4:5 by aspect ratio), "logo" (1:1) or "landscape_logo" (4:1). PNG, JPEG or GIF up to 5120 KB.
- youtube_video_idsstring[], optional
- YouTube video ids to add (the 11 characters after "v=" in the URL), up to 5 per group.
- remove_asset_idsstring[], optional
- Asset ids to unlink from the group (from get_pmax_assets).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_asset_group_signalsDraft adding search themes or an audience signal to a Performance Max asset group, or removing signals: PREVIEW.Changes- asset_group_idstring, required
- Numeric asset group id (from get_pmax_performance).
- add_search_themesstring[], optional
- Search themes to add, short phrases people search for (at most 80 characters each).
- audience_idstring, optional
- Audience to set as the group's audience signal (from get_asset_group_signals available_audiences).
- remove_signal_idsstring[], optional
- Signals to remove (signal_id from get_asset_group_signals).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_assign_custom_conversion_goalPoint a campaign at a custom conversion goal: returns a PREVIEW.Changes- campaign_idstring, required
- Numeric campaign ID to configure.
- custom_conversion_goal_idstring, required
- Numeric goal ID from get_custom_conversion_goals.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
draft_audience_attachmentDraft attaching audiences to a campaign or ad group as observation, targeting or exclusion: returns a PREVIEW.Changes- campaign_idstring, optional
- Numeric campaign id. Pass this or ad_group_id.
- ad_group_idstring, optional
- Numeric ad group id. Pass this or campaign_id.
- user_list_idsstring[], optional
- Remarketing or customer lists (user_list_id from get_audience_lists).
- segment_idsstring[], optional
- In-market or affinity segments (segment_id from search_audience_segments).
- custom_audience_idsstring[], optional
- Custom segments (custom_audience_id from get_audience_lists); Display and Video only.
- combined_audience_idsstring[], optional
- Combined segments (combined_audience_id from get_audience_lists); Search only.
- modestring, optional
- "observation" (default) or "targeting". Ignored for exclusions.
- excludeboolean, optional
- True to exclude the audiences instead of adding them.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_business_name_assetDraft a business name asset for a campaign or the account: returns a PREVIEW.Changes- business_namestring, required
- The name, at most 25 characters.
- campaign_idstring, optional
- Numeric ID of the campaign to link it to.
- scopestring, optional
- Empty (campaign, from campaign_id), "campaign" or "account".
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_call_assetDraft a call asset (a phone number shown with the ads): returns a PREVIEW.Changes- phone_numberstring, required
- The number, national ("030 1234567", "(916) 555-0142") or international ("+49 30 1234567"). Normalised to E.164.
- country_codestring, required
- ISO 3166-1 alpha-2 country of the number ("DE", "US"). Required; it decides how a national number is read and must match the country code of an international one.
- campaign_idstring, optional
- Numeric ID of the campaign to link the number to.
- ad_group_idstring, optional
- Numeric ID of the ad group to link it to, instead of a campaign.
- scopestring, optional
- Empty (follows the id), "campaign", "ad_group" or "account".
- call_conversion_action_idstring, optional
- Numeric ID of the conversion action that counts calls from this number. Empty keeps the account's call conversion setting.
- ad_scheduleobject[], optional
- Optional windows when the number shows, each {day_of_week: MONDAY..SUNDAY, start_hour: 0-23, end_hour: 0-24, start_minute/end_minute: 0, 15, 30 or 45}. Hours are in the account time zone.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_calloutsDraft callout assets for an ad group, a campaign or the account: returns a PREVIEW.Changes- calloutsstring[], required
- Callout texts (at least one), each non-empty and at most 25 characters after trimming.
- campaign_idstring, optional
- Numeric ID of the campaign to link the callouts to.
- ad_group_idstring, optional
- Numeric ID of the ad group to link them to, instead of a campaign.
- scopestring, optional
- Empty (follows the id), "campaign", "ad_group" or "account".
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
- start_datestring, optional
- First day the callouts show, YYYY-MM-DD. Empty: from now.
- end_datestring, optional
- Last day the callouts show, YYYY-MM-DD, so seasonal callouts switch off by themselves. Empty: no end.
draft_campaignDraft a full campaign structure: returns a PREVIEW, does NOT create anything.Changes- campaign_namestring, required
- Name of the new campaign.
- daily_budgetnumber, required
- Daily budget in the account's currency (not micros); must be greater than 0 and at most the config's max_daily_budget.
- bidding_strategystring, required
- MAXIMIZE_CONVERSIONS | TARGET_CPA | TARGET_ROAS | MAXIMIZE_CONVERSION_VALUE | TARGET_SPEND | MANUAL_CPC. BROAD keywords require a Smart Bidding strategy (MAXIMIZE_CONVERSIONS, MAXIMIZE_CONVERSION_VALUE, TARGET_CPA, TARGET_ROAS).
- geo_target_idsstring[], required
- REQUIRED list of geo target constant IDs. Common: "2276" Germany, "2040" Austria, "2756" Switzerland, "2840" USA, "2826" UK, "2250" France. Full list: Google Ads API geo target constants.
- language_idsstring[], required
- REQUIRED list of language constant IDs. Common: "1001" German, "1000" English, "1002" French, "1003" Spanish, "1004" Italian, "1014" Portuguese. Full list: Google Ads API language constants.
- customer_idstring, optional
- Google Ads customer ID (digits, e.g. "1234567890"). Empty uses the configured default account.
- target_cpanumber, optional
- Target cost per acquisition in the account's currency; required if bidding_strategy is TARGET_CPA, optional target for MAXIMIZE_CONVERSIONS. 0 means none.
- target_roasnumber, optional
- Target return on ad spend as a ratio (e.g. 4.0 = 400%); required if bidding_strategy is TARGET_ROAS, optional target for MAXIMIZE_CONVERSION_VALUE. 0 means none.
- channel_typestring, optional
- SEARCH (default). DISPLAY, SHOPPING, VIDEO and PERFORMANCE_MAX are refused with the reason (see above).
- ad_group_namestring, optional
- Name of the initial ad group. Empty uses campaign_name.
- keywordsobject[], optional
- Optional list of {"text": "keyword", "match_type": "EXACT|PHRASE|BROAD"} added to the initial ad group.
- search_partners_enabledboolean, optional
- Include ads on Search partners (SEARCH campaigns only).
- display_network_enabledboolean, optional
- Enable Search campaign display expansion (SEARCH campaigns only). Defaults to off.
- display_expansion_enabledboolean, optional
- Alias for display_network_enabled; both must match when both are given.
- max_cpcnumber, optional
- In the account's currency: the manual CPC bid for the initial ad group when bidding_strategy is MANUAL_CPC, or the Maximize Clicks CPC cap when bidding_strategy is TARGET_SPEND. Not allowed with other strategies; 0 means none.
- location_optionstring, optional
- Who the geo targets reach. PRESENCE (people in or regularly in the locations), PRESENCE_OR_INTEREST (also people elsewhere who show interest in them) or SEARCH_INTEREST (people searching for them). Empty leaves Google's default, PRESENCE_OR_INTEREST. Anything but PRESENCE adds a warning.
- negative_location_optionstring, optional
- Who the location exclusions exclude. PRESENCE or PRESENCE_OR_INTEREST; empty leaves Google's default, PRESENCE_OR_INTEREST. PRESENCE excludes fewer people (only those physically there), so it widens reach and the preview warns.
- tracking_url_templatestring, optional
- Campaign tracking template, e.g. "{lpurl}?utm_source=google&utm_campaign={campaignid}". Must contain {lpurl} or a variant ({lpurl+2}, {unescapedlpurl}, {escapedlpurl+3}, ...). Omitted leaves it unset.
- final_url_suffixstring, optional
- Parameters appended to the landing page URL, e.g. "utm_medium=cpc". Omitted leaves it unset.
- url_custom_parametersobject[], optional
- List of {"key": "grp", "value": "b2c"}, used as {_grp} in the template. Keys alphanumeric, max 8 characters; values up to 250.
- geo_exclude_idsstring[], optional
- Geo target constant IDs to exclude (negative location criteria), e.g. a city inside a targeted state. May not overlap geo_target_ids.
- ad_scheduleobject[], optional
- Windows the campaign serves in: list of {day_of_week (MONDAY..SUNDAY), start_hour 0-23, end_hour 0-24, start_minute, end_minute (0, 15, 30 or 45)}, whole numbers, in the account time zone. No overlaps, at most six a day. Once the campaign is enabled it serves only inside them; the preview warns about that. No double confirmation, since the campaign is created PAUSED.
draft_clear_custom_conversion_goalPut a campaign back on the account-level goals: returns a PREVIEW.Changes- campaign_idstring, required
- Numeric campaign ID to reset.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
draft_create_conversion_actionDraft a new Google Ads ConversionAction: returns a PREVIEW.Changes- namestring, required
- Conversion action name as it appears in Google Ads. Required.
- type_string, required
- ConversionActionType enum value, e.g. AD_CALL, WEBSITE_CALL, WEBPAGE, WEBPAGE_CODELESS, GOOGLE_ANALYTICS_4_CUSTOM, GOOGLE_ANALYTICS_4_PURCHASE, UPLOAD_CALLS, UPLOAD_CLICKS.
- categorystring, optional
- ConversionActionCategory enum value, e.g. PHONE_CALL_LEAD, SUBMIT_LEAD_FORM, PURCHASE, ... (default DEFAULT).
- default_valuenumber, optional
- Value attributed to each conversion, in currency_code units (not micros). Must be >= 0. A positive default_value with always_use_default_value=False is a legal "fallback" config: the preview warns but does NOT flip the flag.
- currency_codestring, optional
- 3-letter ISO 4217 currency code for default_value (default USD).
- always_use_default_valueboolean, optional
- True ignores transaction values from the tag/import and always uses default_value; False uses default_value only as a fallback when no value is supplied.
- counting_typestring, optional
- ONE_PER_CLICK (default; one conversion per click, typical for lead gen) or MANY_PER_CLICK (every conversion counts, typical for ecommerce).
- phone_call_duration_secondsinteger, optional
- Minimum call length in seconds for a call to count; only meaningful for call conversions (PHONE_CALL_LEAD category). 0 leaves Google's default.
- primary_for_goalboolean, optional
- True (default) makes it a Primary action that Smart Bidding optimizes toward; False makes it Secondary (recorded only).
- include_in_conversions_metricboolean, optional
- IMMUTABLE: Google derives it from primary_for_goal and the category's goal, so this value is not sent.
- click_through_window_daysinteger, optional
- Click-through attribution window in days, 1-90. 0 leaves Google's default.
- view_through_window_daysinteger, optional
- View-through attribution window in days, 1-30. 0 leaves Google's default.
- attribution_modelstring, optional
- AttributionModel enum value, e.g. GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN. Empty leaves Google's default.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes allowed). Defaults to the configured account.
draft_custom_conversion_goalCreate a custom conversion goal: returns a PREVIEW.Changes- namestring, required
- Name for the new goal, e.g. "OHL | Kauf + qualifizierte Anrufe".
- conversion_action_idsstring[], required
- Numeric conversion action IDs. Duplicates are collapsed; unknown or REMOVED actions are refused.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
draft_demographic_targetingDraft demographic targeting (age/gender/parental status/income): returns a PREVIEW.Changes- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
- ad_group_idstring, optional
- Numeric ad group ID to add the criteria to. Mutually exclusive with campaign_id.
- campaign_idstring, optional
- Numeric campaign ID to add the criteria to. Mutually exclusive with ad_group_id; campaign-level criteria can only be exclusions (negative=True).
- age_rangesstring[], optional
- Age buckets '18-24', '25-34', '35-44', '45-54', '55-64', '65+', 'undetermined' (or canonical names such as AGE_RANGE_18_24). Google's buckets are FIXED: 'Exclude 23-35' has no exact mapping and needs a choice of buckets.
- gendersstring[], optional
- 'female', 'male', 'undetermined'.
- parental_statusesstring[], optional
- 'parent', 'not_a_parent', 'undetermined'.
- income_rangesstring[], optional
- PERCENTILES (not currency): 'top-10', '11-20', '21-30', '31-40', '41-50', 'lower-50', 'undetermined'. Available in select countries only (US, AU, JP, etc.).
- negativeboolean, optional
- True (default) excludes the listed segments; False adds positive criteria that narrow an ad group's targeting to them.
draft_dismiss_recommendationsDismiss Google Ads recommendations: returns a PREVIEW.Changes- recommendation_idsstring[], required
- `recommendation.id` values from get_recommendations, or full resource names (customers/{customer_id}/recommendations/{id}). Duplicates are collapsed.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
draft_image_assetsDraft image assets from local files, public image URLs or uploads: returns a PREVIEW.Changes- campaign_idstring, optional
- Numeric ID of the campaign to attach the images to. Leave empty with scope="account".
- image_pathsstring[], optional
- Local PNG/JPEG/GIF file paths on the machine running AdLoop. Not available on a hosted server, where image_urls applies instead.
- image_urlsstring[], optional
- Public http(s) URLs of PNG/JPEG/GIF images. Links to private, local or internal addresses are refused.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
- upload_idsstring[], optional
- Ids of images the user uploaded (up_..., from upload_images or list_uploads). The way to use an image that has no public URL.
- scopestring, optional
- Empty follows campaign_id. "account" links the images account-wide, which Google allows for BUSINESS_LOGO only and which is never inferred from an empty campaign_id. An account takes one business logo: while one is linked, the draft is refused and names the link to remove first.
- field_typesstring[], optional
- One per image, in the order upload_ids, image_paths, image_urls: AD_IMAGE (campaign links; the default) or BUSINESS_LOGO (campaign or account links). Required with scope="account".
draft_keywordsDraft keyword additions: returns a PREVIEW, does NOT add keywords.Changes- ad_group_idstring, required
- Numeric ID of the ad group that gets the keywords.
- keywordsobject[], required
- List of {"text": "keyword phrase", "match_type": "EXACT|PHRASE|BROAD"}; at least one is required.
- customer_idstring, optional
- Google Ads customer ID (digits, e.g. "1234567890"). Empty uses the configured default account.
draft_pmax_product_exclusionsDraft which products a retail Performance Max asset group excludes: returns a PREVIEW.Changes- asset_group_idstring, required
- Numeric asset group id of a Performance Max campaign with a Merchant Center feed (from get_pmax_performance).
- exclude_valuesstring[], required
- Every value to exclude, e.g. item ids from the feed, brand names or custom label values. [] removes all exclusions.
- dimensionstring, optional
- "item_id" (default), "brand", or "custom_label_0" to "custom_label_4".
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_prepare_brand_exclusionsDraft the safe standard state for brand exclusions: returns a PREVIEW.Changes- campaign_idstring, required
- Numeric ID of the Search campaign to prepare.
- include_paused_ad_groupsboolean, optional
- Default true: paused ad groups are set too, so re-enabling one later cannot silently restore search term matching.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_price_assetDraft a price asset (the row of prices under an ad): returns a PREVIEW.Changes- offeringsobject[], required
- 3-8 dicts, each with header and description (at most 25 characters each, headers unique), price (greater than 0), final_url, and optional final_mobile_url and unit (PER_HOUR, PER_DAY, PER_WEEK, PER_MONTH, PER_YEAR, PER_NIGHT).
- price_typestring, required
- SERVICES, BRANDS, EVENTS, LOCATIONS, NEIGHBORHOODS, PRODUCT_CATEGORIES, PRODUCT_TIERS, SERVICE_CATEGORIES or SERVICE_TIERS.
- language_codestring, required
- Language of the offerings' text ("de", "en"). Required.
- campaign_idstring, optional
- Numeric ID of the campaign to link the prices to.
- ad_group_idstring, optional
- Numeric ID of the ad group to link them to, instead of a campaign.
- scopestring, optional
- Empty (follows the id), "campaign", "ad_group" or "account".
- price_qualifierstring, optional
- FROM ("From 49 EUR"), UP_TO or AVERAGE; empty for none.
- currency_codestring, optional
- ISO 4217 code of the prices. Empty uses the account currency (shown in the preview).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_promotionDraft a promotion asset ("20% off winter tyres"): returns a PREVIEW.Changes- promotion_targetstring, required
- What the promotion is for, shown in the ad (at most 20 characters).
- final_urlstring, required
- Landing page of the promotion.
- language_codestring, required
- Language of the promotion's text ("de", "en"). Required: Google shows the promotion in that language.
- money_offnumber, optional
- Fixed discount, in the account currency unless currency_code says otherwise. Pass this or percent_off.
- percent_offnumber, optional
- Percentage discount, greater than 0 and at most 100 (15.5 for 15.5%). Pass this or money_off.
- campaign_idstring, optional
- Numeric ID of the campaign to link the promotion to.
- ad_group_idstring, optional
- Numeric ID of the ad group to link it to, instead of a campaign.
- scopestring, optional
- Empty (follows the id), "campaign", "ad_group" or "account".
- currency_codestring, optional
- ISO 4217 code for money_off and orders_over_amount. Empty uses the account currency (shown in the preview).
- promotion_codestring, optional
- Optional coupon code (at most 15 characters). Pass this or orders_over_amount, not both.
- orders_over_amountnumber, optional
- Optional minimum order value that unlocks the promotion.
- occasionstring, optional
- Optional occasion such as BLACK_FRIDAY, CHRISTMAS or SUMMER_SALE.
- discount_modifierstring, optional
- "UP_TO" shows "Up to 20% off"; empty for none.
- start_datestring, optional
- First day the promotion shows, YYYY-MM-DD.
- end_datestring, optional
- Last day the promotion shows, YYYY-MM-DD.
- redemption_start_datestring, optional
- First day the offer can be redeemed, YYYY-MM-DD.
- redemption_end_datestring, optional
- Last day the offer can be redeemed, YYYY-MM-DD.
- ad_scheduleobject[], optional
- Optional windows when the promotion shows, each {day_of_week: MONDAY..SUNDAY, start_hour: 0-23, end_hour: 0-24, start_minute/end_minute: 0, 15, 30 or 45}. Hours are in the account time zone.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_recommendation_subscriptionsPause auto-apply for recommendation types: returns a PREVIEW.Changes- recommendation_typesstring[], required
- RecommendationType names with an ENABLED subscription, e.g. ["KEYWORD", "USE_BROAD_MATCH_KEYWORD"]. Duplicates are collapsed.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
draft_remove_conversion_actionDraft a REMOVAL of a ConversionAction: returns a PREVIEW.Changes- conversion_action_idstring, required
- Numeric ConversionAction ID, e.g. from SELECT conversion_action.id, conversion_action.name FROM conversion_action.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes allowed). Defaults to the configured account.
draft_responsive_search_adDraft a Responsive Search Ad: returns a PREVIEW, does NOT create the ad.Changes- ad_group_idstring, required
- Numeric ID of the ad group that gets the ad.
- headlinesstring | object[], required
- 3-15 headlines, max 30 chars each. Each entry is a plain string (unpinned) or {"text": "...", "pinned_field": "HEADLINE_1"}; valid pins are HEADLINE_1, HEADLINE_2, HEADLINE_3. Keyword or location insertion such as {KeyWord:Drain Cleaning} counts as its default text, which is required.
- descriptionsstring | object[], required
- 2-4 descriptions, max 90 chars each. Each entry is a plain string (unpinned) or {"text": "...", "pinned_field": "DESCRIPTION_1"}; valid pins are DESCRIPTION_1, DESCRIPTION_2. Insertion tags count as their default text, as for headlines.
- final_urlstring, required
- Landing page URL the ad links to; must be reachable.
- customer_idstring, optional
- Google Ads customer ID (digits, e.g. "1234567890"). Empty uses the configured default account.
- path1string, optional
- Optional first display-URL path segment (Google allows up to 15 chars).
- path2string, optional
- Optional second display-URL path segment (Google allows up to 15 chars).
draft_shopping_campaignDraft a Standard Shopping campaign that advertises a Merchant Center feed: returns a PREVIEW.Changes- campaign_namestring, required
- Name of the new campaign.
- daily_budgetnumber, required
- Daily budget in account currency, checked against the max_daily_budget safety cap.
- merchant_idstring, required
- Numeric Merchant Center id (from list_merchant_accounts) whose products the campaign advertises.
- product_bidnumber, required
- CPC bid of the "All products" group in account currency. Google requires it even when the bid strategy sets bids.
- geo_target_idsstring[], required
- Countries or regions as geo target constant ids, e.g. ["2276"] for Germany. Required.
- bidding_strategystring, optional
- MANUAL_CPC (default), TARGET_SPEND (Maximize clicks) or TARGET_ROAS.
- target_roasnumber, optional
- Target return on ad spend for TARGET_ROAS, e.g. 4.0 for 400%.
- max_cpcnumber, optional
- Optional CPC ceiling for TARGET_SPEND, in account currency.
- campaign_prioritystring, optional
- LOW (default), MEDIUM or HIGH. With several Shopping campaigns on the same products, the higher priority serves first.
- feed_labelstring, optional
- Optional feed label to limit the campaign to one feed of the Merchant Center account.
- ad_group_namestring, optional
- Optional ad group name; defaults to "<campaign> - All products".
- search_partners_enabledboolean, optional
- Also serve on Google search partners.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_sitelinksDraft sitelink extensions for a campaign or the account: returns a PREVIEW.Changes- sitelinksobject[], required
- List of dicts (at least one), each with link_text (str, required, max 25 chars): the clickable text shown; final_url (str, required): destination URL for this sitelink; description1 (str, optional, max 35 chars): first description line; description2 (str, optional, max 35 chars): second description line; start_date / end_date (str, optional, YYYY-MM-DD): first and last day the sitelink shows, so seasonal links switch off by themselves.
- campaign_idstring, optional
- Numeric ID of the campaign to attach sitelinks to. Leave empty with scope="account".
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
- scopestring, optional
- Empty follows campaign_id. "account" links the sitelinks account-wide; they serve on every eligible campaign without sitelinks of its own. It is never inferred from an empty campaign_id.
draft_structured_snippetsDraft structured snippet assets for an ad group, a campaign or the account: returns a PREVIEW.Changes- snippetsobject[], required
- At least one dict with "header" and "values". header is one of Google's snippet headers, in the language of the values: Amenities, Brands, Courses, Degree programs, Destinations, Featured Hotels, Insurance coverage, Models, Neighborhoods, Services, Shows, Styles, Types, or Google's translation of one (German: Typen, Marken, Dienstleistungen, Modelle, Kurse, ...; case does not matter). values is a list of 3-10 non-empty strings, each at most 25 characters.
- campaign_idstring, optional
- Numeric ID of the campaign to link the snippets to.
- ad_group_idstring, optional
- Numeric ID of the ad group to link them to, instead of a campaign.
- scopestring, optional
- Empty (follows the id), "campaign", "ad_group" or "account".
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
draft_update_conversion_actionDraft a partial UPDATE of an existing ConversionAction: returns PREVIEW.Changes- conversion_action_idstring, required
- Numeric ConversionAction ID. It comes from: SELECT conversion_action.id, conversion_action.name FROM conversion_action.
- namestring, optional
- New name. Empty keeps the current name.
- primary_for_goalboolean, optional
- True makes it Primary (Smart Bidding optimizes toward it); False demotes it to Secondary. Omit to leave unchanged.
- default_valuenumber, optional
- New default value in the action's currency (not micros), >= 0. 0 leaves it unchanged.
- currency_codestring, optional
- New 3-letter ISO 4217 currency code. Empty leaves it unchanged.
- always_use_default_valueboolean, optional
- True always uses default_value; False uses it only as a fallback when the tag/import supplies no value (the preview warns when combined with a positive default_value). Omit to leave unchanged.
- counting_typestring, optional
- ONE_PER_CLICK or MANY_PER_CLICK. Empty leaves it unchanged.
- phone_call_duration_secondsinteger, optional
- Minimum call length in seconds for a call to count. 0 leaves it unchanged.
- include_in_conversions_metricboolean, optional
- Refused when passed: Google answers IMMUTABLE_FIELD at apply, and a dry run does not catch it. It derives the value from primary_for_goal and whether the goal of the action's category is biddable; use those instead.
- click_through_window_daysinteger, optional
- Click-through attribution window in days, 1-90. 0 leaves it unchanged.
- view_through_window_daysinteger, optional
- View-through attribution window in days, 1-30. 0 leaves it unchanged.
- attribution_modelstring, optional
- AttributionModel enum value, e.g. GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN. Empty leaves it unchanged.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes allowed). Defaults to the configured account.
- categorystring, optional
- ConversionActionCategory to move the action to, e.g. PHONE_CALL_LEAD; that decides which goal it belongs to. The preview pins the current one (current_category); if the category is changed in Google Ads before the apply, nothing is sent. Empty leaves it unchanged.
draft_update_custom_conversion_goalRename and/or re-scope an existing custom conversion goal: PREVIEW.Changes- custom_conversion_goal_idstring, required
- Numeric goal ID from get_custom_conversion_goals.
- namestring, optional
- New name. Empty leaves the name unchanged.
- conversion_action_idsstring[], optional
- The complete new action list. Empty leaves the actions unchanged.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
draft_upload_call_conversionsDraft an offline CALL-conversion upload from a CSV: returns a PREVIEW.Changes- csv_pathstring, optional
- Path of the CSV file holding the upload rows, read on the machine that runs AdLoop. Refused on the hosted server; use upload_id there.
- upload_idstring, optional
- Id of a CSV uploaded with upload_conversion_csv (up_...), instead of csv_path.
- default_regionstring, optional
- ISO 3166-1 alpha-2 country assumed for phone numbers that carry no country code, e.g. "DE" for "0151 12345678". Empty leaves such numbers unusable and the row is skipped.
- consentobject, optional
- Consent signals for GDPR/EEA, as an object with "ad_user_data" and/or "ad_personalization", each "GRANTED", "DENIED" or "UNSPECIFIED". None sends UNSPECIFIED. A row whose own "Ad User Data" / "Ad Personalization" columns are filled in overrides this for that row; empty cells fall back to it.
- customer_idstring, optional
- Google Ads customer ID (digits, e.g. "1234567890"). Empty uses the configured default account.
draft_upload_enhanced_conversions_for_leadsDraft an Enhanced Conversions for LEADS upload from a CSV: PREVIEW.Changes- csv_pathstring, optional
- Path of the CSV file holding the upload rows, read on the machine that runs AdLoop. Refused on the hosted server; use upload_id there.
- upload_idstring, optional
- Id of a CSV uploaded with upload_conversion_csv (up_...), instead of csv_path.
- default_regionstring, optional
- ISO 3166-1 alpha-2 country assumed for phone numbers that carry no country code, e.g. "DE" for "0151 12345678". Empty leaves such numbers unusable; the row still uploads when its email or its complete address identifies the lead.
- consentobject, optional
- Consent signals for GDPR/EEA, as an object with "ad_user_data" and/or "ad_personalization", each "GRANTED", "DENIED" or "UNSPECIFIED". None sends UNSPECIFIED. A row whose own "Ad User Data" / "Ad Personalization" columns are filled in overrides this for that row; empty cells fall back to it.
- customer_idstring, optional
- Google Ads customer ID (digits, e.g. "1234567890"). Empty uses the configured default account.
enable_entityDraft enabling a paused campaign, ad group, ad, or keyword: returns a PREVIEW.Changes- entity_typestring, required
- "campaign", "ad_group", "ad", "keyword" or "asset_group" (Performance Max).
- entity_idstring, required
- ID in the format for its type. campaign: campaign ID (e.g. "12345678"); ad_group: ad group ID (e.g. "12345678"); ad: "adGroupId~adId" (e.g. "12345678~987654"; a bare ad ID is resolved to its ad group at apply time); keyword: "adGroupId~criterionId" (e.g. "12345678~987654").
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
estimate_budgetForecast clicks, cost, and conversions for a set of keywords.Reads- keywordsobject[], required
- List of {"text": "keyword", "match_type": "EXACT|PHRASE|BROAD", "max_cpc": 1.50}. match_type defaults to BROAD; max_cpc is optional (defaults to 1.00 in account currency, not micros). At least one keyword is required.
- daily_budgetnumber, optional
- Daily budget in account currency. If provided, insights will show what % of traffic the budget captures. 0 = no budget comparison.
- geo_target_idstring, optional
- Geo target constant ID (2276=Germany, 2840=USA, 2826=UK, 2250=France). Defaults to 2276.
- language_idstring, optional
- Language constant ID (1000=English, 1001=German, 1002=French, 1003=Spanish). Defaults to 1000.
- forecast_daysinteger, optional
- Forecast horizon in days, starting tomorrow (default 30).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes allowed). Defaults to the configured account.
get_ad_performanceGet ad-level performance data including headlines, descriptions, and metrics.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
- compactboolean, optional
- When true (for audits/overviews), returns totals, the top-10 ads with headline/description COUNTS instead of full asset lists, plus incomplete-RSA, single-ad ad-group and policy findings with approval-status counts (~90% smaller).
get_ai_max_settingsRead the AI Max controls of Search campaigns, per campaign and ad group.Reads- campaign_idstring, optional
- Numeric campaign ID. When omitted, every non-removed Search campaign in the account is listed.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
get_asset_group_signalsSearch themes and the audience signal of a Performance Max asset group, plus the account's audiences.Reads- asset_group_idstring, required
- Numeric asset group id (from get_pmax_performance).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
get_audience_listsThe account's own audiences: remarketing and customer lists, custom segments, combined segments.Reads- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
get_audience_performanceGet audience segment performance metrics.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
- campaign_idstring, optional
- Optional numeric ID to filter to a single campaign.
get_audience_targetingAudiences attached to one campaign or ad group, its exclusions, and the audience mode.Reads- campaign_idstring, optional
- Numeric campaign id. Pass this or ad_group_id.
- ad_group_idstring, optional
- Numeric ad group id. Pass this or campaign_id.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
get_brand_list_brandsList the brands inside a brand list.Reads- shared_set_idstring, required
- Numeric list ID from get_brand_lists (shared_set.id).
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
get_brand_list_campaignsList which campaigns a brand list is attached to.Reads- shared_set_idstring, optional
- Numeric list ID from get_brand_lists. When omitted, all brand-list attachments in the account are returned.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
get_brand_listsList all brand lists (SharedSets of type BRANDS) in the account.Reads- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
get_campaign_performanceGet campaign-level performance metrics for a date range.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
- compactboolean, optional
- When true (for audits/overviews on large accounts), returns account totals, status/type breakdowns, the top-10 spenders, zero-conversion offenders and budget-limited converters instead of every row (~90% smaller).
get_campaign_settingsRead every setting that decides how far a Search campaign reaches, in one call.Reads- campaign_idstring, optional
- Numeric campaign ID of a Search campaign. When omitted, every non-removed Search campaign in the account is listed.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
get_change_historyList recent account changes: who changed what, when, and through which tool.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- date_range_startstring, optional
- Start date as "YYYY-MM-DD", at most 30 days back. Empty starts at the oldest day Google Ads still keeps.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive). Empty means today.
- campaign_idstring, optional
- Optional numeric campaign ID; only changes attributed to that campaign are returned.
- resource_typesstring[], optional
- Optional filter of ChangeEventResourceType names, e.g. ["CAMPAIGN", "CAMPAIGN_BUDGET", "AD_GROUP_AD", "AD_GROUP_CRITERION"]. Empty = all types.
- limitinteger, optional
- Maximum number of changes returned, newest first (1 to 10000; default 1000). The response is marked truncated when the limit is reached.
get_custom_conversion_goalsRead the custom conversion goals and the campaign goal configuration.Reads- campaign_idstring, optional
- Numeric campaign ID. When omitted, the campaign config is skipped.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
get_demographic_targetingList demographic targeting criteria (age, gender, parental status, income).Reads- ad_group_idstring, optional
- Numeric ad group ID. Mutually exclusive with campaign_id.
- campaign_idstring, optional
- Numeric campaign ID. Mutually exclusive with ad_group_id.
- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
get_detailed_asset_performanceGet top-performing asset combinations for Performance Max campaigns.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- campaign_idstring, optional
- Optional numeric ID to filter to a single PMax campaign.
get_keyword_performanceGet keyword metrics including quality scores and competitive data.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
- compactboolean, optional
- When true (for audits/overviews), returns totals, match-type distribution, the top-10 spenders, low-quality-score keywords, and zero-conversion spenders instead of every row (~90% smaller).
get_negative_keyword_list_campaignsList which campaigns a shared negative keyword list is attached to.Reads- shared_set_idstring, optional
- Numeric ID from get_negative_keyword_lists. When omitted, returns all list-to-campaign attachments across the account.
- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
get_negative_keyword_list_keywordsList the keywords inside a shared negative keyword list.Reads- shared_set_idstring, required
- Numeric ID from get_negative_keyword_lists (shared_set.id).
- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
get_negative_keyword_listsList all shared negative keyword lists (SharedSets) in the account.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
get_negative_keywordsList existing negative keywords for a campaign or all campaigns.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- campaign_idstring, optional
- Numeric campaign ID to filter by. If empty, returns negatives across all campaigns.
get_pmax_assetsList the assets of Performance Max campaigns with type, status and content.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- campaign_idstring, optional
- Optional numeric ID to filter to a single PMax campaign.
get_pmax_performanceGet Performance Max campaign and asset group performance.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
get_recommendation_subscriptionsList the recommendation types Google applies automatically (auto-apply).Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
get_recommendationsRetrieve Google's auto-generated recommendations with estimated impact.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- recommendation_typesstring[], optional
- Optional filter of Google Ads RecommendationType names, e.g. ["KEYWORD", "TARGET_CPA_OPT_IN", "MAXIMIZE_CONVERSIONS_OPT_IN", "RESPONSIVE_SEARCH_AD"]. Empty = all types.
- campaign_idstring, optional
- Optional numeric campaign ID to scope to a single campaign.
get_search_termsGet search terms report: what users actually typed before clicking your ads.Reads- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
- compactboolean, optional
- When true (for audits/overviews), returns totals, the top-10 terms by clicks, ready-made negative-keyword waste candidates (5+ clicks, zero conversions), and top converters (~90% smaller).
get_shopping_product_performanceSpend, clicks, conversions, CPA and ROAS per product across Shopping and Performance Max.Reads- date_range_startstring, optional
- Start date "YYYY-MM-DD". Both dates empty means the last 30 days.
- date_range_endstring, optional
- End date "YYYY-MM-DD" (inclusive).
- campaign_idstring, optional
- Optional numeric campaign id to limit the report to.
- limitinteger, optional
- Maximum number of products to return (1-200, default 50).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
link_asset_to_customerDraft linking existing assets at account level: returns a PREVIEW.Changes- linksobject[], required
- Dicts with "asset_id" (numeric) and "field_type", one of BUSINESS_NAME, BUSINESS_LOGO, CALL, CALLOUT, HOTEL_CALLOUT, MOBILE_APP, PRICE, PROMOTION, SITELINK, STRUCTURED_SNIPPET.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
list_accountsList accessible Google Ads accounts.Reads- limitinteger, optional
- Maximum number of accounts listed under the manager (MCC) account. The default cap of 200 covers the vast majority of agency MCCs in one call.
pause_entityDraft pausing a campaign, ad group, ad, or keyword: returns a PREVIEW.Changes- entity_typestring, required
- "campaign", "ad_group", "ad", "keyword" or "asset_group" (Performance Max).
- entity_idstring, required
- ID in the format for its type. campaign: campaign ID (e.g. "12345678"); ad_group: ad group ID (e.g. "12345678"); ad: "adGroupId~adId" (e.g. "12345678~987654"; a bare ad ID is resolved to its ad group at apply time); keyword: "adGroupId~criterionId" (e.g. "12345678~987654").
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
propose_brand_listDraft a brand list and optionally attach it to campaigns: returns a PREVIEW.Changes- list_namestring, required
- Name for the new list, as it should appear in Google Ads.
- brand_idsstring[], required
- Commercial Knowledge Graph MIDs: the `id` field from suggest_brands / check_brand_names, which resolve names; a display name alone cannot be written. Duplicates are dropped.
- campaign_idsstring[], optional
- Optional numeric campaign IDs. When omitted, the list is created without being used yet; attach_brand_list_to_campaigns attaches it later.
- negativeboolean, optional
- True (default) excludes the brands from those campaigns; False restricts targeting to them instead.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
propose_negative_keyword_listDraft a shared negative keyword list and attach it to a campaign: returns a PREVIEW.Changes- campaign_idstring, required
- Numeric ID of the campaign the new list is attached to.
- list_namestring, required
- Name of the new shared negative keyword list.
- keywordsstring[], required
- Negative keyword texts to put in the list (at least one).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
- match_typestring, optional
- Match type applied to every keyword: "EXACT" (default), "PHRASE", or "BROAD" (case-insensitive).
remove_entityDraft REMOVING an entity: returns a PREVIEW. This is IRREVERSIBLE.ChangesCan remove- entity_typestring, required
- "campaign", "ad_group", "ad", "keyword", "asset_group", "negative_keyword", "shared_criterion", "campaign_asset", "ad_group_asset", "asset", "customer_asset", "ad_group_criterion", or "campaign_criterion".
- entity_idstring, required
- The resource ID. campaign / ad_group / asset_group / asset: simple numeric ID. ad: "adGroupId~adId" (a bare ad ID is resolved to its ad group). keyword and ad_group_criterion: "adGroupId~criterionId". negative_keyword and campaign_criterion: "campaignId~criterionId" (the resource_id field from get_negative_keywords). shared_criterion: "sharedSetId~criterionId" (the resource_id field from get_negative_keyword_list_keywords). campaign_asset: "campaignId~assetId~fieldType". ad_group_asset: "adGroupId~assetId~fieldType". customer_asset: "assetId~fieldType".
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
remove_from_brand_listRemove brands from a brand list: returns a PREVIEW.ChangesCan remove- shared_set_idstring, required
- Numeric list ID from get_brand_lists.
- criterion_idsstring[], required
- Numeric criterion_id values from get_brand_list_brands. This is irreversible: the brand leaves the list immediately.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
run_gaqlExecute an arbitrary GAQL (Google Ads Query Language) query.Reads- querystring, required
- The GAQL query, e.g. "SELECT campaign.name, metrics.clicks FROM campaign WHERE segments.date DURING LAST_7_DAYS".
- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (123-456-7890). Empty uses the configured default account.
- formatstring, optional
- Output format: "table" (default, readable), "json" (structured), or "csv" (exportable).
search_audience_segmentsFind Google's in-market and affinity segments by name, with the segment_id to attach.Reads- querystring, required
- Part of the segment name to look for (at least 2 characters).
- kindstring, optional
- "in_market", "affinity" or "all" (default).
- limitinteger, optional
- Maximum number of segments to return (1-100, default 25).
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
suggest_brandsResolve a brand name to the brands Google recognizes for it.Reads- brand_prefixstring, required
- The brand name to look up, free text (e.g. "NoWayOut").
- selected_brand_idsstring[], optional
- Commercial Knowledge Graph MIDs already picked, handed back so Google keeps them in the suggestion set while the prefix narrows. Optional.
- customer_idstring, optional
- Ads account ID. Defaults to the configured account.
update_ad_groupDraft an ad group update for name and/or manual CPC bid: returns a PREVIEW.Changes- ad_group_idstring, required
- Numeric ID of the ad group to update.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
- ad_group_namestring, optional
- New ad group name. Empty leaves the name unchanged.
- max_cpcnumber, optional
- New maximum CPC bid in the account's currency (an amount, not micros). 0 leaves the bid unchanged; negative values are rejected. At least one of ad_group_name or max_cpc is required.
update_call_assetDraft changing a call asset in place: returns a PREVIEW.Changes- asset_idstring, required
- Numeric ID of the CALL asset.
- phone_numberstring, optional
- New number, national or international; needs country_code.
- country_codestring, optional
- ISO 3166-1 alpha-2 country of the new number. Required with phone_number, and only accepted together with it.
- call_conversion_action_idstring, optional
- Numeric ID of the conversion action that counts calls; sets USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
- call_conversion_reporting_statestring, optional
- DISABLED, USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION or USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
- ad_scheduleobject[], optional
- Windows that replace the number's whole schedule (same shape as draft_call_asset). Empty leaves the schedule as it is.
- clear_ad_scheduleboolean, optional
- True removes the schedule, so the number shows at all hours.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
update_calloutDraft changing a callout asset in place: returns a PREVIEW.Changes- asset_idstring, required
- Numeric ID of the callout asset.
- callout_textstring, optional
- The new text, at most 25 characters. Empty keeps it.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
- start_datestring, optional
- First day the callout shows, YYYY-MM-DD. Empty keeps it.
- end_datestring, optional
- Last day the callout shows, YYYY-MM-DD. Empty keeps it.
- clear_fieldsstring[], optional
- "start_date" and/or "end_date" to remove that date.
update_campaignDraft an update to an existing campaign: returns a PREVIEW, does NOT apply.Changes- campaign_idstring, required
- The numeric ID of the campaign to update (required).
- customer_idstring, optional
- Google Ads customer ID (digits, e.g. "1234567890"). Empty uses the configured default account.
- bidding_strategystring, optional
- MAXIMIZE_CONVERSIONS | TARGET_CPA | TARGET_ROAS | MAXIMIZE_CONVERSION_VALUE | TARGET_SPEND | MANUAL_CPC. Empty leaves the strategy unchanged.
- target_cpanumber, optional
- Target CPA in the account's currency; required if bidding_strategy is TARGET_CPA. 0 leaves it unchanged.
- target_roasnumber, optional
- Target ROAS as a ratio (e.g. 4.0 = 400%); required if bidding_strategy is TARGET_ROAS. 0 leaves it unchanged.
- daily_budgetnumber, optional
- New daily budget in the account's currency (not micros), at most the config's max_daily_budget. 0 leaves it unchanged. On a shared budget it is the amount for every campaign sharing it.
- geo_target_idsstring[], optional
- REPLACES all positive geo targets; must not be empty when given. Common IDs: "2276" Germany, "2040" Austria, "2756" Switzerland, "2840" USA, "2826" UK.
- language_idsstring[], optional
- REPLACES all language targets; must not be empty when given. Common IDs: "1001" German, "1000" English, "1002" French, "1003" Spanish, "1004" Italian.
- search_partners_enabledboolean, optional
- Include ads on Search partners. Omitted leaves the setting unchanged.
- display_network_enabledboolean, optional
- Enable Search campaign display expansion. Omitted leaves the setting unchanged.
- display_expansion_enabledboolean, optional
- Alias for display_network_enabled; both must match when both are given.
- max_cpcnumber, optional
- Maximize Clicks CPC cap in the account's currency when bidding_strategy is TARGET_SPEND, or when the existing campaign already uses TARGET_SPEND. Increases are limited by the config's max_bid_increase_pct. 0 leaves it unchanged.
- location_optionstring, optional
- PRESENCE | PRESENCE_OR_INTEREST | SEARCH_INTEREST. Who the geo targets reach; the preview shows the current value (current_location_option) and warns when the new one is anything but PRESENCE. Empty leaves it unchanged.
- negative_location_optionstring, optional
- PRESENCE | PRESENCE_OR_INTEREST. Who the location exclusions exclude; the preview shows the current value. PRESENCE excludes fewer people (only those physically there), so it widens reach and the preview warns. Empty leaves it unchanged.
- tracking_url_templatestring, optional
- Campaign tracking template; must contain {lpurl} or a variant. Omitted leaves it unchanged; "" removes it.
- final_url_suffixstring, optional
- Parameters appended to the landing page URL. Omitted leaves it unchanged; "" removes it.
- url_custom_parametersobject[], optional
- List of {"key", "value"}; REPLACES the campaign's custom parameters. Keys alphanumeric, max 8 characters. Omitted leaves them unchanged; [] removes them. The preview shows each current value (current_tracking_url_template etc.), names any removal, and gives example_click: one of the campaign's final URLs with the campaign's options applied. It is approximate: a template on the ad group, ad or keyword overrides the campaign's.
- keyword_match_typestring, optional
- Campaign-level broad match. BROAD turns it on and CONVERTS every existing phrase and exact keyword in the campaign to broad match (the originals show as Removed; turning it off does not restore them), and since September 2026 Google upgrades such campaigns to AI Max. Refused unless the campaign uses Smart Bidding (MAXIMIZE_CONVERSIONS, MAXIMIZE_CONVERSION_VALUE, TARGET_CPA, TARGET_ROAS), checked again at apply; needs a double confirmation. UNSPECIFIED turns it off: no further conversions, but converted keywords stay broad. Moving a campaign with broad match on to a non-Smart bidding_strategy is refused unless the same call passes UNSPECIFIED. The preview shows the current value. Empty leaves it unchanged.
- geo_exclude_idsstring[], optional
- REPLACES the campaign's negative location criteria. Omitted leaves them unchanged; [] removes them. May not overlap geo_target_ids. The preview shows the current ones (current_geo_exclude_ids); dropping any needs a double confirmation, because the campaign can serve there again. A location can move between geo_target_ids and geo_exclude_ids in one call: its old criterion is removed before the new one is created.
- ad_scheduleobject[], optional
- REPLACES the campaign's schedule windows (shape as in draft_campaign). Omitted leaves them unchanged; [] removes them, so the campaign serves at all hours. The preview shows the current ones (current_ad_schedule). A first schedule and clearing a schedule both need a double confirmation. Only windows that differ are removed or added, removals first. Apply refuses if the exclusions or windows changed after the preview.
update_promotionDraft changing a promotion asset in place: returns a PREVIEW.Changes- asset_idstring, required
- Numeric ID of the PROMOTION asset.
- promotion_targetstring, optional
- New target text, at most 20 characters.
- final_urlstring, optional
- New landing page; must be reachable.
- money_offnumber, optional
- New fixed discount.
- percent_offnumber, optional
- New percentage discount, at most 100.
- currency_codestring, optional
- ISO 4217 code for the amounts. Empty keeps the promotion's currency (or uses the account currency).
- promotion_codestring, optional
- New coupon code, at most 15 characters.
- orders_over_amountnumber, optional
- New minimum order value.
- occasionstring, optional
- New occasion such as BLACK_FRIDAY.
- discount_modifierstring, optional
- "UP_TO", or clear it with clear_fields.
- language_codestring, optional
- New language of the promotion's text.
- start_datestring, optional
- First day the promotion shows, YYYY-MM-DD.
- end_datestring, optional
- Last day the promotion shows, YYYY-MM-DD.
- redemption_start_datestring, optional
- First day the offer can be redeemed, YYYY-MM-DD.
- redemption_end_datestring, optional
- Last day the offer can be redeemed, YYYY-MM-DD.
- clear_fieldsstring[], optional
- Optional fields to remove: promotion_code, orders_over_amount, occasion, discount_modifier, start_date, end_date, redemption_start_date, redemption_end_date, ad_schedule.
- ad_scheduleobject[], optional
- Windows that replace the promotion's whole schedule (same shape as draft_promotion). Empty leaves the schedule as it is.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
update_responsive_search_adUpdate mutable fields on an existing RSA in place: returns a PREVIEW.Changes- ad_idstring, required
- Numeric ID of the existing responsive search ad.
- customer_idstring, optional
- Google Ads customer ID (digits, e.g. "1234567890"). Empty uses the configured default account.
- headlinesstring | object[], optional
- LIST-REPLACE: None or [] means no change; a non-empty list fully swaps in for the existing headlines. Google's RSA constraints apply: 3-15 headlines, max 30 chars each, every pin position fillable. Each entry is a plain string (unpinned) or {"text": "...", "pinned_field": "HEADLINE_1"} (HEADLINE_1-3). Insertion tags such as {KeyWord:Clogged Drain Service} count as their default text, which is required.
- descriptionsstring | object[], optional
- LIST-REPLACE: None or [] means no change; a non-empty list fully swaps in. 2-4 descriptions, max 90 chars each, pins to DESCRIPTION_1 or DESCRIPTION_2 with every position fillable. Same entry format and insertion-tag counting as headlines.
- final_urlstring, optional
- Empty means no change; non-empty replaces the final URL and is checked for reachability.
- path1string, optional
- Empty means no change; non-empty sets the first display path (max 15 chars).
- path2string, optional
- Empty means no change; non-empty sets the second display path (max 15 chars).
- clear_path1boolean, optional
- True sets path1 to an empty string (overrides path1).
- clear_path2boolean, optional
- True sets path2 to an empty string (overrides path2).
update_sitelinkDraft changing a sitelink asset in place: returns a PREVIEW.Changes- asset_idstring, required
- Numeric ID of the sitelink asset.
- link_textstring, optional
- New link text, at most 25 characters.
- final_urlstring, optional
- New landing page URL; must be reachable.
- description1string, optional
- New first description line, at most 35 characters.
- description2string, optional
- New second description line, at most 35 characters. Google needs both description lines or neither.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
- start_datestring, optional
- First day the sitelink shows, YYYY-MM-DD. Empty keeps it.
- end_datestring, optional
- Last day the sitelink shows, YYYY-MM-DD. Empty keeps it.
- clear_fieldsstring[], optional
- "start_date" and/or "end_date" to remove that date.
update_structured_snippetDraft changing a structured snippet asset in place: returns a PREVIEW.Changes- asset_idstring, required
- Numeric ID of the structured snippet asset.
- valuesstring[], required
- The complete new list of 3-10 values, each at most 25 characters.
- headerstring, optional
- New header (English or translated, as in draft_structured_snippets); empty keeps the current one as Google stores it, whatever its language.
- customer_idstring, optional
- Google Ads customer ID (digits, dashes optional). Defaults to the configured account.
upload_conversion_csvLet the user upload a conversion CSV for an offline conversion upload.ReadsNo inputs. Your AI calls it as it is.
Google Analytics20
audit_ga4_propertyAudit a GA4 property's setup in one call: the settings that quietly cost data or conversions.Reads- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
draft_delete_key_eventDraft removing a GA4 key event so the event no longer counts as a conversion, returning a PREVIEW.ChangesCan remove- event_namestring, required
- Event name of the key event to remove, exactly as listed by list_key_events (e.g. "sign_up"). Required.
- property_idstring, optional
- Numeric GA4 property ID, with or without the "properties/" prefix. If empty, uses the default from config.
draft_ga4_annotationDraft creating, changing or deleting a GA4 annotation (a note on a date or date range in GA4's charts), returning a PREVIEW.ChangesCan remove- actionstring, optional
- "create" (default), "update" or "delete".
- titlestring, optional
- Up to 60 characters. Required for create.
- datestring, optional
- The day as YYYY-MM-DD, or the first day of a range together with end_date. Required for create.
- end_datestring, optional
- Last day of a range (YYYY-MM-DD); leave empty for one day.
- descriptionstring, optional
- Up to 150 characters. On update, "" clears it.
- colorstring, optional
- BLUE (default on create), GREEN, RED, PURPLE, BROWN or CYAN.
- annotationstring, optional
- ID or resource name of the annotation to update or delete (list_ga4_annotations).
- property_idstring, optional
- Numeric GA4 property ID, with or without the "properties/" prefix. If empty, uses the default from config.
draft_ga4_audienceDraft creating, renaming or archiving a GA4 audience: returns a PREVIEW.ChangesCan remove- actionstring, optional
- "create" (default), "update" (name and description only) or "archive".
- display_namestring, optional
- Name of the audience; required for create, the new name for update.
- include_eventsstring[], optional
- Create only. Users who sent ANY of these events join, e.g. ["session_start"] for every visitor, ["purchase"] for buyers, ["sign_up", "generate_lead"] for leads. Together with include_pages it is still "any of".
- exclude_eventsstring[], optional
- Create only. Users who sent any of these are kept out, e.g. include ["session_start"] and exclude ["purchase"] for visitors who did not buy.
- membership_duration_daysinteger, optional
- Create only. Days a user stays after last meeting the conditions, 1 to 540 (default 30).
- exclude_permanentlyboolean, optional
- Create only. True keeps users out for good once they sent an excluded event; False (default) only while they keep meeting the exclusion within the membership window.
- descriptionstring, optional
- Optional for create (one is written from the events); the new description for update.
- audiencestring, optional
- For update and archive: the audience's display name or resource name from list_ga4_audiences.
- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
- include_pagesstring[], optional
- Create only. Users who viewed a page whose full URL contains ANY of these texts join, e.g. ["/pricing"] (also matches /pricing/enterprise and /en/pricing). Not case sensitive.
- exclude_pagesstring[], optional
- Create only. Users who viewed such a page are kept out, e.g. ["/thank-you"].
- sequencestring | object[], optional
- Create only, instead of include_events / include_pages. 2 to 10 steps the user must do in this order. Each is an event name ("begin_checkout") or an object: {"event": "..."} or {"page": "/pricing"}, optionally with "directly_followed": true (no other event in between) and "within_minutes": 30 (after the step before). Exclusions can be added as usual.
draft_ga4_custom_dimensionDraft registering, changing or archiving a GA4 custom dimension, returning a PREVIEW.ChangesCan remove- actionstring, optional
- "create" (default), "update" or "archive".
- parameter_namestring, optional
- The event parameter or user property name exactly as sent, e.g. "plan_type". Required for create; identifies the dimension for update and archive.
- scopestring, optional
- EVENT (default), USER or ITEM.
- display_namestring, optional
- Name shown in GA4; defaults to parameter_name on create.
- descriptionstring, optional
- Up to 150 characters. On update, "" clears it.
- disallow_ads_personalizationboolean, optional
- USER scope only: keep this dimension out of ads personalization.
- custom_dimensionstring, optional
- Resource name, instead of parameter_name, for update or archive.
- property_idstring, optional
- Numeric GA4 property ID, with or without the "properties/" prefix. If empty, uses the default from config.
draft_ga4_custom_metricDraft registering, changing or archiving a GA4 custom metric, returning a PREVIEW.ChangesCan remove- actionstring, optional
- "create" (default), "update" or "archive".
- parameter_namestring, optional
- The numeric event parameter exactly as sent, e.g. "discount_amount". Required for create; identifies the metric for update and archive.
- display_namestring, optional
- Name shown in GA4; defaults to parameter_name on create.
- descriptionstring, optional
- Up to 150 characters. On update, "" clears it.
- measurement_unitstring, optional
- STANDARD (default on create), CURRENCY, FEET, METERS, KILOMETERS, MILES, MILLISECONDS, SECONDS, MINUTES or HOURS.
- restricted_metric_typestring[], optional
- For CURRENCY metrics, required: ["COST_DATA"] or ["REVENUE_DATA"] (or both).
- custom_metricstring, optional
- Resource name, instead of parameter_name, for update or archive.
- property_idstring, optional
- Numeric GA4 property ID, with or without the "properties/" prefix. If empty, uses the default from config.
draft_ga4_data_retentionDraft a change to how long GA4 keeps event- and user-level data, returning a PREVIEW.ChangesCan remove- event_data_retentionstring, optional
- Months to keep event-level data: 2, 14, 26, 38 or 50 (or TWO_MONTHS, FOURTEEN_MONTHS, ...). Empty leaves it.
- user_data_retentionstring, optional
- Months to keep user-level data, same values. Empty leaves it.
- reset_user_data_on_new_activityboolean, optional
- True restarts a user's retention period with each new event from that user. Empty leaves it.
- property_idstring, optional
- Numeric GA4 property ID, with or without the "properties/" prefix. If empty, uses the default from config.
draft_key_eventDraft marking a GA4 event as a key event (conversion), or changing an existing one: returns a PREVIEW.Changes- event_namestring, required
- Name of the GA4 event to mark as a key event, exactly as it fires (e.g. "sign_up", "purchase"). Required.
- counting_methodstring, optional
- ONCE_PER_EVENT (counts every occurrence, e.g. purchases) or ONCE_PER_SESSION (counts once per session, e.g. sign-ups). Defaults to ONCE_PER_EVENT.
- property_idstring, optional
- Numeric GA4 property ID, with or without the "properties/" prefix. If empty, uses the default from config.
- default_valuenumber, optional
- Value GA4 gives each key event when the event sends no value parameter, e.g. 20 for a lead. Needs currency_code.
- currency_codestring, optional
- Three-letter currency of default_value, e.g. "EUR".
get_account_summariesList all GA4 accounts and properties accessible by the authenticated user.ReadsNo inputs. Your AI calls it as it is.
get_ga4_propertyShow a GA4 property's configuration in one call: details, linked Google Ads accounts, data streams and data retention.Reads- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID (see get_account_summaries). If empty, uses the default from config.
get_tracking_eventsList all GA4 events and their volume for the given date range.Reads- date_range_startstring, optional
- Start date: "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo"), or "YYYY-MM-DD".
- date_range_endstring, optional
- End date, same formats as date_range_start.
- property_idstring, optional
- GA4 property as "properties/123456789" (see get_account_summaries). If empty, uses the default from config.
list_ga4_annotationsList a GA4 property's annotations, the notes GA4 shows on a date or date range in its charts.Reads- date_range_startstring, optional
- Optional start: "today", "yesterday", "NdaysAgo" or "YYYY-MM-DD". Set together with date_range_end.
- date_range_endstring, optional
- Optional end, same formats.
- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
list_ga4_audiencesList a GA4 property's audiences and check whether they reach Google Ads.Reads- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
list_ga4_custom_definitionsList a GA4 property's custom dimensions and custom metrics, with how many slots are left.Reads- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
list_ga4_dimensions_and_metricsList the dimensions and metrics a GA4 property can report on, including custom ones.Reads- searchstring, optional
- Case-insensitive text matched against API name, UI name, category, description and deprecated API names (e.g. "channel", "revenue", or the legacy "conversions", which finds keyEvents). Empty returns everything.
- kindstring, optional
- "all" (default), "dimensions" or "metrics".
- custom_onlyboolean, optional
- True returns only the property's custom dimensions and metrics.
- include_descriptionsboolean, optional
- Include each field's description. Defaults to true when search is set and false otherwise (the full list is long).
- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
list_key_eventsList the key events (conversions) configured on a GA4 property.Reads- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID (see get_account_summaries). If empty, uses the default from config.
run_ga4_attributionShow which channels, campaigns or sources get the credit for conversions under GA4's attribution models, or compare data-driven with last click.Reads- dimensionsstring[], optional
- Any of campaignName, continent, country, defaultChannelGroup (default), deviceCategory, medium, platform, primaryChannelGroup, source, sourceMedium, sourcePlatform, subcontinent.
- metricsstring[], optional
- Any of allConversionsByConversionDate, allConversionsByInteractionDate, totalRevenueByConversionDate, totalRevenueByInteractionDate, advertiserAdCost, advertiserAdClicks, advertiserAdImpressions, advertiserAdCostPerClick, advertiserAdCostPerAllConversionsByConversionDate, advertiserAdCostPerAllConversionsByInteractionDate, returnOnAdSpendByConversionDate, returnOnAdSpendByInteractionDate. Default: conversions, revenue, ad cost and ROAS by conversion date.
- date_range_startstring, optional
- "today", "yesterday", "NdaysAgo" or "YYYY-MM-DD".
- date_range_endstring, optional
- Same formats.
- conversionsstring[], optional
- Key event names (e.g. ["purchase"]) or GA4 conversion action IDs ("conversionActions/123"); empty for all.
- attribution_modelstring, optional
- DATA_DRIVEN (default), LAST_CLICK, or COMPARE.
- limitinteger, optional
- Maximum rows per model.
- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
run_ga4_funnelRun a GA4 funnel report: how many users go from one step to the next, and where they drop off.Reads- stepsstring | object[], optional
- 2 to 10 steps. Each is an event name ("add_to_cart") or an object: {"event": "purchase", "name": "Bought"}, {"page": "/checkout"} (page views whose URL contains the text), optional "directly_followed": true (no other event in between) and "within_minutes": 30 (must follow the previous step within that time).
- date_range_startstring, optional
- "today", "yesterday", "NdaysAgo" or "YYYY-MM-DD".
- date_range_endstring, optional
- Same formats.
- open_funnelboolean, optional
- False (default) counts only users who start at step 1; true lets users enter at any step.
- breakdownstring, optional
- Dimension to split every step by, e.g. deviceCategory, sessionDefaultChannelGroup, country.
- breakdown_limitinteger, optional
- How many values of the breakdown dimension (1-15).
- next_actionstring, optional
- Dimension for "what came next" after each step, e.g. eventName or pagePath.
- dimension_filterobject[], optional
- Only count users matching these conditions, same format as in run_ga4_report, e.g. [{"field": "deviceCategory", "value": "mobile"}].
- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
run_ga4_reportRun a custom GA4 report with optional filters, ordering, paging and a comparison period.Reads- dimensionsstring[], optional
- GA4 dimension API names, e.g. date, pagePath, sessionSource, sessionMedium, country, deviceCategory, eventName. Custom ones (customEvent:...) and every valid name are listed by list_ga4_dimensions_and_metrics.
- metricsstring[], optional
- GA4 metric API names, e.g. sessions, totalUsers, newUsers, screenPageViews, keyEvents, eventCount, bounceRate.
- date_range_startstring, optional
- Start date: "today", "yesterday", "NdaysAgo" (e.g. "7daysAgo", "28daysAgo", "90daysAgo"), or "YYYY-MM-DD".
- date_range_endstring, optional
- End date, same formats as date_range_start.
- property_idstring, optional
- GA4 property as "properties/123456789" (see get_account_summaries). If empty, uses the default from config.
- limitinteger, optional
- Maximum number of rows returned (positive).
- dimension_filterobject[], optional
- Conditions on dimensions, all of which must hold (AND). Each is {"field": <dimension>, "op": <match>, "value": <string>}; op is EXACT (default), BEGINS_WITH, ENDS_WITH, CONTAINS, FULL_REGEXP, PARTIAL_REGEXP, or IN_LIST with "values": [<strings>]. Optional keys: "case_sensitive" (default false) and "not": true to exclude matches. Example: [{"field": "sessionDefaultChannelGroup", "op": "EXACT", "value": "Paid Search"}]. For OR, put a group in the list: {"any_of": [<conditions>]} matches when any holds, {"all_of": [...]} when all hold; groups take "not" too and nest up to three levels. Example: [{"any_of": [{"field": "sessionSource", "value": "google"}, {"field": "sessionSource", "value": "bing"}]}].
- metric_filterobject[], optional
- Conditions on metrics, applied after aggregation, all of which must hold (AND). Each is {"field": <metric>, "op": <op>, "value": <number>}; op is EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL (or =, <, <=, >, >=), or BETWEEN with "value": [from, to]. Optional "not": true. Groups work as in dimension_filter. Example: [{"field": "sessions", "op": ">", "value": 100}].
- order_byobject[], optional
- Sort order as [{"field": <name>, "desc": true|false}]; each field must be one of the requested dimensions or metrics.
- offsetinteger, optional
- Zero-based row offset for paging; pass next_offset from the previous result to get the following page.
- compare_startstring, optional
- Start of the comparison period (same formats as date_range_start). Set together with compare_end.
- compare_endstring, optional
- End of the comparison period.
- date_rangesobject[], optional
- Up to four named periods in one report, replacing date_range_start/end (not combinable with compare_start/end): [{"start": "2026-10-01", "end": "2026-10-31", "name": "october"}, {"start": "2025-10-01", "end": "2025-10-31", "name": "october_last_year"}]. Rows then carry a dateRange value with the name. Names default to range_1, range_2, ...
- currency_codestring, optional
- ISO 4217 code (e.g. "EUR") to report revenue and cost metrics in that currency instead of the property's own.
run_realtime_reportRun a GA4 realtime report showing current active users and events.Reads- dimensionsstring[], optional
- GA4 realtime dimension API names, e.g. unifiedScreenName, eventName, country, deviceCategory, minutesAgo.
- metricsstring[], optional
- GA4 realtime metric API names, e.g. activeUsers, eventCount, keyEvents. Defaults to ["activeUsers"].
- property_idstring, optional
- GA4 property as "properties/123456789" (see get_account_summaries). If empty, uses the default from config.
- dimension_filterobject[], optional
- Same format as in run_ga4_report, e.g. [{"field": "eventName", "value": "purchase"}].
- metric_filterobject[], optional
- Same format as in run_ga4_report.
- order_byobject[], optional
- [{"field": <requested dimension or metric>, "desc": true}].
- limitinteger, optional
- Maximum rows; 0 uses GA4's default.
- minute_rangesobject[], optional
- Up to two windows, e.g. [{"start_minutes_ago": 4, "end_minutes_ago": 0, "name": "last_5"}, {"start_minutes_ago": 29, "end_minutes_ago": 5, "name": "before"}]. start_minutes_ago is at most 29 on standard properties (59 on 360). With two windows rows carry a dateRange value with the window's name.
Tracking7
analyze_campaign_conversionsCampaign clicks โ GA4 conversions mapping: the real cost-per-conversion.Reads- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- property_idstring, optional
- GA4 property as "properties/123456789" (see get_account_summaries). If empty, uses the default from config.
- campaign_namestring, optional
- Optional case-insensitive substring; only campaigns whose name contains it are included. Empty = all campaigns.
attribution_checkCompare Ads-reported conversions vs GA4: find tracking discrepancies.Reads- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- property_idstring, optional
- GA4 property as "properties/123456789" (see get_account_summaries). If empty, uses the default from config.
- conversion_eventsstring[], optional
- Optional list of GA4 event names to specifically check (e.g. ["sign_up", "purchase"]). If omitted, compares aggregate totals only.
check_key_event_importsCheck that every GA4 key event reaches Google Ads: imported, used for bidding, and actually receiving conversions.Reads- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes. Defaults to the configured ads.customer_id.
- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
draft_conversion_tracking_setupSet up conversion tracking from GA4 into Google Ads in one approved plan, returning a PREVIEW of only the missing steps.Changes- eventsstring | object[], optional
- GA4 event names to track as conversions, e.g. ["sign_up"], or objects {"event": "generate_lead", "counting_method": "ONCE_PER_SESSION"} (counting applies when the event is not a key event yet; default ONCE_PER_EVENT). Empty uses the property's key events that fired in the last 28 days.
- primaryboolean, optional
- True (default) makes the imports primary conversions that Smart Bidding optimizes toward; False imports them as secondary (reported only).
- data_retentionstring, optional
- Optional, e.g. 14: also lengthen GA4 event data retention (months). Only lengthens; empty leaves it.
- ads_personalizationboolean, optional
- Only for a new link. False (default) keeps personalized advertising off, so GA4 shares no audiences or remarketing data with Google Ads.
- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes. Defaults to the configured ads.customer_id.
- property_idstring, optional
- GA4 property as "properties/123456789" or the bare numeric ID. If empty, uses the default from config.
generate_tracking_codeGenerate a GA4 event tracking JavaScript snippet.Reads- event_namestring, required
- GA4 event name for the snippet, e.g. "sign_up" or "generate_lead".
- event_paramsobject, optional
- Event parameters as a name-to-value object, e.g. {"method": "email"}. Missing recommended parameters for well-known events are added as typed placeholders.
- triggerstring, optional
- "form_submit", "button_click", or "page_load": wraps the gtag call in an appropriate event listener (with a YOUR_SELECTOR placeholder for forms and buttons). Empty = bare gtag call.
- property_idstring, optional
- GA4 property as "properties/123456789" used for the existing-event check. If empty, uses the default from config.
- check_existingboolean, optional
- When true (default), looks up the last 28 days of GA4 events to report whether this event already fires.
landing_page_analysisAnalyze which landing pages convert and which don't.Reads- date_range_startstring, optional
- Start date as "YYYY-MM-DD". Both dates must be set to apply a range; if either is empty, the last 30 days are used.
- date_range_endstring, optional
- End date as "YYYY-MM-DD" (inclusive).
- customer_idstring, optional
- Google Ads customer ID, digits with or without dashes (e.g. "123-456-7890"). Defaults to the configured ads.customer_id.
- property_idstring, optional
- GA4 property as "properties/123456789" (see get_account_summaries). If empty, uses the default from config.
validate_trackingCompare tracking events found in the codebase against actual GA4 data.Reads- expected_eventsstring[], required
- Event names found in the codebase, e.g. ["sign_up", "purchase"].
- property_idstring, optional
- GA4 property as "properties/123456789" (see get_account_summaries). If empty, uses the default from config.
- date_range_startstring, optional
- Start date: "today", "yesterday", "NdaysAgo" (e.g. "28daysAgo"), or "YYYY-MM-DD".
- date_range_endstring, optional
- End date, same formats as date_range_start.
Tag Manager19
audit_event_coverageThree-way audit: codebase events โ GTM tags โ GA4 actual fires.Reads- expected_eventsstring[], required
- Distinct event names found in the codebase's gtag('event', ...) and dataLayer.push({event: ...}) calls.
- gtm_account_idstring, optional
- Numeric GTM account ID (Tag Manager UI โ Admin โ Container Settings, or list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (not the GTM-XXXXXXX public ID; see list_gtm_containers). Empty uses gtm.container_id from the config.
- property_idstring, optional
- GA4 property as "properties/123456789". Empty uses the default from config.
- date_range_startstring, optional
- Start date "YYYY-MM-DD". Empty (or an empty date_range_end) means the last 30 days.
- date_range_endstring, optional
- End date "YYYY-MM-DD". Empty (or an empty date_range_start) means the last 30 days.
draft_delete_gtm_entityDraft deleting a Tag Manager tag, trigger or variable: returns a PREVIEW.ChangesCan remove- entity_typestring, required
- "tag", "trigger" or "variable".
- entity_idstring, required
- Numeric ID of the entity (see list_gtm_tags, list_gtm_triggers and list_gtm_variables).
- workspace_idstring, optional
- Workspace to edit (see list_gtm_workspaces). Empty uses the Default Workspace, or the only workspace there is.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
draft_gtm_tagDraft creating or updating a Tag Manager tag: returns a PREVIEW.Changes- namestring, optional
- Tag name, 1-200 characters. Required when creating a tag.
- tag_typestring, optional
- Tag type, required when creating a tag because GTM cannot change a tag's type later: googtag, gaawe (GA4 event), awct (Ads conversion), awcc, awud, sp (Ads remarketing), gclidw, flc, fls, img, html (Custom HTML) or cvt_<id> for a Community Gallery template.
- parametersobject[], optional
- GTM parameter dicts with at least "type" and "key", for example gaawe [{"type": "TEMPLATE", "key": "eventName", "value": "form_submit"}] or awct [{"type": "TEMPLATE", "key": "conversionId", "value": "123456789"}, {"type": "TEMPLATE", "key": "conversionLabel", "value": "AbC-dEf"}]. On update they merge by key: passed keys replace, other keys stay.
- firing_trigger_idsstring[], optional
- Trigger IDs that fire the tag (see list_gtm_triggers). The built-in All Pages trigger is "2147479553".
- blocking_trigger_idsstring[], optional
- Trigger IDs that must not fire the tag.
- pausedboolean, optional
- True stores the tag paused instead of deleting it. None keeps the current state.
- notesstring, optional
- Free-form note stored on the tag. None keeps the current note.
- tag_idstring, optional
- Existing tag ID to update (see list_gtm_tags). Empty creates a new tag.
- workspace_idstring, optional
- Workspace to edit (see list_gtm_workspaces). Empty uses the Default Workspace, or the only workspace there is.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
draft_gtm_triggerDraft creating or updating a Tag Manager trigger: returns a PREVIEW.Changes- namestring, optional
- Trigger name, 1-200 characters. Required when creating a trigger.
- trigger_typestring, optional
- Trigger type, required when creating a trigger and rejected on an existing one, because GTM cannot change it later: pageview, domReady, windowLoaded, click, linkClick, formSubmission, customEvent, elementVisibility, scrollDepth, youTubeVideo, historyChange, timer, jsError or triggerGroup.
- custom_event_namestring, optional
- The dataLayer event name. Required for trigger type customEvent, rejected for every other type, and rejected on an existing trigger, where the event name sits in its custom event filter.
- filtersobject[], optional
- GTM conditions, each a dict with "type" (EQUALS, CONTAINS, MATCH_REGEX, ...) and "parameter" (arg0 = variable, arg1 = value), for example clicks on tel: links [{"type": "CONTAINS", "parameter": [{"type": "TEMPLATE", "key": "arg0", "value": "{{Click URL}}"}, {"type": "TEMPLATE", "key": "arg1", "value": "tel:"}]}]. On update the list replaces the existing one.
- custom_event_filtersobject[], optional
- Conditions on custom event parameters, same shape as filters. On update the list replaces the existing one.
- auto_event_filtersobject[], optional
- Conditions on automatic event parameters, same shape as filters. On update the list replaces the existing one.
- parametersobject[], optional
- GTM parameter dicts with at least "type" and "key". On update they merge by key: passed keys replace, other keys stay.
- notesstring, optional
- Free-form note stored on the trigger. None keeps the current note.
- trigger_idstring, optional
- Existing trigger ID to update (see list_gtm_triggers). Empty creates a new trigger.
- workspace_idstring, optional
- Workspace to edit (see list_gtm_workspaces). Empty uses the Default Workspace, or the only workspace there is.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
draft_gtm_variableDraft creating or updating a Tag Manager variable: returns a PREVIEW.Changes- namestring, optional
- Variable name, 1-200 characters without curly braces. Required when creating a variable.
- variable_typestring, optional
- Required when creating, fixed afterwards: v (Data Layer Variable), c (Constant), u (URL), k (1st-party cookie), j (JavaScript Variable, reads a global), aev (Auto-Event Variable), d (DOM element), f (HTTP referrer), e (Custom event), smm (Lookup table), remm (RegEx table), jsm (Custom JavaScript, gated) or cvt_<id> for a custom template.
- data_layer_keystring, optional
- For Data Layer Variables: the dataLayer key to read, dot notation for nested values, e.g. "ecommerce.transaction_id".
- default_valuestring, optional
- For Data Layer Variables: the value when the key is missing. None sets no default.
- parametersobject[], optional
- GTM parameter dicts with at least "type" and "key" for the other types, e.g. a Constant's [{"type": "TEMPLATE", "key": "value", "value": "G-ABC123"}]. On update they merge by key.
- notesstring, optional
- Free-form note stored on the variable. None keeps the current note.
- variable_idstring, optional
- Existing variable ID to update (see list_gtm_variables). Empty creates a new variable.
- workspace_idstring, optional
- Workspace to edit (see list_gtm_workspaces). Empty uses the Default Workspace, or the only workspace there is.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
draft_publish_gtm_workspaceDraft publishing a Tag Manager workspace LIVE: returns a PREVIEW.ChangesCan remove- version_namestring, optional
- Name of the container version created by the publish. Empty uses "AdLoop publish <UTC timestamp>".
- version_notesstring, optional
- Notes stored on the created version. Empty leaves them out.
- workspace_idstring, optional
- Workspace to publish (see list_gtm_workspaces). Empty uses the Default Workspace, or the only workspace there is.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
draft_rollback_gtm_versionDraft republishing an older Tag Manager version LIVE; returns a PREVIEW.ChangesCan remove- version_idstring, required
- Container version ID to make live again (see list_gtm_versions and get_gtm_version_diff).
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
get_gtm_tagGet the full RAW configuration for a single GTM tag.Reads- tag_idstring, required
- Numeric GTM tag ID, as listed by list_gtm_tags.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
- workspace_idstring, optional
- Workspace to read (see list_gtm_workspaces), which includes drafted changes that are not published yet. Empty reads the live (published) container version.
get_gtm_triggerGet the full RAW configuration for a single GTM trigger.Reads- trigger_idstring, required
- Numeric GTM trigger ID, as listed by list_gtm_triggers or a tag's firing/blocking triggers.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
- workspace_idstring, optional
- Workspace to read (see list_gtm_workspaces), which includes drafted changes that are not published yet. Empty reads the live (published) container version.
get_gtm_versionGet metadata + entity counts for a single GTM container version.Reads- container_version_idstring, required
- Numeric container version ID from list_gtm_versions.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
get_gtm_version_diffCompare two GTM container versions: what a publish changed.Reads- from_version_idstring, optional
- Older version ID (see list_gtm_versions). Empty uses the newest non-archived version created before to_version_id.
- to_version_idstring, optional
- Newer version ID. Empty uses the live (published) version.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
get_gtm_workspace_diffShow drafted-but-not-published changes in a GTM workspace.Reads- workspace_idstring, required
- Numeric GTM workspace ID from list_gtm_workspaces.
- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
list_gtm_accountsList all GTM accounts the AdLoop service account / OAuth user can read.ReadsNo inputs. Your AI calls it as it is.
list_gtm_containersList all containers under a GTM account.Reads- gtm_account_idstring, optional
- Numeric GTM account ID from list_gtm_accounts. Empty uses gtm.account_id from the config; the tool errors when neither is set.
list_gtm_tagsList every tag in the LIVE GTM container, or in one workspace.Reads- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers), not the GTM-XXXXXXX public ID. Empty uses gtm.container_id from the config.
- workspace_idstring, optional
- Workspace to read (see list_gtm_workspaces), which includes drafted changes that are not published yet. Empty reads the live (published) container version.
list_gtm_triggersList every trigger in the LIVE GTM container, or in one workspace.Reads- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
- workspace_idstring, optional
- Workspace to read (see list_gtm_workspaces), which includes drafted changes that are not published yet. Empty reads the live (published) container version.
list_gtm_variablesList GTM variables: both custom and enabled built-in.Reads- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
- workspace_idstring, optional
- Workspace to read (see list_gtm_workspaces), which includes drafted changes that are not published yet. Empty reads the live (published) container version.
list_gtm_versionsList GTM container version headers (newest first).Reads- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
- page_sizeinteger, optional
- Maximum number of version headers returned (newest first).
list_gtm_workspacesList workspaces (drafts) under a GTM container.Reads- gtm_account_idstring, optional
- Numeric GTM account ID (see list_gtm_accounts). Empty uses gtm.account_id from the config.
- gtm_container_idstring, optional
- Numeric GTM container ID (see list_gtm_containers). Empty uses gtm.container_id from the config.
Search Console2
list_gsc_sitesList all Google Search Console properties the authenticated user can access.ReadsNo inputs. Your AI calls it as it is.
run_gsc_reportRun a Google Search Console search analytics report.Reads- site_urlstring, optional
- The GSC property URL (e.g. "https://example.com/" or "sc-domain:example.com"), as listed by list_gsc_sites. Defaults to the configured Search Console site (gsc.site_url).
- dimensionsstring[], optional
- One or more of "query", "page", "country", "device", "date", "searchAppearance" (search result feature, e.g. rich results) or "hour" (hourly rows for roughly the last 10 days; switches data_state to "hourly_all"). Defaults to ["query"].
- date_range_startstring, optional
- Start date as ISO "YYYY-MM-DD" or a relative value like "7daysAgo", "30daysAgo", "today".
- date_range_endstring, optional
- End date, same formats as date_range_start.
- limitinteger, optional
- Maximum rows to return (default 100, max 25000 per request; higher values are capped at 25000).
- search_typestring, optional
- "web" (default), "image", "video", "news", "discover", or "googleNews".
- dimension_filter_groupsobject[], optional
- Optional list of GSC DimensionFilterGroup objects to filter by query, page, country, or device, e.g. [{"filters": [{"dimension": "query", "operator": "contains", "expression": "analytics"}]}]. searchAppearance is filterable too.
- data_statestring, optional
- "final" (default) returns finalized data only; "all" adds fresh data from the last days that can still change; "hourly_all" is the state the hour dimension uses.
- aggregation_typestring, optional
- "auto" (default), "byPage" (aggregate by canonical URL) or "byProperty" (aggregate by property; not combinable with grouping or filtering by page).
- start_rowinteger, optional
- Zero-based offset of the first row, for paging past the 25,000-row cap (pass the previous response's next_start_row).
Merchant Center3
get_merchant_feed_healthMerchant Center feed health: disapproved products + account issues.Reads- account_idstring, optional
- Numeric Merchant Center ID from list_merchant_accounts. Defaults to merchant.account_id in the config.
get_merchant_product_issuesThe products behind the feed-health counts, each with its issues.Reads- account_idstring, optional
- Numeric Merchant Center ID from list_merchant_accounts. Defaults to merchant.account_id in the config.
- statusstring, optional
- "disapproved" (default, not serving), "limited" (serving with restrictions), "pending" (still in review) or "any" (every product with at least one issue).
- issue_codestring, optional
- Only products with this issue code (from issues_by_code or get_merchant_feed_health).
- limitinteger, optional
- Maximum number of products to return (1-200, default 50).
list_merchant_accountsList Google Merchant Center accounts the connected user can access.ReadsNo inputs. Your AI calls it as it is.
Page speed1
analyze_page_speedRun PageSpeed Insights for a landing page: Lighthouse + real-user data.Reads- urlstring, required
- Full URL of the page to analyze, e.g. an ad's final_url ("https://example.com/landing").
- strategystring, optional
- "mobile" (default: most paid traffic) or "desktop".