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/endpoints/post-identity-map.md
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ import Link from '@docusaurus/Link';
9
9
10
10
# POST /identity/map
11
11
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 an advertisting ID may be refreshed, or view the previous advertising ID for advertising IDs that are less than 90 days old.
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 an advertising ID can be refreshed, or view the previous advertising ID if the current one is less than 90 days old.
13
13
14
14
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).
15
15
@@ -53,22 +53,22 @@ The integration environment and the production environment require different <Li
53
53
### Unencrypted JSON Body Parameters
54
54
55
55
:::important
56
-
You can include one or more of the following four parameters as a key-value pair in the JSON body of the request when encrypting it.
56
+
You can include one or more of the following four parameters as key-value pairs in the JSON body of the request when encrypting it.
57
57
:::
58
58
59
-
| Body Parameter | Data Type | Attribute | Description |
60
-
|:---|:---------------------|:---| :--- |
61
-
|`email`| array of DII objects | Conditionally Required | The list of email addresses to be mapped. |
62
-
|`email_hash`| array of DII objects | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email addresses to be mapped. |
63
-
|`phone`| array of DII objects | Conditionally Required | The list of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. |
64
-
|`phone_hash`| array of DII objects | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. |
59
+
| Body Parameter | Data Type | Attribute | Description |
|`email`| array of DII objects | Conditionally Required | The list of email addresses to be mapped. |
62
+
|`email_hash`| array of DII objects | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email addresses to be mapped. |
63
+
|`phone`| array of DII objects | Conditionally Required | The list of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. |
64
+
|`phone_hash`| array of DII objects | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. |
65
65
66
66
67
-
Each DII i.e. email address, email hash, phone or phone hash, is input as a DII object.
67
+
Each email address, email hash, phone, or phone hash is input as a DII object.
68
68
69
-
| Parameter | Data Type | Attribute | Description |
70
-
|:----------|:----|:----|:------------|
71
-
| `i` | string | Required | The email address, email hash, phone or phone hash
69
+
| Parameter | Data Type | Attribute | Description |
|`i`| string | Required | The email address, email hash, phone, or phone hash.|
72
72
73
73
### Request Examples
74
74
@@ -114,9 +114,9 @@ For details, and code examples in different programming languages, see [Encrypti
114
114
The response is encrypted only if the HTTP status code is 200. Otherwise, the response is not encrypted.
115
115
:::
116
116
117
-
A successful decrypted response returns the raw UID2s for the specified email addresses, phone numbers, or their respective hashesin the same array order that was given.
117
+
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.
118
118
119
-
Identifiers that cannot be mapped to an advertising ID are mapped to an error object with the reason for unsuccessful mapping. An unsuccessful mapping will occur 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".
119
+
Identifiers that cannot be mapped to an advertising ID 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".
120
120
121
121
```json
122
122
{
@@ -147,26 +147,26 @@ Identifiers that cannot be mapped to an advertising ID are mapped to an error ob
147
147
148
148
### Response Body Properties
149
149
150
-
| Body Parameter | Data Type | Attribute | Description |
|`email`| array of mapped DII objects | Conditionally Required | The list of mapped DII objects corresponding to the list of given emails. |
153
-
|`email_hash`| array of mapped DII objects | Conditionally Required | The list of mapped DII objects corresponding to the list of given email hashes. |
154
-
|`phone`| array of mapped DII objects | Conditionally Required | The list of mapped DII objects corresponding to the list of given phone numbers. |
155
-
|`phone_hash`| array of mapped DII objects | Conditionally Required | The list of mapped DII objects corresponding to the list of given phone number hashes. |
150
+
| Body Parameter | Data Type | Attribute | Description|
|`email`| array of mapped DII objects | Conditionally Required | The list of mapped DII objects corresponding to the list of emails in the request.|
153
+
|`email_hash`| array of mapped DII objects | Conditionally Required | The list of mapped DII objects corresponding to the list of email hashes in the request. |
154
+
|`phone`| array of mapped DII objects | Conditionally Required | The list of mapped DII objects corresponding to the list of phone numbers in the request. |
155
+
|`phone_hash`| array of mapped DII objects | Conditionally Required | The list of mapped DII objects corresponding to the list of phone number hashes in the request. |
156
156
157
157
158
-
For successfully mapped DIIs, the mapped object includes the properties shown in the following table.
158
+
For successfully mapped DII, the mapped object includes the properties shown in the following table.
0 commit comments