Skip to content

Commit

Permalink
client side documentation for uid2 and euid (prebid#5682)
Browse files Browse the repository at this point in the history
* client side documentation for uid2 and euid

* too many blank lines

* too few blank lines

* too few blank lines

* Update unified2.md

---------

Co-authored-by: bretg <bgorsline@gmail.com>
  • Loading branch information
ssundahlTTD and bretg authored Nov 7, 2024
1 parent 2b65d0b commit 0ba97f9
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 2 deletions.
2 changes: 1 addition & 1 deletion dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ It is possible for a user id submodule to populate several identifiers including

This can be configured inside the `userSync` object in the following manner:

Let's say that the UID2 token populated by the trade desk user id submodule has the value 'uid2_value' and the UID2 token populated by Liveintent user id module has the value 'liveIntentUid2_value' (The actual identifiers populated in this case should be one and the same however the values are written differently in order to help the reader understand the source from which the identifiers get picked up from)
Let's say that the UID2 token populated by the UID2 user ID submodule has the value 'uid2_value' and the UID2 token populated by Liveintent user id module has the value 'liveIntentUid2_value' (The actual identifiers populated in this case should be one and the same however the values are written differently in order to help the reader understand the source from which the identifiers get picked up from)

```javascript
"userSync": {
Expand Down
4 changes: 4 additions & 0 deletions dev-docs/modules/userid-submodules/euid.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,10 @@ pbjs.setConfig({
});
```

## European Unified ID Client Side Integration for Prebid.js

Prebid.js supports fully client side integration for EUID. See the [official EUID documentation](https://euid.eu/docs/guides/integration-prebid) for the most up-to-date integration instructions.

## European Unified ID Configuration

The following parameters apply only to the European Unified ID module integration.
Expand Down
7 changes: 6 additions & 1 deletion dev-docs/modules/userid-submodules/unified2.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ gulp build --modules=uid2IdSystem

You can set up Unified ID 2.0 in one of these ways:

- Include the module to your pb.js wrapper. You will need to apply for publisher access [on the UID2 website](https://unifiedid.com/request-access). Using this option, you must generate UID2 tokens server-side. There is currently no flow for client-side only, unless you use an SSO provider. You provide these tokens to Prebid.js either by using a cookie or directly in the configuration.
- Include the module to your Prebid.js wrapper. You will need to apply for publisher access [on the UID2 website](https://unifiedid.com/request-access). Using this option, you must generate UID2 tokens server-side. You provide these tokens to Prebid.js either by using a cookie or directly in the configuration.
- Use a [managed services](https://prebid.org/product-suite/managed-services/) company that can do this for you.
- Use UID2 Client Side Integration with Prebid.js

Each publisher’s privacy policy should take UnifiedID 2.0 into account.

Expand Down Expand Up @@ -61,6 +62,10 @@ For a server-side integration, you can create a smaller Prebid.js build by disab
gulp build --modules=uid2IdSystem --disable UID2_CSTG
```

## Unified ID 2.0 Client Side Integration for Prebid.js

Prebid.js supports fully client side integration for UID2. See the [official UID2 documentation](https://unifiedid.com/docs/guides/integration-prebid-client-side) for the most up-to-date integration instructions.

## Unified ID 2.0 Configuration

The following parameters apply only to the Unified ID 2.0 module integration.
Expand Down

0 comments on commit 0ba97f9

Please sign in to comment.