API Reference › Google Ads › update_display_frequency_caps

update_display_frequency_caps

Google Ads Write

🚨 **IF THIS TOOL RETURNS A QUOTA ERROR:** - The error message will include a clickable upgrade link - Show the FULL error message to the user (it contains the upgrade link) - DO NOT attempt to work ar

Endpoint

POST https://api.adspirer.ai/api/v1/tools/update_display_frequency_caps/execute

Headers

Description

🚨 **IF THIS TOOL RETURNS A QUOTA ERROR:** - The error message will include a clickable upgrade link - Show the FULL error message to the user (it contains the upgrade link) - DO NOT attempt to work around the error or use alternative data - DO NOT create campaigns or perform actions without valid tool data - STOP and direct the user to upgrade via the provided link REPLACE all frequency caps on a Display campaign. Google requires sending the full desired set each time — partial updates are not supported. Pass [] to remove ALL caps. **Each entry:** - `level`: CAMPAIGN | AD_GROUP | AD_GROUP_AD - `event_type`: IMPRESSION | VIDEO_VIEW - `time_unit`: DAY | WEEK | MONTH - `time_length`: 1-365 (number of time_unit periods) - `cap`: ≥ 1 (max events per user in that window) **Examples:** - 3 impressions/day: `[{level:CAMPAIGN, event_type:IMPRESSION, time_unit:DAY, time_length:1, cap:3}]` - 10 impressions/week + 2/day: two entries in the list - Clear all caps: `[]` **Execution time:** 2-5 seconds.

Request body

All tool arguments are wrapped in an arguments object.

FieldTypeDescription
campaign_idstring requiredDisplay campaign ID.
frequency_capsarray requiredNew set of frequency caps to apply. Pass [] to clear ALL caps. Google requires you to send the complete desired set each time.
customer_idstring optionalRequired for multi-account users.

Example request

{
  "arguments": {
    "campaign_id": "<campaign_id>",
    "frequency_caps": [
      {
        "level": "string",
        "event_type": "string",
        "time_unit": "string",
        "time_length": 1,
        "cap": 1
      }
    ],
    "customer_id": "string"
  }
}

Example responses

200 — Success

{
  "success": true,
  "data": {
    "text": "(tool-specific textual output for update_display_frequency_caps)",
    "quota": {
      "used": 42,
      "limit": 150,
      "tier": "plus",
      "period_end": "2026-05-01"
    }
  },
  "tool": "update_display_frequency_caps"
}

400 — Tool-level error (bad arguments / multi-account selection)

{
  "success": false,
  "error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n  - Acme Holdings (ad_account_id=\"act_123456789\")\n  - Acme EU (ad_account_id=\"act_987654321\")",
  "is_error": true,
  "tool": "update_display_frequency_caps"
}

402 — Quota exhausted

{
  "success": false,
  "error": "\ud83d\udea8 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.",
  "is_error": true,
  "tool": "update_display_frequency_caps",
  "quota": {
    "used": 150,
    "limit": 150,
    "tier": "plus",
    "period_end": "2026-05-01",
    "upgrade_url": "https://adspirer.ai"
  }
}

Try it live

Interactive: Swagger UI

Machine-readable: OpenAPI 3.1 spec · llms-full.txt

More tools: Google Ads · All tools

Adspirer REST API — get an API key at adspirer.ai/keys · adspirer.ai