From d3b101f1aa37d28a6217c3fe047f0a7306fac22d Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Fri, 4 Oct 2024 16:56:43 -0400 Subject: [PATCH 1/8] LiveRamp doc --- docs/guides/integration-liveramp-tips.md | 73 +++++++++++++++++++ .../guides/integration-liveramp-tips.md | 15 ++++ sidebars.js | 6 +- 3 files changed, 93 insertions(+), 1 deletion(-) create mode 100644 docs/guides/integration-liveramp-tips.md create mode 100644 i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md diff --git a/docs/guides/integration-liveramp-tips.md b/docs/guides/integration-liveramp-tips.md new file mode 100644 index 000000000..005895cee --- /dev/null +++ b/docs/guides/integration-liveramp-tips.md @@ -0,0 +1,73 @@ +--- +title: LiveRamp Integration Tips +sidebar_label: LiveRamp Integration Tips +pagination_label: LiveRamp Integration Tips +description: Tips for integrating with UID2 with LiveRamp. +hide_table_of_contents: false +sidebar_position: 04 +--- + +import Link from '@docusaurus/Link'; + +# LiveRamp Integration Tips + +Publishers already using LiveRamp Authenticated Traffic Solution (ATS) can leverage their integration to generate a UID2 token and pass the token to LiveRamp in the bid request. If you want to generate UID2 tokens using LiveRamp ATS, make sure you've correctly implemented the following integration points: + +- [Enable RideAlong](#enable-ridealong) +- [Implement the Correct Hashing Methodology](#implement-the-correct-hashing-methodology) +- [Make Sure the Envelope Refresh Setting Is Valid for UID2](#make-sure-the-envelope-refresh-setting-is-valid-for-uid2) +- [Check Expiration Rate Threshold](#check-expiration-rate-threshold) + +[**GWH_DR/EH_01: In the intro, do we need to mention Prebid? Like, "Publishers already using LiveRamp Authenticated Traffic Solution (ATS) in a Prebid.js instance can leverage their integration..."?**] + +## Enable RideAlong + +In your LiveRamp configuration, you must make sure that RideAlong is enabled. RideAlong is a LiveRamp feature that enables other identity solutions, such as UID2, to embed their identifiers in ATS envelopes. If RideAlong is not enabled, UID2 tokens are not correctly sent. + +To complete this step, contact your LiveRamp representative. + +## Implement the Correct Hashing Methodology + +The hashing methodology used by the UID2 service is very specific. If you use a different hashing algorithm, or miss any of the steps, your UID2s will not be correctly generated. + +For information about the required hashing methodology, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). + +## Make Sure the Envelope Refresh Setting Is Valid for UID2 + +**If using ATS.js and Prebid, what value is set in “storage.refreshInSeconds” - the value should be set to 1800 seconds (30 minutes) / review what value is set for "expire" - we are still evaluating the impact of expire, but typically either 15 or 30 days is set.** + +If you're using `ATS.js` and `Prebid.js`, it's important that the value set in `storage.refreshInSeconds` is a valid value for UID2. + +We recommend that you set this value to **1800 seconds** (30 minutes). + +To check this setting, you can visit an example webpage. Bear in mind that you might have to authenticate in some way, but it's not always required for LiveRamp. + +On the page, right-click for the developer tools, then choose Inspect. Under the Console tab, type `pbjs.getConfig()`. + +Under `userSync` and `userIds`, you should see a breakout of all the user ID modules that are set up and generated in storage. + +Under `identityLink`, you can review the parameters set for the module. + +[**GWH_DR/EH_02: if they are incorrect, where do users actually configure them? Not sure if the above info about checking developer tools is really TAM info but I included it for now. But where does the publisher configure these settings? If we know.**] + +## Check Expiration Rate Threshold + +The LiveRamp ATS envelope is typically set up to expire after 15 or 30 days; UID2 tokens have a much shorter lifetime. This is determined by the `expire` setting in the LiveRamp configuration. + +A common LiveRamp recommendation to publishers is to intentionally delay the loading of ATS in the interests of user experience. As a result, the ATS tag usually isn't loaded before the first request is sent. This has the following results: + +- For users with no envelope/token, the first bid request is sent without a UID2. +- For users with an existing envelope/token, the first bid request is sent with the existing UID2 token, without first refreshing the token. + +The recommended approach depends on your integration type: + +- If your integration is with the [LiveRamp ATS Mobile SDK](https://docs.liveramp.com/privacy-manager/en/implement-ats-mobile-sdk.html), you can update the refresh parameters in the LiveRamp platform. +- If your integration is with [ATS for Web](https://docs.liveramp.com/privacy-manager/en/implement-ats-js.html), using the [Prebid LiveRamp Module](https://docs.prebid.org/dev-docs/modules/userid-submodules/ramp.html), the refresh parameters are set on the page, in the Prebid script. + + [**GWH_DR/EH_03: in this case how do they update? Does it mean the script sets the pages in the webpage? Or "on the page" means a Prebid config page? The Confluence page says "If not set through Prebid, we need to go directly to the publisher to ask for the values." but then if the TAM person asked for the values, what then, where are they updated? Sorry... don't get it.**] + +If it's more than 24 hours since the token was refreshed, the LiveRamp envelope is valid but the UID2 token has expired. Because the refresh process happens after the bidding sequence, an expired UID2 token is sent with the bid. + +## Troubleshooting Assistance + +For more information, or LiveRamp troubleshooting assistance, check the [LiveRamp support page](https://docs.liveramp.com/connect/en/support.html) for help resources or contact your LiveRamp representative. diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md new file mode 100644 index 000000000..51a3dcb4f --- /dev/null +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md @@ -0,0 +1,15 @@ +--- +title: LiveRamp Integration Tips +sidebar_label: LiveRamp Integration Tips +pagination_label: LiveRamp Integration Tips +description: Tips for integrating with UID2 with LiveRamp. +hide_table_of_contents: false +sidebar_position: 04 +--- + +import Link from '@docusaurus/Link'; + +# LiveRamp Integration Tips + +xxx TBD UPTOHERE JAPANESE COPY + diff --git a/sidebars.js b/sidebars.js index dd7572f3e..fe3c75f9a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -175,7 +175,11 @@ const fullSidebar = [ 'guides/mobile-plugin-ima-ios', ], }, - ], + + + 'guides/integration-liveramp-tips', + + ], }, { From 3f478968644502bd9166ea7477b10a052c9a9dbb Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Mon, 14 Oct 2024 14:12:49 -0400 Subject: [PATCH 2/8] edits from DR --- docs/guides/integration-liveramp-tips.md | 44 ++++++------------------ 1 file changed, 11 insertions(+), 33 deletions(-) diff --git a/docs/guides/integration-liveramp-tips.md b/docs/guides/integration-liveramp-tips.md index 005895cee..a95441041 100644 --- a/docs/guides/integration-liveramp-tips.md +++ b/docs/guides/integration-liveramp-tips.md @@ -11,14 +11,14 @@ import Link from '@docusaurus/Link'; # LiveRamp Integration Tips -Publishers already using LiveRamp Authenticated Traffic Solution (ATS) can leverage their integration to generate a UID2 token and pass the token to LiveRamp in the bid request. If you want to generate UID2 tokens using LiveRamp ATS, make sure you've correctly implemented the following integration points: +Publishers already using LiveRamp Authenticated Traffic Solution (ATS) can leverage their integration to generate a UID2 token to be passed in the bid request. + +If you want to generate UID2 tokens using LiveRamp ATS, reach out to your LiveRamp representative and also make sure you have the following integration points set: - [Enable RideAlong](#enable-ridealong) - [Implement the Correct Hashing Methodology](#implement-the-correct-hashing-methodology) -- [Make Sure the Envelope Refresh Setting Is Valid for UID2](#make-sure-the-envelope-refresh-setting-is-valid-for-uid2) -- [Check Expiration Rate Threshold](#check-expiration-rate-threshold) - -[**GWH_DR/EH_01: In the intro, do we need to mention Prebid? Like, "Publishers already using LiveRamp Authenticated Traffic Solution (ATS) in a Prebid.js instance can leverage their integration..."?**] +- [Make Sure the Envelope Refresh Setting Is Set to 1800 Seconds](#make-sure-the-envelope-refresh-setting-is-set-to-1800-seconds) +- [Make Sure the Expire Setting Is Set Correctly](#make-sure-the-expire-setting-is-set-correctly) ## Enable RideAlong @@ -32,41 +32,19 @@ The hashing methodology used by the UID2 service is very specific. If you use a For information about the required hashing methodology, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). -## Make Sure the Envelope Refresh Setting Is Valid for UID2 - -**If using ATS.js and Prebid, what value is set in “storage.refreshInSeconds” - the value should be set to 1800 seconds (30 minutes) / review what value is set for "expire" - we are still evaluating the impact of expire, but typically either 15 or 30 days is set.** - -If you're using `ATS.js` and `Prebid.js`, it's important that the value set in `storage.refreshInSeconds` is a valid value for UID2. - -We recommend that you set this value to **1800 seconds** (30 minutes). - -To check this setting, you can visit an example webpage. Bear in mind that you might have to authenticate in some way, but it's not always required for LiveRamp. +## Make Sure the Envelope Refresh Setting Is Set to 1800 Seconds -On the page, right-click for the developer tools, then choose Inspect. Under the Console tab, type `pbjs.getConfig()`. +When enabling `ATS.js` within `Prebid.js`, make sure that `storage.refreshInSeconds` is set to **1800 seconds** (30 minutes). -Under `userSync` and `userIds`, you should see a breakout of all the user ID modules that are set up and generated in storage. +## Make Sure the Expire Setting Is Set Correctly -Under `identityLink`, you can review the parameters set for the module. - -[**GWH_DR/EH_02: if they are incorrect, where do users actually configure them? Not sure if the above info about checking developer tools is really TAM info but I included it for now. But where does the publisher configure these settings? If we know.**] - -## Check Expiration Rate Threshold +When enabling `ATS.js` within `Prebid.js`, check the value specified for the `expire` setting. The LiveRamp ATS envelope is typically set up to expire after 15 or 30 days; UID2 tokens have a much shorter lifetime. This is determined by the `expire` setting in the LiveRamp configuration. -A common LiveRamp recommendation to publishers is to intentionally delay the loading of ATS in the interests of user experience. As a result, the ATS tag usually isn't loaded before the first request is sent. This has the following results: - -- For users with no envelope/token, the first bid request is sent without a UID2. -- For users with an existing envelope/token, the first bid request is sent with the existing UID2 token, without first refreshing the token. - -The recommended approach depends on your integration type: - -- If your integration is with the [LiveRamp ATS Mobile SDK](https://docs.liveramp.com/privacy-manager/en/implement-ats-mobile-sdk.html), you can update the refresh parameters in the LiveRamp platform. -- If your integration is with [ATS for Web](https://docs.liveramp.com/privacy-manager/en/implement-ats-js.html), using the [Prebid LiveRamp Module](https://docs.prebid.org/dev-docs/modules/userid-submodules/ramp.html), the refresh parameters are set on the page, in the Prebid script. - - [**GWH_DR/EH_03: in this case how do they update? Does it mean the script sets the pages in the webpage? Or "on the page" means a Prebid config page? The Confluence page says "If not set through Prebid, we need to go directly to the publisher to ask for the values." but then if the TAM person asked for the values, what then, where are they updated? Sorry... don't get it.**] +Typically, either 15 days or 30 days is an acceptable value. -If it's more than 24 hours since the token was refreshed, the LiveRamp envelope is valid but the UID2 token has expired. Because the refresh process happens after the bidding sequence, an expired UID2 token is sent with the bid. +[**GWH_DR: Playbook says "we are still evaluating the impact of expire, but typically either 15 or 30 days is set". I'm not sure if this is talking about the default or the recommendation. What do we recommend here?**] ## Troubleshooting Assistance From d9dbf292efef83ad65b4a96cddc203711eaef22e Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Mon, 14 Oct 2024 16:23:29 -0400 Subject: [PATCH 3/8] minor mod --- docs/guides/integration-liveramp-tips.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/integration-liveramp-tips.md b/docs/guides/integration-liveramp-tips.md index a95441041..08c3fd6eb 100644 --- a/docs/guides/integration-liveramp-tips.md +++ b/docs/guides/integration-liveramp-tips.md @@ -13,7 +13,7 @@ import Link from '@docusaurus/Link'; Publishers already using LiveRamp Authenticated Traffic Solution (ATS) can leverage their integration to generate a UID2 token to be passed in the bid request. -If you want to generate UID2 tokens using LiveRamp ATS, reach out to your LiveRamp representative and also make sure you have the following integration points set: +If you want to generate UID2 tokens using LiveRamp ATS, reach out to your LiveRamp representative and also make sure you've addressed the following integration points: - [Enable RideAlong](#enable-ridealong) - [Implement the Correct Hashing Methodology](#implement-the-correct-hashing-methodology) From fa9773ea06646b81db389f4d689bee4431a805ae Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Mon, 14 Oct 2024 16:44:15 -0400 Subject: [PATCH 4/8] additional edits from DR --- docs/guides/integration-liveramp-tips.md | 17 +++-------------- 1 file changed, 3 insertions(+), 14 deletions(-) diff --git a/docs/guides/integration-liveramp-tips.md b/docs/guides/integration-liveramp-tips.md index 08c3fd6eb..c4e7723f4 100644 --- a/docs/guides/integration-liveramp-tips.md +++ b/docs/guides/integration-liveramp-tips.md @@ -17,12 +17,11 @@ If you want to generate UID2 tokens using LiveRamp ATS, reach out to your LiveRa - [Enable RideAlong](#enable-ridealong) - [Implement the Correct Hashing Methodology](#implement-the-correct-hashing-methodology) -- [Make Sure the Envelope Refresh Setting Is Set to 1800 Seconds](#make-sure-the-envelope-refresh-setting-is-set-to-1800-seconds) -- [Make Sure the Expire Setting Is Set Correctly](#make-sure-the-expire-setting-is-set-correctly) +- [Set Envelope Refresh to 1800 Seconds](#set-envelope-refresh-to-1800-seconds) ## Enable RideAlong -In your LiveRamp configuration, you must make sure that RideAlong is enabled. RideAlong is a LiveRamp feature that enables other identity solutions, such as UID2, to embed their identifiers in ATS envelopes. If RideAlong is not enabled, UID2 tokens are not correctly sent. +In your LiveRamp configuration, you must make sure that RideAlong is enabled. RideAlong is a LiveRamp feature that enables other identity solutions, such as UID2, to embed their identifiers in ATS envelopes. If RideAlong is not enabled, UID2 tokens will not be appended to the envelope. To complete this step, contact your LiveRamp representative. @@ -32,20 +31,10 @@ The hashing methodology used by the UID2 service is very specific. If you use a For information about the required hashing methodology, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). -## Make Sure the Envelope Refresh Setting Is Set to 1800 Seconds +## Set Envelope Refresh to 1800 Seconds When enabling `ATS.js` within `Prebid.js`, make sure that `storage.refreshInSeconds` is set to **1800 seconds** (30 minutes). -## Make Sure the Expire Setting Is Set Correctly - -When enabling `ATS.js` within `Prebid.js`, check the value specified for the `expire` setting. - -The LiveRamp ATS envelope is typically set up to expire after 15 or 30 days; UID2 tokens have a much shorter lifetime. This is determined by the `expire` setting in the LiveRamp configuration. - -Typically, either 15 days or 30 days is an acceptable value. - -[**GWH_DR: Playbook says "we are still evaluating the impact of expire, but typically either 15 or 30 days is set". I'm not sure if this is talking about the default or the recommendation. What do we recommend here?**] - ## Troubleshooting Assistance For more information, or LiveRamp troubleshooting assistance, check the [LiveRamp support page](https://docs.liveramp.com/connect/en/support.html) for help resources or contact your LiveRamp representative. From 5623a5a738e64c6540c3b33d6ef8513cb5ce8379 Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Mon, 14 Oct 2024 16:55:26 -0400 Subject: [PATCH 5/8] update JP copy --- .../guides/integration-liveramp-tips.md | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md index 51a3dcb4f..c4e7723f4 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md @@ -11,5 +11,30 @@ import Link from '@docusaurus/Link'; # LiveRamp Integration Tips -xxx TBD UPTOHERE JAPANESE COPY +Publishers already using LiveRamp Authenticated Traffic Solution (ATS) can leverage their integration to generate a UID2 token to be passed in the bid request. +If you want to generate UID2 tokens using LiveRamp ATS, reach out to your LiveRamp representative and also make sure you've addressed the following integration points: + +- [Enable RideAlong](#enable-ridealong) +- [Implement the Correct Hashing Methodology](#implement-the-correct-hashing-methodology) +- [Set Envelope Refresh to 1800 Seconds](#set-envelope-refresh-to-1800-seconds) + +## Enable RideAlong + +In your LiveRamp configuration, you must make sure that RideAlong is enabled. RideAlong is a LiveRamp feature that enables other identity solutions, such as UID2, to embed their identifiers in ATS envelopes. If RideAlong is not enabled, UID2 tokens will not be appended to the envelope. + +To complete this step, contact your LiveRamp representative. + +## Implement the Correct Hashing Methodology + +The hashing methodology used by the UID2 service is very specific. If you use a different hashing algorithm, or miss any of the steps, your UID2s will not be correctly generated. + +For information about the required hashing methodology, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). + +## Set Envelope Refresh to 1800 Seconds + +When enabling `ATS.js` within `Prebid.js`, make sure that `storage.refreshInSeconds` is set to **1800 seconds** (30 minutes). + +## Troubleshooting Assistance + +For more information, or LiveRamp troubleshooting assistance, check the [LiveRamp support page](https://docs.liveramp.com/connect/en/support.html) for help resources or contact your LiveRamp representative. From c496a6aaf82b8ecbdbb3dbd983401c502053baad Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 15 Oct 2024 10:05:02 -0400 Subject: [PATCH 6/8] edit from SW --- docs/guides/integration-liveramp-tips.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/integration-liveramp-tips.md b/docs/guides/integration-liveramp-tips.md index c4e7723f4..690344d77 100644 --- a/docs/guides/integration-liveramp-tips.md +++ b/docs/guides/integration-liveramp-tips.md @@ -16,7 +16,7 @@ Publishers already using LiveRamp Authenticated Traffic Solution (ATS) can lever If you want to generate UID2 tokens using LiveRamp ATS, reach out to your LiveRamp representative and also make sure you've addressed the following integration points: - [Enable RideAlong](#enable-ridealong) -- [Implement the Correct Hashing Methodology](#implement-the-correct-hashing-methodology) +- [Implement the UID2 Hashing Methodology](#implement-the-uid2-hashing-methodology) - [Set Envelope Refresh to 1800 Seconds](#set-envelope-refresh-to-1800-seconds) ## Enable RideAlong @@ -25,7 +25,7 @@ In your LiveRamp configuration, you must make sure that RideAlong is enabled. Ri To complete this step, contact your LiveRamp representative. -## Implement the Correct Hashing Methodology +## Implement the UID2 Hashing Methodology The hashing methodology used by the UID2 service is very specific. If you use a different hashing algorithm, or miss any of the steps, your UID2s will not be correctly generated. From fa9a354644e17efb50f78539b2a85af5607a2a34 Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Thu, 7 Nov 2024 16:00:38 -0500 Subject: [PATCH 7/8] LR doc, edits from LR --- .../getting-started/gs-normalization-encoding.md | 4 ++-- docs/guides/integration-liveramp-tips.md | 16 +++++++++------- docs/ref-info/glossary-uid.md | 2 +- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/getting-started/gs-normalization-encoding.md b/docs/getting-started/gs-normalization-encoding.md index 927663328..d27a74c68 100644 --- a/docs/getting-started/gs-normalization-encoding.md +++ b/docs/getting-started/gs-normalization-encoding.md @@ -55,12 +55,12 @@ For examples of various scenarios, see [Normalization Examples for Email](#norma ## Email Address Hash Encoding -An email hash is a Base64-encoded SHA-256 hash of a normalized email address. The email address is first normalized, then hashed using the SHA-256 hashing algorithm, and then the resulting bytes of the hash value are encoded using Base64 encoding. Note that the Base64 encoding is applied to the bytes of the hash value, not the hex-encoded string representation. +An email hash is a Base64-encoded SHA-256 hash of a normalized email address. The email address is first normalized, then hashed using the SHA-256 hashing algorithm, and then the resulting bytes of the hash value are encoded using Base64 encoding. Note that the Base64 encoding is applied to the bytes of the hash value, not the hex-encoded string representation. | Type | Example | Comments and Usage | | :--- | :--- | :--- | | Normalized email address | `user@example.com` | Normalization is always the first step. | -| SHA-256 hash of normalized email address | `b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514` | This 64-character string is a hex-encoded representation of the 32-byte SHA-256.| +| SHA-256 hash of normalized email address | `b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514` | This 64-character string is a hex-encoded representation of the 32-byte SHA-256. | | Hex to Base64 SHA-256 encoding of normalized email address | `tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=` | This 44-character string is a Base64-encoded representation of the 32-byte SHA-256.
WARNING: The SHA-256 hash string in the example above is a hex-encoded representation of the hash value. You must Base64-encode the raw bytes of the hash or use a Base64 encoder that takes a hex-encoded value as input.
Use this encoding for `email_hash` values sent in the request body. | :::important diff --git a/docs/guides/integration-liveramp-tips.md b/docs/guides/integration-liveramp-tips.md index 690344d77..626c4923c 100644 --- a/docs/guides/integration-liveramp-tips.md +++ b/docs/guides/integration-liveramp-tips.md @@ -11,29 +11,31 @@ import Link from '@docusaurus/Link'; # LiveRamp Integration Tips -Publishers already using LiveRamp Authenticated Traffic Solution (ATS) can leverage their integration to generate a UID2 token to be passed in the bid request. +Publishers who are using LiveRamp's Authenticated Traffic Solution (ATS) can leverage their integration to generate a UID2 token to be passed in the bid request. If you want to generate UID2 tokens using LiveRamp ATS, reach out to your LiveRamp representative and also make sure you've addressed the following integration points: -- [Enable RideAlong](#enable-ridealong) +- [Enable UID2 as an Interoperable ID](#enable-uid2-as-an-interoperable-id) - [Implement the UID2 Hashing Methodology](#implement-the-uid2-hashing-methodology) - [Set Envelope Refresh to 1800 Seconds](#set-envelope-refresh-to-1800-seconds) -## Enable RideAlong +## Enable UID2 as an Interoperable ID -In your LiveRamp configuration, you must make sure that RideAlong is enabled. RideAlong is a LiveRamp feature that enables other identity solutions, such as UID2, to embed their identifiers in ATS envelopes. If RideAlong is not enabled, UID2 tokens will not be appended to the envelope. +In your LiveRamp configuration, you must make sure that the Interoperable IDs feature is enabled. Interoperable IDs is a LiveRamp feature that enables other identity solutions, such as UID2, to embed their identifiers in ATS envelopes. If UID2 is not enabled as an interoperable ID, UID2 tokens will not be appended to the envelope. To complete this step, contact your LiveRamp representative. ## Implement the UID2 Hashing Methodology -The hashing methodology used by the UID2 service is very specific. If you use a different hashing algorithm, or miss any of the steps, your UID2s will not be correctly generated. +To add a valid UID2 token to the ATS envelope, a publisher must provide plain text emails, indicate the SHA-256 hashing methodology, or supply an SHA-256 hashed version of the email directly into the LiveRamp Library. -For information about the required hashing methodology, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). +You must use the SHA-256 hashing methodology, which is supported by both UID2 and LiveRamp. Using any other hashing methodology, or missing any step, results in either no UID2 token added to the ATS envelope or an invalid token added. + +For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). ## Set Envelope Refresh to 1800 Seconds -When enabling `ATS.js` within `Prebid.js`, make sure that `storage.refreshInSeconds` is set to **1800 seconds** (30 minutes). +When enabling ATS within `Prebid.js`, make sure that `storage.refreshInSeconds` is set to **1800 seconds** (30 minutes). This setting is necessary due to the strict TTL on the UID2 token, which is 24 hours. To avoid sending expired envelopes into the bidstream, or passing envelopes where an opt-out has occurred, LiveRamp checks for a new ATS envelope (containing the UID2) every 30 minutes. ## Troubleshooting Assistance diff --git a/docs/ref-info/glossary-uid.md b/docs/ref-info/glossary-uid.md index d73cebfe0..0eb77deb8 100644 --- a/docs/ref-info/glossary-uid.md +++ b/docs/ref-info/glossary-uid.md @@ -411,7 +411,7 @@ import Link from '@docusaurus/Link';
SHA-256
SHA-256 is the secure hashing algorithm that UID2 uses.
-
SHA-256 is part of the SHA-2 family of algorithms developed by the National Institute of Standards and Technology (NIST) and the National Security Agency (NSA) to succeed SHA-1. Each algorithm is named according to the number of bits in the output, so SHA-256 has 256 bits.
+
SHA-256 (sometimes called SHA256) is part of the SHA-2 family of algorithms developed by the National Institute of Standards and Technology (NIST) and the National Security Agency (NSA) to succeed SHA-1. Each algorithm is named according to the number of bits in the output, so SHA-256 has 256 bits.
For details, see https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf (specification).
Sharing (in UID2)
From b0c7e6a06b07f086350ec3e79e76dda849c4e15a Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 12 Nov 2024 17:29:50 -0500 Subject: [PATCH 8/8] v2: edit from DR --- docs/guides/integration-liveramp-tips.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/integration-liveramp-tips.md b/docs/guides/integration-liveramp-tips.md index 626c4923c..50435ea0d 100644 --- a/docs/guides/integration-liveramp-tips.md +++ b/docs/guides/integration-liveramp-tips.md @@ -35,7 +35,7 @@ For details, see [Normalization and Encoding](../getting-started/gs-normalizatio ## Set Envelope Refresh to 1800 Seconds -When enabling ATS within `Prebid.js`, make sure that `storage.refreshInSeconds` is set to **1800 seconds** (30 minutes). This setting is necessary due to the strict TTL on the UID2 token, which is 24 hours. To avoid sending expired envelopes into the bidstream, or passing envelopes where an opt-out has occurred, LiveRamp checks for a new ATS envelope (containing the UID2) every 30 minutes. +When enabling ATS within `Prebid.js`, make sure that `storage.refreshInSeconds` is set to **1800 seconds** (30 minutes). To avoid sending expired envelopes into the bidstream, or passing envelopes where an opt-out has occurred, LiveRamp checks for a new ATS envelope (containing the UID2) every 30 minutes. ## Troubleshooting Assistance