-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
767189f
Merge pull request #1 from prebid/master
wojciech-bialy-wpm ea4a228
Merge pull request #4 from prebid/master
wojciech-bialy-wpm e873ff7
Merge pull request #5 from prebid/master
wojciech-bialy-wpm 66836b7
Merge pull request #7 from prebid/master
wojciech-bialy-wpm f1a6dd7
Merge branch 'master' of https://github.com/prebid/prebid.github.io
wojciech-bialy-wpm 6ae09f8
Merge branch 'prebid:master' into master
decemberWP 4ba0035
ceeIdSystem documentation
decemberWP 4f1b1f2
ceeIdSystem documentation
decemberWP 6447a5c
ceeIdSystem documentation
decemberWP bb4d6e6
ceeIdSystem documentation
decemberWP 1ae1082
ceeIdSystem documentation
decemberWP 607546d
ceeIdSystem documentation
decemberWP a7edeb4
Merge branch 'master' into ceeIdSystem
decemberWP 2c1f547
add meta data
decemberWP d2debce
Merge branch 'ceeIdSystem' of https://github.com/grupawp/prebid.githu…
decemberWP File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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' | ||
} | ||
}] | ||
} | ||
}); | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, meta data added.