Retrieving and passing the Unified ID identifier

When a user's Unified ID identifier can be retrieved from the user's local storage or from Unified ID's endpoint for the current page load, the IX Library passes this identifier to certified bidding adapters as part of the returnparcels parameter to the generateRequestObj function.

The generateRequestObj function is located in each adapter's module file, <adapter-name>-htb.js. For more information on the adapter code structure, see your <adapter-name>-htb.js file in GitHub. Within the generateRequestObj function, the identity object can be found at returnParcels[].identityData.AdserverOrgIp and provides the following identity data:

Location in identity object Field Description

data

source

The Unified ID domain.

uids

id

The user identifier string from Unified ID.
uids.ext rtiPartner Unified ID's ID.

Example

 {
    "data": {
	 "source": "adserver.org",
        "uids": [
            {
	          "id": "uid123"
                 "ext": {
                      "rtiPartner": "TDID"
                 }
            },
            {
                 "id": "TRUE",
                 "ext": {
	              "rtiPartner": "TDID_LOOKUP"
                 }
            }, 
            {    "id": "2020-06-06T18:55:26",
                 "ext": {
                     "rtiPartner": "TDID_CREATED_AT"
                 }
            }
        ]
    }
 }

Note: If your adapter architecture is set to Single Request Architecture (SRA), you will see that all elements in returnParcels[] contain identical identityData.AdserverOrgIp objects. You may use any of these elements to retrieve the Unified ID identifier.

The IX Library will cache a retrieved Unified ID identifier for seven days or 24 hours if it was not able to retrieve the identifier before attempting to update the value.

Updating your adapter

Bidding adapters that want to pass the Unified ID identifier to eligible DSPs must update their adapter code by following the standard certification process. For more information on updating your adapter, see Update a certified adapter.