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

PAIR: adds TechLab version documentation #5785

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
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
68 changes: 68 additions & 0 deletions dev-docs/modules/userid-submodules/open-pair.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
layout: userid
title: Open PAIR ID
description: Open PairId User ID sub-module
useridmodule: openPairIdSystem
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the following meta data

bidRequestUserId: ???
eidsource: ???
example: ???

See https://github.com/prebid/prebid.github.io/blob/master/dev-docs/modules/userid-submodules/amxrtb.md?plain=1 for an example

---

Originally developed by Google and subsequently donated to the industry.
This version supports single and two Data Clean Room setups, in which the advertiser and publisher use different clean rooms.

(Publisher Advertiser Identity Reconciliation) is a secure and privacy-forward way for enabling advertisers and publishers to reconcile their
first-party data for marketing use cases via advanced data encryption methods without the
reliance on third-party cookies.

PAIR can help advertisers and publishers maintain control of first-party data while ensuring there is no pooling of data, no leakage of data, no leakage of insights, durablility for the future using secure encryption methods, and no user tracking across publishers.

See this [page](https://iabtechlab.com/pair/) for more information about the PAIR protocol.

Add it to your Prebid.js package with:

```bash
gulp build --modules=openPairIdSystem
```

## PAIR ID Configuration

{: .table .table-bordered .table-striped }

| Param under userSync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | The name of PAIR ID user ID module. | `"openPairId"` |
| params | Optional | Object | Container of all module params. Each entry can be used to configured a specific clean room. | |

## PAIR ID Examples

Publishers manage PAIR Ids themselves can store pairIds as a byte64 encoded array of ids in local storage and/or 1st party cookies entry `pairId`.

```javascript

// should have byte64 value ready in 'pairId' local storage/cookie entry

pbjs.setConfig({
userSync: {
userIds: [{
name: 'openPairId'
}]
}
});
```

Clean rooms may use specific storage keys, this version supports specifying the storage key for any clean room such as the following example.

```javascript

// value in 'pairId' local storage/cookie entry will be combined with ids provided by cleanroom liveramp
pbjs.setConfig({
userSync: {
userIds: [{
name: 'openPairId',
params: {
cleanRoomVendor: {
storageKey: '_storage_key'
}
},
}]
}
});
```
Loading