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

Add documentation for publink userid module #3225

Merged
merged 1 commit into from
Sep 9, 2021
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion dev-docs/bidders/conversant.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pbs: true
biddercode: conversant
media_types: video
gdpr_supported: true
userIds: criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId
userIds: criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId, publinkId
prebid_member: true
gvl_id: 24
---
Expand Down
43 changes: 43 additions & 0 deletions dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -1311,6 +1311,49 @@ pbjs.setConfig({
});
{% endhighlight %}

### Publisher Link
Publisher Link, provided by [Epsilon](https://www.epsilon.com/us), is a cross-device identity solution that activates publisher first-party, authenticated
data to improve audience identification and increase bid opportunities, specifically designed for sites with authenticated
traffic. Publisher first-party authenticated data and a user's unique encrypted ID is linked to an existing people-based
Epsilon CORE ID. By utilizing Publisher Link, publishers are able to reap the benefits of Epsilon's CORE ID.

#### Publisher Link Registration
There is no registration needed.

The Epsilon privacy is covered in the [Epsilon Privacy Policy](https://www.epsilon.com/us/privacy-policy).

The Publisher Link opt-out is include [here](https://www.epsilon.com/privacy/dms/opt-out/email)

#### Publisher Link Configuration

In addition to the parameters documented above in the Basic Configuration section the following Publisher Link specific configuration is available:

{: .table .table-bordered .table-striped }
| Param under userSync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | The name of this module. | `'publinkId'` |
| params | Required | Object | Customized parameters | |
| params.e | Required | String | Hashed email address of the user | `e80b5017098950fc58aad83c8c14978e` |

#### Publisher Link Examples
```javascript
pbjs.setConfig({
userSync: {
userIds: [{
name: "publinkId",
storage: {
name: "pbjs_publink",
type: "cookie",
expires: 30
},
params: {
e: "e80b5017098950fc58aad83c8c14978e", // example hashed email (md5)
}
}]
}
});
```

### RampID

RampID, formerly known as IdentityLink, provided by [LiveRamp](https://liveramp.com) is a single person-based identifier which allows marketers, platforms and publishers to perform personalized segmentation, targeting and measurement use cases that require a consistent, cross-channel view of the user in anonymous spaces.
Expand Down