You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/gs-normalization-encoding.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,12 +55,12 @@ For examples of various scenarios, see [Normalization Examples for Email](#norma
55
55
56
56
## Email Address Hash Encoding
57
57
58
-
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.
58
+
An email hash is a Base64-encoded <Linkhref="../ref-info/glossary-uid#gl-sha-256">SHA-256</Link> 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.
59
59
60
60
| Type | Example | Comments and Usage |
61
61
| :--- | :--- | :--- |
62
62
| Normalized email address |`[email protected]`| Normalization is always the first step. |
63
-
| SHA-256 hash of normalized email address |`b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514`| This 64-character string is a hex-encoded representation of the 32-byte SHA-256.|
63
+
| SHA-256 hash of normalized email address |`b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514`| This 64-character string is a hex-encoded representation of the 32-byte SHA-256.|
64
64
| 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. |
Copy file name to clipboardExpand all lines: docs/guides/integration-liveramp-tips.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,29 +11,31 @@ import Link from '@docusaurus/Link';
11
11
12
12
# LiveRamp Integration Tips
13
13
14
-
Publishers already using LiveRamp Authenticated Traffic Solution (ATS) can leverage their integration to generate a UID2 token to be passed in the bid request.
14
+
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.
15
15
16
16
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:
17
17
18
-
-[Enable RideAlong](#enable-ridealong)
18
+
-[Enable UID2 as an Interoperable ID](#enable-uid2-as-an-interoperable-id)
19
19
-[Implement the UID2 Hashing Methodology](#implement-the-uid2-hashing-methodology)
20
20
-[Set Envelope Refresh to 1800 Seconds](#set-envelope-refresh-to-1800-seconds)
21
21
22
-
## Enable RideAlong
22
+
## Enable UID2 as an Interoperable ID
23
23
24
-
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.
24
+
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.
25
25
26
26
To complete this step, contact your LiveRamp representative.
27
27
28
28
## Implement the UID2 Hashing Methodology
29
29
30
-
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.
30
+
To add a valid UID2 token to the ATS envelope, a publisher must provide plain text emails, indicate the <Linkhref="../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.
31
31
32
-
For information about the required hashing methodology, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md).
32
+
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.
33
+
34
+
For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md).
33
35
34
36
## Set Envelope Refresh to 1800 Seconds
35
37
36
-
When enabling `ATS.js` within `Prebid.js`, make sure that `storage.refreshInSeconds` is set to **1800 seconds** (30 minutes).
38
+
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.
<dd>SHA-256 is the secure hashing algorithm that UID2 uses.</dd>
414
-
<dd>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.</dd>
414
+
<dd>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.</dd>
415
415
<dd>For details, see <ahref="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf</a> (specification).</dd>
416
416
417
417
<dt><MdxJumpAnchorid="gl-sharing"><ahref="#gl-sharing">Sharing (in UID2)</a></MdxJumpAnchor></dt>
0 commit comments