Skip to content
Ads APIReferences / targets / Get Geo Targets

Get Geo Targets

Returns geo information filterable by query parameters. At least one query parameter must be provided.

Request

  • country_code
    string

    The country or region of a geo in ISO alpha-2 country code format.

    Example value: "US"Default value: ""
  • ids
    array of strings

    A list of unique identifiers for geos.

    Example value: [5259444,"US:11214"]
  • types
    array of strings

    A list of geo types.

    Example value: ["CITY","COUNTRY","DMA_REGION","POSTAL_CODE","REGION"]
  • q
    string

    Query to search by keyword via case-insensitive wildcard matching.

    Example value: "queen"
  • limit
    integer

    Limit or page size for a given response.

    Example value: 50Default value: 50Range: 1 - 50
  • offset
    integer

    Starting position of the next record to assist in data pagination.

    Example value: 0Default value: 0

Response

A list of geos.

  • offset
    integer
  • page_size
    integer
  • An object that represents the geo target entity.

    • country_code
      string

      The country or region of the geo in ISO alpha-2 country code format.

      Example value: "US"
    • id
      string

      A unique identifier for a geo.

      Example value: "94110"
    • type
      string

      The geo type.

      Example value: "DMA_REGION"
    • name
      string

      Name of the geo.

      Example value: "San Francisco"
    • parent_geo_name
      string

      The parent location to this geo if it exists (e.g. city, state, or country).

      Example value: "California"

Response sample

{  "offset": 0,  "page_size": 6,  "geos": [    {      "country_code": "US",      "id": "94110",      "type": "DMA_REGION",      "name": "San Francisco",      "parent_geo_name": "California"    },    {      "country_code": "US",      "id": "94110",      "type": "DMA_REGION",      "name": "San Francisco",      "parent_geo_name": "California"    }  ]}