Skip to content

Commit

Permalink
Merge pull request #45 from IABTechLab/ian-UID2-2203-deprecate-optout…
Browse files Browse the repository at this point in the history
…_check-0

add warning about removing support for policy=0
  • Loading branch information
Ian-Nara authored Dec 5, 2023
2 parents 11cc92f + f2b22ff commit 6d3e4d1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If you're using the SDK's HTTP implementation, follow these steps.

>IMPORTANT: Be sure to call this function only when you have obtained legal basis to convert the user’s [directly identifying information (DII)](https://unifiedid.com/docs/ref-info/glossary-uid#gl-dii) to UID2 tokens for targeted advertising.
>`doNotGenerateTokensForOptedOut()` applies `policy=1` in the [/token/generate](https://unifiedid.com/docs/endpoints/post-token-generate#token-generation-policy) call. Without this, `policy` is omitted to maintain backwards compatibility.
>IMPORTANT: Always apply `doNotGenerateTokensForOptedOut()`. This applies `policy=1` in the [/token/generate](https://unifiedid.com/docs/endpoints/post-token-generate#token-generation-policy) call. Support for `policy=0` will be removed soon.
#### Standard Integration

If you're using standard integration (client and server) (see [UID2 SDK for JavaScript Integration Guide](https://unifiedid.com/docs/guides/publisher-client-side)), follow this step:
Expand Down Expand Up @@ -102,7 +102,7 @@ If you're using server-only integration (see [Publisher Integration Guide, Serve
2. Body: `envelope.getEnvelope()`
>IMPORTANT: Be sure to call this endpoint only when you have obtained legal basis to convert the user’s [directly identifying information (DII)](https://unifiedid.com/docs/ref-info/glossary-uid#gl-dii) to UID2 tokens for targeted advertising.
>`doNotGenerateTokensForOptedOut()` applies `policy=1` in the [/token/generate](https://unifiedid.com/docs/endpoints/post-token-generate#token-generation-policy) call. Without this, `policy` is omitted to maintain backwards compatibility.
>IMPORTANT: Always apply `doNotGenerateTokensForOptedOut()`. This applies `policy=1` in the [/token/generate](https://unifiedid.com/docs/endpoints/post-token-generate#token-generation-policy) call. Support for `policy=0` will be removed soon.
4. If the HTTP response status code is _not_ 200, see [Response Status Codes](https://unifiedid.com/docs/endpoints/post-token-generate#response-status-codes) to determine next steps. Otherwise, convert the UID2 identity response content into a `TokenGenerateResponse` object:

Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/uid2/client/TokenGenerateInput.java
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ TokenGenerateInput doNotHash() {
return this;
}

// Always use .doNotGenerateTokensForOptedOut(), which applies policy=1. Support for policy=0 will be removed soon.
public TokenGenerateInput doNotGenerateTokensForOptedOut() {
generateForOptedOut = false;
return this;
Expand Down

0 comments on commit 6d3e4d1

Please sign in to comment.