User Context¶
Value |
Type |
Description |
---|---|---|
id |
string |
(Recommended) Unique BidSwitch ID of this user. For in-app traffic the
lowercase IDFA, or Android ID is used. For example,
|
buyeruid |
string |
(Recommended) The Buyer user ID as mapped by BidSwitch for the Buyer. The User
ID can be a maximum of |
yob |
integer |
Year of birth as a 4-digit integer, for example, |
gender |
string |
Specifies the user gender, for example,
|
keywords |
string |
Comma separated list of keywords, interests, or intent, for example,
|
geo |
object |
Location of the user’s home base (i.e., not necessarily their current location), see Geo Context |
data |
array of objects |
Additional data. Each data object represents a different data source, for more information, see the User Data Context section. |
consent* |
string |
The binary encoding scheme that is passed in base64 URL/web safe format known
as daisybit, e.g. The data stored in the consent string is divided into 3 parts: metadata, the purposes for which the user has given consent, and to which vendors this consent was given. The Buyer should use the information in the consent array to ascertain which vendors and for which purposes the user gave consent.
For more information see the following links: |
ext |
object |
For more information, see the User Ext Object section. |
User Ext Object¶
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,
|
xuid* |
array of objects |
Passes cross-platform user ID information for the following possible vendors:
|
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 |
dsp_uuids* |
object |
key-value user ID pairs to support direct-like user syncs, see the supp-1-sync section for more details. |
Cross-Platform UID¶
Cross-platform User ID Object.
Value |
Type |
Description |
---|---|---|
provider |
string |
(Required) The provider of the User ID, e.g. |
id |
string |
(Required) The User ID from the provider. |
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 |
User JSON Example¶
{
"user":{
"id":"a0af45c77890045deec100acb8443baff57c",
"buyeruid":"fcd4282456238256034abcdef220d9aa5892",
"consent":"ihdknkhkq8y",
"keywords":"A_18_24,COLLEGE,HHI_75_100,M_18_24,HH_SINGLE",
"data":[
{
"name":"program_types",
"segment":[
{
"name":"HOCKEY_DEC",
"value":"8"
},
{
"name":"BASEBALL_DEC",
"value":"9"
},
{
"name":"FOOTBALL_DEC",
"value":"8.1"
}
]
}
],
"yob":1990,
"gender":"F",
"ext":{
"dsp_uuids":{
"77":"xyz"
},
"xuid":[
{
"provider":"digitrust",
"id":"abc123"
},
{
"provider":"TDID",
"id":"abc12345"
},
{
"provider":"ID5",
"id":"ID5-abc12345"
}
],
"consented_providers_settings":{
"consented_providers":[
1,
52,
45,
23
]
}
}
}
}