You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dev-docs/modules/userId.md
+36-28
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ The User ID module supports multiple ways of establishing pseudonymous IDs for u
29
29
***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.
30
30
***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.
31
31
***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.
33
33
***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).
34
34
***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.
35
35
@@ -85,7 +85,7 @@ of sub-objects. The table below has the options that are common across ID system
85
85
86
86
### BritePool
87
87
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.
The BritePool privacy policy is at [https://britepool.com/services-privacy-notice/](https://britepool.com/services-privacy-notice/).
100
100
@@ -201,7 +201,7 @@ pbjs.setConfig({
201
201
202
202
### ID5 Universal ID
203
203
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.
205
205
206
206
#### ID5 Universal ID Registration
207
207
@@ -224,7 +224,7 @@ The following configuration parameters are available:
224
224
| name | Required | String | The name of this module: `"id5Id"`|`"id5Id"`|
225
225
| params | Required | Object | Details for the ID5 Universal ID. ||
226
226
| 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..."`|
228
228
229
229
{: .alert.alert-info :}
230
230
**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.
@@ -429,11 +433,11 @@ The adapters can be implemented to use the lipibid as the identifier and segment
429
433
430
434
Please register with us if you’re not a LiveIntent customer already: [https://www.liveintent.com/prebid-registration/](https://www.liveintent.com/prebid-registration/)
431
435
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/)
433
437
434
438
#### How does LiveIntent ID work
435
439
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.
437
441
438
442
How does LiveIntent ID sub-module decide, which first-party cookies to use:
439
443
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({
481
485
params: {
482
486
publisherId: "9896876"
483
487
},
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
+
}
489
493
}]
490
494
}
491
495
})
@@ -501,11 +505,11 @@ pbjs.setConfig({
501
505
publisherId: "9896876",
502
506
identifiersToResolve: ["my-own-cookie"]
503
507
},
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
+
}
509
513
}]
510
514
}
511
515
})
@@ -530,11 +534,11 @@ pbjs.setConfig({
530
534
appId: "a-0012"
531
535
}
532
536
},
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
+
}
538
542
}]
539
543
}
540
544
})
@@ -753,17 +757,17 @@ pbjs.setConfig({
753
757
754
758
### Shared ID User ID Submodule
755
759
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.
757
761
758
762
#### 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.
760
764
Add it to your Prebid.js package with:
761
765
762
766
ex: $ gulp build --modules=userId,sharedIdSystem
763
767
764
768
#### Prebid Params
765
769
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.
767
771
```
768
772
pbjs.setConfig({
769
773
usersync: {
@@ -909,8 +913,12 @@ Bidders that want to support the User ID module in Prebid.js, need to update the
909
913
| --- | --- | --- | --- | --- | --- |
910
914
| BritePool ID | BritePool | bidRequest.userId.britepoolid |`"1111"`|
| LiveIntent ID | Live Intent | bidRequest.userId.lipb.lipbid |`"1111"`|
916
924
| IntentIQ ID | IntentIQ | bidRequest.userId.intentiqid |`"1111"`|
@@ -1028,7 +1036,7 @@ pbjs.getUserIds() // returns object like bidRequest.userId. e.g. {"pubcid":"1111
1028
1036
1029
1037
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.
1030
1038
```
1031
-
pbjs.getUserIdsAsEids() // returns userIds in ORTB Eids format. e.g.
1039
+
pbjs.getUserIdsAsEids() // returns userIds in ORTB Eids format. e.g.
1032
1040
[
1033
1041
{
1034
1042
source: 'pubcid.org',
@@ -1049,7 +1057,7 @@ pbjs.getUserIdsAsEids() // returns userIds in ORTB Eids format. e.g.
1049
1057
}]
1050
1058
}
1051
1059
]
1052
-
```
1060
+
```
1053
1061
1054
1062
## Passing UserIds to Google Ad Manager for targeting
0 commit comments