-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* adding user identity pages * initial draft of identity section * removing draft notice * PBJS 5.0 changes * removing mention of pubcommon from nav * removing old sharedid diagram * grammatical updates * review updates * Rename sharedId.md to sharedid.md Co-authored-by: Jean Stemp <jstemp@appnexus.com>
- Loading branch information
Showing
8 changed files
with
272 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| layout: page_v2 | ||
| title: Prebid User Identity | ||
| description: What is Prebid User Identity | ||
| sidebarType: 9 | ||
| --- | ||
|
|
||
| # Prebid User Identity Overview | ||
|
|
||
| Prebid's aim is to enable the protection of user privacy while still supporting publisher's ability to make revenue, | ||
| keeping the Open Web healthy. | ||
|
|
||
| To do this, Prebid offers a number of identity-related products that encourage awareness of privacy regulations such as GDPR, CCPA, and COPPA. The most important projects are: | ||
|
|
||
| - [Prebid.js User Identity Module](/dev-docs/modules/userId.html). This module supports more than 20 different flavors of global IDs with different features that publishers can work with. | ||
| - [SharedID](/identity/sharedid.html). This native hosted ID offering from Prebid is simple, free, robust, and privacy-minded. | ||
| - **Coming soon:** [Unified ID 2.0](https://prebid.org/blog/prebid-org-to-serve-as-operator-of-unified-id-2-0/) | ||
|
|
||
| ## Prebid.js and Identity | ||
|
|
||
| Publishers have several ways to include user identity as part of | ||
| the header bidding auction: | ||
|
|
||
| 1. Install one or more [User ID modules](/dev-docs/modules/userId.html). These modules obtain | ||
| the user's ID from the service and make it available to participating bidders. Publishers | ||
| can define [permissions](/dev-docs/modules/userId.html#permissions) to control which bidders receive which IDs. | ||
| 2. Install the [ID Import Module](/dev-docs/modules/idLibrary.html). This module can be | ||
| used to generate a map of identities present on the page. | ||
| 3. Pass [First Party Data](/features/firstPartyData.html), such as interests, to bidders for more relevant advertising. | ||
| 4. Include [User Syncing](/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing) to allow bid adapters to establish IDs. Publishers have control over which bidders may sync, which syncing mechanisms are allowed, and when the syncing occurs. Syncing is subject to privacy controls such as GDPR, CCPA, and COPPA. | ||
|
|
||
| ## Prebid Server and Identity | ||
|
|
||
| Prebid Server has user sync functionality, allowing server-side bidders to establish | ||
| IDs given appropriate permission from the user for setting cookies. | ||
|
|
||
| Prebid Server can receive extended ID arrays (eids) from Prebid.js and provide them to | ||
| participating server-side bid adapters. It also supports permissioning to determine | ||
| which eids can be sent to which bidders. | ||
|
|
||
| User IDs are not sent to bid adapters in privacy scenarios such as COPPA and | ||
| GDPR requests lacking appropriate consent. For more details see [Prebid Server Privacy](/prebid-server/features/pbs-privacy.html). | ||
|
|
||
| ## Prebid SDK and Identity | ||
|
|
||
| In application environments, performance-based advertisers rely on a device’s IDFA to target, | ||
| frequency cap, and determine attribution, similar to how cookies are used in desktop | ||
| environments. However, IDFAs are persistent to the device. Prebid SDK will read the IDFA from | ||
| the device when available. Additionally, Prebid SDK supports third party identity IDs. | ||
|
|
||
| Prebid Server will strip the IDFA and/or third party identity IDs when enforcing regulations such as GDPR and CCPA. | ||
|
|
||
| ## AMP, Prebid, and Identity | ||
|
|
||
| Prebid Server supports a user [cookie-sync](/prebid-server/developers/pbs-cookie-sync.html) functionality, including integration with | ||
| a consent management platform. This allows server-side bidders to establish IDs given | ||
| the appropriate cookie-setting permissions from the user. | ||
|
|
||
| ## Further Reading | ||
|
|
||
| - [PBJS User ID module](/dev-docs/modules/userId.html) | ||
| - [SharedID](/identity/sharedid.html) | ||
| - [Prebid Server Privacy](/prebid-server/features/pbs-privacy.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| --- | ||
| layout: page_v2 | ||
| title: SharedID | ||
| description: What is SharedID | ||
| sidebarType: 9 | ||
| --- | ||
|
|
||
| # Prebid SharedID | ||
| {: .no_toc} | ||
|
|
||
| * TOC | ||
| {:toc} | ||
|
|
||
| {: .alert.alert-warning :} | ||
| As of Prebid.js 5.0, PubCommon ID is no longer supported -- it's been merged into SharedID. Also, SharedID no longer syncs to sharedid.org like it did in Prebid.js 4.x. | ||
|
|
||
| ## What is it? | ||
|
|
||
| SharedId is a convenient Prebid-owned first party identifier within the [Prebid UserId Module framework](/dev-docs/modules/userId.html). | ||
|
|
||
| ## How does it work? | ||
|
|
||
| The SharedID ID system sets a user id cookie in the publisher’s domain. | ||
| Since the cookie is set in the publisher's first party domain it does not fall in scope of browser restrictions on third party cookies. | ||
|
|
||
| ### Prebid.js 5.x | ||
|
|
||
| The SharedID module reads and/or sets a random ID in | ||
| the cookie name defined by the publisher when initializing | ||
| the module: | ||
|
|
||
| ``` | ||
| pbjs.setConfig({ | ||
| userSync: { | ||
| userIds: [{ | ||
| name: 'sharedId', | ||
| storage: { | ||
| name: '_sharedID', // name of the 1st party cookie | ||
| type: 'cookie', | ||
| expires: 30 | ||
| } | ||
| }] | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| The 'source' value transmitted through OpenRTB (user.ext.eids) is pubcid.org. For example: | ||
| ``` | ||
| user: { | ||
| ext: { | ||
| eids: { | ||
| "source":"pubcid.org", | ||
| "uids":[ | ||
| { | ||
| "id":"01EAJWWNEPN3CYMM5N8M5VXY22", | ||
| "atype":1 | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| {: .alert.alert-info :} | ||
| The 'pubcid.org' EID source was adopted by more buyers than 'sharedid.org', so | ||
| when PubCommon was folded into SharedID, we kept the more commonly recognized | ||
| source value. | ||
|
|
||
| ### Before Prebid.js 5.0 | ||
|
|
||
| In addition to setting a first party cookie, SharedID in Prebid.js 4.x also sets a third party cookie where possible, syncing the first and third party cookies (subject to browser capability and user opt-out). | ||
|
|
||
| SharedID in Prebid.js 4.x was transmitted through the header-bidding ecosystem on user.ext.eids with a different 'source': | ||
| ``` | ||
| user: { | ||
| ext: { | ||
| eids: { | ||
| "source":"sharedid.org", | ||
| "uids":[ | ||
| { | ||
| "id":"01EAJWWNEPN3CYMM5N8M5VXY22", | ||
| "atype":1, | ||
| "ext":{ | ||
| "third":"01EAJWWNEPN3CYMM5N8M5VXY22" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Detailed Walkthrough | ||
|
|
||
| This diagram summarizes the workflow for SharedID: | ||
|
|
||
| {: .pb-lg-img :} | ||
|
|
||
| 1. The page loads the Prebid.js package, which includes the SharedId module. | ||
| 2. The page enables one or more user ID modules with pbjs.setConfig({usersync}) per the module documentation. The publisher can control which bidders are allowed to receive each type of ID. | ||
| 3. If permitted, the SharedID module retrieves and/or sets the designated first party cookie for this user. | ||
| 4. When a header bidding auction is run, the ID modules are invoked to add their IDs into the bid requests. | ||
| 5. Bid adapters send the additional IDs to the bidding endpoints, along with other privacy information such as GDPR consent, US Privacy consent, and the Global Privacy Control header. | ||
| 6. SharedID is used by the bidder for ad targeting, frequency capping, and/or sequential ads. | ||
| 7. Bids are sent to the publisher's ad server, where the best ad is chosen for rendering. | ||
|
|
||
| {: .alert.alert-info :} | ||
| In Prebid.js 4.x, when SharedID performed third-party syncing there | ||
| was an extra step in the diagram between steps 3 and 4 where the module would connect to a server on sharedid.org. This step was | ||
| removed in Prebid.js 5.0. | ||
|
|
||
| ### Privacy Discussion | ||
|
|
||
| There are several privacy scenarios in which a user ID is not created or read: | ||
|
|
||
| 1. The User ID module suppresses all cookie reading and setting activity | ||
| when the [GDPR Enforcement Module](/dev-docs/modules/gdprEnforcement.html) is in place and there's no consent for Purpose 1. | ||
| 2. The User ID module infrastructure supports a first-party opt-out, by setting the `_pbjs_id_optout` cookie or local storage to any value. No other cookies will be set if this one is set. | ||
| 3. The SharedID module will suppress the ID when the COPPA flag is set. | ||
|
|
||
| For all other privacy-sensitive scenarios, it is encumbent upon bid adapters and endpoints | ||
| to be aware of and enforce relevant regulations such as CCPA and Global Privacy Control. | ||
|
|
||
| ## Opt-Out | ||
|
|
||
| Prebid recommends that publishers provide their users with information about how IDs are utilized, including targeting, frequency capping, and special ad features like sequential ads. | ||
|
|
||
| If the publisher's legal staff has determined that a user opt-out is necessary beyond existing | ||
| mechanisms like GDPR and CCPA, the use of first party cookies requires that opt-out flow be owned | ||
| by the publisher. | ||
|
|
||
| Publishers that decide to build a first-party opt-out workflow might follow a process like this: | ||
| - User is presented with an option to turn off ad targeting | ||
| - If the user opts out, the page can do one of two things: | ||
| - set a _pbjs_id_optout first party cookie | ||
| - avoid calling pbjs.setConfig to initialize the user ID modules | ||
|
|
||
| ## Related Topics | ||
|
|
||
| - [Prebid Identity Overview](/identity/prebid-identity.html) | ||
| - [Prebid.js User ID modules](/dev-docs/modules/userId.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters