User Context

User Object Properties
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, "38f72eaf-5d6f-4143-824f-deaf753d7239"
buyeruid string (Recommended) The Buyer user ID as mapped by BidSwitch for the Buyer.
yob integer Year of birth as a 4-digit integer, for example, 1977
gender string

Specifies the user gender, for example, "F"

  • "M" = Male
  • "F" = Female
  • "O" = Known to be other, or omitted if unknown
keywords string Comma separated list of keywords, interests, or intent, for example, "Cars, sports, vacation"
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. "Y29uc2VudCBkYXRh"

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.

  • If the user has not given consent, then do not respond with an ad which utilises user information and neither access nor store information on the user’s device e.g. cookies, IDFA, fingerprints
  • If the user has given consent, then identify all vendors to whom the user has given consent and for which purposes
    • Buyers should also only use and store user data if the user has given consent to the buyer and only for the purposes for which the user has given consent
    • Buyers should only allow third-party direct or redirect links to those who have received consent from the user
    • https://vendorlist.consensu.org/vendorlist.json
  • If no consent is given, you cannot use personal data and may not have the right to use cookies. Each party is responsible for determining what that means for their business. If user consent explicitly states that it is not given, then do not respond with an ad which utilises user information and neither access nor store information on the user’s device e.g. cookies, IDFA, fingerprints

For more information see the following links:

ext object For more information, see the User Ext Object section.

User Ext Object

User Ext Object Properties
Value Type Description
ug integer

User group set up for the target user during cookie syncing, for example 1. This takes the following values:

  • 0: unmatched user
  • 1: matched user
  • 2-6: custom user group.
cookie_age* integer Number of days since the user cookie has been dropped, for example, 10
xuid* array of objects Contains cross-platform user ID information, e.g. for digitrust, ttd, liveramp, id5, see Cross-Platform UID
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

Cross-Platform UID

Cross-platform User ID Object.

xuid Object Properties
Value Type Description
provider string (Required) The provider of the User ID, for the moment only DigiTrust is supported, e.g. "digitrust", id5, ttd
id string (Required) User ID as provided by DigiTrust. If digitrust.keyv is provided then the ID is encrypted
keyv* integer The Key version responsible for encryption, if the ID is encrypted.

Consented Provider Settings

Consented Providers
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",
        "xuid":[
            {
                "provider":"digitrust",
                "id":"abc123",
                "keyv":2
            }
        ],
        "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":{
            "consented_providers_settings":{
                "consented_providers":[
                    1,
                    52,
                    45,
                    23
                ]
            }
        }
    }
}