BidRequest.user

A User object describing the person using the device, who is the advertising audience. It holds exchange and buyer user IDs, extended IDs, data segments, and, since 2.6, the TCF consent string. Recommended.

CurrentobjectRecommendedSince 2.0

Field facts

Path: user
Object: BidRequest
Type: object
Requirement: Recommended
Added: OpenRTB 2.0
Spec section: 3.2.1

How it is used

Identity in User.eids and User.buyeruid drives audience targeting and frequency capping, and the consent signals in User.consent and BidRequest.regs decide whether it may be used. A bidder with no matched ID may pass and report no-bid reason 8, Unmatched User.

Example

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

{
  "id": "req-1",
  "user": {
    "id": "u-55f1c2",
    "buyeruid": "dsp-8812ab",
    "consent": "CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA"
  }
}

Common mistakes

Leaving the consent string at user.ext.consent on a 2.6 request. It moved to User.consent.
Sending User.yob and User.gender, which 2.6 deprecated.

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	Recommended	No
2.3 to 2.6-202606	object	Recommended	No

Related fields

Other BidRequest fields

For a walkthrough of the whole object, read Bid request anatomy.