Skip to content

Commit 05822a8

Browse files
committed
new snippet, new article, added into one integration guide
1 parent ab29645 commit 05822a8

File tree

6 files changed

+115
-1
lines changed

6 files changed

+115
-1
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ You can use this tool to verify that your internal processes are set up to corre
192192

193193
In all scenarios, follow the steps on your side to prepare your DII for processing, and then check your resulting values by using the [UID2 Hashing Tool](#uid2-hashing-tool). If the results don't match, check each step to find the error.
194194

195-
If you're having trouble or getting errors, or even if you just want to be sure you're following the steps correctly, here are some things you can check:
195+
If you're having trouble or getting errors, or if you just want to be sure you're following the steps correctly, here are some things you can check:
196196

197197
- **Phone numbers**: Make sure you're normalizing—and normalizing correctly—as the first step.
198198

docs/guides/integration-options-private-operator.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ displayed_sidebar: docs
88
import Link from '@docusaurus/Link';
99
import SnptUpgradePolicy from '../snippets/_snpt-private-operator-upgrade-policy.mdx';
1010
import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx';
11+
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
1112

1213
# UID2 Private Operator Integration Overview
1314

@@ -98,6 +99,13 @@ For information about supported versions and deprecation dates, see [Private Ope
9899

99100
<SnptRotatingTheKeys />
100101

102+
## Preparing DII for Processing
103+
104+
<!-- uptohere need to replicate this section in many places -->
105+
106+
<SnptPreparingEmailsAndPhoneNumbers />
107+
108+
101109
## Getting Started
102110

103111
To get started as a Private Operator, follow these steps:
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Preparing DII for Processing
3+
description: Summary of key steps to prepare your input data for conversion to UID2s.
4+
hide_table_of_contents: false
5+
sidebar_position: 01
6+
displayed_sidebar: docs
7+
---
8+
9+
import Link from '@docusaurus/Link';
10+
11+
# Preparing Emails and Phone Numbers for Processing
12+
13+
The input data that you provide to the UID2 Service must be in the correct format so that the data is correctly converted to valid UID2s that you can use for targeted advertising.
14+
15+
This is true in all cases, whichever of these solutions you're using to convert your emails and phone numbers to UID2s:
16+
- By making direct calls to the UID2 APIs.
17+
- Via your own Private Operator.
18+
- By using any of the UID2 SDK integrations, Prebid.js integration, or Android/iOS integration.
19+
- By using Snowflake.
20+
21+
The exact steps for preparing your data to be consumed by the UID2 service are laid out in the [Normalization and Encoding](../getting-started/gs-normalization-encoding.md) documentation. The steps, in sequence, are as follows:
22+
1. Normalize the raw data.
23+
2. Create a 32-byte SHA-256 hash of the normalized raw data.
24+
3. Apply Base64-encoding to the 32-byte SHA-256 value.
25+
26+
If you're making direct calls to the UID2 APIs, or calling the UID2 APIs via your own Private Operator, you must complete each step, exactly as described and in the correct sequence.
27+
28+
If you're using a UID2 SDK, or other integration solution such as the Prebid.js integration, Android/iOS integration, or Snowflake, the options for your input data are shown in the following table.
29+
30+
<table>
31+
<thead>
32+
<tr>
33+
<th>Type of DII</th>
34+
<th>Input Format</th>
35+
<th>Instructions</th>
36+
</tr>
37+
</thead>
38+
<tbody>
39+
<tr>
40+
<td>Email</td>
41+
<td>Must be one of the following:<ul><li>Raw email</li><li>Normalized email</li><li>Normalized, then hashed, then base64-encoded</li></ul></td>
42+
<td>[Email Address Normalization](../getting-started/gs-normalization-encoding#email-address-normalization)<br/>[Email Address Hash Encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding)</td>
43+
</tr>
44+
<tr>
45+
<td>Phone Number</td>
46+
<td>Must be one of the following:<ul><li>Normalized, including country code</li><li>Normalized, then hashed, then base64-encoded</li></ul></td>
47+
<td>[Phone Number Normalization](../getting-started/gs-normalization-encoding#phone-number-normalization)<br/>[Phone Number Hash Encoding](../getting-started/gs-normalization-encoding#phone-number-hash-encoding)</td>
48+
</tr>
49+
</tbody>
50+
</table>
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import Link from '@docusaurus/Link';
2+
3+
It's critical that the input data, which you are converting to UID2, is in an acceptable format. If it is not, you will not get the expected results. For example, you must normalize phone numbers to include the country code, as explained in [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization).
4+
5+
For details, see [Preparing Emails and Phone Numbers for Processing](../ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md).
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Preparing DII for Processing
3+
description: Summary of key steps to prepare your input data for conversion to UID2s.
4+
hide_table_of_contents: false
5+
sidebar_position: 01
6+
displayed_sidebar: docs
7+
---
8+
9+
import Link from '@docusaurus/Link';
10+
11+
# Preparing Emails and Phone Numbers for Processing
12+
13+
The input data that you provide to the UID2 Service must be in the correct format so that the data is correctly converted to valid UID2s that you can use for targeted advertising.
14+
15+
This is true in all cases, whichever of these solutions you're using to convert your emails and phone numbers to UID2s:
16+
- By making direct calls to the UID2 APIs.
17+
- Via your own Private Operator.
18+
- By using any of the UID2 SDK integrations, Prebid.js integration, or Android/iOS integration.
19+
- By using Snowflake.
20+
21+
The exact steps for preparing your data to be consumed by the UID2 service are laid out in the [Normalization and Encoding](../getting-started/gs-normalization-encoding.md) documentation. The steps, in sequence, are as follows:
22+
1. Normalize the raw data.
23+
2. Create a 32-byte SHA-256 hash of the normalized raw data.
24+
3. Apply Base64-encoding to the 32-byte SHA-256 value.
25+
26+
If you're making direct calls to the UID2 APIs, or calling the UID2 APIs via your own Private Operator, you must complete each step, exactly as described and in the correct sequence.
27+
28+
If you're using a UID2 SDK, or other integration solution such as the Prebid.js integration, Android/iOS integration, or Snowflake, the options for your input data are shown in the following table.
29+
30+
<table>
31+
<thead>
32+
<tr>
33+
<th>Type of DII</th>
34+
<th>Input Format</th>
35+
<th>Instructions</th>
36+
</tr>
37+
</thead>
38+
<tbody>
39+
<tr>
40+
<td>Email</td>
41+
<td>Must be one of the following:<ul><li>Raw email</li><li>Normalized email</li><li>Normalized, then hashed, then base64-encoded</li></ul></td>
42+
<td>[Email Address Normalization](../getting-started/gs-normalization-encoding#email-address-normalization)<br/>[Email Address Hash Encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding)</td>
43+
</tr>
44+
<tr>
45+
<td>Phone Number</td>
46+
<td>Must be one of the following:<ul><li>Normalized, including country code</li><li>Normalized, then hashed, then base64-encoded</li></ul></td>
47+
<td>[Phone Number Normalization](../getting-started/gs-normalization-encoding#phone-number-normalization)<br/>[Phone Number Hash Encoding](../getting-started/gs-normalization-encoding#phone-number-hash-encoding)</td>
48+
</tr>
49+
</tbody>
50+
</table>

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,7 @@ const fullSidebar = [
381381
'getting-started/gs-environments',
382382
'getting-started/gs-encryption-decryption',
383383
'getting-started/gs-normalization-encoding',
384+
'ref-info/ref-preparing-emails-and-phone-numbers-for-processing',
384385
'getting-started/gs-opt-out',
385386
'ref-info/ref-operators-public-private',
386387
'ref-info/ref-integration-approaches',

0 commit comments

Comments
 (0)