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

Cee id system documentation #5449

Merged
merged 15 commits into from
Jul 11, 2024
Merged
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
74 changes: 74 additions & 0 deletions dev-docs/modules/userid-submodules/ceeIdSystem.md
Copy link
Contributor

Choose a reason for hiding this comment

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

You are missing the meta data for your module

---markdown
layout: userid
title: CEE ID Module
description: CEE ID User ID sub-module
useridmodule: ceeId
---

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, meta data added.

Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
layout: userid
title: CEE ID Module
description: CEE ID User ID sub-module
useridmodule: ceeIdSystem
---

# ceeIdSystem UserID Module

## Prebid Configuration

First, make sure to add ceeIdSystem to your Prebid.js package with:

```bash
gulp build --modules=ceeIdSystem
```

## CEE ID Configuration

| Param under userSync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | The name of CEE ID user ID module. | `"ceeId"` |
| storage | Required | Object | Container of storage options. | |
| storage.type | Required | String | Type of storage to use | `"cookie"` |
| storage.name | Required | String | Name of storage to set | `"ceeIdToken"` |
| storage.expires | Optional | Int | Time when storage should expire it is recommended to use this options otherwise storage last only during session | `7` |
| storage.refreshInSeconds | Optional | Int | Time when storage value and expiration date will get refreshed in seconds | `360` |
| params | Required | Object | Container of all module params. | |
| params.tokenName | Required | String | Your custom name of token to read | `'myExampleTokenName'` |
| params.value | Optional | String | Optional param if you want to pass token value directly through setConfig | `'someTokenValue'` |

## CEE ID Examples

You can configure this submodule in your `userSync.userIds[]` configuration. Publishers manage ceeIds themselves can store ceeIds in local storage or 1st party cookies. You can use your custom name of token to read

```javascript
pbjs.setConfig({
userSync: {
userIds: [{
name: 'ceeId',
storage: {
type: 'cookie',
name: 'ceeIdToken',
expires: 7,
refreshInSeconds: 360
},
params: {
tokenName: 'name' // Your custom name of token to read
}
}]
}
});
```

Or pass value directly thorugh params.value. Note that tokenName is not required then. This param shouldn't be set if token value will be taken by tokenName

```javascript
pbjs.setConfig({
userSync: {
userIds: [{
name: 'ceeId',
storage: {
type: 'cookie',
name: 'ceeIdToken',
expires: 7,
refreshInSeconds: 360
},
params: {
value: 'tokenValue'
}
}]
}
});
```