Skip to content

Commit c379603

Browse files
committed
diagram updates and other updates
1 parent 2b5af82 commit c379603

10 files changed

+125
-47
lines changed

docs/getting-started/gs-faqs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ We do not make any promises about when the rotation takes place. To stay as up-t
170170

171171
#### Do refreshed emails get assigned to the same bucket with which they were previously associated?
172172

173-
Not necessarily. After you remap emails associated with a particular bucket ID, the emails might be assigned to a different bucket ID. To check the bucket ID, [call the mapping function](../guides/integration-advertiser-dataprovider-overview.md#retrieve-a-raw-uid2-for-dii) and save the returned UID2 and bucket ID again.
173+
Not necessarily. After you remap emails associated with a particular bucket ID, the emails might be assigned to a different bucket ID. To check the bucket ID, [call the mapping function](../guides/integration-advertiser-dataprovider-overview.md#generate-a-raw-uid2-for-dii) and save the returned UID2 and bucket ID again.
174174

175175
:::info
176176
When mapping and remapping emails, do not make any assumptions about the number of buckets, their rotation dates, or the specific bucket that an email gets assigned to.
@@ -208,7 +208,7 @@ In general yes, the process of generating a raw UID2 from DII is the same, and r
208208

209209
However, there is a variable factor, which is the <Link href="../ref-info/glossary-uid#gl-salt">salt</Link> value that's used in generating the raw UID2. The salt values are rotated roughly once per year (for details, see [How often should UID2s be refreshed for incremental updates?](#how-often-should-uid2s-be-refreshed-for-incremental-updates)). If the salt value changes between one request and another, those two requests result in two different raw UID2, even when the DII is the same.
210210

211-
For more information, see [Monitor for salt bucket rotations related to your stored raw UID2s](../guides/integration-advertiser-dataprovider-overview.mdmonitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s) in the *Advertiser/Data Provider Integration Guide*.
211+
For more information, see [Monitor for salt bucket rotations related to your stored raw UID2s](../guides/integration-advertiser-dataprovider-overview.md#monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s) in the *Advertiser/Data Provider Integration Guide*.
212212

213213
#### If two operators process the same DII, are the results the same?
214214

File renamed without changes.
121 KB
Loading

docs/guides/images/resource/advertiser-flow-mermaid.md.bak renamed to docs/guides/images/resource/advertiser-flow-endpoints-mermaid.md.bak

File renamed without changes.
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
Updated 12/23/24 to split out Advertiser/Data Provider overview diagram vs endpoints diagram.
2+
3+
URL: https://mermaid.live/edit
4+
5+
6+
<!-- 12/23/24: Code:
7+
8+
sequenceDiagram
9+
participant ADP as Advertuser/Data Provider
10+
participant UID2 as UID2 Operator
11+
participant DSP
12+
loop 1. Generate a raw UID2 from DII.
13+
ADP->>UID2: 1-a. Send a request containing DII using an SDK, raw HTTP endpoint, Snowflake, or AWS Entity Resolution.
14+
UID2->>ADP: 1-b. Store the raw UID2 and salt bucket ID.
15+
end
16+
ADP-->>DSP: 2. Manipulate or combine raw UID2s, then send to DSPs to create audiences and conversions.
17+
18+
loop 3. Monitor for salt bucket rotations related to your stored raw UID2s.
19+
ADP->>UID2: 3-a. Monitor salt bucket rotations using an SDK, raw HTTP endpoint, or Snowflake.
20+
UID2->>ADP: 3-b. Receive salt buckets rotated since a specified timestamp.
21+
ADP->>UID2: 3-c. Compare the rotated salt buckets to the stored UID2 salt buckets.<br>If salt bucket ID has changed, resend DII for a new raw UID2.
22+
UID2->>ADP: 3-d. Store the new raw UID2 and salt bucket ID.
23+
end
24+
loop 4. Monitor for opt-out status.
25+
ADP->>UID2: 4-a. Send a request to the POST /optout/status endpoint.
26+
UID2->>ADP: 4-b. Receive updated optout status. For any new opt-outs, remove the stored raw UID2 and salt bucket ID.
27+
end
28+
29+
-->
30+
31+
<!-- Config:
32+
33+
{
34+
"theme": "forest"
35+
}
36+
37+
-->
38+
39+
<!-- 8/30/24: Code:
40+
41+
sequenceDiagram
42+
participant DP as Data Provider
43+
participant UID2 as UID2 Operator
44+
participant DSP
45+
loop 1. Retrieve a UID2 for DII using the identity map endpoint.
46+
DP->>UID2: 1-a. Send a request containing DII to the identity mapping endpoints.
47+
UID2->>DP: 1-b. Store the raw UID2 and salt bucket returned from the identity mapping service.
48+
end
49+
DP-->>DSP: 2. Send stored UID2s to DSPs to create audiences and conversions.
50+
51+
loop 3. Monitor for salt bucket rotations related to your stored raw UID2s.
52+
DP->>UID2: 3-a. Monitor salt bucket rotations using the bucket service.
53+
UID2->>DP: 3-b. Return salt buckets rotated since a specified timestamp.
54+
DP->>UID2: 3-c. Compare the rotated salt buckets to the stored UID2 salt buckets.<br>If rotated, resend DII to identity mapping service for a new raw UID2.
55+
UID2->>DP: 3-d. Store the raw UID2 and the salt bucket returned from the identity mapping service.
56+
end
57+
58+
-->
59+
60+
<!-- Config:
61+
62+
{
63+
"theme": "forest"
64+
}
65+
66+
-->
67+
68+
<!-- 12/23/24: URL with "Pan & Zoom" on:
69+
70+
https://mermaid.live/edit#pako:eNqNVFtr21AM_ivCz25Kmz6FUSjzLmGUhrpjMPKiHCvJofGRdy4pofS_T7KdxO1S1kCIY0v6bvJ5zgxXlE0ygEB_EjlDhcWVx3ruQD4N-miNbdBFuClmgAFuqi35mAL58wIjwszz1lbk_234OS0utaP9vWvIY-QTZUU5625umBu4GME3clpLgODxqWtfeq6hmE5HXalwObu-1icTuDjDEZTkKq1XESGCYRfROutW2gQp6BU6KIsfeTv0-8PDDKSnYetiDqXjp-UGHykH9nDzq4QvLtq4g3sKvEnRsuuRFVOghYAiLwRZRBHENR3JonAJuImwSOaRIkyLvlkAj_xlikifwOUIbtHZJm1Us8AbrhfWHeeFXMc7SUjmRlbDgv4aT61LqbIaXGhxRbnkE4RwENCBsWOBYWeFLSzlO-TnOaJKDOKfkmhRdpykSsVVRya9jjcJjDWB_fDTg_-bgHQeQjiiDN0eq9v3ZMhuaYgSOhihKRhGtyY0ZOzSqg5byzpg3bxH3IzgM9eyjn2E-0nD8WKGPuu9aBMePh99Wvjr6fJN4rCWzTdrdCuqRDC14ekuqvkIjp4Orr4ntxou17DhAwvWRn71OnJu4hmnKEJQ3t_TjlydeJl6_bO78gHOZYjMOO9mHPI7LeFqmFhqqtbabsCeBHxVO9yu1dcTDOpXzVsa2v4h7Vme1eRrtJUcac96e57JjJrm2UQuxQTRM8_m7kUqMUUud85kk-gT5ZnntFpnkyVugvzr6PaH4eEuVermbXdmtkdnnskh9pt5X_PyF8MiupQ
71+
72+
-->
73+
74+
<!-- 8/30/24: URL with "Pan & Zoom" on:
75+
76+
https://mermaid-js.github.io/mermaid-live-editor/edit#pako:eNqlVMGO2jAQ_ZWRz9mIhISFqOLS9MBhVbSol4qLiQfWKrFT22FLEf_esZOwoIVTuQRnZt5782biE6u0QFYwAIu_W1QVlpLvDK_XCujXcONkJRuuHJRL4BZK7jgsjT5IgeZz0o9Fmfq08PzeoOFO30krV8vu5V7rBpIYXtEZiQcE3pVutYFysYDWSrUD94ZAfMpJd4SaN4BKNFoqF3co5fJpPvd1BSRPPIYVxQnJ-Jasg0orx6XySB7T6U-AjY8NoLZH9YCEWy496oZQqRUMpYa_950Sj-V7B5u2-oWOGF1rFArYGl3fZ7FoDrLCnoM4Ly14rhWRpX0D1vOJQGS9aAqGZ2WQO3KqFdIPzAYV1OMBjZVaeflX5o5jeNFKElYw9Uatdtz5CtK9J0jh0Y-6NQP10OfgyK3VY2_1gH0f92N8fei2-1uTx97k1-DgNZzt8EgOgVV-Q2yDldxKr1fWNGBeNw8EVjF81TVtXj-3AegavV-HK7dv4vGXjZkvtkNtRF5ZP51-kx7NN5jNQeH7xcUHTYuHmxVk_fd2sYjVaGouBX3nJx9YM6qtcc0K-ks6ycI1W6szZfLW6dVRVaxwpsWIGd3u3lix5XtLp7YR5EF_Qwwp3ctvwq_BJRPD8aW7XMIdEzH68n9qfamjIytO7A8rxvkkTpPseTYZJXmSpHnEjqzI0zifzLJxRqFsNkqm54j9DfWjeJqlWf48nY3yZJTns-T8D5qfkDg
77+
78+
-->

docs/guides/integration-advertiser-dataprovider-endpoints.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ The following diagram outlines the steps that data collectors must complete to m
2323

2424
DII refers to a user's normalized email address or phone number, or the normalized and SHA-256-hashed email address or phone number.
2525

26-
![Advertiser Flow](images/advertiser-flow-mermaid.png)
26+
![Advertiser Flow](images/advertiser-flow-endpoints-mermaid.png)
2727

28-
<!-- diagram source: resource/advertiser-flow-mermaid.md.bak -->
28+
<!-- diagram source: resource/advertiser-flow-endpoints-mermaid.md.bak -->
2929

3030

3131
## Detailed Steps
@@ -34,7 +34,7 @@ The steps for advertisers and data providers integrating with UID2 by calling th
3434

3535
1. Generate a raw UID2 from <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link>, or receive UID2s from another UID2 participant such as a data provider acting on your behalf.
3636

37-
**Instructions**: see [Retrieve a raw UID2 for DII](#retrieve-a-raw-uid2-for-dii).
37+
**Instructions**: see [Retrieve a raw UID2 for DII](#generate-a-raw-uid2-for-dii).
3838

3939
2. Use the UID2s you received in Step 1. For example, you might do one or more of the following:
4040
- Do some manipulation: for example, combine UID2s you generated from DII and UID2s received from another participant such as an advertiser or data provider.
@@ -58,14 +58,14 @@ The steps for advertisers and data providers integrating with UID2 by calling th
5858

5959
6. Periodically, monitor for opt-out status, to be sure that you don't continue using UID2s for users that have recently opted out.
6060

61-
**Instructions**: See [Check Opt-Out Status](#check-opt-out-status).
61+
**Instructions**: See [Monitor for Opt-Out Status](#monitor-for-opt-out-status).
6262

63-
### Retrieve a raw UID2 for DII
63+
### Generate a raw UID2 for DII
6464

6565
| Step | Endpoint | Description |
6666
| --- | --- | --- |
6767
| 1-a | [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) request | Send a request containing DII to the identity mapping endpoint. |
68-
| 1-b | [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) response | The `advertising_id` (raw UID2) returned in the response can be used to target audiences on relevant DSPs.<br/>The response returns a user's raw UID2 and the corresponding `bucket_id` for the salt bucket. The salt assigned to the bucket rotates annually, which impacts the generated raw UID2. For details on how to check for salt bucket rotation, see [3: Monitor for salt bucket rotations](monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s).<br/>For ease of maintenance, a recommended approach is to store a user's raw UID2 and `bucket_id` in a mapping table. For guidance on incremental updates, see [Use an incremental process to continuously update raw UID2s](#use-an-incremental-process-to-continuously-update-raw-uid2s). |
68+
| 1-b | [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) response | The `advertising_id` (raw UID2) returned in the response can be used to target audiences on relevant DSPs.<br/>The response returns a user's raw UID2 and the corresponding `bucket_id` for the salt bucket. The salt assigned to the bucket rotates annually, which impacts the generated raw UID2. For details on how to check for salt bucket rotation, see [3: Monitor for salt bucket rotations](#monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s).<br/>For ease of maintenance, a recommended approach is to store a user's raw UID2 and `bucket_id` in a mapping table. For guidance on incremental updates, see [Use an incremental process to continuously update raw UID2s](#use-an-incremental-process-to-continuously-update-raw-uid2s). |
6969

7070
### Send stored raw UID2s to DSPs to create audiences or conversions
7171

@@ -91,14 +91,14 @@ To help ensure that your integration has the current raw UID2s, check salt bucke
9191

9292
To keep your UID2-based audience information accurate and up to date, follow these integration steps every day:
9393

94-
1. The response from the [UID2 retrieval step](#retrieve-a-raw-uid2-for-dii) contains mapping information. Cache the following:
94+
1. The response from the [UID2 retrieval step](#generate-a-raw-uid2-for-dii) contains mapping information. Cache the following:
9595
- The mapping between DII (`identifier`), raw UID2 (`advertising_id`), and salt bucket (`bucket_id`).
9696
- The most recent `last_updated` timestamp.
97-
2. Using the results from Step 3, [Monitor for salt bucket rotations related to your stored raw UID2s](monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s), remap any raw UID2 for which the salt buckets have been rotated by retrieving new raw UID2 for those IDs, following Step 1, [Retrieve a raw UID2 for DII](#retrieve-a-raw-uid2-for-dii).
97+
2. Using the results from Step 3, [Monitor for salt bucket rotations related to your stored raw UID2s](#monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s), remap any raw UID2 for which the salt buckets have been rotated by retrieving new raw UID2 for those IDs, following Step 1, [Retrieve a raw UID2 for DII](#generate-a-raw-uid2-for-dii).
9898

9999
Then, use the refreshed UID2s to update audiences or conversions, following Step 2, [send raw UID2 to a DSP](#send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions).
100100

101-
## Check Opt-Out Status
101+
## Monitor for Opt-Out Status
102102

103103
It's important to honor user opt-out status. Here are two ways you can check that you have the latest opt-out information:
104104

0 commit comments

Comments
 (0)