Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
a4c487c
Add POST /identity/map v3
genwhittTTD Jun 6, 2025
4bb0bbf
initial update of identity map docs with v3 fields
sophia-chen-ttd Jun 11, 2025
c7899f4
small fixes
sophia-chen-ttd Jun 11, 2025
e1146d6
added more detail on response properties
sophia-chen-ttd Jun 11, 2025
fb32e80
small fix
sophia-chen-ttd Jun 11, 2025
e2669aa
added example previous uid
sophia-chen-ttd Jun 11, 2025
b5f24e1
fixed wording
sophia-chen-ttd Jun 12, 2025
cf110c4
removed dii object in request
sophia-chen-ttd Jun 13, 2025
cd95e48
fixed response table
sophia-chen-ttd Jun 13, 2025
eaf3bdf
removing unwanted files
sophia-chen-ttd Jun 13, 2025
fc604d3
updated version section
sophia-chen-ttd Jun 13, 2025
d3a8492
small word fix
sophia-chen-ttd Jun 13, 2025
ef811bf
Removed mentions of migration
sophia-chen-ttd Jun 13, 2025
9872640
Update content and links
vishalegbert-ttd Jun 19, 2025
afa8cdf
Rename
vishalegbert-ttd Jun 19, 2025
6ba50ad
Clean up
vishalegbert-ttd Jun 19, 2025
4ed42b2
Update
vishalegbert-ttd Jun 19, 2025
9801714
Update title
vishalegbert-ttd Jun 19, 2025
7c2af7e
Clarity
vishalegbert-ttd Jun 19, 2025
774cbcd
Update Japanese translation links
vishalegbert-ttd Jun 20, 2025
18af9b1
Revert (v3)
vishalegbert-ttd Jun 20, 2025
4f49e04
Add input example
vishalegbert-ttd Jun 24, 2025
3ce7252
Clean up
vishalegbert-ttd Jun 24, 2025
f981484
Clean up
vishalegbert-ttd Jun 24, 2025
0c780ba
Merge branch 'main' into sch-UID2-5558-v3-identity-map
genwhittTTD Jun 24, 2025
32ae9a3
POST /identity/map update, partial GWH edits
genwhittTTD Jun 24, 2025
b09c6f2
Reverted Japanese file changes
gmsdelmundo Jun 26, 2025
84402a1
Updated post-identity-map filenames and corresponding URLs
gmsdelmundo Jun 27, 2025
8278704
Fixed broken link in sidebar
gmsdelmundo Jun 27, 2025
46debc6
Merge pull request #898 from IABTechLab/sch-UID2-5558-v3-identity-map
gmsdelmundo Jun 27, 2025
a290931
integration overview
aulme Jun 26, 2025
25ae8fb
Updated advertiser summary mermaid
aulme Jun 26, 2025
0ffa745
Integration HTTP guide
aulme Jun 26, 2025
26a439f
Endpoint Integration mermaid
aulme Jun 26, 2025
18174c2
FAQ changes for V3 Identity Map
aulme Jun 26, 2025
f74b43e
Fixing some links
aulme Jun 30, 2025
6c2abc3
glossary
aulme Jun 30, 2025
78bb707
Advertiser and Data Provider overviews, excluding diagrams
aulme Jun 30, 2025
997b3e7
Addressed Gen's feedback and some changes in the same spirit
aulme Jul 1, 2025
26bba33
Some more changes inspired by Gen's feedback
aulme Jul 1, 2025
cb50b6b
Including both old and new docs
aulme Jul 1, 2025
c37cfd9
Re-added older faqs
aulme Jul 1, 2025
3caf042
POST Identity Map V3 improvements and tests for sample code
aulme Jul 4, 2025
c38cc60
V3 Identity Map doc
aulme Jul 4, 2025
24b84a8
Merge pull request #909 from IABTechLab/aul-UID2-5560-java-identity-m…
aulme Jul 4, 2025
b66c8fe
Updating in response to feedback
aulme Jul 7, 2025
ab61ebb
Merge pull request #900 from IABTechLab/aul-UID2-5559-integration-page-2
aulme Jul 7, 2025
952f615
Merge pull request #907 from IABTechLab/aul-UID2-5558-identity-map-v3…
aulme Jul 7, 2025
b18cbaa
Making it clear input is a variable
aulme Jul 7, 2025
8a62eeb
Preparing RC
aulme Jul 7, 2025
2dc45e4
Japanese files
aulme Jul 7, 2025
3a488ab
Release notes first draft
aulme Jul 7, 2025
5eb498e
Small fixes
aulme Jul 7, 2025
2d9a8cb
fix broken link in FAQs file
genwhittTTD Jul 7, 2025
656114c
edits to POST /identity/map migration section
genwhittTTD Jul 7, 2025
b1f7301
update to SDK Summary page
genwhittTTD Jul 7, 2025
34b60ce
Java sdk link uncommented
aulme Jul 8, 2025
029854d
at least -> roughly
aulme Jul 8, 2025
12aba10
update sidebar settings, fix merge conflicts
genwhittTTD Jul 8, 2025
c1001cc
edits to adv guide, mermain diagrams, other edits
genwhittTTD Jul 8, 2025
a9fb1cd
Updated V2/3 -> v2/3 for consistency with other docs
aulme Jul 9, 2025
2e288dd
DIIs -> DII
aulme Jul 9, 2025
f499466
Addressed Gen's feedback re v2 stuff docs being too verbose
aulme Jul 9, 2025
5cd5051
Merge branch 'main' into staging-identity-map-v3
genwhittTTD Jul 9, 2025
4710fca
mods to ADP file updates
genwhittTTD Jul 9, 2025
0a5e576
Figma diagram updates
genwhittTTD Jul 9, 2025
9993d26
few edits
genwhittTTD Jul 9, 2025
5b68657
fix typo
genwhittTTD Jul 9, 2025
2f74875
additional edits
genwhittTTD Jul 9, 2025
62adee8
Copy the English Identity Map content into Japanese until translation…
aulme Jul 10, 2025
7cbff81
Clearer optional steps for Java SDK.
aulme Jul 10, 2025
3b0884d
minor edits
genwhittTTD Jul 10, 2025
20a8d39
Merge branch 'main' into staging-identity-map-v3
genwhittTTD Jul 10, 2025
7571842
Using js null instead of Java Null in JSON api docs
aulme Jul 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 11 additions & 25 deletions docs/guides/integration-advertiser-dataprovider-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,48 +133,34 @@ For details about the UID2 opt-out workflow and how users can opt out, see [User
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).
:::

