Skip to content

Commit 18af9b1

Browse files
Revert (v3)
1 parent 774cbcd commit 18af9b1

10 files changed

Lines changed: 16 additions & 16 deletions

File tree

docs/endpoints/post-identity-map-v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For details about the UID2 opt-out workflow and how users can opt out, see [User
1717

1818
## Version
1919

20-
This documentation is for earlier version 2 of this endpoint. For documentation for the latest version 3 of this endpoint, see: [POST /identity/map (v3)](post-identity-map-v3.md).
20+
This documentation is for earlier version 2 of this endpoint. For documentation for the latest version 3 of this endpoint, see: [POST /identity/map](post-identity-map.md).
2121

2222
## Batch Size and Request Parallelization Requirements
2323

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: POST /identity/map (v3)
2+
title: POST /identity/map
33
description: Maps DII to UID2s.
44
hide_table_of_contents: false
55
sidebar_position: 08
@@ -8,7 +8,7 @@ displayed_sidebar: docs
88

99
import Link from '@docusaurus/Link';
1010

11-
# POST /identity/map (v3)
11+
# POST /identity/map
1212

1313
Maps multiple email addresses, phone numbers, or their respective hashes to their UID2s. You can also use this endpoint to check for updates to opt-out information, check when a UID2 can be refreshed, or view the previous UID2 if the current UID2 is less than 90 days old.
1414

docs/endpoints/summary-endpoints.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Calling the /identity/buckets endpoint is no longer necessary when calling the l
3434

3535
| Endpoint | Description | Request Encryption | Response Decryption |
3636
| :--- | :--- | :--- | :--- |
37-
| [POST /identity/map (v3)](post-identity-map-v3.md) | Maps UID2s, previous UID2s and refresh timestamps for one or more email addresses, phone numbers, or their respective hashes. | Required | Required |
37+
| [POST /identity/map](post-identity-map.md) | Maps UID2s, previous UID2s and refresh timestamps for one or more email addresses, phone numbers, or their respective hashes. | Required | Required |
3838

3939
### Earlier V2 Identity Map Endpoints
4040

docs/getting-started/gs-credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Each UID2 <a href="../overviews/participants-overview#uid2-external-participants
2222
If you're using the integration <Link href="../ref-info/glossary-uid#gl-environment">environment</Link> as well as the production environment, you'll get a separate set of credentials for each environment. See [Getting Your Credentials](#getting-your-credentials).
2323

2424
In addition, in some cases, we recommend, but do not require, that you have a different set of credentials for a different scenario. For example:
25-
- If you're a publisher who generates UID2 tokens (via [POST /token/generate](../endpoints/post-token-generate.md) or in some other way), but you also create/map raw UID2s on your own behalf (see [POST /identity/map (v3)](../endpoints/post-identity-map-v3.md)), you might have separate credentials for each of these activities.
25+
- If you're a publisher who generates UID2 tokens (via [POST /token/generate](../endpoints/post-token-generate.md) or in some other way), but you also create/map raw UID2s on your own behalf (see [POST /identity/map)](../endpoints/post-identity-map.md)), you might have separate credentials for each of these activities.
2626
- If you're an advertiser, in a scenario where you allow multiple service providers to operate using your advertiser keys, you might choose to have separate credentials for each service provider.
2727

2828
## Getting Your Credentials

docs/getting-started/gs-faqs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Yes. Through the [Transparency and Control Portal](https://www.transparentadvert
3838

3939
No. None of the components of the <Link href="../ref-info/glossary-uid#gl-uid2-service">UID2 service</Link> store any DII.
4040

41-
In addition, in almost all cases, UID2 doesn't store any values at all once the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md), [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md), or [POST&nbsp;/identity/map (v3)](../endpoints/post-identity-map-v3.md) call is complete. A necessary exception is the case where a user has opted out. In this scenario, UID2 stores a hashed, opaque value to indicate the opted-out user. The stored value cannot be reverse engineered back to the original value of the DII, but can be used to identify future requests for a UID2 generated from the same DII, which are therefore denied.
41+
In addition, in almost all cases, UID2 doesn't store any values at all once the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md), [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md), or [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) call is complete. A necessary exception is the case where a user has opted out. In this scenario, UID2 stores a hashed, opaque value to indicate the opted-out user. The stored value cannot be reverse engineered back to the original value of the DII, but can be used to identify future requests for a UID2 generated from the same DII, which are therefore denied.
4242

4343
#### Does UID2 allow the processing of HIPAA-regulated data?
4444

@@ -203,23 +203,23 @@ Unless you are using a <Link href="../ref-info/glossary-uid#gl-private-operator"
203203

204204
#### How should I handle user opt-outs?
205205

206-
When a user opts out of UID2-based targeted advertising through the [Transparency and Control Portal](https://www.transparentadvertising.com/), the opt-out signal is sent to DSPs and publishers, who handle opt-outs at bid time. We recommend that advertisers and data providers regularly check whether a user has opted out, via the [POST /identity/map (v3)](../endpoints/post-identity-map-v3.md) endpoint.
206+
When a user opts out of UID2-based targeted advertising through the [Transparency and Control Portal](https://www.transparentadvertising.com/), the opt-out signal is sent to DSPs and publishers, who handle opt-outs at bid time. We recommend that advertisers and data providers regularly check whether a user has opted out, via the [POST /identity/map](../endpoints/post-identity-map.md) endpoint.
207207

208208
Advertisers and data providers can also check the opt-out status of raw UID2s using the [POST&nbsp;/optout/status](../endpoints/post-optout-status.md) endpoint.
209209

210210
If a user opts out through your website, you should follow your internal procedures for handling the opt-out. For example, you might choose not to generate a UID2 for that user.
211211

212212
#### Does the same DII always result in the same raw UID2?
213213

214-
In general yes, the process of generating a raw UID2 from DII is the same, and results in the same value, no matter who sent the request. If two UID2 participants were to send the same email address to the [POST&nbsp;/identity/map (v3)](../endpoints/post-identity-map-v3.md) endpoint at the same time, they would both get the same raw UID2 in response.
214+
In general yes, the process of generating a raw UID2 from DII is the same, and results in the same value, no matter who sent the request. If two UID2 participants were to send the same email address to the [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) endpoint at the same time, they would both get the same raw UID2 in response.
215215

216216
However, there is a variable factor, which is the secret <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.
217217

218218
For more information, see [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s](../guides/integration-advertiser-dataprovider-overview.md#5-monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s) in the *Advertiser/Data Provider Integration Guide*.
219219

220220
#### If two operators process the same DII, are the results the same?
221221

222-
Yes, if the request is for a <Link href="../ref-info/glossary-uid#gl-raw-uid2">raw UID2</Link>. As covered in the previous FAQ, [Does the same DII always result in the same raw UID2?](#does-the-same-dii-always-result-in-the-same-raw-uid2), if an advertiser or data provider sends the same DII to the UID2 Operator, by using an SDK or the [POST&nbsp;/identity/map (v3)](../endpoints/post-identity-map-v3.md) endpoint, at the same time, the same raw UID2 is created.
222+
Yes, if the request is for a <Link href="../ref-info/glossary-uid#gl-raw-uid2">raw UID2</Link>. As covered in the previous FAQ, [Does the same DII always result in the same raw UID2?](#does-the-same-dii-always-result-in-the-same-raw-uid2), if an advertiser or data provider sends the same DII to the UID2 Operator, by using an SDK or the [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) endpoint, at the same time, the same raw UID2 is created.
223223

224224
The result is the same, regardless of the <Link href="../ref-info/glossary-uid#gl-operator">Operator</Link> and whether it's a Private Operator or a Public Operator.
225225

docs/getting-started/gs-opt-out.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The following steps provide a high-level outline of the opt-out workflow intende
4949
| :--- | :--- |
5050
| Publishers | A publisher calling [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) with the required `optout_check` parameter set to `1`, or [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md), receives the opt-out response instead of the UID2 token. |
5151
| DSPs | The UID2 Operator Service distributes information on all opted-out users to DSPs via a webhook provided for the purpose. For details, see [Honor User Opt-Outs](../guides/dsp-guide#honor-user-opt-outs).<br/>DSPs can also check the opt-out status of raw UID2s using the [POST&nbsp;/optout/status](../endpoints/post-optout-status.md) endpoint. |
52-
| Advertisers and data providers | The UID2 Operator Service distributes opt-out information to advertisers and data providers via the [POST&nbsp;/identity/map (v3)](../endpoints/post-identity-map-v3.md) endpoint. Another option is to check the opt-out status of raw UID2s using the [POST&nbsp;/optout/status](../endpoints/post-optout-status.md) endpoint. |
52+
| Advertisers and data providers | The UID2 Operator Service distributes opt-out information to advertisers and data providers via the [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) endpoint. Another option is to check the opt-out status of raw UID2s using the [POST&nbsp;/optout/status](../endpoints/post-optout-status.md) endpoint. |
5353
| Sharers | UID2 sharers can check the opt-out status of raw UID2s using the [POST&nbsp;/optout/status](../endpoints/post-optout-status.md) endpoint. |
5454

5555
This workflow allows users to opt out of personalized advertising based on their UID2 through the Transparency and Control Portal.

docs/getting-started/gs-permissions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ The following table lists the key permissions, the types of participants that co
2626
| Generator | Publishers | Permission to call the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md), [POST&nbsp;/token/validate](../endpoints/post-token-validate.md), and [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) endpoints, to generate UID2 tokens from <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> and to refresh them, using one of these integration methods:<ul><li>A Prebid integration</li><li>The SDK for JavaScript</li><li>An integration that directly calls the applicable API endpoints for retrieving and managing UID2 tokens.</li></ul> |
2727
| Bidder | DSPs | Permission to decrypt UID2 tokens coming in from the <Link href="../ref-info/glossary-uid#gl-bidstream">bidstream</Link> from publishers into raw UID2s for bidding purposes. |
2828
| Sharer | Any participant type that takes part in UID2 sharing. For details, see [UID2 Sharing: Overview](../sharing/sharing-overview.md). | Permission to do both of the following:<ul><li>Encrypt raw UID2s into UID2 tokens for sharing with another authorized sharing participant, using a UID2 SDK or Snowflake</li><li>Decrypt UID2 tokens received from another authorized sharing participant into raw UID2s.</li></ul> |
29-
| Mapper | Advertisers<br/>Data Providers | Permission to call the [POST&nbsp;/identity/map (v3)](../endpoints/post-identity-map-v3.md) endpoint to map multiple email addresses, phone numbers, or their respective hashes to their raw UID2s, previous raw UID2s and refresh timestamps. Permission to use the earlier V2 Identity Map [POST&nbsp;/identity/map (v2)](../endpoints/post-identity-map-v2.md) and [POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md) endpoints as well. |
29+
| Mapper | Advertisers<br/>Data Providers | Permission to call the [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) endpoint to map multiple email addresses, phone numbers, or their respective hashes to their raw UID2s, previous raw UID2s and refresh timestamps. Permission to use the earlier V2 Identity Map [POST&nbsp;/identity/map (v2)](../endpoints/post-identity-map-v2.md) and [POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md) endpoints as well. |

docs/sdks/summary-sdks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The following table summarizes the functionality available with each SDK.
2828
|Android | Client&nbsp;(Mobile) | &#8212; | &#8212; | &#9989; | &#9989; | &#8212; | &#8212; |
2929
|iOS | Client (Mobile) | &#8212; | &#8212; | &#9989;| &#9989; |&#8212; | &#8212; |
3030

31-
&ast;Advertisers and Data Providers who need to generate raw UID2s from DII can also do this via Snowflake (see [Snowflake Integration Guide](../guides/integration-snowflake.md)) or by using the [POST&nbsp;/identity/map (v3)](../endpoints/post-identity-map-v3.md) endpoint.
31+
&ast;Advertisers and Data Providers who need to generate raw UID2s from DII can also do this via Snowflake (see [Snowflake Integration Guide](../guides/integration-snowflake.md)) or by using the [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) endpoint.
3232

3333
<!-- &#9989; = Supported | &#8212; = Not Supported -->
3434

i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map-v3.md renamed to i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: POST /identity/map (v3)
2+
title: POST /identity/map
33
description: Maps DII to UID2s.
44
hide_table_of_contents: false
55
sidebar_position: 08

sidebars.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -322,10 +322,10 @@ const fullSidebar = [
322322
'endpoints/post-identity-buckets',
323323
{
324324
type: 'category',
325-
label: 'POST /identity/map (v3)',
325+
label: 'POST /identity/map',
326326
link: {
327327
type: 'doc',
328-
id: 'endpoints/post-identity-map-v3',
328+
id: 'endpoints/post-identity-map',
329329
},
330330
collapsed: true,
331331
items: [
@@ -409,7 +409,7 @@ const sidebars = {
409409
'DSP Integrations',
410410
'guides/dsp-guide',
411411
'endpoints/post-identity-buckets',
412-
'endpoints/post-identity-map-v3',
412+
'endpoints/post-identity-map',
413413
'endpoints/post-identity-map-v2',
414414
'endpoints/post-optout-status'
415415
),

0 commit comments

Comments
 (0)