Skip to content

Commit 1bd27d5

Browse files
authored
Merge pull request #992 from IABTechLab/sas-UID2-4117-prebid-optout-docs
added example of optout response
2 parents 7fa094b + 67ae225 commit 1bd27d5

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

docs/guides/integration-prebid-client-side.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,23 @@ pbjs.setConfig({
161161

162162
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.
163163

164+
The following example shows the response for a user that has opted out:
165+
166+
```json
167+
{
168+
identity: 'optout',
169+
status: 'optout'
170+
}
171+
```
172+
173+
The following example shows the decoded UID2 userId object:
174+
175+
```json
176+
uid2: {
177+
optout: true
178+
}
179+
```
180+
164181
## Checking the Integration
165182

166183
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.

0 commit comments

Comments
 (0)