Skip to end of metadata
Go to start of metadata

Region Service

The read-only Region Service allows you to see information about the regions/states registered in the AppNexus system, including the country to which each region/state belongs. You can use this service to retrieve region IDs for targeting in campaigns (see region_targets in the Profile Service).

On This Page

REST API

View all regions:

View a specific region:

Find out which fields you can filter and sort by:

JSON Fields

Field

Type

Description

id

int

The ID of the region.

name

string

The name of the region.

code

string

Deprecated

iso_3166_2stringThe ISO 3166-2 code for the region.
country_idintThe ID of the country to which the region belongs.

country_name

string

The name of the country to which the region belongs. You can use the Country Service to retrieve a complete list of country names.

country_code

enum

The ISO code for the country to which the region belongs. You can use the Country Service to retrieve a complete list of country codes.

activeBoolean

If true, the region is available for targeting. If false, there is no geolocation data for the region and so delivery is not possible.

For more information, see How AppNexus Geography Targeting Works.

Examples

View all regions in Germany
View all regions in Germany and France
View all regions that contain "California" in their names