Geo§3.2.19 · Bid Request
This object encapsulates various methods for specifying a geographic location. When subordinate to a Device object, it indicates the location of the device which can also be interpreted as the user's current location. When subordinate to a User object, it indicates the location of the user's home base (i.e., not necessarily their current location). The lat/lon attributes should only be passed if they conform to the accuracy depicted in the type attribute. For example, the centroid of a geographic region such as postal code should not be passed.
| Attribute | Type | Description |
|---|---|---|
| lat | float | Latitude from -90.0 to +90.0, where negative is south. |
| lon | float | Longitude from -180.0 to +180.0, where negative is west. |
| type | integer | Source of location data; recommended when passing lat/lon. Refer to List 5.20.Enum Location Types · 3 values1GPS/Location Services 2IP Address 3User Provided (e.g., registration data) |
| accuracy | integer | Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device's location services (i.e., type = 1). Note that this is the accuracy as reported from the device. Consult OS specific documentation (e.g., Android, iOS) for exact interpretation. |
| lastfix | integer | Number of seconds since this geolocation fix was established. Note that devices may cache location data across multiple fetches. Ideally, this value should be from the time the actual fix was taken. |
| ipservice | integer | Service or provider used to determine geolocation from IP address if applicable (i.e., type = 2). Refer to List 5.23.Enum IP Location Services · 6 values1ip2location 2Neustar (Quova) 3MaxMind 4NetAcuity (Digital Element) 51151Degrees (High Confidence) 51251Degrees (Medium Confidence) |
| country | string | Country code using ISO-3166-1-alpha-3. |
| region | string | Region code using ISO-3166-2; 2-letter state code if USA. |
| regionfips104 | string | Region of a country using FIPS 10-4 notation. While OpenRTB supports this attribute, it has been withdrawn by NIST in 2008. |
| metro | string | Google metro code; similar to but not exactly Nielsen DMAs. See Appendix A for a link to the codes. |
| city | string | City using United Nations Code for Trade & Transport Locations. See Appendix A for a link to the codes. |
| zip | string | Zip or postal code. |
| utcoffset | integer | Local time as the number +/- of minutes from UTC. |
| ext | object | Placeholder for exchange-specific extensions to OpenRTB. |
Field descriptions reconciled against the official 2.6 draft; 2.5-specific fields come from a third-party Go implementation source (Apache 2.0), proofread against the official PDF · first-draft proofreading