Ads API •References / targets / Get Geo Targets
Get Geo Targets
Returns geo information filterable by query parameters. At least one query parameter must be provided.
Request
- country_codestring
The country or region of a geo in ISO alpha-2 country code format.
Example value:"US"
Default value:""
- idsarray of strings
A list of unique identifiers for geos.
Example value:[5259444,"US:11214"]
- typesarray of strings
A list of geo types.
Example value:["CITY","COUNTRY","DMA_REGION","POSTAL_CODE","REGION"]
- qstring
Query to search by keyword via case-insensitive wildcard matching.
Example value:"queen"
- limitinteger
Limit or page size for a given response.
Example value:50
Default value:50
Range:1
-50
- offsetinteger
Starting position of the next record to assist in data pagination.
Example value:0
Default value:0
Response
A list of geos.
- offsetinteger
- page_sizeinteger
An object that represents the geo target entity.
- country_codestring
The country or region of the geo in ISO alpha-2 country code format.
Example value:"US"
- idstring
A unique identifier for a geo.
Example value:"94110"
- typestring
The geo type.
Example value:"DMA_REGION"
- namestring
Name of the geo.
Example value:"San Francisco"
- parent_geo_namestring
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" } ]}