Skip to content

Aul UI d2 5559 integration page 2 #900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 7, 2025
10 changes: 5 additions & 5 deletions docs/endpoints/post-identity-map-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,10 @@ Input:
```json
{
"email": [
"[email protected]" // Corresponding UID2 rotated in the last 90 days
"[email protected]" // Corresponding UID2 rotated more than 90 days ago
"invalid email string" // Invalid identifier
"[email protected]" // DII is opted out
"[email protected]", // Corresponding UID2 rotated in the last 90 days
"[email protected]", // Corresponding UID2 rotated more than 90 days ago
"invalid email string", // Invalid identifier
"[email protected]" // DII is opted out
]
}
```
Expand Down Expand Up @@ -175,7 +175,7 @@ For successfully mapped DII, the mapped object includes the properties shown in
|:---------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------|
| `u` | string | The raw UID2 corresponding to the email or phone number provided in the request. |
| `p` | string | One of the following:<ul><li>If the current raw UID2 has been rotated in the last 90 days: the previous value.</li><li>If the current raw UID2 is older than 90 days: `Null`.</li></ul> |
| `r` | number | The Unix timestamp (in milliseconds) that indicates when the raw UID2 can be refreshed. |
| `r` | number | The Unix timestamp (in milliseconds) that indicates when the raw UID2 might be refreshed. The raw UID2 is guaranteed to be valid until this timestamp. |

For unsuccessfully mapped input values, the mapped object includes the properties shown in the following table.

Expand Down
80 changes: 53 additions & 27 deletions docs/getting-started/gs-faqs.md

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- 1/8/25: updated based on revised main Advertiser/Data Provider diagram, but listing endpoints:
<!-- 1/8/25: updated based on revised main Advertiser/Data Provider diagram, but listing endpoints:

sequenceDiagram
participant ADP as Advertiser/Data Provider
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
%%26/6/25: V3 API Update - Updated endpoints diagram to use V3 identity map API with refresh timestamps instead of salt bucket monitoring.

sequenceDiagram
participant ADP as Advertiser/Data Provider
participant UID as UID2 Operator
participant DSP
Note over ADP,DSP: 1. Generate raw UID2s from DII using the identity map endpoint.
loop
ADP->>UID: 1-a. Send a request containing DII to the POST /identity/map endpoint.
UID->>ADP: 1-b. Store the raw UID2 (u), refresh timestamp (r), and optionally previous UID2 (p) returned from the POST /identity/map endpoint.
end
Note over ADP,DSP: 2. Store raw UID2s and refresh timestamps.
Note over ADP,DSP: 3. Manipulate or combine raw UID2s.
Note over ADP,DSP: 4. Send raw UID2s to DSPs.
ADP-->>DSP: Send stored raw UID2s to DSPs to create audiences and conversions, or use them for measurement.
Note over ADP,DSP: 5. Monitor for raw UID2 refresh.
loop
ADP->>ADP: 5-a. Check current time against stored refresh timestamps.
ADP->>UID: 5-b. If refresh time reached, resend DII to the POST /identity/map endpoint for updated raw UID2.
UID->>ADP: 5-c. Store the new raw UID2 (u), refresh timestamp (r), and optionally previous UID2 (p) returned from the POST /identity/map endpoint.
end
Note over ADP,DSP: 6. Monitor for opt-out status. Remove all opt-outs from local storage and do not use.
loop
ADP->>UID: 6-a. Monitor for optout status using the POST /optout/status endpoint.
UID->>ADP: 6-b. Return optout status.
end

%%URL:
%%https://mermaid.live/edit#pako:eNrNVU1v2kAQ_SujPSUSGDDYgA-RolBVHNKg0F4qLht7gFXxrrsfSWmU_97ZNeYjASnH-oDZ3Zk3b948rV9ZrgpkGQMw-NuhzHEi-ErzciGBnoprK3JRcWnhdjIDbuC2eEbaNKg7E245zLR6FgXqjwk_phOfQK8YHirU3KozUZP5rN78piyCInBfqUXbGfQi-IrSZyJo_hKgDCy1KmEynYIzQq7ArhGIgLTCbqHkFaAsKiWkjWpc_2yUqqBeEnj75oaQCL7NI5hTOHDQvn1jIVfSciE9sC9hVcCfPcy_Q6ep0jlThQAJlsA97BPBUrMYchvicOWuW1RnqdGswYqSyvGygitN25xIqMoKJflms4VK47NQbifeVXVNedZpiUXd_ec40fKitHFD8aCr5_CBnokuQvQjuOdSVG7j56M0aVc-CXkE2UzgTPJgp_yhPElNJ02OHxMJGmJDoPFsz8T7d67RU-CuEN7CdSs0SapoSFLT8uycCfMoYUmLErlxGkvci3WGY0INKimocMjZD3In0i7Re2vvtNpdwQaJd9fdGvNfkDutqVJQFfiK_EVOaxq6pPipVxNvqunyJJwWPF9j4V1lvEafc2xoxlUFSXbQ81D0yMlJOz92ssSX_9TN6emkqHZbOS8xt85E8IglxQORaY52t8hG5XwTJsFXGGgXCqSy3iyXxxsGkvrxvit6qHl0N9Wd1aed3enHK-pI9dSP-jEodAr6Xojml7XYSouCZVY7bLESdcn9kr36iAXzrscFy-gvEaVBLdhCvlEWXcA_lSqbRK3cas2yJd8YWtUO2X0O9rvcWTXfyrzJqaO-FF6GfRCG5X39aQlfmFCLZa_sD8t6vW6UxINBPOyP416aDvsttmXZoJ9ESTKIR6M0jodJmvTfWuxvoNeNRoNxf9BNe8M0SYfd4YjIkgyo75STlmXjt38Vsi5b
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
%%26/6/25: V3 API Update - Updated diagram to use V3 identity map API with refresh timestamps instead of salt bucket monitoring.

