Geo Object – API Help Center

Related Entities

Endpoints Using the Geo Object

targetAudience Resource

Parent Objects

targetAudience Object

Geo Targeting Items Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Note

Note: Each geo targeting item has a list of objects with unique IDs that you must retrieve before adding the object to the target audience. For example, to target users from New York, you need to retrieve the country ID for the USA ("countryId": 840, and then the state ID for New York (regionId": 33). The following table includes the methods for retrieving this information. For more information about each method and code examples, see Geo Resource.

Name	Description	Type	required	Notes
branchItemClientIds	Internal		Read-only
countries	IDs of the countries targeted.	Array of integers	Optional	To retrieve the list of countries and IDs, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries
cities	IDs of the cities targeted.	Array of integers	Optional	To retrieve the list of cities and IDs, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/cities?from=0&max=250&order=asc&sort=name&stateId=33
states/regions	IDs of the states/regions targeted.	Array of integers	Optional	To retrieve the list of states/regions and IDs, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name
AreaCode	Targeted area codes.	Array of Geo Area Code Object Definition	Optional	To retrieve the list of countries and IDs that support area code targeting use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=areaCode To retrieve the list of states/regions and IDs that support area code targeting use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=areaCode To retrieve the list of area codes for a specific state, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/areaCodes?from=0&max=250&order=asc&sort=name&stateId=33
zipcodes	Targeted zip codes.	Array of Geo ZIP Code Object Definition	Optional	To retrieve the list of countries and IDs that support postal code targeting, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=postalCode
nielsenDMAs	Targeted DMAs.	Array of Geo Nielsen DMA Object Definition	Optional	To retrieve the list of countries and IDs that support DMA targeting, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=dma To retrieve the list of states/regions and IDs that support DMA targeting, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=dma To retrieve the list of DMAs for a specific state, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/dmas?from=0&max=250&order=asc&sort=name&stateId=33
Isps	ISP IDs that are targeted.	Array of integers	Optional	To retrieve the list of countries and IDs that support ISP targeting, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=isp To retrieve the the list of ISPs for a specific country, use this method: GET https://api.sizmek.com /rest/csb/strategies/targetingData/isps?countryId=840&from=0&max=250&order=asc&sort=name rest/csb/strategies/targetingData/isps?countryId=840&from=0&max=250&order=asc&sort=name

Object JSON Example

Geo Area Code Object Definition

Name	Description	Type	required	Notes
Type	Type of geo targeting	String	Required	Value is AreaCode.
ID	ID of the area code targeted.	Array of integers	Required
countryId	ID of the country to which the area code belongs.	Long	Required
regionid	ID of the region to which the area code belongs.	Long	Required

Object JSON Example

...
 {
            "type": "GeoTargeting",...
            "areaCodes": [{
                "type": "AreaCode",
                "id": 684,
                "clientRefId": null,
                "relationsBag": null,
                "uiPermissions": null,
                "version": null,
                "countryId": 16,
                "regionId": "11571"
            }],
            "zipCodes": [{...}], 
            "nodeType": "GeoTargeting",
            "nielsenDMAs": [{...}],
            "isps": [58222]
        },...

Geo ZIP Code Object Definition

Name	Description	Type	Required
countryid	ID of the country to which the ZIP code belongs.	Long	Required
countryZipCodes	Targeted ZIP code.	Array of integers	Required
type	Null.	Internal	Internal

Object JSON Example

Geo Nielsen DMA Object Definition

Name	Description	Type	Required	Notes
Type	Type of geo targeting.	String	Required	Value is NielsenDMA.
ID	ID of the Nielsen DMA targeted.	Array of integers	Required
countryId	ID of the country to which the Nielsen DMA belongs.	Long	Required
regionid	ID of the region to which the Nielsen DMA belongs.	Long	Required

Object JSON Example

...
 {
            "type": "GeoTargeting",
            "branchItemClientIds": [],
            "countries": [376],
            "cities": [8737],
            "regions": [11867],
            "areaCodes": [{...}],
            "zipCodes": [{...}],
            "nodeType": "GeoTargeting",
            "nielsenDMAs": [{
                "type": "NielsenDMA",
                "id": 36402,
                "clientRefId": null,
                "relationsBag": null,
                "uiPermissions": null,
                "version": null,
                "countryId": 36,
                "regionId": "689"
            }],
            "isps": [58222]
        },...

Related Entities

Endpoints Using the Geo Object

Parent Objects

Geo Targeting Items Object Definition

Note

Note

Object JSON Example

Geo Area Code Object Definition

Object JSON Example

Geo ZIP Code Object Definition

Object JSON Example

Geo Nielsen DMA Object Definition

Object JSON Example

Comments