From 5af030840d202f3e160ff712ec3812884e1a3c53 Mon Sep 17 00:00:00 2001 From: scott sundahl Date: Thu, 19 Feb 2026 14:37:58 -0700 Subject: [PATCH 1/4] added docs to explain optout response for uid2 and euid --- dev-docs/modules/userid-submodules/euid.md | 18 +++++++++++++++++ .../modules/userid-submodules/unified2.md | 20 +++++++++++++++++-- 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/dev-docs/modules/userid-submodules/euid.md b/dev-docs/modules/userid-submodules/euid.md index 7f1321754e..e2dfb86f62 100644 --- a/dev-docs/modules/userid-submodules/euid.md +++ b/dev-docs/modules/userid-submodules/euid.md @@ -48,6 +48,24 @@ The following sample is fictitious, but shows what the token response object loo When this full data structure is provided, the module automatically refreshes the token periodically, as long as the refresh token hasn't expired. +The following example shows the response for a user that has opted out: + +```json +{ + identity: 'optout', + status: 'optout' +} +``` + +The following example shows the decoded EUID userId object: + +```json +euid: { + optout: true +} +``` +``` + ## Client Refresh mode This is the recommended mode for most scenarios. In this mode, the full response body from the EUID Token Generate or Token Refresh endpoint must be provided to the module. As long as the refresh token remains valid, the module will refresh the advertising token as needed. diff --git a/dev-docs/modules/userid-submodules/unified2.md b/dev-docs/modules/userid-submodules/unified2.md index 74593d37df..569508325b 100644 --- a/dev-docs/modules/userid-submodules/unified2.md +++ b/dev-docs/modules/userid-submodules/unified2.md @@ -49,6 +49,23 @@ The following sample is fictitious, but shows what the token response object loo When this full data structure is provided, the module automatically refreshes the token periodically, as long as the refresh token hasn't expired. +The following example shows the response for a user that has opted out: + +```json +{ + identity: 'optout', + status: 'optout' +} +``` + +The following example shows the decoded UID2 userId object: + +```json +uid2: { + optout: true +} +``` + ## Unified ID 2.0 Server-Only Mode There is a server-only mode where the value of the advertising token can be provided either directly (see the `value` parameter in the [Unified ID 2.0 Configuration](#unified-id-20-configuration) section) or via a cookie. In this mode, no attempt is made to automatically refresh the token. @@ -71,8 +88,6 @@ Prebid.js supports fully client side integration for UID2. See the [official UI The following parameters apply only to the Unified ID 2.0 module integration. -{: .table .table-bordered .table-striped } - | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | ID value for the Unified ID 2.0 module - `"uid2"` | `"uid2"` | @@ -81,6 +96,7 @@ The following parameters apply only to the Unified ID 2.0 module integration. | params.uid2ApiBase | Optional | String | Overrides the default UID2 API endpoint. | `https://prod.uidapi.com` _(default)_ | | value | Optional | Object | Used only if the page has a separate mechanism for storing the UID 2.0 ID. The value is an object containing the values to be sent to the adapters. In this scenario, no URL is called and nothing is added to local storage, and the tokens are **not** automatically refreshed. | `{"uid2": { "id": "eb33b0cb-8d35-4722-b9c0-1a31d4064888"}}` | | params.storage | Optional, Client refresh | String | Specify whether to use `cookie` or `localStorage` for module-internal storage. It is recommended to not provide this and allow the module to use the default. | `localStorage` _(default)_ | +{: .table .table-bordered .table-striped } ## Unified ID 2.0 Examples From cc299aa8544a6117d771cfdb0560a404c94a23c4 Mon Sep 17 00:00:00 2001 From: scott sundahl Date: Thu, 19 Feb 2026 14:40:01 -0700 Subject: [PATCH 2/4] revert format change --- dev-docs/modules/userid-submodules/unified2.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dev-docs/modules/userid-submodules/unified2.md b/dev-docs/modules/userid-submodules/unified2.md index 569508325b..651f0d708a 100644 --- a/dev-docs/modules/userid-submodules/unified2.md +++ b/dev-docs/modules/userid-submodules/unified2.md @@ -88,6 +88,8 @@ Prebid.js supports fully client side integration for UID2. See the [official UI The following parameters apply only to the Unified ID 2.0 module integration. +{: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | ID value for the Unified ID 2.0 module - `"uid2"` | `"uid2"` | @@ -96,7 +98,6 @@ The following parameters apply only to the Unified ID 2.0 module integration. | params.uid2ApiBase | Optional | String | Overrides the default UID2 API endpoint. | `https://prod.uidapi.com` _(default)_ | | value | Optional | Object | Used only if the page has a separate mechanism for storing the UID 2.0 ID. The value is an object containing the values to be sent to the adapters. In this scenario, no URL is called and nothing is added to local storage, and the tokens are **not** automatically refreshed. | `{"uid2": { "id": "eb33b0cb-8d35-4722-b9c0-1a31d4064888"}}` | | params.storage | Optional, Client refresh | String | Specify whether to use `cookie` or `localStorage` for module-internal storage. It is recommended to not provide this and allow the module to use the default. | `localStorage` _(default)_ | -{: .table .table-bordered .table-striped } ## Unified ID 2.0 Examples From d265b7d953c38dd861090dba16e56463f21925da Mon Sep 17 00:00:00 2001 From: scott sundahl Date: Thu, 19 Feb 2026 14:47:09 -0700 Subject: [PATCH 3/4] remove typo ticks --- dev-docs/modules/userid-submodules/euid.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/modules/userid-submodules/euid.md b/dev-docs/modules/userid-submodules/euid.md index e2dfb86f62..16fe26abf4 100644 --- a/dev-docs/modules/userid-submodules/euid.md +++ b/dev-docs/modules/userid-submodules/euid.md @@ -64,7 +64,7 @@ euid: { optout: true } ``` -``` + ## Client Refresh mode From f357858e803750eed922ef6728485d0a92813264 Mon Sep 17 00:00:00 2001 From: scott sundahl Date: Thu, 19 Feb 2026 14:50:02 -0700 Subject: [PATCH 4/4] too many new lines --- dev-docs/modules/userid-submodules/euid.md | 1 - 1 file changed, 1 deletion(-) diff --git a/dev-docs/modules/userid-submodules/euid.md b/dev-docs/modules/userid-submodules/euid.md index 16fe26abf4..4742a7e025 100644 --- a/dev-docs/modules/userid-submodules/euid.md +++ b/dev-docs/modules/userid-submodules/euid.md @@ -65,7 +65,6 @@ euid: { } ``` - ## Client Refresh mode This is the recommended mode for most scenarios. In this mode, the full response body from the EUID Token Generate or Token Refresh endpoint must be provided to the module. As long as the refresh token remains valid, the module will refresh the advertising token as needed.