Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update SharedId docs with Conversant content #3137

Merged
merged 20 commits into from
Jul 27, 2021
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 32 additions & 5 deletions dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -1334,10 +1334,10 @@ pbjs.setConfig({

### SharedID

This module stores an unique user id in the first party domain and makes it accessible to all adapters. Similar to IDFA and AAID, this is a simple UUID that can be utilized to improve user matching, especially for iOS and MacOS browsers, and is compatible with ITP (Intelligent Tracking Prevention). It’s lightweight and self contained. Adapters that support Publisher Common ID will be able to pick up the user ID and return it for additional server-side cross device tracking.
This module stores an unique user id in the first party domain and makes it accessible to all adapters. Similar to IDFA and AAID, this is a simple UUID that can be utilized to improve user matching, especially for iOS and MacOS browsers, and is compatible with ITP (Intelligent Tracking Prevention). It’s lightweight and self contained. Adapters that support SharedId will be able to pick up the user ID and return it for additional server-side cross device tracking.
bretg marked this conversation as resolved.
Show resolved Hide resolved

There is no special registration or configuration for SharedID. Each publisher's privacy policy should take
SharedID into account.
SharedID into account. Prebid recommends implementing a method where users can easily opt-out of targeted advertising. Please refer to the User Opt-Out section located at the bottom of this page. For more information check out Prebid's dedicated [identity page](/identity/sharedid.html)

Add it to your Prebid.js package with:

Expand All @@ -1354,8 +1354,12 @@ In addition to the parameters documented above in the Basic Configuration sectio
| name | Required | String | The name of this module. | `'pubCommonId'` |
| params | Optional | Object | Customized parameters | |
| params.create | Optional | Boolean | For publisher server support only. If true, the publisher's server will create the (pubcid) cookie. Default is true. | `true` |
| params.pixelUrl | Optional | String | For publisher server support only. This is a URL of a pixel for updating cookies' expiration times. Fired after a new ID has been created or an existing ID is being extended. No default. | `'https://example.com/ping'`
| params.pixelUrl | Optional | String | For publisher server support only. Where to call out to for a server cookie -- see [Prebid Identity](/identity/sharedid.html) for more information. | `/wp-json/pubcid/v1/extend/`
| params.extend | Optional | Boolean | If true, the expiration time of the stored IDs will be refreshed during each page load. Default is false. | `false` |
| storage | Required | Object | The publisher must specify some kind of local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage. |
jdwieland8282 marked this conversation as resolved.
Show resolved Hide resolved
| storage.expires | Integer | Required | How long the user ID information will be stored. | `365` |
| storage.name | String | Required | The name of the cookie or html5 local storage where the user ID will be stored. | `_pubcid`
| storage.type | String | Required | This is where the results of the user ID will be stored. Must be either: Must be either: "cookie" or "html5". For server side implementations, which have the best identifier life and revenue impact, this must be a cookie. | `cookie`

#### SharedID Examples

Expand All @@ -1368,7 +1372,7 @@ pbjs.setConfig({
name: "pubCommonId",
storage: {
type: "cookie",
name: "_pubcid", // create a cookie with this name
name: `"_pubcid"`, // create a cookie with this name
expires: 365 // expires in 1 years
}
}]
Expand All @@ -1393,9 +1397,12 @@ pbjs.setConfig({
}
},{
name: "pubCommonId",
params: {
pixelUrl: "/wp-json/pubcid/v1/extend/"
jdwieland8282 marked this conversation as resolved.
Show resolved Hide resolved
},
storage: {
type: "cookie",
name: "_pubcid", // create a cookie with this name
name: `"_pubcid"`, // create a cookie with this name
expires: 180
}
}],
Expand All @@ -1404,6 +1411,26 @@ pbjs.setConfig({
});
{% endhighlight %}

3) Publisher supports SharedID and first party domain cookie storage initiated by a first party server

{% highlight javascript %}
pbjs.setConfig({
userSync: {
userIds: [{
name: "pubCommonId",
params: {
pixelUrl: "/wp-json/pubcid/v1/extend/" //pixelUrl should be specified when the server plugin is used
},
storage: {
type: "cookie",
name: `"_pubcid"`, // create a cookie with this name
expires: 365 // expires in 1 years
}
}]
}
});
{% endhighlight %}

### PubProvided ID

The PubProvided Id module allows publishers to set and pass a first party user id into the bid stream. This module has several unique characteristics:
Expand Down
Loading