Skip to content

Commit f4596ac

Browse files
genwhittTTDgenwhittTTD
authored
Merge pull request #1044 from IABTechLab/gwh-APIDOCS-3988-table-headers-sentence-case-uid2
gwh-APIDOCS-3988-table-headers-sentence-case-uid2
2 parents 05877c5 + bf5a416 commit f4596ac

76 files changed

Lines changed: 226 additions & 226 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/endpoints/post-identity-buckets.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You must encrypt all requests using your secret. For details, and code examples
3131

3232
### Path parameters
3333

34-
| Path Parameter | Data Type | Attribute | Description |
34+
| Path parameter | Data type | Attribute | Description |
3535
| :--- | :--- | :--- | :--- |
3636
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
3737

@@ -45,7 +45,7 @@ The integration environment and the production environment require different <Li
4545
You must include the following parameter as a key-value pair in the JSON body of a request when encrypting it.
4646
:::
4747

48-
| Body Parameter | Data Type | Attribute | Description | Format |
48+
| Body parameter | Data type | Attribute | Description | Format |
4949
| :--- | :--- | :--- | :--- | :--- |
5050
| `since_timestamp` | date-time or integer | Required | Specify the date and time to which to compare the last updated UTC timestamps of the buckets to be returned. | ISO 8601 format:<br/>`YYYY-MM-DDThh:mm:ss` |
5151

@@ -106,7 +106,7 @@ The response body includes the properties shown in the following table.
106106

107107
The following table lists the `status` property values and their HTTP status code equivalents.
108108

109-
| Status | HTTP Status Code | Description |
109+
| Status | HTTP status code | Description |
110110
| :--- | :--- | :--- |
111111
| `success` | 200 | The request was successful. The response will be encrypted. |
112112
| `client_error` | 400 | The request had missing or invalid parameters. |

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You must encrypt all requests using your secret. For details, and code examples
4848

4949
### Path parameters
5050

51-
| Path Parameter | Data Type | Attribute | Description |
51+
| Path parameter | Data type | Attribute | Description |
5252
| :--- | :--- | :--- | :--- |
5353
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
5454

@@ -62,7 +62,7 @@ The integration environment and the production environment require different <Li
6262
You must include only **one** of the following four conditional parameters as a key-value pair in the JSON body of the request when encrypting it.
6363
:::
6464

65-
| Body Parameter | Data Type | Attribute | Description |
65+
| Body parameter | Data type | Attribute | Description |
6666
| :--- | :--- | :--- | :--- |
6767
| `email` | string array | Conditionally Required | The list of email addresses to be mapped. |
6868
| `email_hash` | string 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. |
@@ -192,7 +192,7 @@ If some identifiers have opted out from the UID2 ecosystem, the opted-out identi
192192

193193
The response body includes the properties shown in the following table.
194194

195-
| Property | Data Type | Description |
195+
| Property | Data type | Description |
196196
| :--- | :--- | :--- |
197197
| `identifier` | string | The email address, phone number, or respective hash specified in the request body. |
198198
| `advertising_id` | string | The corresponding advertising ID (raw UID2). |
@@ -202,7 +202,7 @@ The response body includes the properties shown in the following table.
202202

203203
The following table lists the `status` property values and their HTTP status code equivalents.
204204

205-
| Status | HTTP Status Code | Description |
205+
| Status | HTTP status code | Description |
206206
| :--- | :--- | :--- |
207207
| `success` | 200 | The request was successful. The response will be encrypted. |
208208
| `client_error` | 400 | The request had missing or invalid parameters.|

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You must encrypt all requests using your secret. For details, and code examples
4848

4949
### Path parameters
5050

51-
| Path Parameter | Data Type | Attribute | Description |
51+
| Path parameter | Data type | Attribute | Description |
5252
| :--- | :--- | :--- | :--- |
5353
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
5454

@@ -62,7 +62,7 @@ The integration environment and the production environment require different <Li
6262
Include one or more of the following four parameters as key-value pairs in the JSON body of the request when encrypting it.
6363
:::
6464

65-
| Body Parameter | Data Type | Attribute | Description |
65+
| Body parameter | Data type | Attribute | Description |
6666
|:---------------|:----------------------------|:-----------------------| :--- |
6767
| `email` | string array | Conditionally Required | The list of email addresses to be mapped. |
6868
| `email_hash` | string 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. |
@@ -166,7 +166,7 @@ Response:
166166

167167
The response body includes one or more of the properties shown in the following table.
168168

169-
| Body Parameter | Data Type | Description |
169+
| Body parameter | Data type | Description |
170170
|:---------------|:----------------------------|:------------------------------------------------------------------------------------------------|
171171
| `email` | array of mapped DII objects | The list of mapped DII objects corresponding to the list of emails in the request. |
172172
| `email_hash` | array of mapped DII objects | The list of mapped DII objects corresponding to the list of email hashes in the request. |
@@ -176,7 +176,7 @@ The response body includes one or more of the properties shown in the following
176176

177177
For successfully mapped DII, the mapped object includes the properties shown in the following table.
178178

