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
+28-30Lines changed: 28 additions & 30 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 advertisting ID may be refreshed, or view the previous advertising ID for advertising IDs that are 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
@@ -32,7 +32,7 @@ Here's what you need to know:
32
32
33
33
## Request Format
34
34
35
-
`POST '{environment}/v2/identity/map'`
35
+
`POST '{environment}/v3/identity/map'`
36
36
37
37
For authentication details, see [Authentication and Authorization](../getting-started/gs-auth.md).
38
38
@@ -56,19 +56,20 @@ The integration environment and the production environment require different <Li
56
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.
57
57
:::
58
58
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. |
65
65
66
66
#### DII Object
67
-
Each DII i.e. email address, email hash, phone or phone hash is input as a DII object.
68
67
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
72
73
73
74
### Request Examples
74
75
@@ -115,6 +116,7 @@ The response is encrypted only if the HTTP status code is 200. Otherwise, the re
115
116
:::
116
117
117
118
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".
118
120
119
121
```json
120
122
{
@@ -129,7 +131,9 @@ A successful decrypted response returns the raw UID2s for the specified email ad
@@ -139,34 +143,28 @@ A successful decrypted response returns the raw UID2s for the specified email ad
139
143
}
140
144
```
141
145
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".
143
146
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
-
```
158
147
159
148
### Response Body Properties
160
149
161
-
For successfully mapped DIIs, the response body includes the properties shown in the following table.
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. |
156
+
157
+
#### Mapped DII Objects
158
+
159
+
For successfully mapped DIIs, the mapped object includes the properties shown in the following table.
0 commit comments