User Object¶
Note
Fields marked with asterisk (*) are optional.
Value |
Type |
Description |
---|---|---|
id* |
string |
Unique BidSwitch ID of this user, for example,
|
buyeruid* |
string |
The Buyer user ID as mapped by BidSwitch for the DSP. The User ID can be
a maximum of |
suid* |
string |
Unique Supplier ID of the user if the BidSwitch user ID is unknown for some reason,
for example, |
keywords* |
string |
Comma separated list of keywords, interests, or intent,
for example, |
yob* |
integer |
Year of birth as a 4-digit integer, for example, |
gender* |
string |
Specifies the user gender, for example,
|
data* |
array of objects |
Additional data. Each data object represents a different data source, for more information, see the Data Object section. |
ext* |
object |
For more information, see the User Ext Object Properties section. |
User Ext Object Properties¶
Value |
Type |
Description |
---|---|---|
ug* |
integer |
User group set up for the target user during cookie syncing, for
example
|
cookie_age* |
integer |
Number of days since the user cookie has been dropped, for example,
|
digitrust* |
object |
Deprecated since version 5.3: passing this value moved to the Container object for the DigiTrust ID and related attributes, see the DigiTrust Object object for more details. |
xuid* |
array of objects |
Contains cross-platform user ID information for the following possible
vendors: Deprecated since version December: 2020, replaced by |
eids* |
array of objects |
Contains the Extended identifiers object, see the Extended Identifiers section for details |
google_consent* |
array of integers |
Set of IDs corresponding to providers for whom the publisher has provided user consent using Google vendor list. A mapping of provider ID to provider name is posted at https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv Deprecated since version 5.3. Replaced by the |
impdepth* |
int |
The count of impressions for a specific placement type in a given app session.
The impression depth is reset once the session ends, e.g |
sessionduration* |
int |
The total duration of time a user has spent so far in a specific app session
expressed in seconds. For example, a user has been playing Word Game for 45
seconds, e.g. |
consented_providers _settings* |
object |
Passes a set of IDs corresponding to providers for whom the publisher has provided user consent using Google vendor list. See the Consented Provider Settings |
consent* |
string |
Passes the Transparency & Consent Framework string. The current valid version of this string is v2.0. You can read more about the the information encoded within the consent string here: Transparency and Consent String with Global Vendor & CMP List Formats The Buyer should use the information in the consent string to ascertain which vendors and for which purposes the user gave consent.
For more information see the following links: |
Consented Provider Settings¶
Value |
Type |
Description |
---|---|---|
consented_providers |
array of integers |
Set of IDs corresponding to providers for whom the publisher has provided user consent using Google vendor list. A mapping of provider ID to provider name is posted at https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv |
DigiTrust Object¶
Value |
Type |
Description |
---|---|---|
id |
string |
User ID as provided by DigiTrust. Deprecated since version 5.3: moved into Cross-Platform UID |
Cross-Platform UID¶
Important
This field has been deprecated and replaced by the IAB OpenRTB community extension, see the Extended Identifiers section. Until all partners have switched over to the replacement field, you will see both objects in bid requests.
Cross-platform User ID object used to pass any additional User IDs the Supplier may have for this user.
Value |
Type |
Description |
---|---|---|
provider |
string |
(Required) The provider of the additional User ID value, the possible values
are: |
id |
string |
(Required) User ID with this provider. |
Extended Identifiers¶
Supports the official Open RTB community extension for passing multiple third party user identifiers, see the official Extended Identifiers spec for more details.
This object passes any additional User IDs a Supplier, Consent Management Platform (CMP), Data Management Platform (DMP), or BidSwitch may have for a user. There is a number of identity solutions that provide IDs for users that are not based on 3rd party data, and many of these solution providers extend their first-party data as offerings that can be used to offset the decline of 3rd party cookies.
BidSwitch and many of our partners support these offerings and have build systems to collate, map, and make these IDs available to Buyers, who can use them to improve the robustness of targeted advertising. When the appropriate consent is in place (e.g CCPA, GDPR) BidSwitch passes these IDs to Buyers.
The TradeDesk ID known as the Unified ID 2.0 and passed as
"adserver.org"
, is based on a Single-Sign On (SSO) email validation service for publisher site access. The cookie-based Unified ID 1.0 is also passed using this ID. You can read more about that here https://www.thetradedesk.com/industry-initiatives/unified-id-solutionThe LiveIntent ID, passed as
"liveintent.com"
, is built and authenticated daily through consent-based email, you can read more about here https://www.liveintent.com/identity-solutions/The ID5 ID, passed as
"id5-sync.com"
, enables publishers to create and distribute a shared first-party identifier, you can read more about that here https://www.id5.io/The prebid managed SharedID, passed using
"sharedid.org"
, see https://prebid.org/product-suite/sharedid/ for more detailsThe LiveRamp ID, passed as
"liveramp.com"
, associates anonymous device IDs and other online customer IDs from publishers, platforms, or data providers with an IdentityLink (IDL) single person-based identifier. You can read more about it here https://liveramp.com/our-platform/identity-resolution/
Note
The LiveRamp ID is encrypted and only enabled for certain Buyers that have the business contracts in place to decrypt and use this ID, contact support@bidswitch.com if you are a LiveRamp partner.
The LiveIntent ID is only available to certain Buyers to whom LiveIntent wish to grant usage rights.
Value |
Type |
Description |
---|---|---|
source |
string |
(Required) Source or technology provider responsible for the set of included IDs. Expressed as a top-level domain. BidSwitch includes the following IDs when available.
|
uids |
array of objects |
(Required) Passes the User IDs matched from the given provider. |
uids Object¶
Value |
Type |
Description |
---|---|---|
id |
string |
(Required) The User ID with this provider. |
atype |
int |
(Optional) The type of user agent the match is from.
|
User Object Example¶
{
"user":{
"id":"45asdf987656789adfad4678rew656789",
"buyeruid":"1234567890",
"keywords":"sports, entertainment",
"yob":1976,
"gender":"F",
"ext":{
"ug":1,
"cookie_age":15,
"consent":"Y29uc2VudCBkYXRh",
"consented_providers_settings":{
"consented_providers":[
1791
]
},
"eids":[
{
"source":"adserver.org",
"uids":[
{
"id":"zzz",
"atype":1
},
{
"id":"DB700403-9A24-4A4B-A8D5-8A0B4BE777D2",
"atype":2
}
]
},
{
"source":"liveintent.com",
"uids":[
{
"id":"IPl4zj44RhezVyNE83bYfogYRN6W8LaCy3USy8dPQ==",
"atype":3
}
]
},
{
"source":"liveramp.com",
"uids":[
{
"id":"0db20294a3908612bc7e732c2022095391074cf3"
}
]
}
]
},
"xuid":[
{
"provider":"TDID",
"id":"abc12345"
},
{
"provider":"id5",
"id":"ID5-abc12345"
}
]
}
}