Skip to content

Commit 4ed42b2

Browse files
Update
1 parent 6ba50ad commit 4ed42b2

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
22
title: POST /identity/map
3-
description: Maps DII to raw UID2s.
3+
description: Maps DII to UID2s.
44
hide_table_of_contents: false
55
sidebar_position: 08
6+
displayed_sidebar: docs
67
---
78

89
import Link from '@docusaurus/Link';
910

1011
# POST /identity/map (v3)
1112

12-
Maps multiple email addresses, phone numbers, or their respective hashes to their raw 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.
13+
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.
1314

1415
Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md).
1516

@@ -19,7 +20,7 @@ For details about the UID2 opt-out workflow and how users can opt out, see [User
1920

2021
This documentation is for the latest version of this endpoint.
2122

22-
If needed, documentation is also available for the previous version, v2: see [POST /identity/map (v2)](post-identity-map-v2.md).
23+
If needed, documentation is also available for the earlier version 2 of this endpoint, see: [POST /identity/map (v2)](post-identity-map-v2.md).
2324

2425
## Batch Size and Request Parallelization Requirements
2526

@@ -28,7 +29,7 @@ Here's what you need to know:
2829
- The maximum request size is 1MB.
2930
- To map a large number of email addresses, phone numbers, or their respective hashes, send them in *sequential* batches with a maximum batch size of 5,000 items per batch.
3031
- Unless you are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>, do not send batches in parallel. In other words, use a single HTTP connection and send batches of hashed or unhashed <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> values consecutively, without creating multiple parallel connections.
31-
- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.<br/>Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of raw UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).
32+
- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.<br/>Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).
3233

3334
## Request Format
3435

@@ -108,9 +109,9 @@ For details, and code examples in different programming languages, see [Encrypti
108109
The response is encrypted only if the HTTP status code is 200. Otherwise, the response is not encrypted.
109110
:::
110111

111-
A successful decrypted response returns the raw UID2s for the specified email addresses, phone numbers, or their respective hashes. The sequence in the response matches the sequence in the request.
112+
A successful decrypted response returns the UID2s for the specified email addresses, phone numbers, or their respective hashes. The sequence in the response matches the sequence in the request.
112113

113-
Identifiers that cannot be mapped to a raw UID2 are mapped to an error object with the reason for unsuccessful mapping. An unsuccessful mapping occurs if the identifier is considered invalid or if the identifier has opted out from the UID2 ecosystem. In these cases, the response status is still "success".
114+
Identifiers that cannot be mapped to a UID2 are mapped to an error object with the reason for unsuccessful mapping. An unsuccessful mapping occurs if the identifier is considered invalid or if the identifier has opted out from the UID2 ecosystem. In these cases, the response status is still "success".
114115

115116
```json
116117
{
@@ -153,15 +154,15 @@ For successfully mapped DII, the mapped object includes the properties shown in
153154

154155
| Property | Data Type | Description |
155156
|:---------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------|
156-
| `u` | string | The raw UID2 of the DII provided in the request. |
157-
| `p` | string | The previous raw UID2 if the current ID has been refreshed in the last 90 days. `Null` if the current ID is older than 90 days. |
158-
| `r` | number | The Unix timestamp (in milliseconds) that indicates when the raw UID2 can be refreshed. |
157+
| `u` | string | The UID2 of the DII provided in the request. |
158+
| `p` | string | The previous UID2 if the current UID2 has been rotated in the last 90 days. `Null` if the current UID2 is older than 90 days. |
159+
| `r` | number | The Unix timestamp (in milliseconds) that indicates when the UID2 can be refreshed. |
159160

160161
For unsuccessfully mapped DII, the mapped object includes the properties shown in the following table.
161162

162163
| Property | Data Type | Description |
163164
|:---------|:----------|:-----------------------------------------------------------------------------------------------------------------|
164-
| `e` | string | The reason for being unable to map the DII to an raw UID2. Either one of "optout" or "invalid identifier". |
165+
| `e` | string | The reason for being unable to map the DII to a UID2. Either one of "optout" or "invalid identifier". |
165166

166167
### Response Status Codes
167168

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: POST /identity/map
33
description: Maps DII to raw UID2s.
44
hide_table_of_contents: false
55
sidebar_position: 08
6+
displayed_sidebar: docs
67
---
78

89
import Link from '@docusaurus/Link';

0 commit comments

Comments
 (0)