Skip to content

Commit 9023c4b

Browse files
committed
update id5 userid docs with new links, updated object structure
1 parent 48e4a06 commit 9023c4b

File tree

1 file changed

+36
-28
lines changed

1 file changed

+36
-28
lines changed

dev-docs/modules/userId.md

+36-28
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The User ID module supports multiple ways of establishing pseudonymous IDs for u
2929
* **Lotame Panorama ID** - a people-based identifier available across all browsers -- including when third-party cookies are not available -- to connect and activate first, second, and third party data for programmatic advertising.
3030
* **Parrable ID** - an encrypted pseudonymous ID that is consistent across all browsers and webviews on a device for every publisher the device visits. This module contacts Parrable to obtain the Parrable EID belonging to the specific device which can then be used by the bidder.
3131
* **PubCommon ID** – an ID is generated on the user’s browser and stored for later use on this publisher’s domain.
32-
* **Quantcast ID** - an ID independent of third-party cookies for publishers with Quantcast Measure tag.
32+
* **Quantcast ID** - an ID independent of third-party cookies for publishers with Quantcast Measure tag.
3333
* **Unified ID** – a simple cross-vendor approach – it calls out to a URL that responds with that user’s ID in one or more ID spaces (e.g. adsrvr.org).
3434
* **netID** – provides an open, standardized, EU-GDPR compliant, IAB TCF aware, cross-device enabled Advertising Identifier Framework, which can be leveraged by publishers and advertisers (and vendors supporting them) to efficiently deliver targeted advertising bought through programmatic systems.
3535

@@ -85,7 +85,7 @@ of sub-objects. The table below has the options that are common across ID system
8585

8686
### BritePool
8787

