From fc0a10b37118e63e84e3b7eebaa92c84b05284ad Mon Sep 17 00:00:00 2001 From: scott sundahl Date: Wed, 18 Feb 2026 14:35:44 -0700 Subject: [PATCH 1/3] added example of optout response --- docs/guides/integration-prebid-client-side.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/guides/integration-prebid-client-side.md b/docs/guides/integration-prebid-client-side.md index ce56cf44f..6c3c267b3 100644 --- a/docs/guides/integration-prebid-client-side.md +++ b/docs/guides/integration-prebid-client-side.md @@ -161,6 +161,15 @@ pbjs.setConfig({ It is possible that the user has opted out of UID2 previously. In this case, the UID2 module respects the user's optout and no UID2 token is generated and collected by Prebid.js. +The response for a user that has opted out can be seen below: + +```json +{ + identity: 'optout', + status: 'optout' +} +``` + ## Checking the Integration To check that the UID2 module has successfully generated a UID2 token, call `pbjs.getUserIds().uid2`. If a value is returned, a valid UID2 token exists in the UID2 module. From 3cb9420aa5ae54fb6a16b2176de65495850b7605 Mon Sep 17 00:00:00 2001 From: scott sundahl Date: Wed, 18 Feb 2026 15:03:35 -0700 Subject: [PATCH 2/3] exmaple of decoded uid2 userId --- docs/guides/integration-prebid-client-side.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/guides/integration-prebid-client-side.md b/docs/guides/integration-prebid-client-side.md index 6c3c267b3..6f0c5e08f 100644 --- a/docs/guides/integration-prebid-client-side.md +++ b/docs/guides/integration-prebid-client-side.md @@ -170,6 +170,14 @@ The response for a user that has opted out can be seen below: } ``` +The decoded UID2 userId object will look like: + +```json +uid2: { + optout: true +} +``` + ## Checking the Integration To check that the UID2 module has successfully generated a UID2 token, call `pbjs.getUserIds().uid2`. If a value is returned, a valid UID2 token exists in the UID2 module. From 67ae2256339a768c586099b37dee800fb372eb1f Mon Sep 17 00:00:00 2001 From: scott sundahl Date: Thu, 19 Feb 2026 08:47:26 -0700 Subject: [PATCH 3/3] wording corrections --- docs/guides/integration-prebid-client-side.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/integration-prebid-client-side.md b/docs/guides/integration-prebid-client-side.md index 6f0c5e08f..bc65e091d 100644 --- a/docs/guides/integration-prebid-client-side.md +++ b/docs/guides/integration-prebid-client-side.md @@ -161,7 +161,7 @@ pbjs.setConfig({ It is possible that the user has opted out of UID2 previously. In this case, the UID2 module respects the user's optout and no UID2 token is generated and collected by Prebid.js. -The response for a user that has opted out can be seen below: +The following example shows the response for a user that has opted out: ```json { @@ -170,7 +170,7 @@ The response for a user that has opted out can be seen below: } ``` -The decoded UID2 userId object will look like: +The following example shows the decoded UID2 userId object: ```json uid2: {