Link Search Menu Expand Document

PDF

User Object

Demand Partners

BidRequest 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 nameData typeDescriptionSent?
buyeruidstringOpenX 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
dataarray (data object)An array of Data objects to provide details about the user.Sometimes
extextensions objectAn object containing properties that describe custom fields related to this user,Sometimes
genderstringThe end-user’s gender (M, F, or O)Sometimes
geogeo objectAn object containing properties that describe the user’s primary location, which is not necessarily their current locationSometimes
idstringThe 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
yobintegerThe end-user’s four digit year of birth. For example, 1972Sometimes

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 nameData typeDescriptionSent?
consentstringDeclaration 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_settingsobjectInformation 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
eidsobject arrayIncorporates external identifiers related to user data.Sometimes

BidRequest.user.ext.consented_providers_settings

Field nameData typeDescriptionSent?
consented_providersinteger arraySet 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 nameData typeDescriptionSent?
sourcestringThe source of the external identifier, typically a top-level domain URL, such as adsrver.org.Sometimes
uidsobject arrayAn 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 nameData typeDescriptionSent?
idstringOne of the IDs in a uids array.Sometimes
extextensions objectAn object containing properties that describe custom fields related to a unified ID.Sometimes

BidRequest.user.ext.eids.uids.ext

Field nameData typeDescriptionSent?
rtiPartnerstringThe name of the real-time identity partner.Sometimes

See also, OpenRTB Advisory-GDPR.