179-
| Property | Data Type | Description |
179+
| Property | Data type | Description |
180180
|:---------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------|
181181
| `u` | string | The raw UID2 corresponding to the email or phone number provided in the request. |
182182
| `p` | string | One of the following:<ul><li>If the current raw UID2 was rotated in the last 90 days: the previous raw UID2.</li><li>Otherwise: `null`.</li></ul> |
@@ -188,15 +188,15 @@ The raw UID2 does not change before the refresh timestamp. After the refresh tim
188188

189189
For unsuccessfully mapped input values, the mapped object includes the properties shown in the following table.
190190

191-
| Property | Data Type | Description |
191+
| Property | Data type | Description |
192192
|:---------|:----------|:-----------------------------------------------------------------------------------------------------------------|
193193
| `e` | string | The reason for being unable to map the DII to a raw UID2. One of two possible values:<ul><li>`optout`</li><li>`invalid identifier`</li></ul> |
194194

195195
### Response status codes
196196

197197
The following table lists the `status` property values and their HTTP status code equivalents.
198198

199-
| Status | HTTP Status Code | Description |
199+
| Status | HTTP status code | Description |
200200
| :--- | :--- | :--- |
201201
| `success` | 200 | The request was successful. The response will be encrypted. |
202202
| `client_error` | 400 | The request had missing or invalid parameters. |
@@ -226,12 +226,12 @@ The following sections provide general information and guidance for migrating to
226226

227227
The following table shows key differences between the versions.
228228

229-
| Feature | v2 Implementation | v3 Implementation |
229+
| Feature | v2 implementation | v3 implementation |
230230
|:-------------------------------|:--------------------------------------------|:-------------------------------------------|
231-
| Endpoints Required | `/v2/identity/map` + `/v2/identity/buckets` | `/v3/identity/map` only |
232-
| Identity Types per Request | Single identity type only | Multiple identity types |
233-
| Refresh Management | Monitor salt bucket rotations via `/identity/buckets` endpoint | Re-map when past `refresh_from` timestamps |
234-
| Previous UID2 Access | Not available | Available for 90 days |
231+
| Endpoints required | `/v2/identity/map` + `/v2/identity/buckets` | `/v3/identity/map` only |
232+
| Identity types per request | Single identity type only | Multiple identity types |
233+
| Refresh management | Monitor salt bucket rotations via `/identity/buckets` endpoint | Re-map when past `refresh_from` timestamps |
234+
| Previous UID2 access | Not available | Available for 90 days |
235235

236236
### Required changes
237237

‎docs/endpoints/post-optout-status.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ You must encrypt all requests using your secret. For details, and code examples
3838

3939
### Path parameters
4040

41-
| Path Parameter | Data Type | Attribute | Description |
41+
| Path parameter | Data type | Attribute | Description |
4242
| :--- | :--- | :--- | :--- |
4343
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
4444

@@ -50,7 +50,7 @@ The integration environment and the production environment require different <Li
5050

5151
There is a single body parameter.
5252

53-
| Body Parameter | Data Type | Attribute | Description |
53+
| Body parameter | Data type | Attribute | Description |
5454
| :--- | :--- | :--- | :--- |
5555
| `advertising_ids` | string array | Required | The list of raw UID2s for which you want to check the opt-out status.<br/>Include a maximum of 5,000 entries in one API call. |
5656

@@ -115,7 +115,7 @@ The response body includes the following properties.
115115

116116
The following table lists the status property values and their HTTP status code equivalents.
117117

118-
| Status | HTTP Status Code | Description |
118+
| Status | HTTP status code | Description |
119119
| :--- | :--- | :--- |
120120
| `success` | 200 | The request was successful. The response will be encrypted. |
121121
| `client_error` | 400 | The request had missing or invalid parameters. |

‎docs/endpoints/post-token-generate.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Here's what you need to know about sending requests to this endpoint:
3434

3535
### Path parameters
3636

37-
| Path Parameter | Data Type | Attribute | Description |
37+
| Path parameter | Data type | Attribute | Description |
3838
| :--- | :--- | :--- | :--- |
3939
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md).<br/>Notes:<ul><li>The `integ` environment and the `prod` environment require different <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link>.</li><li>Token expiration time is subject to change, but is always significantly shorter in the `integ` environment than it is in the `prod` environment.</li></ul> |
4040

@@ -44,7 +44,7 @@ Here's what you need to know about sending requests to this endpoint:
4444
You must include only **one** of the following four conditional parameters as key-value pairs in the JSON body of the request when encrypting it.
4545
:::
4646