88-
BritePool ID, provided by [BritePool](https://britepool.com) is a Universal Identity resolution which does not depend on 3rd party cookies.
88+
BritePool ID, provided by [BritePool](https://britepool.com) is a Universal Identity resolution which does not depend on 3rd party cookies.
8989

9090
Add it to your Prebid.js package with:
9191

@@ -94,7 +94,7 @@ gulp build --modules=britepoolIdSystem
9494

9595
#### BritePool Registration
9696

97-
Please reach out to [[email protected]](mailto:[email protected]) and request your `api_key`.
97+
Please reach out to [[email protected]](mailto:[email protected]) and request your `api_key`.
9898

9999
The BritePool privacy policy is at [https://britepool.com/services-privacy-notice/](https://britepool.com/services-privacy-notice/).
100100

@@ -201,7 +201,7 @@ pbjs.setConfig({
201201

202202
### ID5 Universal ID
203203

204-
The ID5 Universal ID is a shared, neutral identifier that publishers and ad tech platforms can use to recognise users even in environments where 3rd party cookies are not available. The ID5 Universal ID is designed to respect users' privacy choices and publishers’ preferences throughout the advertising value chain. For more information about the ID5 Universal ID and detailed integration docs, please visit [our documentation](https://console.id5.io/docs/public/prebid). We also recommend that you sign up for our [release notes](https://id5.io/universal-id/release-notes) to stay up-to-date with any changes to the implementation of the ID5 Universal ID in Prebid.
204+
The ID5 Universal ID is a shared, neutral identifier that publishers and ad tech platforms can use to recognise users even in environments where 3rd party cookies are not available. The ID5 Universal ID is designed to respect users' privacy choices and publishers’ preferences throughout the advertising value chain. For more information about the ID5 Universal ID and detailed integration docs, please visit [our documentation](https://wiki.id5.io/x/BIAZ). We also recommend that you sign up for our [release notes](https://id5.io/universal-id/release-notes) to stay up-to-date with any changes to the implementation of the ID5 Universal ID in Prebid.
205205

206206
#### ID5 Universal ID Registration
207207

@@ -224,7 +224,7 @@ The following configuration parameters are available:
224224
| name | Required | String | The name of this module: `"id5Id"` | `"id5Id"` |
225225
| params | Required | Object | Details for the ID5 Universal ID. | |
226226
| params.partner | Required | Number | This is the ID5 Partner Number obtained from registering with ID5. | `173` |
227-
| params.pd | Optional | String | Publisher-supplied data used for linking ID5 IDs across domains. See [our documentation](https://wiki.id5.io/display/PD/Prebid.js+UserId+Module) for details on generating the string. Omit the parameter or leave as an empty string if no data to supply | `"MT1iNTBjY..."` |
227+
| params.pd | Optional | String | Publisher-supplied data used for linking ID5 IDs across domains. See [our documentation](https://wiki.id5.io/x/BIAZ) for details on generating the string. Omit the parameter or leave as an empty string if no data to supply | `"MT1iNTBjY..."` |
228228

229229
{: .alert.alert-info :}
230230
**NOTE:** The ID5 Universal ID that is delivered to Prebid will be encrypted by ID5 with a rotating key to avoid unauthorized usage and to enforce privacy requirements. Therefore, we strongly recommend setting `storage.refreshInSeconds` to `8` hours (`8*3600` seconds) to ensure all demand partners receive an ID that has been encrypted with the latest key, has up-to-date privacy signals, and allows them to transact against it.
@@ -261,7 +261,11 @@ pbjs.setConfig({
261261
userSync: {
262262
userIds: [{
263263
name: "id5Id",
264-
value: { "id5id": "ID5-8ekgswyBTQqnkEKy0ErmeQ1GN5wV4pSmA-RE4eRedA" }
264+
value: {
265+
id5id: {
266+
uid: "ID5-8ekgswyBTQqnkEKy0ErmeQ1GN5wV4pSmA-RE4eRedA"
267+
}
268+
}
265269
}]
266270
}
267271
});
@@ -429,11 +433,11 @@ The adapters can be implemented to use the lipibid as the identifier and segment
429433

430434
Please register with us if you’re not a LiveIntent customer already: [https://www.liveintent.com/prebid-registration/](https://www.liveintent.com/prebid-registration/)
431435

432-
When adding LiveIntent’s ID to your Prebid.js package, you disclose or make available Personal Information to LiveIntent. This information made available to LiveIntent is used to (i) connect with and reference data that already exists in LiveIntent’s graph (the “LiveIntent Graph”), and (ii) authenticate and validate data in aggregate to improve the performance of the services LiveIntent provides. By activating LiveIntent’s module, you hereby confirm that with regard to all individuals to whom Personal Information relates, you have, at or before the point of collecting Personal Information or making Personal Information available to LiveIntent, provided any legally required notices, obtained any legally required consents, and provided individuals with an opportunity to opt-out of the sharing of Personal Information, if such an opt-out is required under applicable laws, such that LiveIntent can provide service to you as described here and in LiveIntent’s privacy policies for the services which can be found at [https://www.liveintent.com/services-privacy-policy/](https://www.liveintent.com/services-privacy-policy/)
436+
When adding LiveIntent’s ID to your Prebid.js package, you disclose or make available Personal Information to LiveIntent. This information made available to LiveIntent is used to (i) connect with and reference data that already exists in LiveIntent’s graph (the “LiveIntent Graph”), and (ii) authenticate and validate data in aggregate to improve the performance of the services LiveIntent provides. By activating LiveIntent’s module, you hereby confirm that with regard to all individuals to whom Personal Information relates, you have, at or before the point of collecting Personal Information or making Personal Information available to LiveIntent, provided any legally required notices, obtained any legally required consents, and provided individuals with an opportunity to opt-out of the sharing of Personal Information, if such an opt-out is required under applicable laws, such that LiveIntent can provide service to you as described here and in LiveIntent’s privacy policies for the services which can be found at [https://www.liveintent.com/services-privacy-policy/](https://www.liveintent.com/services-privacy-policy/)
433437

434438
#### How does LiveIntent ID work
435439

436-
The LiveIntent ID sub-module resolves the identity of audiences by connecting impression opportunities to a stable identifier (nonID). In order to provide resolution one or more first-party cookies are used to create a stable identifier.
440+
The LiveIntent ID sub-module resolves the identity of audiences by connecting impression opportunities to a stable identifier (nonID). In order to provide resolution one or more first-party cookies are used to create a stable identifier.
437441

438442
How does LiveIntent ID sub-module decide, which first-party cookies to use:
439443
1. By default LiveIntent ID sub-module generates its own first-party identifier on the publisher’s domain. Publishers have the option to disable the cookie generation when configuring the LiveIntent ID sub-module.
@@ -481,11 +485,11 @@ pbjs.setConfig({
481485
params: {
482486
publisherId: "9896876"
483487
},
484-
storage: {
485-
type: “cookie”,
486-
name: “pbjs_li_nonid”, //create a cookie with this name
487-
expires: 1 // cookie is stored for 1 day
488-
}
488+
storage: {
489+
type: “cookie”,
490+
name: “pbjs_li_nonid”, //create a cookie with this name
491+
expires: 1 // cookie is stored for 1 day
492+
}
489493
}]
490494
}
491495
})
@@ -501,11 +505,11 @@ pbjs.setConfig({
501505
publisherId: "9896876",
502506
identifiersToResolve: ["my-own-cookie"]
503507
},
504-
storage: {
505-
type: “cookie”,
506-
name: “pbjs_li_nonid”, //create a cookie with this name
507-
expires: 1 // cookie is stored for 1 day
508-
}
508+
storage: {
509+
type: “cookie”,
510+
name: “pbjs_li_nonid”, //create a cookie with this name
511+
expires: 1 // cookie is stored for 1 day
512+
}
509513
}]
510514
}
511515
})
@@ -530,11 +534,11 @@ pbjs.setConfig({
530534
appId: "a-0012"
531535
}
532536
},
533-
storage: {
534-
type: “cookie”,
535-
name: “pbjs_li_nonid”, //create a cookie with this name
536-
expires: 1 // cookie is stored for 1 day
537-
}
537+
storage: {
538+
type: “cookie”,
539+
name: “pbjs_li_nonid”, //create a cookie with this name
540+
expires: 1 // cookie is stored for 1 day
541+
}
538542
}]
539543
}
540544
})
@@ -753,17 +757,17 @@ pbjs.setConfig({
753757

754758
### Shared ID User ID Submodule
755759

756-
Shared ID User ID Module generates a UUID that can be utilized to improve user matching.This module enables timely synchronization which handles sharedId.org optout. This module does not require any registration.
760+
Shared ID User ID Module generates a UUID that can be utilized to improve user matching.This module enables timely synchronization which handles sharedId.org optout. This module does not require any registration.
757761

758762
#### Building Prebid with Shared Id Support
759-
Your Prebid build must include the modules for both **userId** and **sharedId** submodule.
763+
Your Prebid build must include the modules for both **userId** and **sharedId** submodule.
760764
Add it to your Prebid.js package with:
761765

762766
ex: $ gulp build --modules=userId,sharedIdSystem
763767

764768
#### Prebid Params
765769

766-
Individual params may be set for the Shared ID User ID Submodule.
770+
Individual params may be set for the Shared ID User ID Submodule.
767771
```
768772
pbjs.setConfig({
769773
usersync: {
@@ -909,8 +913,12 @@ Bidders that want to support the User ID module in Prebid.js, need to update the
909913
| --- | --- | --- | --- | --- | --- |
910914
| BritePool ID | BritePool | bidRequest.userId.britepoolid | `"1111"` |
911915
| CriteoID | Criteo | bidRequest.userId.criteoId | `"1111"` |
916+
<<<<<<< HEAD
912917
| ID+ | Zeotap | bidRequest.userId.IDP | `"1111"` |
913918
| ID5 ID | ID5 | bidRequest.userId.id5id | `"1111"` |
919+
=======
920+
| ID5 ID | ID5 | bidRequest.userId.id5id | `{ uid: "1111", ext: { linkType: 2 } }` |
921+
>>>>>>> 12ba25f7... update id5 userid docs with new links, updated object structure
914922
| IdentityLink | Trade Desk | bidRequest.userId.idl_env | `"1111"` |
915923
| LiveIntent ID | Live Intent | bidRequest.userId.lipb.lipbid | `"1111"` |
916924
| IntentIQ ID | IntentIQ | bidRequest.userId.intentiqid | `"1111"` |
@@ -1028,7 +1036,7 @@ pbjs.getUserIds() // returns object like bidRequest.userId. e.g. {"pubcid":"1111
10281036

10291037
You can use `getUserIdsAsEids()` to get the user IDs stored by Prebid User ID module in ORTB Eids format. Refer [eids.md](https://github.com/prebid/Prebid.js/blob/master/modules/userId/eids.md) for output format.
10301038
```
1031-
pbjs.getUserIdsAsEids() // returns userIds in ORTB Eids format. e.g.
1039+
pbjs.getUserIdsAsEids() // returns userIds in ORTB Eids format. e.g.
10321040
[
10331041
{
10341042
source: 'pubcid.org',
@@ -1049,7 +1057,7 @@ pbjs.getUserIdsAsEids() // returns userIds in ORTB Eids format. e.g.
10491057
}]
10501058
}
10511059
]
1052-
```
1060+
```
10531061

10541062
## Passing UserIds to Google Ad Manager for targeting
10551063

0 commit comments

Comments
 (0)