From b5ed11bdf23b49ecf0c6ed0c081e416354e032a7 Mon Sep 17 00:00:00 2001 From: jon8787 <112368577+jon8787@users.noreply.github.com> Date: Fri, 16 Jun 2023 11:33:20 +1000 Subject: [PATCH 1/9] Update readme docs to replace deprecated token generate functions with the new ones which handle opt-out --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 73c3288..b899b8b 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ If you're using the SDK's HTTP implementation, follow these steps. `private final PublisherUid2Client publisherUid2Client = new PublisherUid2Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);` -2. When the user has authenticated, and has authorized the creation of a UID2, call a function that takes the user's email address or phone number as input and generates an `IdentityTokens` object. The following example uses an email address: +2. When the user has authenticated, and has authorized the creation of a UID2, call a function that takes the user's email address or phone number as input and generates a `TokenGenerateResponse` object. The following example uses an email address: - `IdentityTokens identity = publisherUid2Client.generateToken(TokenGenerateInput.fromEmail(emailAddress));` + `TokenGenerateResponse tokenGenerateResponse = publisherUid2Client.generateTokenResponse(TokenGenerateInput.fromEmail(emailAddress).doNotGenerateTokensForOptedOut());` #### Standard Integration @@ -54,13 +54,13 @@ If you're using standard integration (client and server) (see [Client-Side JavaS * Send this identity as a JSON string back to the client (to use in the [identity field](https://unifiedid.com/docs/sdks/client-side-identity#initopts-object-void)) using the following: - `identity.getJsonString()` + `tokenGenerateResponse.getIdentityJsonString()` //Note: this method will return null if the user has opted out, so be sure to handle that case. #### Server-Only Integration If you're using server-only integration (see [Publisher Integration Guide, Server-Only](https://unifiedid.com/docs/guides/custom-publisher-integration)): -1. Store this identity as a JSON string in the user's session, using the `identity.getJsonString()` function. +1. Store this identity as a JSON string in the user's session, using the `tokenGenerateResponse.getIdentityJsonString()` function. This method will return null if the user has opted out, so be sure to handle that case. 2. To use the user's UID2 token, use the `identity.getAdvertisingToken()` function. 3. When the user accesses another page, or on a timer, determine whether a refresh is needed: 1. Retrieve the identity JSON string from the user's session, and then call the following function that takes the identity information as input and generates an `IdentityTokens` object: @@ -92,9 +92,9 @@ If you're using server-only integration (see [Publisher Integration Guide, Serve `.putHeader("Authorization", "Bearer " + UID2_API_KEY)` `.putHeader("X-UID2-Client-Version", PublisherUid2Helper.getVersionHeader())` 2. Body: `envelope.getEnvelope()` -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 an `IdentityTokens` object: +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: - `IdentityTokens identity = publisherUid2Helper.createIdentityfromTokenGenerateResponse({response body}, envelope);` + `TokenGenerateResponse tokenGenerateResponse = publisherUid2Helper.createTokenGenerateResponse({response body}, envelope);` #### Standard Integration @@ -102,14 +102,14 @@ If you're using standard integration (client and server) (see [Client-Side JavaS * Send this identity as a JSON string back to the client (to use in the [identity field](https://unifiedid.com/docs/sdks/client-side-identity#initopts-object-void)) using the following: - `identity.getJsonString()` + `tokenGenerateResponse.getIdentityJsonString()` //Note: this method will return null if the user has opted out, so be sure to handle that case. #### Server-Only Integration If you're using server-only integration (see [Publisher Integration Guide, Server-Only](https://unifiedid.com/docs/guides/custom-publisher-integration)): -1. Store this identity as a JSON string in the user's session, using: `identity.getJsonString()`. -2. To use the user's UID2 token, use `identity.getAdvertisingToken()`. +1. Store this identity as a JSON string in the user's session, using: `tokenGenerateResponse.getIdentityJsonString()`. This method will return null if the user has opted out, so be sure to handle that case. +2. To use the user's UID2 token, use `IdentityTokens identity = tokenGenerateResponse.getIdentity()` followed by `identity.getAdvertisingToken()`. 3. When the user accesses another page, or on a timer, determine whether a refresh is needed: 1. Retrieve the identity JSON string from the user's session, and then call the following function that generates an `IdentityTokens` object: From ff89f3a8951115470c703db235a32c5607751878 Mon Sep 17 00:00:00 2001 From: jon8787 <112368577+jon8787@users.noreply.github.com> Date: Fri, 16 Jun 2023 12:19:34 +1000 Subject: [PATCH 2/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b899b8b..872e1b2 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ If you're using standard integration (client and server) (see [Client-Side JavaS If you're using server-only integration (see [Publisher Integration Guide, Server-Only](https://unifiedid.com/docs/guides/custom-publisher-integration)): 1. Store this identity as a JSON string in the user's session, using the `tokenGenerateResponse.getIdentityJsonString()` function. This method will return null if the user has opted out, so be sure to handle that case. -2. To use the user's UID2 token, use the `identity.getAdvertisingToken()` function. +2. To use the user's UID2 token, use `IdentityTokens identity = tokenGenerateResponse.getIdentity()` followed by `identity.getAdvertisingToken()`. 3. When the user accesses another page, or on a timer, determine whether a refresh is needed: 1. Retrieve the identity JSON string from the user's session, and then call the following function that takes the identity information as input and generates an `IdentityTokens` object: From 760e5e2478d7be20bfaa97ed4c8ef2cf5a3f1fc9 Mon Sep 17 00:00:00 2001 From: jon8787 <112368577+jon8787@users.noreply.github.com> Date: Sun, 18 Jun 2023 21:30:17 +1000 Subject: [PATCH 3/9] Update README.md --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 872e1b2..4d1e8f7 100644 --- a/README.md +++ b/README.md @@ -54,15 +54,20 @@ If you're using standard integration (client and server) (see [Client-Side JavaS * Send this identity as a JSON string back to the client (to use in the [identity field](https://unifiedid.com/docs/sdks/client-side-identity#initopts-object-void)) using the following: - `tokenGenerateResponse.getIdentityJsonString()` //Note: this method will return null if the user has opted out, so be sure to handle that case. + `tokenGenerateResponse.getIdentityJsonString()` //Note: this method returns null if the user has opted out, so be sure to handle that case. #### Server-Only Integration If you're using server-only integration (see [Publisher Integration Guide, Server-Only](https://unifiedid.com/docs/guides/custom-publisher-integration)): -1. Store this identity as a JSON string in the user's session, using the `tokenGenerateResponse.getIdentityJsonString()` function. This method will return null if the user has opted out, so be sure to handle that case. -2. To use the user's UID2 token, use `IdentityTokens identity = tokenGenerateResponse.getIdentity()` followed by `identity.getAdvertisingToken()`. -3. When the user accesses another page, or on a timer, determine whether a refresh is needed: +1. Store this identity as a JSON string in the user's session, using the `tokenGenerateResponse.getIdentityJsonString()` function. This method returns null if the user has opted out, so be sure to handle that case. +2. To retrieve the user's UID2 token, use: + + ``` + IdentityTokens identity = tokenGenerateResponse.getIdentity(); + if (identity != null) { String advertisingToken = identity.getAdvertisingToken(); } + ``` +4. When the user accesses another page, or on a timer, determine whether a refresh is needed: 1. Retrieve the identity JSON string from the user's session, and then call the following function that takes the identity information as input and generates an `IdentityTokens` object: `IdentityTokens identity = IdentityTokens.fromJsonString(identityJsonString);` @@ -72,11 +77,11 @@ If you're using server-only integration (see [Publisher Integration Guide, Serve 3. Determine if a refresh is needed: `if (identity.isDueForRefresh()) {..}` -4. If needed, refresh the token and associated values: +5. If needed, refresh the token and associated values: `TokenRefreshResponse tokenRefreshResponse = publisherUid2Client.refreshToken(identity);` -5. Store `tokenRefreshResponse.getIdentityJsonString()` in the user's session. If the user has opted out, this method returns null, indicating that the user's identity should be removed from the session. To confirm optout, you can use the `tokenRefreshResponse.isOptout()` function. +6. Store `tokenRefreshResponse.getIdentityJsonString()` in the user's session. If the user has opted out, this method returns null, indicating that the user's identity should be removed from the session. To confirm optout, you can use the `tokenRefreshResponse.isOptout()` function. ### Advanced Usage @@ -109,7 +114,12 @@ If you're using standard integration (client and server) (see [Client-Side JavaS If you're using server-only integration (see [Publisher Integration Guide, Server-Only](https://unifiedid.com/docs/guides/custom-publisher-integration)): 1. Store this identity as a JSON string in the user's session, using: `tokenGenerateResponse.getIdentityJsonString()`. This method will return null if the user has opted out, so be sure to handle that case. -2. To use the user's UID2 token, use `IdentityTokens identity = tokenGenerateResponse.getIdentity()` followed by `identity.getAdvertisingToken()`. +2. To retrieve the user's UID2 token, use: + + ``` + IdentityTokens identity = tokenGenerateResponse.getIdentity(); + if (identity != null) { String advertisingToken = identity.getAdvertisingToken(); } + ``` 3. When the user accesses another page, or on a timer, determine whether a refresh is needed: 1. Retrieve the identity JSON string from the user's session, and then call the following function that generates an `IdentityTokens` object: From d3d4db48edbe25ac60f0e13034bd1246b4e5686a Mon Sep 17 00:00:00 2001 From: jon8787 <112368577+jon8787@users.noreply.github.com> Date: Mon, 19 Jun 2023 15:25:03 +1000 Subject: [PATCH 4/9] use same "be sure" text as /token/generate endpoint; explaing why doNotGenerateTokensForOptedOut() is needed --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4d1e8f7..c31ca67 100644 --- a/README.md +++ b/README.md @@ -44,10 +44,13 @@ If you're using the SDK's HTTP implementation, follow these steps. `private final PublisherUid2Client publisherUid2Client = new PublisherUid2Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);` -2. When the user has authenticated, and has authorized the creation of a UID2, call a function that takes the user's email address or phone number as input and generates a `TokenGenerateResponse` object. The following example uses an email address: +2. Next, call a function that takes the user's email address or phone number as input and generates a `TokenGenerateResponse` object. The following example uses an email address: `TokenGenerateResponse tokenGenerateResponse = publisherUid2Client.generateTokenResponse(TokenGenerateInput.fromEmail(emailAddress).doNotGenerateTokensForOptedOut());` - + + >IMPORTANT: Be sure to call this function only when you have obtained legal basis to convert the user’s [directly Identifying information (DII)](../ref-info/glossary-uid.md#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 due to backwards compatibility. #### Standard Integration If you're using standard integration (client and server) (see [Client-Side JavaScript SDK Integration Guide](https://unifiedid.com/docs/guides/publisher-client-side)), follow this step: @@ -90,13 +93,17 @@ If you're using server-only integration (see [Publisher Integration Guide, Serve `private final PublisherUid2Helper publisherUid2Helper = new PublisherUid2Helper(UID2_SECRET_KEY);` 2. When the user has authenticated, and has authorized the creation of a UID2, call a function that takes the user's email address or phone number as input and creates a secure request data envelope. See [Encrypting requests](https://unifiedid.com/docs/getting-started/gs-encryption-decryption#encrypting-requests). The following example uses an email address: - `EnvelopeV2 envelope = publisherUid2Helper.createEnvelopeForTokenGenerateRequest(TokenGenerateInput.fromEmail(emailAddress));` + `EnvelopeV2 envelope = publisherUid2Helper.createEnvelopeForTokenGenerateRequest(TokenGenerateInput.fromEmail(emailAddress).doNotGenerateTokensForOptedOut());` 3. Using an HTTP client library of your choice, post this envelope to the [POST token/generate](https://unifiedid.com/docs/endpoints/post-token-generate) endpoint, including headers and body: 1. Headers: Depending on your HTTP library, this might look something like the following: `.putHeader("Authorization", "Bearer " + UID2_API_KEY)` `.putHeader("X-UID2-Client-Version", PublisherUid2Helper.getVersionHeader())` 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)](../ref-info/glossary-uid.md#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 due to backwards compatibility. + 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: `TokenGenerateResponse tokenGenerateResponse = publisherUid2Helper.createTokenGenerateResponse({response body}, envelope);` From 87922ae5666d45ddcc880f6cfcdbfb0b6ad5e234 Mon Sep 17 00:00:00 2001 From: jon8787 <112368577+jon8787@users.noreply.github.com> Date: Mon, 19 Jun 2023 15:51:30 +1000 Subject: [PATCH 5/9] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c31ca67..d8b022e 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ If you're using the SDK's HTTP implementation, follow these steps. `private final PublisherUid2Client publisherUid2Client = new PublisherUid2Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);` -2. Next, call a function that takes the user's email address or phone number as input and generates a `TokenGenerateResponse` object. The following example uses an email address: +2. Call a function that takes the user's email address or phone number as input and generates a `TokenGenerateResponse` object. The following example uses an email address: `TokenGenerateResponse tokenGenerateResponse = publisherUid2Client.generateTokenResponse(TokenGenerateInput.fromEmail(emailAddress).doNotGenerateTokensForOptedOut());` @@ -91,7 +91,7 @@ If you're using server-only integration (see [Publisher Integration Guide, Serve 1. Create an instance of PublisherUid2Helper as an instance variable: `private final PublisherUid2Helper publisherUid2Helper = new PublisherUid2Helper(UID2_SECRET_KEY);` -2. When the user has authenticated, and has authorized the creation of a UID2, call a function that takes the user's email address or phone number as input and creates a secure request data envelope. See [Encrypting requests](https://unifiedid.com/docs/getting-started/gs-encryption-decryption#encrypting-requests). The following example uses an email address: +2. Call a function that takes the user's email address or phone number as input and creates a secure request data envelope. See [Encrypting requests](https://unifiedid.com/docs/getting-started/gs-encryption-decryption#encrypting-requests). The following example uses an email address: `EnvelopeV2 envelope = publisherUid2Helper.createEnvelopeForTokenGenerateRequest(TokenGenerateInput.fromEmail(emailAddress).doNotGenerateTokensForOptedOut());` 3. Using an HTTP client library of your choice, post this envelope to the [POST token/generate](https://unifiedid.com/docs/endpoints/post-token-generate) endpoint, including headers and body: From a0c2e6f5fd3d20c5780e6a475ba86865eb099eb8 Mon Sep 17 00:00:00 2001 From: jon8787 <112368577+jon8787@users.noreply.github.com> Date: Mon, 19 Jun 2023 15:53:25 +1000 Subject: [PATCH 6/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8b022e..e096966 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ If you're using standard integration (client and server) (see [Client-Side JavaS * Send this identity as a JSON string back to the client (to use in the [identity field](https://unifiedid.com/docs/sdks/client-side-identity#initopts-object-void)) using the following: - `tokenGenerateResponse.getIdentityJsonString()` //Note: this method will return null if the user has opted out, so be sure to handle that case. + `tokenGenerateResponse.getIdentityJsonString()` //Note: this method returns null if the user has opted out, so be sure to handle that case. #### Server-Only Integration From 2b438c4be8d465bdc16decbb2ded660e88fc821e Mon Sep 17 00:00:00 2001 From: jon8787 <112368577+jon8787@users.noreply.github.com> Date: Mon, 19 Jun 2023 17:51:44 +1000 Subject: [PATCH 7/9] minor changes --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e096966..ddcc758 100644 --- a/README.md +++ b/README.md @@ -48,22 +48,22 @@ If you're using the SDK's HTTP implementation, follow these steps. `TokenGenerateResponse tokenGenerateResponse = publisherUid2Client.generateTokenResponse(TokenGenerateInput.fromEmail(emailAddress).doNotGenerateTokensForOptedOut());` - >IMPORTANT: Be sure to call this function only when you have obtained legal basis to convert the user’s [directly Identifying information (DII)](../ref-info/glossary-uid.md#gl-dii) to UID2 tokens for targeted advertising. + >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 due to backwards compatibility. + >`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. #### Standard Integration If you're using standard integration (client and server) (see [Client-Side JavaScript SDK Integration Guide](https://unifiedid.com/docs/guides/publisher-client-side)), follow this step: * Send this identity as a JSON string back to the client (to use in the [identity field](https://unifiedid.com/docs/sdks/client-side-identity#initopts-object-void)) using the following: - `tokenGenerateResponse.getIdentityJsonString()` //Note: this method returns null if the user has opted out, so be sure to handle that case. + `tokenGenerateResponse.getIdentityJsonString()` //Note: this method returns `null` if the user has opted out, so be sure to handle that case. #### Server-Only Integration If you're using server-only integration (see [Publisher Integration Guide, Server-Only](https://unifiedid.com/docs/guides/custom-publisher-integration)): -1. Store this identity as a JSON string in the user's session, using the `tokenGenerateResponse.getIdentityJsonString()` function. This method returns null if the user has opted out, so be sure to handle that case. +1. Store this identity as a JSON string in the user's session, using the `tokenGenerateResponse.getIdentityJsonString()` function. This method returns `null` if the user has opted out, so be sure to handle that case. 2. To retrieve the user's UID2 token, use: ``` @@ -84,7 +84,7 @@ If you're using server-only integration (see [Publisher Integration Guide, Serve `TokenRefreshResponse tokenRefreshResponse = publisherUid2Client.refreshToken(identity);` -6. Store `tokenRefreshResponse.getIdentityJsonString()` in the user's session. If the user has opted out, this method returns null, indicating that the user's identity should be removed from the session. To confirm optout, you can use the `tokenRefreshResponse.isOptout()` function. +6. Store `tokenRefreshResponse.getIdentityJsonString()` in the user's session. If the user has opted out, this method returns `null`, indicating that the user's identity should be removed from the session. To confirm optout, you can use the `tokenRefreshResponse.isOptout()` function. ### Advanced Usage @@ -100,9 +100,9 @@ If you're using server-only integration (see [Publisher Integration Guide, Serve `.putHeader("Authorization", "Bearer " + UID2_API_KEY)` `.putHeader("X-UID2-Client-Version", PublisherUid2Helper.getVersionHeader())` 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)](../ref-info/glossary-uid.md#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 due to backwards compatibility. + >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. 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: @@ -114,13 +114,13 @@ If you're using standard integration (client and server) (see [Client-Side JavaS * Send this identity as a JSON string back to the client (to use in the [identity field](https://unifiedid.com/docs/sdks/client-side-identity#initopts-object-void)) using the following: - `tokenGenerateResponse.getIdentityJsonString()` //Note: this method returns null if the user has opted out, so be sure to handle that case. + `tokenGenerateResponse.getIdentityJsonString() //Note: this method returns null if the user has opted out, so be sure to handle that case.` #### Server-Only Integration If you're using server-only integration (see [Publisher Integration Guide, Server-Only](https://unifiedid.com/docs/guides/custom-publisher-integration)): -1. Store this identity as a JSON string in the user's session, using: `tokenGenerateResponse.getIdentityJsonString()`. This method will return null if the user has opted out, so be sure to handle that case. +1. Store this identity as a JSON string in the user's session, using: `tokenGenerateResponse.getIdentityJsonString()`. This method returns null if the user has opted out, so be sure to handle that case. 2. To retrieve the user's UID2 token, use: ``` From 37ea51b544e806eebf7fc67f243a0dc221d0ca08 Mon Sep 17 00:00:00 2001 From: jon8787 <112368577+jon8787@users.noreply.github.com> Date: Wed, 21 Jun 2023 10:43:28 +1000 Subject: [PATCH 8/9] capitalization --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ddcc758..bbc538e 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ If you're using the SDK's HTTP implementation, follow these steps. `TokenGenerateResponse tokenGenerateResponse = publisherUid2Client.generateTokenResponse(TokenGenerateInput.fromEmail(emailAddress).doNotGenerateTokensForOptedOut());` - >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. + >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. #### Standard Integration @@ -100,7 +100,7 @@ If you're using server-only integration (see [Publisher Integration Guide, Serve `.putHeader("Authorization", "Bearer " + UID2_API_KEY)` `.putHeader("X-UID2-Client-Version", PublisherUid2Helper.getVersionHeader())` 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. + >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. From 63b52f6ce0a926fc76e3917b0110b7eaebf6daab Mon Sep 17 00:00:00 2001 From: jon8787 <112368577+jon8787@users.noreply.github.com> Date: Wed, 21 Jun 2023 11:20:08 +1000 Subject: [PATCH 9/9] fix link text --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bbc538e..2735b00 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ If you're using the SDK's HTTP implementation, follow these steps. >`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. #### Standard Integration -If you're using standard integration (client and server) (see [Client-Side JavaScript SDK Integration Guide](https://unifiedid.com/docs/guides/publisher-client-side)), follow this step: +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: * Send this identity as a JSON string back to the client (to use in the [identity field](https://unifiedid.com/docs/sdks/client-side-identity#initopts-object-void)) using the following: @@ -110,7 +110,7 @@ If you're using server-only integration (see [Publisher Integration Guide, Serve #### Standard Integration -If you're using standard integration (client and server) (see [Client-Side JavaScript SDK Integration Guide](https://unifiedid.com/docs/guides/publisher-client-side)): +If you're using standard integration (client and server) (see [UID2 SDK for JavaScript Integration Guide](https://unifiedid.com/docs/guides/publisher-client-side)): * Send this identity as a JSON string back to the client (to use in the [identity field](https://unifiedid.com/docs/sdks/client-side-identity#initopts-object-void)) using the following: