Geo.region
The region within the country, using ISO 3166-2 subdivision codes. For US traffic the convention is the two-letter state code, such as "NY".
Field facts
- Path
device.geo.region,user.geo.region- Object
- Geo
- Type
- string
- Requirement
- Optional
- Added
- OpenRTB 2.0
- Spec section
- 3.2.19
How it is used
Outside the US, use the ISO 3166-2 subdivision code and tell buyers whether you include the country prefix, since both forms appear in practice.
Example
Where the field sits in a payload, with everything else left out:
{
"id": "req-1",
"device": {
"geo": {
"region": "NY"
}
}
}Common mistakes
- Sending a full state or province name instead of a code.
Version history
Added in OpenRTB 2.0, and present in the latest snapshot. The table shows how each version's spec text types the field.
| Versions | Type in the spec | Required | Deprecated |
|---|---|---|---|
| 2.0 to 2.2 | string | No | No |
| 2.3 to 2.3.1 | string | No | No |
| 2.4 | string | No | No |
| 2.5 to 2.6-202606 | string | No | No |