47-
| Body Parameter | Data Type | Attribute | Description |
47+
| Body parameter | Data type | Attribute | Description |
4848
| :--- | :--- | :--- | :--- |
4949
| `email` | string | Conditionally Required | The email address for which to generate tokens. |
5050
| `email_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) hash of a [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email address. |
@@ -118,7 +118,7 @@ Here is an example response when the user has opted out.
118118

119119
The response body includes the properties shown in the following table.
120120

121-
| Property | Data Type | Description |
121+
| Property | Data type | Description |
122122
| :--- | :--- | :--- |
123123
| `advertising_token` | string | An encrypted advertising (UID2) token for the user. |
124124
| `refresh_token` | string | An encrypted token that can be exchanged with the UID2 Service for the latest set of identity tokens. |
@@ -131,7 +131,7 @@ The response body includes the properties shown in the following table.
131131

132132
The following table lists the `status` property values and their HTTP status code equivalents.
133133

134-
| Status | HTTP Status Code | Description |
134+
| Status | HTTP status code | Description |
135135
| :--- | :--- | :--- |
136136
| `success` | 200 | The request was successful. The response will be encrypted. |
137137
| `optout` | 200 | The request was successful. Could not generate token because the user has opted out. |
@@ -142,7 +142,7 @@ If the `status` value is anything other than `success`, the `message` field prov
142142

143143
## Test identities
144144

145-
| Type | Identity | Purpose | Next Endpoint |
145+
| Type | Identity | Purpose | Next endpoint |
146146
|:------|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------|
147147
| Email | `validate@example.com` | Test that the `advertising_token` you've cached matches the `advertising_token` for the specified email address. | [POST&nbsp;/token/validate](post-token-validate.md) |
148148
| Email | `optout@example.com` | Using this email for the request always generates an `optout` response. | [POST&nbsp;/token/generate](post-token-generate.md) |

‎docs/endpoints/post-token-refresh.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Here's what you need to know about this endpoint:
3535

3636
### Path parameters
3737

38-
| Path Parameter | Data Type | Attribute | Description |
38+
| Path parameter | Data type | Attribute | Description |
3939
| :--- | :--- | :--- | :--- |
4040
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md).<br/>Notes:<ul><li>The `integ` environment and the `prod` environment require different <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link>.</li><li>Token expiration time is subject to change, but is always significantly shorter in the `integ` environment than it is in the `prod` environment.</li></ul> |
4141

@@ -95,7 +95,7 @@ An error response might look like the following:
9595

9696
The response body includes the properties shown in the following table.
9797

98-
| Property | Data Type | Description |
98+
| Property | Data type | Description |
9999
| :--- | :--- | :--- |
100100
| `advertising_token` | string | The <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 token</Link> (also known as advertising token) for the user. |
101101
| `refresh_token` | string | An encrypted token that can be exchanged with the UID2 Service for the latest set of identity tokens. |
@@ -108,7 +108,7 @@ The response body includes the properties shown in the following table.
108108

109109
The following table lists the `status` property values and their HTTP status code equivalents.
110110

111-
| Status | HTTP Status Code | Description |
111+
| Status | HTTP status code | Description |
112112
| :--- | :--- | :--- |
113113
| `success` | 200 | The request was successful and a new UID2 token, with associated values, is returned in the response. The response is encrypted. |
114114
| `optout` | 200 | The user opted out. This status is returned only for authorized requests. The response is encrypted. |

‎docs/endpoints/post-token-validate.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You must encrypt all requests using your secret key. For details, and code examp
2929

3030
### Path parameters
3131

32-
| Path Parameter | Data Type | Attribute | Description |
32+
| Path parameter | Data type | Attribute | Description |
3333
| :--- | :--- | :--- | :--- |
3434
| `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
3535

@@ -44,7 +44,7 @@ Here are some key points about using this endpoint:
4444
- Include only one of the following four valid options, as listed in the Body Parameter table: `email`, `email_hash`, `phone`, or `phone_hash`.
4545
- Include the required body parameters as key-value pairs in the JSON body of the request when encrypting it.
4646

47-
| Body Parameter | Data Type | Attribute | Description |
47+
| Body parameter | Data type | Attribute | Description |
4848
| :--- | :--- | :--- | :--- |
4949
| `token` | string | Required | The advertising token returned by the [POST&nbsp;/token/generate](post-token-generate.md) response.<br/>You can only validate an advertising token that has been generated with your own credentials.
5050
| `email` | string | Conditionally Required | The email address for token validation. You can use any valid email value, normalized or not. |
@@ -112,15 +112,15 @@ A successful decrypted response returns a boolean value that indicates the valid
112112

113113
The following table provides information about the response body.
114114

115-
| Property | Data Type | Description |
115+
| Property | Data type | Description |
116116
| :--- | :--- | :--- |
117117
| `body` | boolean | A value of `true` indicates that the email address, phone number, or the respective hash specified in the request is the same as the one used to generate the advertising token.<br/>A value of `false` indicates that the email address, phone number, or the respective hash specified in the request is not the same as the one used to generated the advertising token. |
118118

119119
### Response status codes
120120

121121
The following table lists the `status` property values and their HTTP status code equivalents.
122122

123-
| Status | HTTP Status Code | Description |
123+
| Status | HTTP status code | Description |
124124
| :--- | :--- | :--- |
125125
| `success` | 200 | The request was successful. The response will be encrypted. |
126126
| `client_error` | 400 | The request had missing or invalid parameters. |

0 commit comments

Comments
 (0)