User.geo

The user's home location, as a Geo object, typically from registration or profile data. It is not necessarily where the user is now; current location belongs in device.geo.

CurrentobjectOptionalSince 2.0

Field facts

Path: user.geo
Object: User
Type: object
Requirement: Optional
Added: OpenRTB 2.0
Spec section: 3.2.20

How it is used

When sent, it is usually coarse, such as a country, region, or postal code, with Geo.type 3 for user-provided data. Buyers should not treat it as a location fix.

Example

Where the field sits in a payload, with everything else left out:

{
  "id": "req-1",
  "user": {
    "geo": {
      "country": "GBR",
      "zip": "SW1A 1AA",
      "type": 3
    }
  }
}

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	object	No	No
2.3 to 2.3.1	object	No	No
2.4	object	No	No
2.5 to 2.6-202606	object	No	No

Related fields

Other User fields

For a walkthrough of the whole object, read User identity and EIDs.