User Object

Note

Fields marked with asterisk (*) are optional.

User Object Properties

Value

Type

Description

id*

string

Your unique ID for this user. The User ID can be a maximum of 50 characters.

buyeruid*

string

The BidSwitch ID for this user. For in-app traffic the lowercase IDFA, or Android ID is used. For example, "38f72eaf-5d6f-4143-824f-deaf753d7239". The User ID can be a maximum of 50 characters.

keywords*

string

Comma separated list of keywords, interests, or intent, for example, Cars, sports, vacation

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

data*

array of objects

Additional data. Each data object represents a different data source, for more information, see the Data Object section.

ext*

object

See User Ext Object

User Ext Object

User Ext Object Properties

Value

Type

Description

xuid*

array of objects

Contains cross-platform user ID information for the following possible vendors: "digitrust", "TDID", "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

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 Supplier should pass this information to Buyers to ensure they can bid appropriately in their responses. For more information see the following links:

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

Cross-Platform UID

Cross-platform User ID object used to pass any additional User IDs the Supplier may have for this user.

xuid Object Properties

Value

Type

Description

provider

string

(Required) The provider of the additional User ID value, the possible vendors are: "digitrust", "TDID", "id5"

id

string

(Required) User ID with this provider.

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
            ]
         },
         "xuid":[
            {
               "provider":"digitrust",
               "id":"F6vrzeiV625KD2WaTcGs68ajfRYokPFm6jNUSsawIKAdo"
            },
            {
               "provider":"TDID",
               "id":"abc12345"
            },
            {
               "provider":"ID5",
               "id":"ID5-abc12345"
            }
         ]
      }
   }
}