PDF

User Object

BidRequest.user

Each BidRequest object can contain a User object, which provides details about the end-user.

The User object can contain an Extensions object and can reference the user’s Geo via their Device.

NOTE
With the enactment of the General Data Protection Regulation (GDPR), OpenX includes GDPR-specific elements in its support of OpenRTB. For more information, please contact your OpenX Platform Development Manager. See also Regs object.

Field name	Data type	Description	Sent?
`buyeruid`	`string`	OpenX can return data to the bidder that was previously synced with OpenX and tracked by an OpenX cookie. For example, the bidder’s unique identifier for a user could be synchronized and later reported back to the bidder when the user’s cookie data becomes available.	Sometimes
`data`	`array` (`data object`)	An array of Data objects to provide details about the user.	Sometimes
`ext`	`extensions object`	An object containing properties that describe custom fields related to this user,	Sometimes
`gender`	`string`	The end-user’s gender (`M`, `F`, or `O`)	Sometimes
`geo`	`geo object`	An object containing properties that describe the user’s primary location, which is not necessarily their current location	Sometimes
`id`	`string`	The OpenX ID for the user, which is only returned when OpenX is able to set the cookie for the user. To protect the identity of the user, the ID is different for each bidder. For example, Ad Exchange may send a value of `1234` to bidder A and a value of `5678` to bidder B to represent the same user.	Sometimes
`yob`	`integer`	The end-user’s four digit year of birth. For example, `1972`	Sometimes

For additional publisher enrichment fields, see Supplemental Data.

To provide additional details about the end-user, Ad Exchange may include an Extensions object.

BidRequest.user.ext

Field name	Data type	Description	Sent?
`consent`	`string`	Declaration that the user has consented to having his or her data collected by the publisher’s site, as mandated by the GDPR.	Sometimes
`consented_providers_settings`	`object`	Information about Google providers for whom the publisher has informed Google that its European Economic Area (EEA) users have consented to the use of their personal data for ad personalization. This field is only relevant for requests that are subject to GDPR. Note: This object is only populated for Google Exchange Bidding traffic.	Sometimes
`eids`	`object array`	Incorporates external identifiers related to user data.	Sometimes

BidRequest.user.ext.consented_providers_settings

Field name	Data type	Description	Sent?
`consented_providers`	`integer array`	Set of Google IDs corresponding to Google providers for whom the publisher has informed Google that its European Economic Area (EEA) users have consented to the use of their personal data for ad personalization. Google has publicly provided a .csv file containing the mapping of provider IDs to provider names. Note: This field is only populated for Google Exchange Bidding traffic.	Sometimes

BidRequest.user.ext.eids

Field name	Data type	Description	Sent?
`source`	`string`	The source of the external identifier, typically a top-level domain URL, such as adsrver.org.	Sometimes
`uids`	`object array`	An array of unified identifiers that are mapped, for standardization, to user IDs collected by exchange partners who adopt a given standard.	Sometimes

BidRequest.user.ext.eids.uids

Field name	Data type	Description	Sent?
`id`	`string`	One of the IDs in a uids array.	Sometimes
`ext`	`extensions object`	An object containing properties that describe custom fields related to a unified ID.	Sometimes

BidRequest.user.ext.eids.uids.ext

Field name	Data type	Description	Sent?
`rtiPartner`	`string`	The name of the real-time identity partner.	Sometimes