Skip to content

Commit e1146d6

Browse files
added more detail on response properties
1 parent c7899f4 commit e1146d6

File tree

1 file changed

+28
-30
lines changed

1 file changed

+28
-30
lines changed

docs/endpoints/post-identity-map.md

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Link from '@docusaurus/Link';
99

1010
# POST /identity/map
1111

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 advertisting ID may be refreshed, or view the previous advertising ID for advertising IDs that are less than 90 days old.
1313

1414
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).
1515

@@ -32,7 +32,7 @@ Here's what you need to know:
3232

3333
## Request Format
3434

35-
`POST '{environment}/v2/identity/map'`
35+
`POST '{environment}/v3/identity/map'`
3636

3737
For authentication details, see [Authentication and Authorization](../getting-started/gs-auth.md).
3838

@@ -56,19 +56,20 @@ The integration environment and the production environment require different <Li
5656
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.
5757
:::
5858

59-
| Body Parameter | Data Type | Attribute | Description |
60-
| :--- |:-----------------| :--- | :--- |
61-
| `email` | DII object array | Conditionally Required | The list of email addresses to be mapped. |
62-
| `email_hash` | DII object array | 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` | DII object array | Conditionally Required | The list of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. |
64-
| `phone_hash` | DII object array | 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 |
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. |
6565

6666
#### DII Object
67-
Each DII i.e. email address, email hash, phone or phone hash is input as a DII object.
6867

69-
| DII Object Parameter | Data Type | Attribute | Description |
70-
| :--- | :---- | :---- |:------------|
71-
| `i` | string | Required | The DII input i.e. email address, email hash, phone or phone hash
68+
Each DII i.e. email address, email hash, phone or phone hash, is input as a DII object.
69+
70+
| Parameter | Data Type | Attribute | Description |
71+
|:----------| :---- | :---- |:------------|
72+
| `i` | string | Required | The email address, email hash, phone or phone hash
7273

7374
### Request Examples
7475

@@ -115,6 +116,7 @@ The response is encrypted only if the HTTP status code is 200. Otherwise, the re
115116
:::
116117

117118
A successful decrypted response returns the raw UID2s for the specified email addresses, phone numbers, or their respective hashes in the same array order that was given.
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".
118120

119121
```json
120122
{
@@ -129,7 +131,9 @@ A successful decrypted response returns the raw UID2s for the specified email ad
129131
"u": "IbW4n6LIvtDj/8fCESlU0QG9K/fH63UdcTkJpAG8fIQ=",
130132
"p": null,
131133
"r": 1735862400000
132-
}
134+
},
135+
{ "e": "invalid identifier" },
136+
{ "e": "optout" }
133137
],
134138
"email_hash": [],
135139
"phone": [],
@@ -139,34 +143,28 @@ A successful decrypted response returns the raw UID2s for the specified email ad
139143
}
140144
```
141145

142-
Identifiers that cannot be mapped to an advertising ID are mapped to an error object with the reason for unsuccessful mapping. This 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".
143146

144-
```json
145-
{
146-
"body":{
147-
"email": [
148-
{ "e": "invalid identifier" },
149-
{ "e": "optout" }
150-
],
151-
"email_hash": [],
152-
"phone": [],
153-
"phone_hash": []
154-
},
155-
"status":"success"
156-
}
157-
```
158147

159148
### Response Body Properties
160149

161-
For successfully mapped DIIs, the response body includes the properties shown in the following table.
150+
| Body Parameter | Data Type | Attribute | Description |
151+
| :--- |:----------------------------| :--- |:-------------------------------------------------------------------------------------------|
152+
| `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. |
156+
157+
#### Mapped DII Objects
158+
159+
For successfully mapped DIIs, the mapped object includes the properties shown in the following table.
162160

163161
| Property | Data Type | Description |
164162
|:---------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------|
165163
| `u` | string | The advertising ID (raw UID2) of the DII given in the request. |
166164
| `p` | string | The previous advertising ID if the current ID has been refreshed in the last 90 days. `Null` if the current ID is older than 90 days. |
167165
| `r` | number | The Unix timestamp (in milliseconds) that indicates when the advertising ID may be refreshed. |
168166

169-
For unsuccessfully mapped DIIs, the response body includes the properties shown in the following table.
167+
For unsuccessfully mapped DIIs, the mapped object includes the properties shown in the following table.
170168

171169
| Property | Data Type | Description |
172170
|:---------|:----------|:-----------------------------------------------------------------------------------------------|

0 commit comments

Comments
 (0)