User Object

Note

Fields marked with asterisk (*) are optional.

User Object Properties

Value

Type

Description

id*

string

Unique BidSwitch ID of this user, for example, "252eb154-b3e5-473f-bad8-9b6d7f8646e5". 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.

buyeruid*

string

The Buyer user ID as mapped by BidSwitch for the DSP. The User ID can be a maximum of 50 characters.

suid*

string

Unique Supplier ID of the user if the BidSwitch user ID is unknown for some reason, for example, "252eb154-b3e5-473f-bad8-9b6d7f8646e5".

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

For more information, see the User Ext Object Properties section.

User Ext Object Properties

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 - 99: custom user group.

cookie_age*

integer

Number of days since the user cookie has been dropped, for example, 10

digitrust*

object

Deprecated since version 5.3: passing this value moved to the xuid object

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: "digitrust", "TDID", "id5", see Cross-Platform UID

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 consented_providers_settings object, with the IDs passed in its consented_providers array.

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 2

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. 45

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 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:

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

DigiTrust Object

DigiTrust Object Properties

Value

Type

Description

id

string

User ID as provided by DigiTrust.

Deprecated since version 5.3: moved into Cross-Platform UID

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 values 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"
            }
         ]
      }
   }
}