The following sections provide information about implementing an earlier version, including:
The key differences when using v2 of the Identity Map API are:

- [Earlier Versions: High-Level Steps](#earlier-versions-high-level-steps)
- [Integration Diagram (V2)](#integration-diagram-v2)
- [Store Raw UID2s and Salt Bucket IDs (V2)](#store-raw-uid2s-and-salt-bucket-ids-v2)
- [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (V2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2)
- **Step 2**: Store salt bucket IDs instead of refresh timestamps
- **Step 5**: Monitor for salt bucket rotations instead of using refresh timestamps

### Earlier Versions: High-Level Steps

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).

1. [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii)

2. [Store Raw UID2s and Salt Bucket IDs (v2)](#store-raw-uid2s-and-salt-bucket-ids-v2)

3. [Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s)

4. [Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions)

5. [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2)

6. [Monitor for Opt-Out Status](#6-monitor-for-opt-out-status)
All other steps (1, 3, 4, and 6) are the same as described in the v3 implementation above.

### Integration Diagram (v2)

The following diagram outlines the steps that data collectors must complete to map DII to raw UID2s for audience building and targeting.

DII refers to a user's normalized email address or phone number, or the normalized and SHA-256-hashed email address or phone number.
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):
Comment thread
aulme marked this conversation as resolved.
Outdated

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

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

### Store Raw UID2s and Salt Bucket IDs (v2)

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:
**This step replaces Step 2 in the v3 implementation.**

The response from Step 1 contains mapping information. We recommend that you store the following information returned in Step 1:

- Cache the mapping between DII (`identifier`), raw UID2 (`advertising_id`), and salt bucket (`bucket_id`).
- 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).
- 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)

**This step replaces Step 5 in the v3 implementation.**

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 <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> rotation.

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.
Expand Down
45 changes: 11 additions & 34 deletions docs/guides/integration-advertiser-dataprovider-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,57 +149,34 @@ For details about the UID2 opt-out workflow and how users can opt out, see [User
The following information is relevant only to integration approaches that use an earlier version of the `POST&nbsp;/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).
:::

The following sections provide information about implementing an earlier version, including:
The key differences when using v2 of the Identity Map API are:

- [Earlier Versions: High-Level Steps](#earlier-versions-high-level-steps)
- [Implementation Options (V2)](#implementation-options-v2)
- [Integration Diagram (V2)](#integration-diagram-v2)
- [Store Raw UID2s and Salt Bucket IDs (V2)](#store-raw-uid2s-and-salt-bucket-ids-v2)
- [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (V2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2)
- **Step 2**: Store salt bucket IDs instead of refresh timestamps
- **Step 5**: Monitor for salt bucket rotations instead of using refresh timestamps

### Earlier Versions: High-Level Steps

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).

1. [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii)

2. [Store Raw UID2s and Salt Bucket IDs (V2)](#store-raw-uid2s-and-salt-bucket-ids-v2)

3. [Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s)

4. [Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions)

5. [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (V2)](#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2)

6. [Monitor for Opt-Out Status](#6-monitor-for-opt-out-status)

### Implementation Options (v2)

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&nbsp;/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).
All other steps (1, 3, 4, and 6) are the same as described in the v3 implementation above.

### Integration Diagram (v2)

The following diagram outlines the steps that data collectors must complete to map DII to raw UID2s for audience building and targeting.

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

To keep your UID2-based audience information accurate and up to date, follow these integration steps every day.
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):

![Advertiser Flow](images/advertiser-flow-overview-mermaid.png)

<!-- diagram source: resource/advertiser-flow-overview-v2-mermaid.md.bak -->

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.

### Store Raw UID2s and Salt Bucket IDs (v2)

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:
**This step replaces Step 2 in the v3 implementation.**

The response from Step 1 contains mapping information. We recommend that you store the following information returned in Step 1:

- Cache the mapping between DII (`identifier`), raw UID2 (`advertising_id`), and salt bucket (`bucket_id`).
- 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).
- 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)

**This step replaces Step 5 in the v3 implementation.**

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 <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> rotation.

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.
Expand Down