sequenceDiagram
participant ADP as Advertiser/Data Provider
participant UID as UID2 Operator
participant DSP
Note over ADP,DSP: 1. Generate raw UID2s from DII.
loop
ADP->>UID: 1-a. Send a request containing DII using an SDK, Snowflake, AWS Entity Resolution, or HTTP endpoint.
UID->>ADP: 1-b. Receive the raw UID2 (u), refresh timestamp (r), and optionally previous UID2 (p).
end
Note over ADP,DSP: 2. Store raw UID2s and refresh timestamps.
Note over ADP,DSP: 3. Manipulate or combine raw UID2s.
Note over ADP,DSP: 4. Send raw UID2s to DSPs.
ADP-->>DSP: Send stored raw UID2s to DSPs to create audiences and conversions, or use them for measurement.
Note over ADP,DSP: 5. Monitor for raw UID2 refresh.
loop
ADP->>ADP: 5-a. Check current time against stored refresh timestamps.
ADP->>UID: 5-b. If refresh time reached, resend DII to get updated raw UID2.
UID->>ADP: 5-c. Store the new raw UID2, refresh timestamp, and optionally previous UID2.
end
Note over ADP,DSP: 6. Monitor for opt-out status. Remove all opt-outs from local storage and do not use.
loop
ADP->>UID: 6-a. Monitor for optout status using the POST optout/status endpoint.
UID->>ADP: 6-b. Return optout status.
end

%% URL:
%% https://mermaid.live/edit#pako:eNqNVF1v2kAQ_Cure0ok44DBhvghUhSiFlVpUElVqeLlYh9win3n3gcpjfLfu2sbCAlU9Yt9552d3dm5e2GZzgVLGYAVv7xQmRhLvjS8nCvAp-LGyUxWXDm4Hk-BW7jO1wI3rTAXY-44TI1ey1yYj4DvkzEB8BXBfSUMd_pI1Hg2bTa_aidAY3JiCnA7hV4In4QipADDn-tUFhZGlzCeTMIGR0-hdQXNEsGdqyuMRHiHhzATKgcOhtqzDjKtHJdKqiWlAG_piyuYjb8EMFP6eVHwJxHA9Y8Z3Con3Qa-CasL76RWAWgDnx8epoBJKy2Va2tAOiRFaiJ9DBGSCbkW4Fb7wuHMnwdYx8IIuwInSyyHlxWcGdzmWKSuiIMXxQYqI9ZS-1a8s-q85UHak2JF2Csq_FYpyvqB0IYnU_RDuONKVr4gxbHXTJePUr1JudX8CHjQar2nd5qmu8XQYFCkOrYOtFTtkXh6Z0ZQCdznkkzZtIKzQ0aLItl6Et7WCpewwEUpuPVGlGI3lCM1xtigVhKJa8xuNK1ILZDctPNW46d6tDH56WYlsifIvDHIVKsKfImOQm9tGzql-KE7YzLKZHEQjguerUROPrGkEXkU5VgKB77KUZK9Xvukb9wXd7KtDch7Sjzv4o9479---w_PJYd6YqaO9iQEd97SMSgxHjD19ld7egud8aLWiy9FXUSuQWlHIz09hFq2hIbwjnTP2R5o6n16P3tof160P9-d2kPpkubgOm_UYc69DixgSyNzljrjRcBKYUpOS_ZCIXNGZhRzluInVoYaz9lcvSIKb7qfWpdboNF-uWLpghcWV81g23t3t8u907ONyraYJuo2p753QaJe3jV3eH2V11wsfWG_WdrrdcM4GgyiYf8y6iXJsB-wDUsH_TiM40E0GiVRNIyTuP8asD91ed1wNLjsD7pJb5jEybA7HGGx2LgwN9orhyn7r38BOSL5zQ
Loading