Ads · Ad Campaigns

Edit a Google campaign's device, location, excluded location, or language targeting

Edits a Google campaign's device, location, excluded location, or language targeting. Works with Google Ads.

PUThttps://api.pozy.ai/v1/ads/campaigns/{campaignId}/targeting

Google WorkspaceupdateCampaignTargeting

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`campaignId`required	string

Request body

application/json, required

platformstringrequired
One of google.
targetingobjectrequired
- devicesarray of string or object
  One of:
  string
  Option 2 (2 fields)
  devicestringrequired
  One of MOBILE, DESKTOP, TABLET, CONNECTED_TV.
  bidModifiernumberrequired
- locationsarray of string or object
  One of:
  array of string
  Option 2 (5 fields)
  countriesarray of string
  regionsarray of string or object
  One of:
  string
  Option 2 (2 fields)
  keystringrequired
  namestring
  citiesarray of string or object
  One of:
  string
  Option 2 (2 fields)
  keystringrequired
  namestring
  zipsarray of string or object
  One of:
  string
  Option 2 (2 fields)
  keystringrequired
  namestring
  metrosarray of string or object
  One of:
  string
  Option 2 (2 fields)
  keystringrequired
  namestring
- languagesarray of string
- excludedLocationsarray of string or object
  One of:
  array of string
  Option 2 (5 fields)
  countriesarray of string
  regionsarray of string or object
  One of:
  string
  Option 2 (2 fields)
  keystringrequired
  namestring
  citiesarray of string or object
  One of:
  string
  Option 2 (2 fields)
  keystringrequired
  namestring
  zipsarray of string or object
  One of:
  string
  Option 2 (2 fields)
  keystringrequired
  namestring
  metrosarray of string or object
  One of:
  string
  Option 2 (2 fields)
  keystringrequired
  namestring
- locationTargetingTypestring
  One of presence, presence_or_interest.

Example

curl -X PUT "https://api.pozy.ai/v1/ads/campaigns/65a3737dd8b11ea61f199e6e/targeting" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "platform": "google",
  "targeting": {
    "devices": [
      "MOBILE"
    ],
    "locations": [
      "string"
    ],
    "languages": [
      "string"
    ]
  }
}'

const res = await fetch("https://api.pozy.ai/v1/ads/campaigns/65a3737dd8b11ea61f199e6e/targeting", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    platform: "google",
    targeting: {
      devices: [
        "MOBILE"
      ],
      locations: [
        "string"
      ],
      languages: [
        "string"
      ]
    }
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.put(
    "https://api.pozy.ai/v1/ads/campaigns/65a3737dd8b11ea61f199e6e/targeting",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "platform": "google",
        "targeting": {
            "devices": [
                "MOBILE",
            ],
            "locations": [
                "string",
            ],
            "languages": [
                "string",
            ],
        },
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

campaignIdstring
adGroupIdstring
updatedarray of string
Each item: one of devices, locations, excludedLocations, languages, locationTargetingType.
locationTargetingTypestring
One of presence, presence_or_interest. Can be null.
devicesarray of object
- devicestring
  One of MOBILE, DESKTOP, TABLET, CONNECTED_TV.
- includedboolean
- bidModifiernumber
  Can be null.
locationsarray of object
- geoTargetIdstring
- negativeboolean
- namestring
  Can be null.
- canonicalNamestring
  Can be null.
- typestring
  Can be null.
- countryCodestring
  Can be null.
excludedLocationsarray of object
- geoTargetIdstring
- negativeboolean
- namestring
  Can be null.
- canonicalNamestring
  Can be null.
- typestring
  Can be null.
- countryCodestring
  Can be null.
languagesarray of object
- codestring
- idstring
- namestring

200 response

{
  "campaignId": "65a3737dd8b11ea61f199e6e",
  "adGroupId": "6ad180be375f36f2c328e52b",
  "updated": [
    "devices"
  ],
  "locationTargetingType": "presence",
  "devices": [
    {
      "device": "MOBILE",
      "included": true,
      "bidModifier": 12.5
    }
  ],
  "locations": [
    {
      "geoTargetId": "686554da543721f04aabf2a9",
      "negative": true,
      "name": "Acme",
      "canonicalName": "Acme",
      "type": "string",
      "countryCode": "US"
    }
  ],
  "excludedLocations": [
    {
      "geoTargetId": "686554da543721f04aabf2a9",
      "negative": true,
      "name": "Acme",
      "canonicalName": "Acme",
      "type": "string",
      "countryCode": "US"
    }
  ],
  "languages": [
    {
      "code": "string",
      "id": "6bfebd43ddc270f6d2c56fc5",
      "name": "Acme"
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Ad Campaigns

GETList ads GETList Google Ads recommendations POSTApply Google Ads recommendations POSTDismiss Google Ads recommendations GETList portfolio bid strategies POSTCreate portfolio bid strategy PATCHUpdate portfolio bid strategy GETList shared budgets POSTCreate a shared budget GETList Search keywords POSTAdd Search ad-group keywords PATCHPause or enable a Search keyword DELRemove a Search keyword GETList campaigns POSTCreate a standalone campaign PUTPause or resume a campaign GETRead a campaign's ad schedule (dayparting)PUTReplace a campaign's ad schedule (dayparting)GETRead a campaign's current bidding GETGet live campaign details PUTUpdate a campaign DELDelete a campaign GETList campaign-level negative keywords PUTReplace campaign-level negative keywords POSTPause or resume many campaigns POSTDuplicate a campaign GETRead a Google campaign's device, location, excluded location, and language targeting GETList ad sets POSTCreate a standalone ad group POSTDuplicate an ad set POSTDuplicate an ad GETGet live ad-set details PUTUpdate an ad set DELDelete an ad set GETRead a Reddit ad group's targeting and schedule PUTPause or resume a single ad set GETGet campaign tree GETGet daily account metrics GETGet ad details PUTUpdate ad DELCancel an ad PUTPause or resume a single ad GETList campaign assets POSTAttach campaign assets PUTUpdate campaign assets DELRemove campaign assets GETList ad-group assets POSTAttach ad-group assets PUTUpdate ad-group assets DELRemove ad-group assets GETRead the platform's review verdict for an ad GETReview status of each creative in a TikTok Smart+ ad GETList ads that need attention POSTDismiss an ads alert GETReview status of every TikTok Smart+ ad of an advertiser GETList campaign negative lists PUTReplace campaign negative lists POSTBoost post as ad GETList Performance Max asset groups POSTCreate a Performance Max asset group GETGet a Performance Max asset group PATCHUpdate a Performance Max asset group DELRemove a Performance Max asset group POSTLink or unlink asset group assets PUTReplace an asset group's listing-group tree POSTCreate standalone ad GETGet campaign conversion goals PATCHUpdate campaign conversion goals