Skip to content
Ads APIReferences / Targets / Search Geo Targets

Search Geo Targets

Returns data for a specific targetable geo (country, region, DMA, or city) based on either name or id. Either the 'q' or 'ids' parameter must be specified in request.

Request

  • ids
    string
  • q
    string

    Search for geo location by name. Ex: 'New', 'New York'

  • type
    string

    Filter results by the type of geo. Ex: 'Country'

    Allowed values: "COUNTRY", "REGION", "DMA_REGION", "CITY"
  • pageSize
    integer
  • offset
    integer

Response

Geo targeting information

  • Required
    • country_code
      string
      Example: "US"
    • id
      integer [int32]
      Required
    • name
      string
      Required
    • type
      string
      Allowed values: "COUNTRY", "REGION", "DMA_REGION", "CITY"Example: "COUNTRY"

Response sample

{  "geo-targets": [    {      "country_code": "US",      "id": 1,      "name": "name",      "type": "COUNTRY"    },    {      "country_code": "US",      "id": 1,      "name": "name",      "type": "COUNTRY"    }  ]}