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
+39-44Lines changed: 39 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,59 +17,49 @@ This guide covers integration steps for advertisers and data providers to integr
17
17
For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md).
18
18
:::
19
19
20
-
## Integration Diagram
21
-
22
-
The following diagram outlines the steps that data collectors must complete to map DII to raw UID2s for audience building and targeting.
20
+
## High-Level Steps
23
21
24
-
DII refers to a user's normalized email address or phone number, or the normalized and SHA-256-hashed email address or phone number.
22
+
At a high level, the steps for advertisers and data providers integrating with UID2 are as follows:
1.[Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii)
29
25
26
+
2.[Store Raw UID2s and Salt Bucket IDs](#2-store-raw-uid2s-and-salt-bucket-ids)
30
27
31
-
## Detailed Steps
28
+
3.[Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s)
32
29
33
-
The steps for advertisers and data providers integrating with UID2 by calling the HTTP endpoints are given in the following sections:
30
+
4.[Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions)
34
31
35
-
1. Generate a raw UID2 from <Linkhref="../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.
32
+
5.[Monitor for Salt Bucket Rotations for Your Stored Raw UID2s](#5-monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s)
36
33
37
-
**Instructions**: see [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii).
34
+
6.[Monitor for Opt-Out Status](#6-monitor-for-opt-out-status)
38
35
39
-
2. Use the UID2s you received in Step 1. For example, you might do one or more of the following:
40
-
- Do some manipulation: for example, combine UID2s you generated from DII and UID2s received from another participant such as an advertiser or data provider.
41
-
- Add new UID2s into an existing audience.
42
-
43
-
**Instructions**: This step is is out of band and entirely up to you.
44
-
45
-
3. Use the raw UID2s for some purpose such as:
46
-
- Send stored raw UID2s to DSPs to create audiences and conversions.
47
-
- Use the raw UID2s for measurement.
48
-
49
-
**Instructions**: see [Send stored raw UID2s to DSPs to create audiences or conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions).
50
-
51
-
4. Store the raw UID2 and the salt bucket ID returned from the `POST /identity/map` endpoint.
52
-
53
-
**Instructions**: This step is is out of band and entirely up to you.
36
+
## Integration Diagram
54
37
55
-
5. Monitor for salt bucket rotations related to your stored raw UID2s.
38
+
The following diagram outlines the steps that data collectors must complete to map DII to raw UID2s for audience building and targeting.
56
39
57
-
**Instructions**: See [Monitor for salt bucket rotations related to your stored raw UID2s](#5-monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s).
40
+
DII refers to a user's normalized email address or phone number, or the normalized and SHA-256-hashed email address or phone number.
58
41
59
-
6. Periodically, monitor for opt-out status, to be sure that you don't continue using UID2s for users that have recently opted out.
| 1-a |[POST /identity/map](../endpoints/post-identity-map.md) request | Send a request containing DII to the identity mapping endpoint. |
68
-
| 1-b |[POST /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 [5: Monitor for salt bucket rotations related to your stored raw UID2s](#5-monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s). |
51
+
| 1-b |[POST /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 [5: Monitor for salt bucket rotations related to your stored raw UID2s](#5-monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s). |
52
+
53
+
54
+
### 2: Store Raw UID2s and Salt Bucket IDs
69
55
70
-
### 2: Send stored raw UID2s to DSPs to create audiences or conversions
56
+
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 raw UID2s and the salt bucket IDs returned in Step 1.
71
57
72
-
Send the `advertising_id` (raw UID2) returned in Step 1-b to a DSP while building your audiences. Each DSP has a unique integration process for building audiences; follow the integration guidance provided by the DSP for sending raw UID2s to build an audience.
58
+
Cache the mapping between DII (`identifier`), raw UID2 (`advertising_id`), and salt bucket (`bucket_id`).
59
+
60
+
:::note
61
+
We recommend that you also store the most recent `last_updated` timestamp, returned in a later step, with the mapping information. For details, see [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s](#5-monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s).
62
+
:::
73
63
74
64
### 3: Manipulate or Combine Raw UID2s
75
65
@@ -80,17 +70,20 @@ Use the UID2s you received in Step 1. For example, you might do one or more of t
80
70
81
71
### 4: Send Stored Raw UID2s to DSPs to Create Audiences or Conversions
82
72
83
-
xxx uptohere TODO
73
+
Use the raw UID2s for some purpose such as:
84
74
85
-
### 5: Monitor for salt bucket rotations related to your stored raw UID2s
75
+
- Sending stored raw UID2s to DSPs to create audiences and conversions.
76
+
- Using the raw UID2s for measurement.
86
77
87
-
A raw UID2 is an identifier for a user at a specific moment in time. The raw UID2 for a specific user changes at least once per year, as a result of the salt rotation.
78
+
For example, you could send the `advertising_id` (<Linkhref="../ref-info/glossary-uid#gl-raw-uid2">raw UID2</Link>) returned in Step 1-b to a DSP while building your audiences. Each DSP has a unique integration process for building audiences; follow the integration guidance provided by the DSP for sending raw UID2s to build an audience.
88
79
89
-
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.
80
+
You could also send conversion information via API or pixels for measurement (attribution) or for retargeting.
90
81
91
-
:::important
92
-
To help ensure that your integration has the current raw UID2s, check salt bucket rotation for active users every day.
93
-
:::
82
+
### 5: Monitor for Salt Bucket Rotations for Your Stored Raw UID2s
83
+
84
+
A raw UID2 is an identifier for a user at a specific moment in time. The raw UID2 for a specific user changes at least once per year, as a result of the <Linkhref="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> rotation.
85
+
86
+
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.
94
87
95
88
| Step | Endpoint | Description |
96
89
| --- | --- | --- |
@@ -99,12 +92,14 @@ To help ensure that your integration has the current raw UID2s, check salt bucke
99
92
| 5-c |[POST /identity/map](../endpoints/post-identity-map.md)| Compare the returned `bucket_id` to the salt buckets of raw UID2s that you've cached.<br/>If you find that the salt bucket was updated for one or more raw UID2s, re-send the DII to the `POST /identity/map` endpoint for a new raw UID2. |
100
93
| 5-d |[POST /identity/map](../endpoints/post-identity-map.md)| Store the new values returned for `advertising_id` and `bucket_id`. |
101
94
102
-
## Monitor for Opt-Out Status
95
+
### 6: Monitor for Opt-Out Status
96
+
97
+
It's important to honor user opt-out status. Periodically, monitor for opt-out status, to be sure that you don't continue using UID2s for users that have recently opted out.
103
98
104
-
It's important to honor user opt-out status. Here are two ways you can check that you have the latest opt-out information:
99
+
There are two ways that you can check with the UID2 <Linkhref="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> to make sure you have the latest opt-out information:
105
100
106
-
-The UID2 <Linkhref="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> distributes opt-out information to advertisers and data providers via the [POST /identity/map](../endpoints/post-identity-map.md) endpoint.
101
+
-Call the [POST /identity/map](../endpoints/post-identity-map.md) endpoint to check for opt-outs. If the DII has been opted out, no raw UID2 is generated.
107
102
108
-
-Advertisers and data providers can check the opt-out status of raw UID2s using the [POST /optout/status](../endpoints/post-optout-status.md) endpoint.
103
+
-Check the opt-out status of raw UID2s using the [POST /optout/status](../endpoints/post-optout-status.md) endpoint.
109
104
110
105
For details about the UID2 opt-out workflow and how users can opt out, see [User Opt-Out](../getting-started/gs-opt-out.md).
Copy file name to clipboardExpand all lines: docs/guides/integration-advertiser-dataprovider-overview.md
+5-9Lines changed: 5 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,12 +23,8 @@ There are other ways that you can use UID2, outside these use cases. These are j
23
23
| Send/Receive? | Action | Advantage/Result |
24
24
| --- | --- | --- |
25
25
| Send in audiences | Send UID2s via API or pixels | Create audiences. |
26
-
| Send in conversions | Send UID2s as conversion information | Use conversion information for measurement (attribution) or for retargeting via API or pixels. |
27
-
| Receive graph data | Receive UID2s from graph/data providers via API or pixels | Build graph data. |
28
-
29
-
<!-- - **Create/send in audiences**: You can send UID2s to create audiences via API or pixels
30
-
- **Send in conversions**: You can send UID2s as conversion information that can be used for measurement (attribution) or retargeting via API or pixels
31
-
- **Receive graph data**: You can receive UID2s from graph/data providers via API or pixels. -->
26
+
| Send in conversions | Send UID2s as conversion information | Use conversion information for measurement (attribution) or for retargeting via API or pixels. |
27
+
| Receive graph data | Receive UID2s from graph/data providers via API or pixels | Build graph data. |
32
28
33
29
## High-Level Steps
34
30
@@ -44,7 +40,7 @@ At a high level, the steps for advertisers and data providers integrating with U
44
40
45
41
5.[Monitor for Salt Bucket Rotations for Your Stored Raw UID2s](#5-monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s)
46
42
47
-
6.[Monitor for opt-out status](#6-monitor-for-opt-out-status)
43
+
6.[Monitor for Opt-Out Status](#6-monitor-for-opt-out-status)
48
44
49
45
## Summary of Implementation Options
50
46
@@ -57,7 +53,7 @@ The following table shows the implementation options that are available for adve
57
53
|[3: Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s)| Custom (your choice). |
58
54
|[4: Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions)| Custom (your choice). |
59
55
|[5: Monitor for Salt Bucket Rotations for Your Stored Raw UID2s](#5-monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s)| Any of the following options:<ul><li><strong>Python SDK</strong>: see <Linkhref="../sdks/sdk-ref-python">SDK for Python Reference Guide</Link></li><li><strong>Snowflake</strong>: see <Linkhref="snowflake_integration">Snowflake Integration Guide</Link>, section titled <Linkhref="snowflake_integration#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s">Monitor for Salt Bucket Rotation and Regenerate Raw UID2s</Link></li><li><strong>Raw HTTP endpoint</strong>: <Linkhref="../endpoints/post-identity-buckets">POST /identity/buckets</Link></li></ul> |
60
-
|[6: Monitor for opt-out status](#6-monitor-for-opt-out-status)| API call to the [POST /optout/status](../endpoints/post-optout-status.md) endpoint. |
56
+
|[6: Monitor for Opt-Out Status](#6-monitor-for-opt-out-status)| API call to the [POST /optout/status](../endpoints/post-optout-status.md) endpoint. |
61
57
62
58
## Integration Diagram
63
59
@@ -134,7 +130,7 @@ For instructions for monitoring for salt bucket rotations, refer to one of the f
134
130
135
131
- Snowflake: [Monitor for Salt Bucket Rotation and Regenerate Raw UID2s](snowflake_integration.md#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s).
136
132
137
-
- HTTP endpoints: [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s](integration-advertiser-dataprovider-endpoints.md#5-monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s).
133
+
- HTTP endpoints: [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s](integration-advertiser-dataprovider-endpoints.md#5-monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s).
138
134
139
135
:::note
140
136
For AWS Entity Resolution, there is no way to do salt bucket monitoring. As an alternative, you could regenerate raw UID2s periodically using the AWS Entity Resolution service.
0 commit comments