User object
The User object describes the person behind the device: the exchange's and the buyer's IDs for them, extended IDs from identity providers, audience data segments, and the TCF consent string. It sits at BidRequest.user. Its IDs may rotate under privacy policies, but when present they should stay stable long enough for frequency capping and retargeting.
How it is used
Every field is optional, and what a seller may send depends on consent and regulation. When GDPR applies, buyers read user.consent for their own vendor and purpose consent before using any identifier. The COPPA guidance in OpenRTB 2.5 recommends suppressing id, buyeruid, yob, and gender when regs.coppa is 1. OpenRTB 2.6 promoted consent and eids out of user.ext into first-class fields and deprecated yob and gender.
The User identity and EIDs page covers it in more depth.
Fields
| Field | Type | Requirement | Since | Status |
|---|---|---|---|---|
buyerid | string | Recommended | 2.3 | Removed after 2.3 |
buyeruid | string | Optional | 2.0 | Current |
consent | string | Optional | 2.6-202204 | Current |
customdata | string | Optional | 2.0 | Current |
data | object array | Optional | 2.0 | Current |
eids | object array | Optional | 2.6-202204 | Current |
ext | object | Optional | 2.1 | Current |
gender | string | Optional | 2.0 | Deprecated 2.6-202204 |
geo | object | Optional | 2.0 | Current |
id | string | Optional | 2.0 | Current |
keywords | string | Optional | 2.0 | Current |
kwarray | string array | Optional | 2.6-202204 | Current |
yob | integer | Optional | 2.0 | Deprecated 2.6-202204 |
Where it sits
Contained in: BidRequest.
All objects
The field reference index lists every OpenRTB 2.x object.