ID5 Prebid User ID Module (id5/api-config-prebid
)
operated by: ID5 Technology Ltd.
(get company information on datarequests.org)This endpoint is used to integrate ID5 into the User ID module of the Prebid.js header bidding solution.
With this integration, demand partners configured in Prebid can retrieve the ID5 ID and share it with server-side RTB partners, allowing them to target individual users.
Endpoint URLs
These are URLs or regexes of endpoints the tracker sends data to. We use these to determine which adapter to apply to a request. Some trackers use the same endpoint for several formats. In this case we use additional logic to match the adapter to the request, refer to the code for more information.https://id5-sync.com/api/config/prebid
Decoding steps
Every tracking library has its own way of transmitting tracking data, often even several. They are regularly pretty convoluted, nested encoding schemes. Because of that, the adapter needs to decode the request information into a consistent format. We try to keep keys and paths intact, but the structure results from our decoding. All steps used in the decoding for this adapter are documented here.- Parse the request body as JSON. Store that in the result for the request body.
- Decode the result for the request body at
params.pd
as a Base64 string. Store that in the result for the request body atparams.pdDecoded
. - Parse the result for the request body at
params.pdDecoded
as a query string. Store that in the result for the request body atparams.pdParsed
. - Get the property at JSONPath
$
in the request headers. Store that in the result for the request headers. - Get the cookie
$
. Store that in the result for the cookies.
1res.body = parseJson(body)
2res.body.params.pdDecoded = decodeBase64(res.body.params.pd)
3res.body.params.pdParsed = parseQueryString(res.body.params.pdDecoded)
4res.header = header.$
5res.cookie = cookie.$
Observed data transmissions
This is data that we observed being transmitted by this tracker. Not every request contains all of this data. The context of the data describes where we found the data in the request, the path describes the location of the data in the decoded request. The examples are a selection of observed values.References
- Documentation for
params.partner
: https://wiki.id5.io/en/identitycloud/retrieve-id5-ids/prebid-user-id-module/id5-prebid-user-id-module#configuration-parameters - Documentation for
params.pdParsed.10
: https://wiki.id5.io/identitycloud/retrieve-id5-ids/passing-partner-data-to-id5#supported-partner-data-keys - Documentation for
params.pdParsed.11
: https://wiki.id5.io/identitycloud/retrieve-id5-ids/passing-partner-data-to-id5#supported-partner-data-keys - Documentation for
User-Agent
: https://id5.io/platform-privacy-policy/#what-information-do-we-collect - Documentation for
user-agent
: https://id5.io/platform-privacy-policy/#what-information-do-we-collect - Documentation for
sec-ch-ua
: https://id5.io/platform-privacy-policy/#what-information-do-we-collect - Documentation for
params.pdParsed.12
: https://wiki.id5.io/identitycloud/retrieve-id5-ids/passing-partner-data-to-id5#supported-partner-data-keys - Documentation for
id5
: https://github.com/id5io/id5-api.js/blob/874ace5d11a667b992650df198d53775fdb60709/README.md#id5-id - Documentation for
params.pdParsed.8
: https://wiki.id5.io/identitycloud/retrieve-id5-ids/passing-partner-data-to-id5#supported-partner-data-keys - Documentation for
params.pdParsed.9
: https://wiki.id5.io/identitycloud/retrieve-id5-ids/passing-partner-data-to-id5#supported-partner-data-keys