add_campaign_proximity

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/add_campaign_proximity/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 Add proximity (radius) targeting to a campaign โ€” target everyone within N miles/km of an address. **When to use:** - "Target people within 10 miles of downtown San Francisco" - Local businesses wanting a radius around a store, not a whole city/state **Different from city/state targeting:** for country/state/city/postal geo_target_constant targeting, use `update_campaign` (locations_to_add) instead. Proximity is a RADIUS around a point. **Each proximity needs:** - radius + radius_units (MILES | KILOMETERS) - an address: any of city_name, province_name/province_code, postal_code, country_code, street_address - optional bid_modifier (1.2 = +20%) **Required:** campaign_id + 1+ proximities.

Request body

All tool arguments are wrapped in an arguments object.

FieldTypeDescription
campaign_idstring requiredCampaign ID (from list_campaigns).
proximitiesarray required1+ proximity circles. Each: radius + radius_units + an address (city/state/postal/country/street) + optional bid_modifier.
customer_idstring optionalGoogle Ads customer ID. Required for multi-account users.

Example request

{
  "arguments": {
    "campaign_id": "<campaign_id>",
    "proximities": [
      {
        "radius": 1.0,
        "radius_units": "MILES",
        "country_code": "string",
        "province_code": "string",
        "province_name": "string",
        "city_name": "string",
        "postal_code": "string",
        "street_address": "string",
        "bid_modifier": 0.1
      }
    ],
    "customer_id": "string"
  }
}

Example responses

200 โ€” Success

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

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": "add_campaign_proximity"
}

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": "add_campaign_proximity",
  "quota": {
    "used": 150,
    "limit": 150,
    "tier": "plus",
    "period_end": "2026-05-01",
    "upgrade_url": "https://adspirer.ai"
  }
}

Try it live


Adspirer REST API โ€” get an API key at adspirer.ai/keys ยท adspirer.ai