User and User Ext

User

Field Type Description
buyeruid String; optional

A DSP's UID for this user (see user matching for format).

Note: Always present in default user match configuration.

id String; optional

IX static identifier for this user (contains only alphanumeric or the following characters: @ - . _ ).

Note: Always present in default user match configuration.

ext Object; optional The User Ext Object, which is used to indicate requests that contain certain user identifiers and/or are subject to GDPR regulations.

User Ext

Field Type Description
consent String; optional

Included for requests that are subject to GDPR regulations (as indicated via the gdpr field in the Regulations Ext Object). This field is always sent where GDPR applies.

This field passes the consent string from the Transparency and Consent Framework (TCF) for versions 1.1 and 2.0. Index Exchange (IX) will continue to support TCF 1.1 along the IAB's timeline until June 30, 2020.

DSPs should be ready to accept TCF 2.0 by the transition timeline set by the IAB. For more information, see TCF 2.0.

When a user does not provide consent for their personal information through TCF, the following bid request fields are updated:

  • ip (device object): The last octet of the user’s IP address is replaced with a zero.

  • lat and lon (geo object): Latitude and longitude coordinates are reduced to two decimals which translates to accuracy no less than one third of a mile.

  • All unique IDs from the bid request in the device and user objects that indirectly identify a user are removed.

  • deals (pmp object): Audience segment targeted deal IDs are no longer added to the bid request.
eids Array of objects; optional An array of eIDs Objects, used to communicate email IDs for this user.
gdpr Integer; optional

Indicates requests that are subject to GDPR regulations. If omitted, the GDPR status is considered unknown.

0 = Impression does not fall under GDPR regulations.

1 = Impression falls under GDPR regulations.

eIDs

Field Type Description
source String; optional The source of the IDs, e.g. "adserver.org".
uids Array of objects; optional An array of uIDs Objects.
id String; optional The user ID received in the request.
ext Object; optional The eIDs Extension Object.

eIDs Ext

Field Type Description
rtipartner String; optional The name of the real-time Identity partner (e.g. "tradedesk").

uIDs

Field Type Description
id String; optional The user ID, e.g. "uid123".
ext Object; optional The uIDs Extension Object.

uIDs Ext

Field Type Description
rtipartner String; optional The name of the real-time Identity partner (e.g. "appnexus").

Was this page helpful?

You are invited to take a 1-minute survey to help us improve this site.

START SURVEY