Merge pull request #726 from IABTechLab/gwh-APIDOCS-1474-LiveRamp-doc

LiveRamp doc

docs/getting-started/gs-normalization-encoding.md

@@ -60,7 +60,7 @@ An email hash is a Base64-encoded <Link href="../ref-info/glossary-uid#gl-sha-25
 | Type | Example | Comments and Usage |
 | :--- | :--- | :--- |
 | Normalized email address | `[email protected]` | 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.<br/>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.<br/>Use this encoding for `email_hash` values sent in the request body. |
 
 :::important

docs/guides/integration-liveramp-tips.md

@@ -0,0 +1,42 @@
+---
+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 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 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 UID2 as an Interoperable ID
+
+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
+
+To add a valid UID2 token to the ATS envelope, a publisher must provide plain text emails, indicate the <Link href="../ref-info/glossary-uid#gl-sha-256">SHA-256</Link> hashing methodology, or supply an SHA-256 hashed version of the email directly into the LiveRamp Library.
+
+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 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
+
+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.

i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md

@@ -0,0 +1,40 @@
+---
+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 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.

sidebars.js

@@ -176,7 +176,11 @@ const fullSidebar = [
               'guides/mobile-plugin-ima-ios',
             ],
           },
-          ],
+
+
+          'guides/integration-liveramp-tips',
+
+        ],
         },
 
         {