From 4ba0035cb5aac287351b5f0e1e86660ec851e601 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Grudzie=C5=84?= Date: Fri, 21 Jun 2024 11:26:02 +0200 Subject: [PATCH 1/7] ceeIdSystem documentation --- .../modules/userid-submodules/ceeIdSystem.md | 72 +++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 dev-docs/modules/userid-submodules/ceeIdSystem.md diff --git a/dev-docs/modules/userid-submodules/ceeIdSystem.md b/dev-docs/modules/userid-submodules/ceeIdSystem.md new file mode 100644 index 0000000000..7451f505ae --- /dev/null +++ b/dev-docs/modules/userid-submodules/ceeIdSystem.md @@ -0,0 +1,72 @@ +--- +layout: userid +title: Cee ID System +description: ceeId User ID sub-module +useridmodule: ceeIdSystem +--- + +Add it to your Prebid.js package with: + +{: .alert.alert-info :} +gulp build --modules=ceeIdSystem + +## CEE ID Configuration + +{: .table .table-bordered .table-striped } +| 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 | | +| params.value | Optional | String | Optional param if you want to pass token value directly through setConfig | | + +## CEE ID Examples + +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 from cookie or LS + +```javascript + +pbjs.setConfig({ + userSync: { + userIds: [{ + name: 'ceeId', + storage: { + type: 'cookie', + name: 'ceeIdToken', + expires: 7, + refreshInSeconds: 360 + }, + params: { + value: 'tokenValue' + } + }] + } +}); +``` From 4f1b1f20b67d8f23f0c176a4c43332547383493b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Grudzie=C5=84?= Date: Fri, 21 Jun 2024 11:50:36 +0200 Subject: [PATCH 2/7] ceeIdSystem documentation --- dev-docs/modules/userid-submodules/ceeIdSystem.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/dev-docs/modules/userid-submodules/ceeIdSystem.md b/dev-docs/modules/userid-submodules/ceeIdSystem.md index 7451f505ae..7b5d2ff4dc 100644 --- a/dev-docs/modules/userid-submodules/ceeIdSystem.md +++ b/dev-docs/modules/userid-submodules/ceeIdSystem.md @@ -5,10 +5,11 @@ description: ceeId User ID sub-module useridmodule: ceeIdSystem --- -Add it to your Prebid.js package with: +First, make sure to add ceeIdSystem to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=ceeIdSystem +``` ## CEE ID Configuration @@ -22,12 +23,12 @@ gulp build --modules=ceeIdSystem | 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 | | -| params.value | Optional | String | Optional param if you want to pass token value directly through setConfig | | +| 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 -Publishers manage ceeIds themselves can store ceeIds in local storage or 1st party cookies. You can use your custom name of token to read +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 From 6447a5cd926cdeb47717aa3b9626df71c9ca8c35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Grudzie=C5=84?= Date: Fri, 21 Jun 2024 11:51:36 +0200 Subject: [PATCH 3/7] ceeIdSystem documentation --- dev-docs/modules/userid-submodules/ceeIdSystem.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/dev-docs/modules/userid-submodules/ceeIdSystem.md b/dev-docs/modules/userid-submodules/ceeIdSystem.md index 7b5d2ff4dc..9c4fe0abde 100644 --- a/dev-docs/modules/userid-submodules/ceeIdSystem.md +++ b/dev-docs/modules/userid-submodules/ceeIdSystem.md @@ -13,7 +13,6 @@ gulp build --modules=ceeIdSystem ## CEE ID Configuration -{: .table .table-bordered .table-striped } | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of CEE ID user ID module. | `"ceeId"` | @@ -31,7 +30,6 @@ gulp build --modules=ceeIdSystem 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: [{ @@ -53,7 +51,6 @@ pbjs.setConfig({ 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 from cookie or LS ```javascript - pbjs.setConfig({ userSync: { userIds: [{ From bb4d6e6ef59830a051c2d747db63f8741e6e772a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Grudzie=C5=84?= Date: Fri, 21 Jun 2024 11:53:01 +0200 Subject: [PATCH 4/7] ceeIdSystem documentation --- dev-docs/modules/userid-submodules/ceeIdSystem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/modules/userid-submodules/ceeIdSystem.md b/dev-docs/modules/userid-submodules/ceeIdSystem.md index 9c4fe0abde..edaedae0c3 100644 --- a/dev-docs/modules/userid-submodules/ceeIdSystem.md +++ b/dev-docs/modules/userid-submodules/ceeIdSystem.md @@ -48,7 +48,7 @@ pbjs.setConfig({ }); ``` -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 from cookie or LS +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({ From 1ae108222146d3a1fbb2b02f930215ccb9bb44eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Grudzie=C5=84?= Date: Fri, 21 Jun 2024 13:11:12 +0200 Subject: [PATCH 5/7] ceeIdSystem documentation --- dev-docs/modules/userid-submodules/ceeIdSystem.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/dev-docs/modules/userid-submodules/ceeIdSystem.md b/dev-docs/modules/userid-submodules/ceeIdSystem.md index edaedae0c3..24f7f7d3c2 100644 --- a/dev-docs/modules/userid-submodules/ceeIdSystem.md +++ b/dev-docs/modules/userid-submodules/ceeIdSystem.md @@ -1,9 +1,6 @@ ---- -layout: userid -title: Cee ID System -description: ceeId User ID sub-module -useridmodule: ceeIdSystem ---- +# TNCID UserID Module + +## Prebid Configuration First, make sure to add ceeIdSystem to your Prebid.js package with: From 607546d96b95fa0634072bfc7bd33358ae6eafe5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Grudzie=C5=84?= Date: Fri, 21 Jun 2024 13:13:10 +0200 Subject: [PATCH 6/7] ceeIdSystem documentation --- dev-docs/modules/userid-submodules/ceeIdSystem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/modules/userid-submodules/ceeIdSystem.md b/dev-docs/modules/userid-submodules/ceeIdSystem.md index 24f7f7d3c2..fd1e8317f1 100644 --- a/dev-docs/modules/userid-submodules/ceeIdSystem.md +++ b/dev-docs/modules/userid-submodules/ceeIdSystem.md @@ -1,4 +1,4 @@ -# TNCID UserID Module +# ceeIdSystem UserID Module ## Prebid Configuration From 2c1f547d52cf6ee9fbbb59dab85f70dbce627d0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Grudzie=C5=84?= Date: Tue, 2 Jul 2024 13:33:47 +0200 Subject: [PATCH 7/7] add meta data --- dev-docs/modules/userid-submodules/ceeIdSystem.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/dev-docs/modules/userid-submodules/ceeIdSystem.md b/dev-docs/modules/userid-submodules/ceeIdSystem.md index fd1e8317f1..5a65c35a40 100644 --- a/dev-docs/modules/userid-submodules/ceeIdSystem.md +++ b/dev-docs/modules/userid-submodules/ceeIdSystem.md @@ -1,3 +1,10 @@ +--- +layout: userid +title: CEE ID Module +description: CEE ID User ID sub-module +useridmodule: ceeIdSystem +--- + # ceeIdSystem UserID Module ## Prebid Configuration