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.
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. 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://vendor-list.consensu.org/v2/vendor-list.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: https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework https://gdpr-info.eu/ http://gdpr-demo.labs.quantcast.com/user-examples/cookie-workshop.html
customdata*	string	Optional feature to pass bidder data that was set in the exchange’s cookie. The string must be in base85 cookie safecharacters and be in any format. Proper JSON encoding must be used to include “escaped” quotation marks.
eids*	array of objects	Contains the Extended identifiers object, see the Extended Identifiers section for details
keywords*	string	A comma separated list of keywords about the App, e.g `"news, weather, sports"`. Only one of `keywords` or `kwarray` should be passed.
kwarray*	array of string	An array of keywords about the App, e.g `["news", "weather", "sports"]`. Only one of `keywords` or `kwarray` should be passed.
yob*	integer	Year of birth as a 4-digit integer, for example, `1977` Deprecated since version 5.3.
gender*	string	Specifies the user gender. Deprecated since version 5.3.
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`
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 section below

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

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 all and any correctly set ID in this field. The following IDs are the most commonly sent through BidSwitch, but if you are looking for a particular ID in requests, you should check the source value to identify it. You can find a more extensive list of possible IDs on the Prebid User ID Module page

The TradeDesk ID known as the Unified ID 2.0 and passed as "uidapi.com", is based on a Single-Sign On (SSO) email validation service for publisher site access.
The TradeDesk ID known as the Unified ID 1.0 and passed as "adserver.org".You can read more about that here https://www.thetradedesk.com/us/about-us/industry-initiatives/unified-id-solution-2-0/unified-id-solution-1-0
The 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 details
The Intimate Merger ID is commonly used in the Japanese marketplace, with the source passed as intimatemerger.com.
The 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.

eids Object Properties¶
Value	Type	Description
source	string	(Required) Source or technology provider responsible for the set of included IDs. Expressed as a top-level domain. For universal or alt-IDs, it’s the domain of the party who defined/created the ID itself. For cookie IDs, it’s the domain of the party to whom the cookie belongs.
uids	array of objects	(Required) Passes the User IDs matched from the given provider.
matcher	string	(Required if `mm` and `inserter` are present) Technology providing the match method as defined in `mm`. When blank, it is assumed that the `matcher` is equal to the `source`. May be omitted when `mm` = `0`, `1`, or `2`.
mm	integer	(Required if `matcher` and `inserter` are present) Match method used by the `matcher`. Refer to List: ID Match Methods in AdCOM 1.0
inserter	string	(Required if `matcher` and `mm` are present) The party that’s putting the ID into the bid request. Can be Publisher, Supplier or BidSwitch

uids Object¶

uids Object Properties¶
Value	Type	Description
id	string	(Required) The User ID with this provider.
atype	int	(Optional) The type of user agent the match is from. `1` An ID which is tied to a specific web browser or device (cookie-based, probabilistic, or other). `2` In-app impressions, which will typically contain a type of device ID (or rather, the privacy-compliant versions of device IDs). `3` A person-based ID, i.e., that is the same across devices. `500+` Vendor-specific codes.

User Object Example¶

{
  "user":{
    "id":"45asdf987656789adfad4678rew656789",
    "buyeruid":"1234567890",
    "keywords":"sports, entertainment",
    "consent":"Y29uc2VudCBkYXRh",
    "eids":[
      {
        "source":"adserver.org",
        "uids":[
          {
            "id":"zzz123",
            "atype":1
          },
          {
            "id":"DB700403-9A24-4A4B-A8D5-8A0B4BE777D2",
            "atype":2
          }
        ]
      },
      {
        "source":"liveintent.com",
        "matcher":"idvendor.com",
        "mm":4,
        "inserter":"sspdomain.com",
        "uids":[
          {
            "id":"IPl4zj44RhezVyNE83bYfogYRN6W8LaCy3USy8dPQ==",
            "atype":3
          }
        ]
      },
      {
        "source":"liveramp.com",
        "uids":[
          {
            "id":"0db20294a3908612bc7e732c2022095391074cf3"
          }
        ]
      },
      {
        "matcher": "idvendor.com",
        "inserter": "sspdomain.com",
        "source": "universalid.com",
        "mm": 4,
        "uids": [
          {
            "id": "fac13741-0648-436a-88cf-aceafdf45c9a",
            "atype": 3
          }
        ]
      }
    ]
  },
  "ext":{
    "ug":1,
    "cookie_age":15,
    "consented_providers_settings":{
      "consented_providers":[
        1791
      ]
    }
  }
}