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/guides/integration-advertiser-dataprovider-endpoints.md
+11-25Lines changed: 11 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -133,48 +133,34 @@ For details about the UID2 opt-out workflow and how users can opt out, see [User
133
133
The following information is relevant only if you are using version 2 or earlier of the `POST /identity/map` endpoint, and is provided for reference only. New implementations should use the latest version. For instructions, see [High-Level Steps](#high-level-steps).
134
134
:::
135
135
136
-
The following sections provide information about implementing an earlier version, including:
136
+
The key differences when using v2 of the Identity Map API are:
-[Store Raw UID2s and Salt Bucket IDs (V2)](#store-raw-uid2s-and-salt-bucket-ids-v2)
141
-
-[Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (V2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2)
138
+
-**Step 2**: Store salt bucket IDs instead of refresh timestamps
139
+
-**Step 5**: Monitor for salt bucket rotations instead of using refresh timestamps
142
140
143
-
### Earlier Versions: High-Level Steps
144
-
145
-
At a high level, the steps for advertisers and data providers integrating with UID2 using the `POST /v2/identity/map endpoint` are the same as for the current version, as shown in the following summary of steps. However, Step 2 and Step 5 are significantly different: for details, see [Integration Diagram (v2)](#integration-diagram-v2).
146
-
147
-
1.[Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii)
148
-
149
-
2.[Store Raw UID2s and Salt Bucket IDs (v2)](#store-raw-uid2s-and-salt-bucket-ids-v2)
150
-
151
-
3.[Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s)
152
-
153
-
4.[Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions)
154
-
155
-
5.[Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2)
156
-
157
-
6.[Monitor for Opt-Out Status](#6-monitor-for-opt-out-status)
141
+
All other steps (1, 3, 4, and 6) are the same as described in the v3 implementation above.
158
142
159
143
### Integration Diagram (v2)
160
144
161
-
The following diagram outlines the steps that data collectors must complete to map DII to raw UID2s for audience building and targeting.
162
-
163
-
DII refers to a user's normalized email address or phone number, or the normalized and SHA-256-hashed email address or phone number.
145
+
The following diagram outlines the v2 integration flow. Note that the differences are in Step 2 (storing salt bucket IDs) and Step 5 (monitoring salt bucket rotations):
The response from Step 1, [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii), contains mapping information. We recommend that you store the following information returned in Step 1:
153
+
**This step replaces Step 2 in the v3 implementation.**
154
+
155
+
The response from Step 1 contains mapping information. We recommend that you store the following information returned in Step 1:
172
156
173
157
- Cache the mapping between DII (`identifier`), raw UID2 (`advertising_id`), and salt bucket (`bucket_id`).
174
-
- Store the timestamp for when you received the response data. Later, you can compare this timestamp with the `last_updated` timestamp returned in Step 5, [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2).
158
+
- Store the timestamp for when you received the response data. Later, you can compare this timestamp with the `last_updated` timestamp returned in Step 5.
175
159
176
160
### Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)
177
161
162
+
**This step replaces Step 5 in the v3 implementation.**
163
+
178
164
A raw UID2 is an identifier for a user at a specific moment in time. The raw UID2 for a specific user changes roughly once per year, as a result of the <Linkhref="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> rotation.
179
165
180
166
Even though each salt bucket is updated approximately once per year, individual bucket updates are spread over the year. Approximately 1/365th of all salt buckets are rotated daily. Based on this, we recommend checking salt bucket rotation regularly, on a cadence that aligns with your audience refreshes. For example, if you refresh weekly, check for salt bucket updates weekly.
Copy file name to clipboardExpand all lines: docs/guides/integration-advertiser-dataprovider-overview.md
+11-34Lines changed: 11 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -149,57 +149,34 @@ For details about the UID2 opt-out workflow and how users can opt out, see [User
149
149
The following information is relevant only to integration approaches that use an earlier version of the `POST /identity/map` endpoint, version 2, and is provided for reference only. New implementations should use the latest version: see [High-Level Steps](#high-level-steps).
150
150
:::
151
151
152
-
The following sections provide information about implementing an earlier version, including:
152
+
The key differences when using v2 of the Identity Map API are:
-[Store Raw UID2s and Salt Bucket IDs (V2)](#store-raw-uid2s-and-salt-bucket-ids-v2)
158
-
-[Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (V2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2)
154
+
-**Step 2**: Store salt bucket IDs instead of refresh timestamps
155
+
-**Step 5**: Monitor for salt bucket rotations instead of using refresh timestamps
159
156
160
-
### Earlier Versions: High-Level Steps
161
-
162
-
At a high level, the steps for advertisers and data providers integrating with UID2 using the `POST /v2/identity/map endpoint` are the same as for the current version, as shown in the following summary of steps. However, Step 2 and Step 5 are significantly different: for details, see [Integration Diagram (V2)](#integration-diagram-v2).
163
-
164
-
1.[Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii)
165
-
166
-
2.[Store Raw UID2s and Salt Bucket IDs (V2)](#store-raw-uid2s-and-salt-bucket-ids-v2)
167
-
168
-
3.[Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s)
169
-
170
-
4.[Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions)
171
-
172
-
5.[Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (V2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2)
173
-
174
-
6.[Monitor for Opt-Out Status](#6-monitor-for-opt-out-status)
175
-
176
-
### Implementation Options (v2)
177
-
178
-
The implementation options that are available for advertisers and data providers are the same regardless of version. For details, see [Summary of Implementation Options](#summary-of-implementation-options). However, if you're using an implementation that uses the `POST /v2/identity/map` endpoint, Step 5 is different, as shown in [Integration Diagram (v2)](#integration-diagram-v2). For instructions for Step 5, see [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2).
157
+
All other steps (1, 3, 4, and 6) are the same as described in the v3 implementation above.
179
158
180
159
### Integration Diagram (v2)
181
160
182
-
The following diagram outlines the steps that data collectors must complete to map DII to raw UID2s for audience building and targeting.
183
-
184
-
DII refers to a user's normalized email address or phone number, or the normalized and SHA-256-hashed email address or phone number.
185
-
186
-
To keep your UID2-based audience information accurate and up to date, follow these integration steps every day.
161
+
The following diagram outlines the v2 integration flow. Note that the main differences are in Step 2 (storing salt bucket IDs) and Step 5 (monitoring salt bucket rotations):
For details about the different parts of the diagram, refer to [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2) for Step 5, or [Summary of Implementation Options](#summary-of-implementation-options) for all other steps.
193
-
194
167
### Store Raw UID2s and Salt Bucket IDs (v2)
195
168
196
-
The response from Step 1, [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii), contains mapping information. We recommend that you store the following information returned in Step 1:
169
+
**This step replaces Step 2 in the v3 implementation.**
170
+
171
+
The response from Step 1 contains mapping information. We recommend that you store the following information returned in Step 1:
197
172
198
173
- Cache the mapping between DII (`identifier`), raw UID2 (`advertising_id`), and salt bucket (`bucket_id`).
199
-
- Store the timestamp for when you received the response data. Later, you can compare this timestamp with the `last_updated` timestamp returned in Step 5, [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2).
174
+
- Store the timestamp for when you received the response data. Later, you can compare this timestamp with the `last_updated` timestamp returned in Step 5.
200
175
201
176
### Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)
202
177
178
+
**This step replaces Step 5 in the v3 implementation.**
179
+
203
180
A raw UID2 is an identifier for a user at a specific moment in time. The raw UID2 for a specific user changes roughly once per year, as a result of the <Linkhref="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> rotation.
204
181
205
182
Even though each salt bucket is updated approximately once per year, individual bucket updates are spread over the year. Approximately 1/365th of all salt buckets are rotated daily. Based on this, we recommend checking salt bucket rotation regularly, on a cadence that aligns with your audience refreshes. For example, if you refresh weekly, check for salt bucket updates weekly.
0 commit comments