From 77dfe2b48081fb9acf79746839dc9333512e9599 Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 7 Jul 2026 09:39:38 -0400 Subject: [PATCH 1/9] gwh-APIDOCS-3988-table-headers-sentence-case-uid2 --- docs/endpoints/post-identity-buckets.md | 6 ++--- docs/endpoints/post-identity-map-v2.md | 8 +++---- docs/endpoints/post-identity-map.md | 22 ++++++++--------- docs/endpoints/post-optout-status.md | 6 ++--- docs/endpoints/post-token-generate.md | 10 ++++---- docs/endpoints/post-token-refresh.md | 6 ++--- docs/endpoints/post-token-validate.md | 8 +++---- docs/endpoints/summary-endpoints.md | 8 +++---- docs/getting-started/gs-account-setup.md | 6 ++--- docs/getting-started/gs-credentials.md | 4 ++-- .../gs-encryption-decryption.md | 8 +++---- docs/getting-started/gs-environments.md | 2 +- .../gs-normalization-encoding.md | 8 +++---- docs/getting-started/gs-opt-out.md | 2 +- docs/getting-started/gs-permissions.md | 2 +- ...ration-advertiser-dataprovider-overview.md | 4 ++-- .../integration-aws-entity-resolution.md | 8 +++---- docs/guides/integration-ctv-guide.md | 4 ++-- docs/guides/integration-databricks.md | 12 +++++----- docs/guides/integration-javascript.md | 2 +- docs/guides/integration-mobile-overview.md | 24 +++++++++---------- .../integration-options-private-operator.md | 2 +- .../integration-options-publisher-web.md | 2 +- .../integration-prebid-client-server.md | 10 ++++---- docs/guides/integration-prebid.md | 2 +- ...egration-snowflake-before-february-2025.md | 22 ++++++++--------- docs/guides/integration-snowflake-previous.md | 22 ++++++++--------- docs/guides/integration-snowflake.md | 24 +++++++++---------- docs/guides/mobile-plugin-gma-ios.md | 4 ++-- docs/guides/mobile-plugin-ima-ios.md | 4 ++-- docs/guides/operator-guide-aks-enclave.md | 2 +- docs/guides/operator-guide-aws-marketplace.md | 14 +++++------ docs/guides/operator-guide-azure-enclave.md | 6 ++--- ...operator-private-gcp-confidential-space.md | 6 ++--- docs/guides/summary-guides.md | 18 +++++++------- docs/overviews/overview-advertisers.md | 4 ++-- docs/overviews/overview-data-providers.md | 4 ++-- docs/overviews/overview-dsps.md | 2 +- docs/overviews/participants-overview.md | 6 ++--- docs/portal/audit-trail.md | 2 +- docs/portal/client-side-integration.md | 8 +++---- docs/portal/portal-getting-started.md | 2 +- docs/portal/portal-overview.md | 10 ++++---- docs/ref-info/deprecation-schedule.md | 14 +++++------ docs/ref-info/ref-how-uid-is-created.md | 2 +- ...emails-and-phone-numbers-for-processing.md | 2 +- .../ref-server-side-token-generation.md | 2 +- docs/ref-info/ref-token-validator.md | 6 ++--- docs/ref-info/ref-uid-verify.md | 12 +++++----- docs/ref-info/uid-components.md | 8 +++---- docs/ref-info/uid-identifier-types.md | 4 ++-- docs/ref-info/uid-workflows.md | 2 +- docs/ref-info/updates-doc.md | 2 +- docs/sdks/sdk-ref-android.md | 8 +++---- docs/sdks/sdk-ref-cplusplus.md | 4 ++-- docs/sdks/sdk-ref-csharp-dotnet.md | 2 +- docs/sdks/sdk-ref-ios.md | 12 +++++----- docs/sdks/sdk-ref-java.md | 6 ++--- docs/sdks/sdk-ref-javascript-v2.md | 18 +++++++------- docs/sdks/sdk-ref-javascript-v3.md | 6 ++--- docs/sdks/sdk-ref-javascript.md | 6 ++--- docs/sdks/sdk-ref-python.md | 6 ++--- docs/sdks/summary-sdks.md | 18 +++++++------- docs/sharing/sharing-overview.md | 2 +- .../sharing-tokenized-from-data-bid-stream.md | 8 +++---- .../sharing-tokenized-from-data-pixel.md | 2 +- docs/sharing/sharing-tokenized-from-raw.md | 2 +- docs/sharing/sharing-tokenized-overview.md | 14 +++++------ docs/summary-doc-v2.md | 2 +- 69 files changed, 253 insertions(+), 253 deletions(-) diff --git a/docs/endpoints/post-identity-buckets.md b/docs/endpoints/post-identity-buckets.md index bea54a6ed..42a1022cf 100644 --- a/docs/endpoints/post-identity-buckets.md +++ b/docs/endpoints/post-identity-buckets.md @@ -31,7 +31,7 @@ You must encrypt all requests using your secret. For details, and code examples ### Path parameters -| Path Parameter | Data Type | Attribute | Description | +| Path parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`
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). | @@ -45,7 +45,7 @@ The integration environment and the production environment require different
  • `YYYY-MM-DDThh:mm:ss` | @@ -106,7 +106,7 @@ The response body includes the properties shown in the following table. The following table lists the `status` property values and their HTTP status code equivalents. -| Status | HTTP Status Code | Description | +| Status | HTTP status code | Description | | :--- | :--- | :--- | | `success` | 200 | The request was successful. The response will be encrypted. | | `client_error` | 400 | The request had missing or invalid parameters. | diff --git a/docs/endpoints/post-identity-map-v2.md b/docs/endpoints/post-identity-map-v2.md index 362116130..ec4258684 100644 --- a/docs/endpoints/post-identity-map-v2.md +++ b/docs/endpoints/post-identity-map-v2.md @@ -48,7 +48,7 @@ You must encrypt all requests using your secret. For details, and code examples ### Path parameters -| Path Parameter | Data Type | Attribute | Description | +| Path parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`
    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). | @@ -62,7 +62,7 @@ The integration environment and the production environment require different
  • 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). | @@ -62,7 +62,7 @@ The integration environment and the production environment require different
  • If the current raw UID2 was rotated in the last 90 days: the previous raw UID2.
  • Otherwise: `null`.
    • | @@ -188,7 +188,7 @@ The raw UID2 does not change before the refresh timestamp. After the refresh tim For unsuccessfully mapped input values, the mapped object includes the properties shown in the following table. -| Property | Data Type | Description | +| Property | Data type | Description | |:---------|:----------|:-----------------------------------------------------------------------------------------------------------------| | `e` | string | The reason for being unable to map the DII to a raw UID2. One of two possible values: | @@ -196,7 +196,7 @@ For unsuccessfully mapped input values, the mapped object includes the propertie The following table lists the `status` property values and their HTTP status code equivalents. -| Status | HTTP Status Code | Description | +| Status | HTTP status code | Description | | :--- | :--- | :--- | | `success` | 200 | The request was successful. The response will be encrypted. | | `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 The following table shows key differences between the versions. -| Feature | v2 Implementation | v3 Implementation | +| Feature | v2 implementation | v3 implementation | |:-------------------------------|:--------------------------------------------|:-------------------------------------------| -| Endpoints Required | `/v2/identity/map` + `/v2/identity/buckets` | `/v3/identity/map` only | -| Identity Types per Request | Single identity type only | Multiple identity types | -| Refresh Management | Monitor salt bucket rotations via `/identity/buckets` endpoint | Re-map when past `refresh_from` timestamps | -| Previous UID2 Access | Not available | Available for 90 days | +| Endpoints required | `/v2/identity/map` + `/v2/identity/buckets` | `/v3/identity/map` only | +| Identity types per request | Single identity type only | Multiple identity types | +| Refresh management | Monitor salt bucket rotations via `/identity/buckets` endpoint | Re-map when past `refresh_from` timestamps | +| Previous UID2 access | Not available | Available for 90 days | ### Required changes diff --git a/docs/endpoints/post-optout-status.md b/docs/endpoints/post-optout-status.md index c7c1e896f..ee86412bc 100644 --- a/docs/endpoints/post-optout-status.md +++ b/docs/endpoints/post-optout-status.md @@ -38,7 +38,7 @@ You must encrypt all requests using your secret. For details, and code examples ### Path parameters -| Path Parameter | Data Type | Attribute | Description | +| Path parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`
    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). | @@ -50,7 +50,7 @@ The integration environment and the production environment require different
  • Include a maximum of 5,000 entries in one API call. | @@ -115,7 +115,7 @@ The response body includes the following properties. The following table lists the status property values and their HTTP status code equivalents. -| Status | HTTP Status Code | Description | +| Status | HTTP status code | Description | | :--- | :--- | :--- | | `success` | 200 | The request was successful. The response will be encrypted. | | `client_error` | 400 | The request had missing or invalid parameters. | diff --git a/docs/endpoints/post-token-generate.md b/docs/endpoints/post-token-generate.md index ac4d7ef01..05ae62a36 100644 --- a/docs/endpoints/post-token-generate.md +++ b/docs/endpoints/post-token-generate.md @@ -34,7 +34,7 @@ Here's what you need to know about sending requests to this endpoint: ### Path parameters -| Path Parameter | Data Type | Attribute | Description | +| Path parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`
    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).
    Notes: | @@ -44,7 +44,7 @@ Here's what you need to know about sending requests to this endpoint: 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. ::: -| Body Parameter | Data Type | Attribute | Description | +| Body parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `email` | string | Conditionally Required | The email address for which to generate tokens. | | `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. The response body includes the properties shown in the following table. -| Property | Data Type | Description | +| Property | Data type | Description | | :--- | :--- | :--- | | `advertising_token` | string | An encrypted advertising (UID2) token for the user. | | `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. The following table lists the `status` property values and their HTTP status code equivalents. -| Status | HTTP Status Code | Description | +| Status | HTTP status code | Description | | :--- | :--- | :--- | | `success` | 200 | The request was successful. The response will be encrypted. | | `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 ## Test identities -| Type | Identity | Purpose | Next Endpoint | +| Type | Identity | Purpose | Next endpoint | |:------|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------| | Email | `validate@example.com` | Test that the `advertising_token` you've cached matches the `advertising_token` for the specified email address. | [POST /token/validate](post-token-validate.md) | | Email | `optout@example.com` | Using this email for the request always generates an `optout` response. | [POST /token/generate](post-token-generate.md) | diff --git a/docs/endpoints/post-token-refresh.md b/docs/endpoints/post-token-refresh.md index d7265e893..c56eac1ac 100644 --- a/docs/endpoints/post-token-refresh.md +++ b/docs/endpoints/post-token-refresh.md @@ -35,7 +35,7 @@ Here's what you need to know about this endpoint: ### Path parameters -| Path Parameter | Data Type | Attribute | Description | +| Path parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`
    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).
    Notes: | @@ -95,7 +95,7 @@ An error response might look like the following: The response body includes the properties shown in the following table. -| Property | Data Type | Description | +| Property | Data type | Description | | :--- | :--- | :--- | | `advertising_token` | string | The UID2 token (also known as advertising token) for the user. | | `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. The following table lists the `status` property values and their HTTP status code equivalents. -| Status | HTTP Status Code | Description | +| Status | HTTP status code | Description | | :--- | :--- | :--- | | `success` | 200 | The request was successful and a new UID2 token, with associated values, is returned in the response. The response is encrypted. | | `optout` | 200 | The user opted out. This status is returned only for authorized requests. The response is encrypted. | diff --git a/docs/endpoints/post-token-validate.md b/docs/endpoints/post-token-validate.md index 423689c80..556ea017c 100644 --- a/docs/endpoints/post-token-validate.md +++ b/docs/endpoints/post-token-validate.md @@ -29,7 +29,7 @@ You must encrypt all requests using your secret key. For details, and code examp ### Path parameters -| Path Parameter | Data Type | Attribute | Description | +| Path parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`
    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). | @@ -44,7 +44,7 @@ Here are some key points about using this endpoint: - Include only one of the following four valid options, as listed in the Body Parameter table: `email`, `email_hash`, `phone`, or `phone_hash`. - Include the required body parameters as key-value pairs in the JSON body of the request when encrypting it. -| Body Parameter | Data Type | Attribute | Description | +| Body parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `token` | string | Required | The advertising token returned by the [POST /token/generate](post-token-generate.md) response.
    You can only validate an advertising token that has been generated with your own credentials. | `email` | string | Conditionally Required | The email address for token validation. You can use any valid email value, normalized or not. | @@ -112,7 +112,7 @@ A successful decrypted response returns a boolean value that indicates the valid The following table provides information about the response body. -| Property | Data Type | Description | +| Property | Data type | Description | | :--- | :--- | :--- | | `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.
    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. | @@ -120,7 +120,7 @@ The following table provides information about the response body. The following table lists the `status` property values and their HTTP status code equivalents. -| Status | HTTP Status Code | Description | +| Status | HTTP status code | Description | | :--- | :--- | :--- | | `success` | 200 | The request was successful. The response will be encrypted. | | `client_error` | 400 | The request had missing or invalid parameters. | diff --git a/docs/endpoints/summary-endpoints.md b/docs/endpoints/summary-endpoints.md index 92c627223..0817f70ab 100644 --- a/docs/endpoints/summary-endpoints.md +++ b/docs/endpoints/summary-endpoints.md @@ -27,7 +27,7 @@ The following table shows the UID2 endpoints, with the audience for each. For de The following endpoints are for retrieving and managing UID2 tokens (identity tokens, advertising tokens), and are used mainly by publishers. -| Endpoint | Description | Request Encryption | Response Decryption | +| Endpoint | Description | Request encryption | Response decryption | | :--- | :--- | :--- | :--- | | [POST /token/generate](post-token-generate.md) | Requests a UID2 token generated from a user's DII (email address or phone number). If the DII is valid, and the user has not opted out of UID2, this operation returns a UID2 token and associated values. | Required | Required | | [POST /token/validate](post-token-validate.md) | Used for testing, to validate that an advertising token (UID2) matches the specified email address, phone number, or the respective hash. | Required | Required | @@ -47,7 +47,7 @@ If you're using the earlier version, we recommend that you upgrade as soon as po The latest identity map integration uses the following endpoint: -| Endpoint | Description | Request Encryption | Response Decryption | +| Endpoint | Description | Request encryption | Response decryption | | :--- | :--- | :--- | :--- | | [POST /v3/identity/map](post-identity-map.md) | Maps raw UID2s, previous raw UID2s, and refresh timestamps for one or more email addresses, phone numbers, or their respective hashes. | Required | Required | @@ -55,7 +55,7 @@ The latest identity map integration uses the following endpoint: The following endpoints are part of the earlier identity map integration (version 2). -| Endpoint | Description | Request Encryption | Response Decryption | +| Endpoint | Description | Request encryption | Response decryption | | :--- | :--- | :--- | :--- | | [POST /identity/buckets](post-identity-buckets.md) | Monitors rotated salt buckets using their last updated timestamp. | Required | Required | | [POST /v2/identity/map](post-identity-map-v2.md) | Maps raw UID2s and salt bucket IDs for one or more email addresses, phone numbers, or their respective hashes. | Required | Required | @@ -66,6 +66,6 @@ The following endpoint can be used by advertisers, third-party data providers, D For details about the UID2 opt-out workflow and how users can opt out, see [User opt-out](../getting-started/gs-opt-out.md). -| Endpoint | Description | Request Encryption | Response Decryption | +| Endpoint | Description | Request encryption | Response decryption | | :--- | :--- | :--- | :--- | | [POST /optout/status](post-optout-status.md) | Checks the opt-out status of UID2s. This endpoint takes a list of UID2s as input, and returns the UID2s that have opted out, as well as the time that the opt-out took place. | Required | Required | diff --git a/docs/getting-started/gs-account-setup.md b/docs/getting-started/gs-account-setup.md index 3c42d2a86..d527c95a7 100644 --- a/docs/getting-started/gs-account-setup.md +++ b/docs/getting-started/gs-account-setup.md @@ -21,10 +21,10 @@ If you have an existing relationship with The Trade Desk (the current UID2 Admin Contacting The Trade Desk for access is temporary. When the system is moved to independent governance, the governing organizations will manage access requests. ::: -| Your Role | Contact Email | +| Your role | Contact email | | :--- | :--- | -| Publisher, App Developer | [UID2publishers@thetradedesk.com](mailto:UID2publishers@thetradedesk.com) | -| Agency, Brand, DSP, SSP, customer data platform (CDP), Data Provider | [UID2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) | +| Publisher, app developer | [UID2publishers@thetradedesk.com](mailto:UID2publishers@thetradedesk.com) | +| Agency, brand, DSP, SSP, customer data platform (CDP), data provider | [UID2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) | ## Account setup details diff --git a/docs/getting-started/gs-credentials.md b/docs/getting-started/gs-credentials.md index a64cdb45a..41b235f68 100644 --- a/docs/getting-started/gs-credentials.md +++ b/docs/getting-started/gs-credentials.md @@ -33,8 +33,8 @@ The following table shows how you get your credentials, for each [integration ap Environment - Integration Type - Getting Credentials + Integration type + Getting credentials diff --git a/docs/getting-started/gs-encryption-decryption.md b/docs/getting-started/gs-encryption-decryption.md index 3b80ce610..bfba77317 100644 --- a/docs/getting-started/gs-encryption-decryption.md +++ b/docs/getting-started/gs-encryption-decryption.md @@ -55,7 +55,7 @@ You have the option of writing your own code for encrypting requests, using a UI The following table describes the field layout for request encryption code. -| Offset (Bytes) | Size (Bytes) | Description | +| Offset (bytes) | Size (bytes) | Description | | :--- | :--- | :--- | | 0 | 8 | The Unix timestamp (in milliseconds) of the request, in int64 big endian format.
    When the server receives and decrypts the envelope, it checks the embedded timestamp. If the timestamp is older than 60 seconds, the request is considered stale and is rejected. | | 8 | 8 | Nonce: Random 64 bits of data used to help protect against replay attacks. The corresponding [Unencrypted response data envelope](#unencrypted-response-data-envelope) should contain the same nonce value for the response to be considered valid. | @@ -65,7 +65,7 @@ The following table describes the field layout for request encryption code. The following table describes the field layout for request encryption code. -| Offset (Bytes) | Size (Bytes) | Description | +| Offset (bytes) | Size (bytes) | Description | | :--- | :--- | :--- | | 0 | 1 | The version of the envelope format. Must be `1`. | | 1 | 12 | 96-bit initialization vector (IV), which is used to randomize data encryption. | @@ -84,7 +84,7 @@ The response is encrypted only if the service returns HTTP status code 200. The following table describes the field layout for response decryption code. -| Offset (Bytes) | Size (Bytes) | Description | +| Offset (bytes) | Size (bytes) | Description | | :--- | :--- | :--- | | 0 | 12 | 96-bit initialization vector (IV), which is used to randomize data encryption. | | 12 | N | Payload ([Unencrypted response data envelope](#unencrypted-response-data-envelope)) encrypted using the AES/GCM/NoPadding algorithm. | @@ -94,7 +94,7 @@ The following table describes the field layout for response decryption code. The following table describes the field layout for response decryption code. -| Offset (Bytes) | Size (Bytes) | Description | +| Offset (bytes) | Size (bytes) | Description | | :--- | :--- | :--- | | 0 | 8 | The Unix timestamp (in milliseconds) of the response, in int64 big endian format. | | 8 | 8 | Nonce. For the response to be considered valid, this should match the nonce in the [unencrypted request data envelope](#unencrypted-request-data-envelope). | diff --git a/docs/getting-started/gs-environments.md b/docs/getting-started/gs-environments.md index 95fcb485b..5c62337fa 100644 --- a/docs/getting-started/gs-environments.md +++ b/docs/getting-started/gs-environments.md @@ -15,7 +15,7 @@ Learn about the different environments available, and tips to reduce latency by The following table lists all current integration (also known as testing) and production environments for UID2. -| Environment | Cloud Region | Code | Base URL | +| Environment | Cloud region | Code | Base URL | | :--- | :--- | :--- | :--- | | Integration (for testing) | AWS US East (Ohio) | `us-east-2` | `https://operator-integ.uidapi.com` | | Production | Automatically optimized region routing via the AWS Global Accelerator | `n/a` | `https://global.prod.uidapi.com` | diff --git a/docs/getting-started/gs-normalization-encoding.md b/docs/getting-started/gs-normalization-encoding.md index 794bdae1f..bf080fb3f 100644 --- a/docs/getting-started/gs-normalization-encoding.md +++ b/docs/getting-started/gs-normalization-encoding.md @@ -65,7 +65,7 @@ The final value, the hex to Base64-encoded representation of the SHA-256 hash, i When applying Base64 encoding, be sure to Base64-encode the raw bytes of the hash or use a Base64 encoder that takes a hex-encoded value as input. If you use a function that takes text as input, the result is a longer string which is invalid for the purposes of UID2. ::: -| Type | Example | Comments and Usage | +| Type | Example | Comments and usage | | :--- | :--- | :--- | | Raw email address | `USER@example.com` | N/A | | Normalized email address | `user@example.com` | Normalization is always the first step. | @@ -87,8 +87,8 @@ In working with your own UID2s, always provide the final value, the Base64-encod - - + + @@ -152,7 +152,7 @@ The final value, the hex to Base64-encoded representation of the SHA-256 hash, i When applying Base64 encoding, be sure to use a function that takes a hex value as input. If you use a function that takes text as input, the result is a longer string which is invalid for the purposes of UID2. ::: -| Type | Example | Comments and Usage | +| Type | Example | Comments and usage | | :--- | :--- | :--- | | Raw phone number | `1 (234) 567-8901` | N/A | | Normalized phone number | `+12345678901` | Normalization is always the first step. | diff --git a/docs/getting-started/gs-opt-out.md b/docs/getting-started/gs-opt-out.md index c2d3a0518..472dc2ab7 100644 --- a/docs/getting-started/gs-opt-out.md +++ b/docs/getting-started/gs-opt-out.md @@ -45,7 +45,7 @@ The following steps provide a high-level outline of the opt-out workflow intende 2. The Transparency and Control Portal sends the opt-out request to the UID2 Operator Service. 3. If the user has opted out, the UID2 Operator Service distributes the opt-out information to UID2 participants, as shown in the following table. - | Participant | Distribution Method | + | Participant | Distribution method | | :--- | :--- | | Publishers | A publisher calling [POST /token/generate](../endpoints/post-token-generate.md), or [POST /token/refresh](../endpoints/post-token-refresh.md), receives the opt-out response instead of the UID2 token. | | DSPs | The UID2 Operator Service distributes information on all opted-out users to DSPs via a webhook provided for the purpose. For details, see [Honor user opt-outs](../guides/dsp-guide#honor-user-opt-outs).
    DSPs can also check the opt-out status of raw UID2s using the [POST /optout/status](../endpoints/post-optout-status.md) endpoint. | diff --git a/docs/getting-started/gs-permissions.md b/docs/getting-started/gs-permissions.md index 3c555996b..fd91e99af 100644 --- a/docs/getting-started/gs-permissions.md +++ b/docs/getting-started/gs-permissions.md @@ -21,7 +21,7 @@ A participant can have one or several sets of API credentials with associated pe The following table lists the key permissions, the types of participants that commonly use them, and a summary of the key associated activities. -| Name | Participant Type | Permissions | +| Name | Participant type | Permissions | | :--- | :--- | :--- | | Generator | Publishers | Permission to call the [POST /token/generate](../endpoints/post-token-generate.md), [POST /token/validate](../endpoints/post-token-validate.md), and [POST /token/refresh](../endpoints/post-token-refresh.md) endpoints, to generate UID2 tokens from DII and to refresh them, using one of these integration methods: | | Bidder | DSPs | Permission to decrypt UID2 tokens coming in from the bidstream from publishers into raw UID2s for bidding purposes. | diff --git a/docs/guides/integration-advertiser-dataprovider-overview.md b/docs/guides/integration-advertiser-dataprovider-overview.md index 86ee77723..ca1aff09c 100644 --- a/docs/guides/integration-advertiser-dataprovider-overview.md +++ b/docs/guides/integration-advertiser-dataprovider-overview.md @@ -21,7 +21,7 @@ Within the ad tech industry, advertisers use identity to build audiences, track There are other ways that you can use UID2, outside these use cases. These are just some examples. ::: -| Send/Receive? | Action | Advantage/Result | +| Send/receive? | Action | Advantage/result | | --- | --- | --- | | Send in audiences | Send raw UID2s via API or pixels | Create audiences. | | Send in conversions | Send raw UID2s as conversion information | Use conversion information for measurement (attribution) or for retargeting via API or pixels. | @@ -55,7 +55,7 @@ If your implementation uses a version of the [POST /identity/map](../endpoi The following table shows the implementation options that are available for advertisers and data providers, for each of the high-level steps. Some steps are managed solely as part of your own custom implementation; some steps can be managed by one or more of the UID2 implementation options available. For details, click the link on each step. -| High-Level Step | Implementation Options | +| High-level step | Implementation options | | --- | --- | | [1: Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) | Use any of the following options to map DII to raw UID2s: | | [2: Store raw UID2s and refresh timestamps](#2-store-raw-uid2s-and-refresh-timestamps) | Custom (your choice). | diff --git a/docs/guides/integration-aws-entity-resolution.md b/docs/guides/integration-aws-entity-resolution.md index 0ccf908af..9608d43ee 100644 --- a/docs/guides/integration-aws-entity-resolution.md +++ b/docs/guides/integration-aws-entity-resolution.md @@ -30,7 +30,7 @@ For a summary of all integration options and steps for advertisers and data prov The following table summarizes the functionality available with the AWS Entity Resolution integration. -| Encrypt Raw UID2 to UID2 Token | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | +| Encrypt raw UID2 to UID2 token | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | | :--- | :--- | :--- | :--- | :--- | | No | No | No | No | Yes | @@ -38,7 +38,7 @@ The following table summarizes the functionality available with the AWS Entity R The following table summarizes the steps to integrate with UID2 using AWS Entity Resolution. -| Step/Link | Details | +| Step/link | Details | | --- | --- | | [Initial setup steps](#initial-setup-steps) | Create UID2 account, create AWS account, and link them: | | [Configure AWS account](#configure-aws-account) | Set up IAM users, data tables, and schema mapping for your data. | @@ -149,7 +149,7 @@ To create the matching workflow, first sign in to the AWS Management console, op - **Description**: An optional description for the matching workflow. - **Data input**: The source for your data in AWS. From the drop-down list, select an AWS Glue database, then the AWS Glue table, and then the schema mapping. You can specify more than one data input. In the following example, email is the only type of data input: - | UniqueId | Name | Email | Date of Birth | + | UniqueId | Name | Email | Date of birth | |----------|--------|------------------|---------------| | 0001 | Test 1 | test1@uidapi.com | 1/1/90 | | 0002 | Test 2 | test2@gmail.com | 1/2/78 | @@ -194,7 +194,7 @@ To create the matching workflow, first sign in to the AWS Management console, op - Select the input fields that you want to exclude from the output, and the fields that you want to hash in the output data, as shown in the following example. - | UniqueId | Name | Email | Date of Birth | UID2_identifier | UID2_advertising_id | UID2_bucket_id | + | UniqueId | Name | Email | Date of birth | UID2_identifier | UID2_advertising_id | UID2_bucket_id | |----------|--------|------------------|---------------|------------------|------------------------------------------------|----------------| | 0001 | Test 1 | test1@uidapi.com | 1/1/90 | test1@uidapi.com | Q4A5ZBuBCYfuV3Wd8Fdsx2+i33v7jyFcQbcMG/LH4eM= | ad1ANEmVZ | | 0002 | Test 2 | test2@gmail.com | 1/2/78 | test2@gmail.com | kds8hgBuBCYfuV3Wd8Fdsx2+i33v7jyFcQbcMG/jgksuh= | kd9ANE98d | diff --git a/docs/guides/integration-ctv-guide.md b/docs/guides/integration-ctv-guide.md index 224421568..c6c93d3ee 100644 --- a/docs/guides/integration-ctv-guide.md +++ b/docs/guides/integration-ctv-guide.md @@ -82,7 +82,7 @@ To implement using this approach, follow the instructions in the [Client-side in The following table shows supported operating systems, with links to applicable documentation resources. -| Operating System | Integration Guide | Link to SDK Guide | +| Operating system | Integration guide | Link to SDK guide | | :--- | :--- | :--- | | [Apple tvOS](https://developer.apple.com/tvos/) | [Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) | [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) | | [Android TV](https://www.android.com/tv/) | [Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) | [SDK for Android reference guide](../sdks/sdk-ref-android.md) | @@ -116,7 +116,7 @@ To implement using this approach, follow the instructions in the [Client-server The following table shows supported operating systems, with links to applicable documentation resources. -| Operating System | Integration Guide | Link to SDK Guide | +| Operating system | Integration guide | Link to SDK guide | | :--- | :--- | :--- | | [Apple tvOS](https://developer.apple.com/tvos/) | [Client-server integration guide for mobile](../guides/integration-mobile-client-server.md) | [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) | | [Android TV](https://www.android.com/tv/) | [Client-server integration guide for mobile](../guides/integration-mobile-client-server.md) | [SDK for Android reference guide](../sdks/sdk-ref-android.md) | diff --git a/docs/guides/integration-databricks.md b/docs/guides/integration-databricks.md index 1a856dcb2..33c279aa8 100644 --- a/docs/guides/integration-databricks.md +++ b/docs/guides/integration-databricks.md @@ -10,7 +10,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Databricks clean rooms integration guide +# Databricks Clean Rooms integration guide This guide is for advertisers and data providers who want to convert their user data to raw UID2s in a Databricks environment. @@ -30,7 +30,7 @@ When you've set up the Databricks Clean Rooms environment, you establish a trust The following table summarizes the functionality available with the UID2 Databricks integration. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | | :--- | :--- | :--- | :--- | :--- | | — | — | — | — | ✅ | @@ -108,7 +108,7 @@ The notebook has two parameters, `input_schema` and `input_table`. Together, the For example, to map DII in the clean room table named `creator.default.emails`, set `input_schema` to `default` and `input_table` to `emails`. -| Parameter Name | Description | +| Parameter name | Description | | :--- | :--- | | `input_schema` | The schema containing the table or view. | | `input_table` | The name you specify for the table or view containing the DII to be mapped. | @@ -117,7 +117,7 @@ For example, to map DII in the clean room table named `creator.default.emails`, The input table or view must have the two columns shown in the following table. The table or view can have additional columns, but the notebook doesn't use any additional columns, only these two. -| Column Name | Data Type | Description | +| Column name | Data type | Description | | :--- | :--- | :--- | | `INPUT` | string | The DII to map. | | `INPUT_TYPE` | string | The type of DII to map. Allowed values: `email`, `email_hash`, `phone`, and `phone_hash`. | @@ -139,7 +139,7 @@ For details, see [Overview of output tables](https://docs.databricks.com/aws/en/ The following table provides information about the structure of the output data, including field names and values. -| Column Name | Data Type | Description | +| Column name | Data type | Description | | :--- | :--- | :--- | | `UID` | string | The value is one of the following: | | `PREV_UID` | string | The value is one of the following: | @@ -186,7 +186,7 @@ This section includes the following reference information: UID2 sharing identifiers can change. Before creating a new clean room, check this section to make sure you have the latest sharing identifier. -| Environment | UID2 Sharing Identifier | +| Environment | UID2 sharing identifier | | :--- | :--- | | Production | `aws:us-east-2:21149de7-a9e9-4463-b4e0-066f4b033e5d:673872910525611:010d98a6-8cf2-4011-8bf7-ca45940bc329` | | Integration | `aws:us-east-2:4651b4ea-b29c-42ec-aecb-2377de70bbd4:2366823546528067:c15e03bf-a348-4189-92e5-68b9a7fb4018` | diff --git a/docs/guides/integration-javascript.md b/docs/guides/integration-javascript.md index 8ca0099bc..c7864f272 100644 --- a/docs/guides/integration-javascript.md +++ b/docs/guides/integration-javascript.md @@ -39,7 +39,7 @@ For additional flexibility, UID2 also provides alternative methods for some of t The options for integrating with UID2 using the SDK for JavaScript are summarized in the following table. Choose the option that's best for you. -| Scenario | Option | Integration Guide | +| Scenario | Option | Integration guide | | :--- | :--- | :--- | | You have access to DII on the client side and want to do front-end development only. | Client-side integration | [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | | You have access to DII on the server side and can do server-side development, or you are using a Private Operator. | Client-server integration | [Client-server integration guide for JavaScript](integration-javascript-client-server.md) | diff --git a/docs/guides/integration-mobile-overview.md b/docs/guides/integration-mobile-overview.md index 4db704690..18a6b265e 100644 --- a/docs/guides/integration-mobile-overview.md +++ b/docs/guides/integration-mobile-overview.md @@ -83,7 +83,7 @@ The options for integrating with UID2 using the UID2 mobile SDKs are summarized For details, see [Integration approaches](../ref-info/ref-integration-approaches.md). -| Scenario | Option | Integration Guide | +| Scenario | Option | Integration guide | | :--- | :--- | :--- | | You have access to DII (email address or phone number) on the client side/within the mobile app, and want to keep changes within your app only. | Client-Side integration | [Client-side integration guide for mobile](integration-mobile-client-side.md) | | You have access to DII on the server side only and can do the necessary development to generate UID2 tokens server-side, but you want to refresh tokens on the client side—or you are using a Private Operator. | Client-server integration | [Client-server integration guide for mobile](integration-mobile-client-server.md) | @@ -96,9 +96,9 @@ The following table summarizes the mobile integration options for managing the U
    Original ValueProcessing Steps and Resulting ValuesOriginal valueProcessing steps and resulting values
    - - - + + + @@ -121,13 +121,13 @@ There are many options for sending your UID2 tokens to the bidstream. The following table summarizes the options supported by UID2. -| Scenario | Integration Guide | +| Scenario | Integration guide | | :--- | :--- | | You want to use Google GMA to integrate video, banner, interstitial, or native ads into your Android app | Both of the following, in this sequence:
    1. [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md)
    2. One of the following:
      • Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
      • Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
    | | You want to use Google GMA to integrate video, banner, interstitial, or native ads into your iOS app | Both of the following, in this sequence:
    1. [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md)
    2. One of the following:
      • Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
      • Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
    | | You want to use Google IMA to integrate multimedia ads into your Android app | Both of the following, in this sequence:
    1. [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md)
    2. One of the following:
      • Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
      • Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
    | | You want to use Google IMA to integrate multimedia ads into your iOS app | Both of the following, in this sequence:
    1. [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md)
    2. One of the following:
      • Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
      • Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
    | -| You want to use the Prebid Mobile SDK and Prebid Server to send out ad requests from your Android or iOS app | One of the following: | +| You want to use the Prebid Mobile SDK and Prebid server to send out ad requests from your Android or iOS app | One of the following: | ### Functionality summary @@ -135,15 +135,15 @@ The following table summarizes the functionality available with the various inte All options support either client-side or server-side integration. -| Implementation Option | Generate Token from DII | Refresh Token | Android/iOS? | Send Token to Bidstream | +| Implementation option | Generate token from DII | Refresh token | Android/iOS? | Send token to bidstream | | :--- | :--- | :--- | :--- | :--- | | UID2 SDK for Android | ✅ | ✅ | Android | * | | UID2 SDK for iOS | ✅| ✅ | iOS | * | -| GMA Plugin for Android
    (Requires UID2 SDK for Android) | — | — | Android | ✅** | -| GMA Plugin for iOS
    (Requires UID2 SDK for iOS) | — | — | iOS | ✅** | -| IMA Plugin for Android
    (Requires UID2 SDK for Android)| — | — | Android | ✅** | -| IMA Plugin for iOS
    (Requires UID2 SDK for iOS)| — | — | iOS | ✅** | -| UID2 Integration with Prebid Mobile SDK | — | — | Either | ✅*** | +| GMA plugin for Android
    (requires UID2 SDK for Android) | — | — | Android | ✅** | +| GMA plugin for iOS
    (requires UID2 SDK for iOS) | — | — | iOS | ✅** | +| IMA plugin for Android
    (requires UID2 SDK for Android)| — | — | Android | ✅** | +| IMA plugin for iOS
    (requires UID2 SDK for iOS)| — | — | iOS | ✅** | +| UID2 integration with Prebid Mobile SDK | — | — | Either | ✅*** | *You can combine the SDK with the IMA/GMA Plugin or the UID2 Integration with Prebid Mobile SDK to send the token to the bidstream via Google or Prebid Server, or you can retrieve the token manually from the SDK and pass it to the bidstream in another way, according to your preference. diff --git a/docs/guides/integration-options-private-operator.md b/docs/guides/integration-options-private-operator.md index 072bf7d3e..089d0707d 100644 --- a/docs/guides/integration-options-private-operator.md +++ b/docs/guides/integration-options-private-operator.md @@ -134,7 +134,7 @@ The following documentation resources are available for Private Operators to imp There is no functional difference between the Private Operator versions. -| Integration Type| Documentation | Content Description | +| Integration type| Documentation | Content description | | :--- | :--- | :--- | | AWS | [Private Operator for AWS integration guide](../guides/operator-guide-aws-marketplace.md) | Instructions for setting up a Private Operator service for AWS Marketplace. | | GCP Confidential Space | [Private Operator for GCP integration guide](../guides/operator-private-gcp-confidential-space.md) | Information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. | diff --git a/docs/guides/integration-options-publisher-web.md b/docs/guides/integration-options-publisher-web.md index f573bb3f9..aba313db0 100644 --- a/docs/guides/integration-options-publisher-web.md +++ b/docs/guides/integration-options-publisher-web.md @@ -32,7 +32,7 @@ The following table summarizes the solutions available for each integration step To accomplish all steps, you can combine solutions. For example, you could use the SDK for JavaScript, client-side, to generate and refresh the token, and Google Ad Manager Secure Signals to pass the token to the bidstream. -| Integration Solution | Generate Token | Refresh Token |Pass Token to the Bidstream | +| Integration solution | Generate token | Refresh token |Pass token to the bidstream | | :--- | :--- | :--- | :--- | | [Prebid.js client-side (8.21.0 or later)](integration-prebid-client-side.md) | ✅ | ✅ | ✅ | | [Prebid.js client-server (7.53.0 or later)](integration-prebid-client-server.md) | — | ✅ | ✅ | diff --git a/docs/guides/integration-prebid-client-server.md b/docs/guides/integration-prebid-client-server.md index a7845d362..e5940db25 100644 --- a/docs/guides/integration-prebid-client-server.md +++ b/docs/guides/integration-prebid-client-server.md @@ -84,7 +84,7 @@ When account setup is complete, you'll receive a client keypair consisting of tw You'll need to configure the UID2 Prebid module to complete the following two actions: -| Step | Action | Link to Instructions | +| Step | Action | Link to instructions | | --- | --- | --- | | 1 | Send a server-side API call to generate a UID2 token. | [Generating a UID2 token on the server](#generating-a-uid2-token-on-the-server) | | 2 | Store the response value, so that the Prebid module can manage token refresh as well as opt-out if needed. | [Refreshing a UID2 token](#refreshing-a-uid2-token) | @@ -105,7 +105,7 @@ For security reasons, the API key and secret used in token generation must be ca There are two ways to refresh a UID2 token, as shown in the following table. -| Mode | Description | Link to Section | +| Mode | Description | Link to section | | --- | --- | --- | | Client Refresh mode | Prebid.js automatically refreshes the tokens internally.
    This is the simplest approach. | [Client Refresh mode](#client-refresh-mode) | | Server-only mode | Prebid.js doesn't automatically refresh the token. It is up to the publisher to manage token refresh.
    Examples of why you might want to choose this option: | [Server-only mode](#server-only-mode) | @@ -131,7 +131,7 @@ This section includes the following information: When you configure the module to use Client Refresh mode, you must choose **one** of the following options for providing the token to the Prebid module. -| Option | Details | Use Case | +| Option | Details | Use case | | --- | --- | --- | | Set `params.uid2Cookie` to the name of the cookie that contains the response body as a JSON string. | See [Client Refresh mode cookie example](#client-refresh-mode-cookie-example) | Use this option only if you're sure that there is enough space left in your cookie to store the response body. If you're not sure, or the cookie storage needs might vary, choose the other option. | | Set `params.uid2Token` to the response body as a JavaScript object. | See [Client Refresh mode uid2Token example](#client-refresh-mode-uid2token-example) | You might choose to provide the response body via `params.uid2Token` in either of these cases: | @@ -196,7 +196,7 @@ In server-only mode, only the advertising token is provided to the module. The m To configure the module to use server-only mode, do **one** of the following: -| Implementation Method | Link to Example | +| Implementation method | Link to example | | --- | --- | | Set a cookie named `__uid2_advertising_token` and store the advertising token value in it. | [Server-only mode cookie example](#server-only-mode-cookie-example) | | Set `value` to an ID block containing the advertising token. | [Server-only mode value example](#server-only-mode-value-example) | @@ -328,7 +328,7 @@ The following parameters apply only to the UID2 Prebid User ID Module integratio In this table, CR = Client Refresh mode, SO = Server-Only mode, and N/A = not applicable. -| Param under userSync.userIds[] | Mode/Scope | Type | Description | Example | +| Param under userSync.userIds[] | Mode/scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | CR: Required
    SO: Required | String | ID value for the UID2 module. Always `"uid2"`. | `"uid2"` | | value | CR: N/A
    SO: Optional | Object | An object containing the value for the advertising token. | See [Configuration parameter examples: Value](#configuration-parameter-examples-value) | diff --git a/docs/guides/integration-prebid.md b/docs/guides/integration-prebid.md index 295fb9e37..7923dd8b7 100644 --- a/docs/guides/integration-prebid.md +++ b/docs/guides/integration-prebid.md @@ -47,7 +47,7 @@ Depending on access to DII, there are two methods to generate UID2 tokens for us Determine which method is best for you, and then follow the applicable integration guide. -| Scenario | Integration Guide | +| Scenario | Integration guide | | :--- | :--- | | You have access to DII on the client side and want to do front-end development only | [Client-side integration guide for Prebid.js](integration-prebid-client-side.md) | | You have access to DII on the server side and can do server-side development | [Client-server integration guide for Prebid.js](integration-prebid-client-server.md) | diff --git a/docs/guides/integration-snowflake-before-february-2025.md b/docs/guides/integration-snowflake-before-february-2025.md index e7ddf8c31..eb592a745 100644 --- a/docs/guides/integration-snowflake-before-february-2025.md +++ b/docs/guides/integration-snowflake-before-february-2025.md @@ -29,7 +29,7 @@ For a summary of all integration options and steps for advertisers and data prov The following table summarizes the functionality available with the UID2 Snowflake integration. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | —* | — | ✅ | @@ -45,9 +45,9 @@ The following diagram and table illustrate the different parts of the UID2 integ ![Snowflake integration architecture](images/uid2-snowflake-integration-architecture-drawio.png) -|Partner Snowflake Account|UID2 Snowflake Account|UID2 Core Opt-Out Cloud Setup| +|Partner Snowflake account|UID2 Snowflake account|UID2 core opt-out cloud setup| | :--- | :--- | :--- | -|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 Share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can’t access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | +|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can’t access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | |When you use shared functions and views, you pay Snowflake for transactional computation costs. |These private tables, secured in the UID2 Snowflake account, automatically synchronize with the UID2 Core/Optout Snowflake storage that holds internal data used to complete UID2-related tasks. | | ## Access the UID2 shares @@ -111,7 +111,7 @@ select UID2, BUCKET_ID, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_U All query examples use the following default values for each name variable: -| Variable |Advertiser Solution Default Value | Data Provider Solution Default Value| Comments | +| Variable |Advertiser solution default value | Data provider solution default value| Comments | | :--- | :--- | :--- | :--- | | `{DATABASE_NAME}` | `UID2_PROD_ADV_SH` | `UID2_PROD_DP_SH` | If needed, you can change the default database name when creating a new database after you are granted access to the selected UID2 Share. | | `{SCHEMA_NAME}`| `ADV` | `DP` | This is an immutable name. | @@ -124,14 +124,14 @@ If the DII is an email address, the service normalizes the data using the UID2 [ If the DII is a phone number, you must normalize it before sending it to the service, using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. -|Argument|Data Type|Description| +|Argument|Data type|Description| | :--- | :--- | :--- | | `INPUT` | varchar(256) | The DII to map to the UID2 and salt bucket ID. | | `INPUT_TYPE` | varchar(256) | The type of DII to map. Allowed values: `email`, `email_hash`, `phone`, and `phone_hash`. A successful query returns the following information for the specified DII. -|Column Name|Data Type|Description| +|Column name|Data type|Description| | :--- | :--- | :--- | | `UID2` | TEXT | The value is one of the following: | | `BUCKET_ID` | TEXT | The value is one of the following: | @@ -417,7 +417,7 @@ The `UID2_SALT_BUCKETS` view query returns the date and time when the salt bucke To determine which UID2s need regeneration, compare the timestamps of when they were generated to the most recent timestamp of the salt bucket update. -|Column Name|Data Type|Description| +|Column name|Data type|Description| | :--- | :--- | :--- | | `BUCKET_ID` | TEXT | The ID of the salt bucket. This ID parallels the `BUCKET_ID` returned by the identity map function. Use the `BUCKET_ID` as the key to do a join query between the function call results and results from this view call. | | `LAST_SALT_UPDATE_UTC` | TIMESTAMP_NTZ | The last time the salt in the bucket was updated. This value is expressed in UTC. | @@ -549,13 +549,13 @@ To encrypt raw UID2s to UID2 tokens, use the `FN_T_UID2_ENCRYPT` function. Use t - For advertisers: `ADV.FN_T_UID2_ENCRYPT` - For data providers: `DP.FN_T_UID2_ENCRYPT` -|Argument|Data Type|Description| +|Argument|Data type|Description| | :--- | :--- | :--- | | `RAW_UID2` | varchar(128) | The raw UID2 to encrypt to a UID2 token. | A successful query returns the following information for the specified raw UID2. -|Column Name|Data Type|Description| +|Column name|Data type|Description| | :--- | :--- | :--- | | `UID2_TOKEN` | TEXT | The value is one of the following: | | `ENCRYPTION_STATUS` | TEXT | The value is one of the following: | @@ -635,13 +635,13 @@ To decrypt UID2 tokens to raw UID2s, use the `FN_T_UID2_DECRYPT` function. Use t - For advertisers: `ADV.FN_T_UID2_DECRYPT` - For data providers: `DP.FN_T_UID2_DECRYPT` -|Argument|Data Type|Description| +|Argument|Data type|Description| | :--- | :--- | :--- | | `UID2_TOKEN` | varchar(512) | The UID2 token to decrypt to a raw UID2. | A successful query returns the following information for the specified UID2 token. -|Column Name|Data Type|Description| +|Column name|Data type|Description| | :--- | :--- | :--- | | `UID2` | TEXT | The value is one of the following: | | `SITE_ID` | INT | The value is one of the following: | diff --git a/docs/guides/integration-snowflake-previous.md b/docs/guides/integration-snowflake-previous.md index 9ccd6a1c4..617751ab2 100644 --- a/docs/guides/integration-snowflake-previous.md +++ b/docs/guides/integration-snowflake-previous.md @@ -30,7 +30,7 @@ For a summary of all integration options and steps for advertisers and data prov The following table summarizes the functionality available with the UID2 Snowflake integration. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | —* | — | ✅ | @@ -68,9 +68,9 @@ The following diagram and table illustrate the different parts of the UID2 integ ![Snowflake integration architecture](images/uid2-snowflake-integration-architecture-drawio.png) -|Partner Snowflake Account|UID2 Snowflake Account|UID2 Core Opt-Out Cloud Setup| +|Partner Snowflake account|UID2 Snowflake account|UID2 core opt-out cloud setup| | :--- | :--- | :--- | -|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 Share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can’t access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | +|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can’t access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | |When you use shared functions and views, you pay Snowflake for transactional computation costs. |These private tables, secured in the UID2 Snowflake account, automatically synchronize with the UID2 Core/Optout Snowflake storage that holds internal data used to complete UID2-related tasks. | | ## Access the UID2 share @@ -132,7 +132,7 @@ select UID, BUCKET_ID, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_ID All query examples use the following default values for each name variable: -| Variable | Default Value | Comments | +| Variable | Default value | Comments | |:------------------|:-------------------|:------------------------------------------------------------------------------------------------------------------------------------------| | `{DATABASE_NAME}` | `UID2_PROD_UID_SH` | If needed, you can change the default database name when creating a new database after you are granted access to the selected UID2 Share. | | `{SCHEMA_NAME}` | `UID` | This is an immutable name. | @@ -145,14 +145,14 @@ If the DII is an email address, the service normalizes the data using the UID2 [ If the DII is a phone number, you must normalize it before sending it to the service, using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. -| Argument | Data Type | Description | +| Argument | Data type | Description | |:-------------|:-------------|:------------------------------------------------------------------------------------------| | `INPUT` | varchar(256) | The DII to map to the UID2 and salt bucket ID. | | `INPUT_TYPE` | varchar(256) | The type of DII to map. Allowed values: `email`, `email_hash`, `phone`, and `phone_hash`. | A successful query returns the following information for the specified DII. -| Column Name | Data Type | Description | +| Column name | Data type | Description | |:------------|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `UID` | TEXT | The value is one of the following: | | `BUCKET_ID` | TEXT | The value is one of the following: | @@ -366,7 +366,7 @@ The `SALT_BUCKETS` view query returns the date and time when the salt buckets fo To determine which UID2s need regeneration, compare the timestamps of when they were generated to the most recent timestamp of the salt bucket update. -| Column Name | Data Type | Description | +| Column name | Data type | Description | |:-----------------------|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `BUCKET_ID` | TEXT | The ID of the salt bucket. This ID parallels the `BUCKET_ID` returned by the identity map function. Use the `BUCKET_ID` as the key to do a join query between the function call results and results from this view call. | | `LAST_SALT_UPDATE_UTC` | TIMESTAMP_NTZ | The last time the salt in the bucket was updated. This value is expressed in UTC. | @@ -433,13 +433,13 @@ The following activities support tokenized sharing: To encrypt raw UID2s to UID2 tokens, use the `FN_T_ENCRYPT` function. -|Argument|Data Type|Description| +|Argument|Data type|Description| | :--- | :--- | :--- | | `RAW_UID2` | varchar(128) | The raw UID2 to encrypt to a UID2 token. | A successful query returns the following information for the specified raw UID2. -|Column Name|Data Type|Description| +|Column name|Data type|Description| | :--- | :--- | :--- | | `UID_TOKEN` | TEXT | The value is one of the following: | | `ENCRYPTION_STATUS` | TEXT | The value is one of the following: | @@ -501,13 +501,13 @@ The following table identifies each item in the response, including `NULL` value To decrypt UID2 tokens to raw UID2s, use the `FN_T_DECRYPT` function. -| Argument | Data Type | Description | +| Argument | Data type | Description | |:------------|:-------------|:-----------------------------------------| | `UID_TOKEN` | varchar(512) | The UID2 token to decrypt to a raw UID2. | A successful query returns the following information for the specified UID2 token. -| Column Name |Data Type|Description| +| Column name |Data type|Description| |:--------------------| :--- | :--- | | `UID` | TEXT | The value is one of the following: | | `SITE_ID` | INT | The value is one of the following: | diff --git a/docs/guides/integration-snowflake.md b/docs/guides/integration-snowflake.md index a6237b9b8..55e2c329a 100644 --- a/docs/guides/integration-snowflake.md +++ b/docs/guides/integration-snowflake.md @@ -31,7 +31,7 @@ For a summary of all integration options and steps for advertisers and data prov The following table summarizes the functionality available with the UID2 Snowflake integration. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | —* | — | ✅ | @@ -51,7 +51,7 @@ These changes assume that your code integration uses the version of Snowflake fu The following table shows the differences between the old and new identity mapping functions. -| Function | Version | Return Fields | Key Differences | Comments | +| Function | Version | Return fields | Key differences | Comments | | :-- | :-- | :-- | :-- | :-- | | `FN_T_IDENTITY_MAP` | Previous | `UID`, `BUCKET_ID`, `UNMAPPED` | Basic identity mapping with salt bucket tracking | Legacy function using salt bucket monitoring for refresh management. For details, see [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md).| | `FN_T_IDENTITY_MAP_V3` | Current | `UID`, `PREV_UID`, `REFRESH_FROM`, `UNMAPPED` | Enhanced with previous UID2 access and refresh timestamps | Returns previous UID2 for 90 days after rotation and uses refresh timestamps instead of salt bucket monitoring. For details, see [Map DII](#map-dii).| @@ -69,9 +69,9 @@ The following diagram and table illustrate the different parts of the UID2 integ ![Snowflake integration architecture](images/uid2-snowflake-integration-architecture-drawio.png) -|Partner Snowflake Account|UID2 Snowflake Account|UID2 Core Opt-Out Cloud Setup| +|Partner Snowflake account|UID2 Snowflake account|UID2 core opt-out cloud setup| | :--- | :--- | :--- | -|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 Share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can't access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | +|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can't access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | |When you use shared functions and views, you pay Snowflake for transactional computation costs. |These private tables, secured in the UID2 Snowflake account, automatically synchronize with the UID2 Core/Optout Snowflake storage that holds internal data used to complete UID2-related tasks. | | ## Preparing DII for processing @@ -154,7 +154,7 @@ select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_ All query examples use the following default values for each name variable: -| Variable | Default Value | Comments | +| Variable | Default value | Comments | |:------------------|:-------------------|:------------------------------------------------------------------------------------------------------------------------------------------| | `{DATABASE_NAME}` | `UID2_PROD_UID_SH` | If needed, you can change the default database name when creating a new database after you are granted access to the selected UID2 Share. | | `{SCHEMA_NAME}` | `UID` | This is an immutable name. | @@ -167,14 +167,14 @@ If the DII is an email address, the service normalizes the data using the UID2 [ If the DII is a phone number, you must normalize it before sending it to the service, using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. -| Argument | Data Type | Description | +| Argument | Data type | Description | |:-------------|:-------------|:--------------------------------------------------------------------------------------------| | `INPUT` | varchar(256) | The DII to map to the UID2, refresh timestamp and previous UID2 for 90 days after rotation. | | `INPUT_TYPE` | varchar(256) | The type of DII to map. Allowed values: `email`, `email_hash`, `phone`, and `phone_hash`. | A successful query returns the following information for the specified DII. -| Column Name | Data Type | Description | +| Column name | Data type | Description | |:---------------|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `UID` | TEXT | The value is one of the following: | | `PREV_UID` | TEXT | The value is one of the following: | @@ -397,7 +397,7 @@ The raw UID2 does not change before the refresh timestamp. After the refresh tim To determine which UID2s need regeneration, compare the current time to the `REFRESH_FROM` timestamps returned by the function. -| Column Name | Data Type | Description | +| Column name | Data type | Description | |:------------------|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `UID` | TEXT | The UID2 associated with the DII. This is the current UID2 value returned by the identity mapping function. | | `REFRESH_FROM` | NUMBER | The timestamp (in epoch seconds) indicating when this UID2 should be refreshed. Compare this value to the current time to determine if regeneration is needed. | @@ -462,13 +462,13 @@ The following activities support tokenized sharing: To encrypt raw UID2s to UID2 tokens, use the `FN_T_ENCRYPT` function. -|Argument|Data Type|Description| +|Argument|Data type|Description| | :--- | :--- | :--- | | `RAW_UID2` | varchar(128) | The raw UID2 to encrypt to a UID2 token. | A successful query returns the following information for the specified raw UID2. -|Column Name|Data Type|Description| +|Column name|Data type|Description| | :--- | :--- | :--- | | `UID_TOKEN` | TEXT | The value is one of the following: | | `ENCRYPTION_STATUS` | TEXT | The value is one of the following: | @@ -530,13 +530,13 @@ The following table identifies each item in the response, including `NULL` value To decrypt UID2 tokens to raw UID2s, use the `FN_T_DECRYPT` function. -| Argument | Data Type | Description | +| Argument | Data type | Description | |:------------|:-------------|:-----------------------------------------| | `UID_TOKEN` | varchar(512) | The UID2 token to decrypt to a raw UID2. | A successful query returns the following information for the specified UID2 token. -| Column Name |Data Type|Description| +| Column name |Data type|Description| |:--------------------| :--- | :--- | | `UID` | TEXT | The value is one of the following: | | `SITE_ID` | INT | The value is one of the following: | diff --git a/docs/guides/mobile-plugin-gma-ios.md b/docs/guides/mobile-plugin-gma-ios.md index f729145c2..b4b9afb3f 100644 --- a/docs/guides/mobile-plugin-gma-ios.md +++ b/docs/guides/mobile-plugin-gma-ios.md @@ -73,9 +73,9 @@ dependencies: [ In the Xcode user interface, under Package Dependencies, add the following entry for your apps: -| Name | Location | Dependency Rule | +| Name | Location | Dependency rule | | :--- | :--- | :--- | -| uid2-ios-plugin-google-gma | `git@github.com:IABTechLab/uid2-ios-plugin-google-gma.git` | Exact Version: 1.0.0 | +| UID2-iOS-plugin-Google-GMA | `git@github.com:IABTechLab/uid2-ios-plugin-google-gma.git` | Exact Version: 1.0.0 | ### Installing with CocoaPods diff --git a/docs/guides/mobile-plugin-ima-ios.md b/docs/guides/mobile-plugin-ima-ios.md index b41d146e0..f8fcde72b 100644 --- a/docs/guides/mobile-plugin-ima-ios.md +++ b/docs/guides/mobile-plugin-ima-ios.md @@ -73,9 +73,9 @@ dependencies: [ In the Xcode user interface, under Package Dependencies, add the following entry for your apps: -| Name | Location | Dependency Rule | +| Name | Location | Dependency rule | | :--- | :--- | :--- | -| uid2-ios-plugin-google-ima | `git@github.com:IABTechLab/uid2-ios-plugin-google-ima.git` | Exact Version: 1.0.0 | +| UID2-iOS-plugin-Google-IMA | `git@github.com:IABTechLab/uid2-ios-plugin-google-ima.git` | Exact Version: 1.0.0 | ### Installing with CocoaPods diff --git a/docs/guides/operator-guide-aks-enclave.md b/docs/guides/operator-guide-aks-enclave.md index a3a50db7d..953e1e56e 100644 --- a/docs/guides/operator-guide-aks-enclave.md +++ b/docs/guides/operator-guide-aks-enclave.md @@ -35,7 +35,7 @@ UID2 Private Operator for AKS is not supported in these areas: Europe, China. The latest ZIP file is linked in the AKS Download column in the following table. -| AKS Version Name | Version #/Release Notes | AKS Download | Date | Deprecation Date | +| AKS version name | Version #/release notes | AKS download | Date | Deprecation date | | ------- | ------ | ------ | ------ | ------ | | Q2 2025 | xxx | xxx | xxx | xxx | diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index ae80b09e1..6483b4403 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -35,7 +35,7 @@ By subscribing to UID2 Private Operator for AWS, you gain access to the followin The latest ZIP file is linked in the Release Notes column in the following table. -| Version Name | Version #/Release Notes | AWS Version | Date | +| Version name | Version #/release notes | AWS version | Date | | ------- | ------ | ------ | ------ | | H1 2026 | [v5.70.159](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.70.159-r0) | v5.70.159-r0 | June 23, 2026 | @@ -149,7 +149,7 @@ Here's what you can customize during or after the [deployment](#deployment): To avoid passing certificates associated with your domain into the enclave, inbound HTTP is allowed instead of HTTPS. This also avoids the cost of a secure layer, if used in a private network that is internal to your organization. ::: -| Port Number | Direction | Protocol | Description | +| Port number | Direction | Protocol | Description | | ----------- | --------- | -------- | ------ | | 80 | Inbound | HTTP | Serves all UID2 APIs, including the healthcheck endpoint `/ops/healthcheck`.
    When everything is up and running, the endpoint returns HTTP 200 with a response body of `OK`. For details, see [Checking UID2 Operator status](#checking-uid2-operator-status). | | 9080 | Inbound | HTTP | Serves Prometheus metrics (`/metrics`). | @@ -203,11 +203,11 @@ The following table explains the parameter values that you need to provide in st | :--- |:--- | |Stack name |Any name of your choice. | |OPERATOR_KEY |The Operator Key that you received from the UID2 Admin team. | -|UID2 Environment |Select `prod` for production environment or `integ` for the integration test environment. | -|Instance Type |`m5.2xlarge` is recommended. | +|UID2 environment |Select `prod` for production environment or `integ` for the integration test environment. | +|Instance type |`m5.2xlarge` is recommended. | |Instance root volume size |15 GB or more is recommended. | -|Key Name for SSH |Your EC2 key pair for SSH access to the deployed EC2 instances. | -|Trusted Network CIDR |The CIDR (Classless Inter-Domain Routing) value determines the IP address range that can access your operator service.
    To limit access to the UID2 Operators so that they can only be accessed through an internal network or a load balancer, specify an internal IP range as the CIDR value. | +|Key name for SSH |Your EC2 key pair for SSH access to the deployed EC2 instances. | +|Trusted network CIDR |The CIDR (Classless Inter-Domain Routing) value determines the IP address range that can access your operator service.
    To limit access to the UID2 Operators so that they can only be accessed through an internal network or a load balancer, specify an internal IP range as the CIDR value. | |VPC |The existing VPC ID. | |VpcSubnet1 |The existing VPC AZ1 Subnet ID. | |VpcSubnet2 |The existing VPC AZ2 Subnet ID. | @@ -386,7 +386,7 @@ Error codes for Private Operator issues are applicable only to release v5.49.7 a The following errors might occur during operator startup: -| Error Code | Issue | Steps to Resolve | +| Error code | Issue | Steps to resolve | | :--- | :--- | :--- | | E01 | InstanceProfileMissingError | Attach an IAM instance profile to the EC2 instance with the required permissions. The UID2 Operator needs these permissions to access configurations from AWS Secrets Manager. | | E02 | OperatorKeyNotFoundError | Make sure that the secret referenced by the Private Operator exists in AWS Secrets Manager in the same region as the operator, and that the IAM instance profile has permission to access the secret. If needed, you can check the logs for the specific secret name and region. | diff --git a/docs/guides/operator-guide-azure-enclave.md b/docs/guides/operator-guide-azure-enclave.md index a7f2a5ae4..dcc2cd641 100644 --- a/docs/guides/operator-guide-azure-enclave.md +++ b/docs/guides/operator-guide-azure-enclave.md @@ -32,7 +32,7 @@ UID2 Private Operator for Azure is not supported in these areas: Europe, China. The latest ZIP file is linked in the Azure Download column in the following table. -| Version Name | Version Number | Release Notes | Azure Download | Date | Deprecation Date | +| Version name | Version number | Release notes | Azure download | Date | Deprecation date | | ------- | ------ | ------ | ------ | ------ | ------ | | H1 2026 | v5.70.159 | [v5.70.159](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.70.159-r0) | [azure-cc-deployment-files-5.70.159-r0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.70.159-r0/azure-cc-deployment-files-5.70.159-r0.zip) | June 23, 2026 | June 30, 2027 | @@ -325,7 +325,7 @@ To avoid passing certificates associated with your domain into the enclave, only The following table provides information about supported protocols. -| Port Number | Direction | Protocol | Description | +| Port number | Direction | Protocol | Description | | ----------- | --------- | -------- | ------ | | 80 | Inbound | HTTP | Serves all UID2 APIs, including the health check endpoint `/ops/healthcheck`.
    When everything is up and running, the endpoint returns HTTP 200 with a response body of `OK`. For details, see [Running the health check](#running-the-health-check). | | 9080 | Inbound | HTTP | Serves Prometheus metrics (`/metrics`). For details, see [Scraping metrics](#scraping-metrics). | @@ -377,7 +377,7 @@ Error codes for Private Operator issues are applicable only to release v5.49.7 a The following errors might occur during operator startup: -| Error Code | Issue | Steps to Resolve | +| Error code | Issue | Steps to resolve | | :--- | :--- | :--- | | E02 | OperatorKeyNotFoundError | Make sure that the secret vault and secret name that store the operator key are correctly configured. Make sure they are set as `VAULT_NAME` and `OPERATOR_KEY_SECRET_NAME`. | | E03 | ConfigurationMissingError | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes before running the Azure operator. | diff --git a/docs/guides/operator-private-gcp-confidential-space.md b/docs/guides/operator-private-gcp-confidential-space.md index 285c4471b..cb20f080f 100644 --- a/docs/guides/operator-private-gcp-confidential-space.md +++ b/docs/guides/operator-private-gcp-confidential-space.md @@ -34,7 +34,7 @@ When the attestation is successful, the UID2 Core Service provides seed informat The latest ZIP file is linked in the GCP Download column in the following table. -| Version Name | Version #/Release Notes | GCP Download | Date | Deprecation Date | +| Version name | Version #/release notes | GCP download | Date | Deprecation date | | ------- | ------ | ------ | ------ | ------ | | H1 2026 | [v5.70.159](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.70.159-r0) | [gcp-oidc-deployment-files-5.70.159-r0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.70.159-r0/gcp-oidc-deployment-files-5.70.159-r0.zip) | June 23, 2026 | June 30, 2027 | @@ -416,7 +416,7 @@ This section includes: Placeholder values are defined in the following table. -| Placeholder | Actual Value | +| Placeholder | Actual value | | :--- | :--- | | `{INSTANCE_NAME}` | Your own valid VM name. | | `{ZONE}` | The Google Cloud zone that the VM instance will be deployed on. | @@ -557,7 +557,7 @@ Error codes for Private Operator issues are applicable only to release v5.49.7 a The following errors might occur during operator startup: -| Error Code | Issue | Steps to Resolve | +| Error code | Issue | Steps to resolve | | :--- | :--- | :--- | | E02 | OperatorKeyNotFoundError | Make sure that the secret name specified exists in GCP Secret Manager in the same project as the operator, and that the service account has permission to access the secret. Make sure it's set to: `tee-env-API_TOKEN_SECRET_NAME`. If needed, you can check the logs for the specific secret name. | | E03 | ConfigurationMissingError | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes before running GCP operator. | diff --git a/docs/guides/summary-guides.md b/docs/guides/summary-guides.md index f081b6ca0..3ac4753a3 100644 --- a/docs/guides/summary-guides.md +++ b/docs/guides/summary-guides.md @@ -40,7 +40,7 @@ The following documentation resources are available for publisher web integratio For a detailed summary of web integration options, see [Publisher web integration overview](integration-options-publisher-web.md). ::: -| Integration Guide | Content Description | +| Integration guide | Content description | | :--- | :--- | | [Integration overview for Prebid](integration-prebid.md) | An overview of options for publishers who want to integrate with UID2 and generate UID2 tokens (advertising tokens) to be passed by Prebid.js and the Prebid Mobile SDK in the RTB bidstream. | | [Client-side integration guide for Prebid.js](integration-prebid-client-side.md) | An integration guide for publishers who want to integrate with UID2 and want Prebid.js to manage token generation and automatic token refresh as well as passing the tokens into the RTB bidstream. This guide is for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach. | @@ -55,7 +55,7 @@ For a detailed summary of web integration options, see [Publisher web integratio The following documentation resources are available for publishers integrating with Android or iOS devices. -| Integration Guide | Content Description | +| Integration guide | Content description | | :--- | :--- | | [Mobile integration overview for Android and iOS](integration-mobile-overview.md) | An overview of options for mobile app publishers who want to integrate with UID2 using the SDK for Android or the SDK for iOS. | | [Client-side integration guide for mobile](integration-mobile-client-side.md) | An integration guide for mobile app publishers who want to integrate with UID2 with changes only within the mobile app (no server-side changes). | @@ -66,7 +66,7 @@ The following documentation resources are available for publishers integrating w The following documentation resources are available for publisher integrations supporting CTV. -| Integration Guide | Content Description | +| Integration guide | Content description | | :--- | :--- | | [CTV integration guide](integration-ctv-guide.md) | A summary of CTV integration options, with links to additional information and instructions. | @@ -74,7 +74,7 @@ The following documentation resources are available for publisher integrations s The following resources are available for publishers integrating with Prebid. -| Integration Guide | Content Description | +| Integration guide | Content description | | :--- | :--- | | [Integration overview for Prebid](integration-prebid.md) | An overview of options for publishers who want to integrate with UID2 and generate UID2 tokens to be passed by Prebid.js or the Prebid Mobile SDK in the RTB bidstream. | | [Client-side integration guide for Prebid.js](integration-prebid-client-side.md) | An integration guide for publishers who want to integrate with UID2 and want Prebid.js to manage token generation and automatic token refresh as well as passing the tokens into the RTB bidstream. This guide is for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach. | @@ -85,7 +85,7 @@ The following resources are available for publishers integrating with Prebid. The following resources are available for publishers integrating with Google Ad Manager. -| Integration Guide | Content Description | +| Integration guide | Content description | | :--- | :--- | | [Google Ad Manager Secure Signals integration guide](integration-google-ss.md) | This integration guide covers the additional steps needed for publishers using UID2 with the Google Ad Manager Secure Signals feature (previously known as Encrypted Signals for Publishers, ESP). | | [GMA Plugin for Android integration guide](mobile-plugin-gma-android.md) | The UID2 Google Mobile Ads (GMA) Plugin for Android enables publishers that use the [Google GMA SDK](https://developers.google.com/ad-manager/mobile-ads-sdk) to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps. | @@ -97,11 +97,11 @@ The following resources are available for publishers integrating with Google Ad The following documentation resources are available for advertisers and data providers integrating with UID2. -| Integration Guide | Content Description | +| Integration guide | Content description | | :--- | :--- | | [Advertiser/data provider overview](integration-advertiser-dataprovider-overview.md) | This guide provides an overview of integration options for organizations that collect user data and push it to other UID2 participants. | | [Snowflake integration guide](integration-snowflake.md) | Instructions for generating UID2s from emails or phone numbers within Snowflake. | -| [Databricks clean rooms integration guide](integration-databricks.md) | Instructions for generating UID2s from emails or phone numbers in a Databricks Clean Rooms environment. | +| [Databricks Clean Rooms integration guide](integration-databricks.md) | Instructions for generating UID2s from emails or phone numbers in a Databricks Clean Rooms environment. | | [AWS Entity Resolution integration guide](integration-aws-entity-resolution.md) | Instructions for integrating with the UID2 framework using AWS Entity Resolution. | | [Advertiser/data provider integration to HTTP endpoints](integration-advertiser-dataprovider-endpoints.md) | This guide covers integration steps for advertisers and data providers to integrate with UID2 by writing code to call UID2 HTTP endpoints, rather than using another implementation option such as an SDK, Snowflake, or AWS Entity Resolution. | | [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | A guide for advertisers and data providers who want to use this SDK for adding a UID2 token to their tracking pixels. | @@ -110,7 +110,7 @@ The following documentation resources are available for advertisers and data pro The following documentation resources are available for DSPs integrating with UID2. -| Integration Guide | Content Description | +| Integration guide | Content description | | :--- | :--- | | [DSP integration guide](dsp-guide.md) | This integration guide for DSPs covers handling UID2s for bidding and honoring user opt-outs. | | [DSP direct integration instructions](integration-dsp-no-sdk.md) | Instructions for DSPs who prefer to integrate without using one of the UID2 SDKs. | @@ -119,7 +119,7 @@ The following documentation resources are available for DSPs integrating with UI The following resources are available for Private Operator integrations. -| Integration Guide | Content Description | +| Integration guide | Content description | | :--- | :--- | | [Private Operator for AWS](operator-guide-aws-marketplace.md) | Instructions for setting up a Private Operator service for AWS Marketplace. | | [Private Operator for GCP](operator-private-gcp-confidential-space.md) | Information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from [Google Cloud](https://cloud.google.com/docs/overview/) Platform. | diff --git a/docs/overviews/overview-advertisers.md b/docs/overviews/overview-advertisers.md index 4e1b32398..f0c0500b3 100644 --- a/docs/overviews/overview-advertisers.md +++ b/docs/overviews/overview-advertisers.md @@ -71,11 +71,11 @@ To get started, follow these steps: The following documentation resources are available for advertisers and data providers to implement UID2. -| Integration Type| Documentation | Content Description | +| Integration type| Documentation | Content description | | :--- | :--- | :--- | | Overview of integration options for organizations that collect user data and push it to other UID2 participants | [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) | This guide covers integration workflows for mapping identity for audience-building and targeting. | | Snowflake | [Snowflake integration guide](../guides/integration-snowflake.md) | This guide provides instructions for generating UID2s from emails or phone numbers within Snowflake. | -| Databricks Clean Rooms | [Databricks clean rooms integration guide](../guides/integration-databricks.md) | This guide provides instructions for generating UID2s from emails or phone numbers in a Databricks Clean Rooms environment. | +| Databricks Clean Rooms | [Databricks Clean Rooms integration guide](../guides/integration-databricks.md) | This guide provides instructions for generating UID2s from emails or phone numbers in a Databricks Clean Rooms environment. | | AWS Entity Resolution | [AWS Entity Resolution integration guide](../guides/integration-aws-entity-resolution.md) | This guide provides instructions for integrating with the UID2 framework using AWS Entity Resolution. | | Integration steps for organizations that collect user data and push it to other UID2 participants, using UID2 HTTP endpoints only | [Advertiser/data provider integration to HTTP endpoints](../guides/integration-advertiser-dataprovider-endpoints.md) | This guide covers integration steps for advertisers and data providers to integrate with UID2 by writing code to call UID2 HTTP endpoints, rather than using another implementation option such as an SDK, Snowflake, or AWS Entity Resolution. | | Integration steps for advertisers and data providers who want to use the client-side JavaScript SDK for adding a UID2 token to their tracking pixels. | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | This guide provides instructions for generating UID2 tokens (advertising tokens) using only JavaScript client-side changes. | diff --git a/docs/overviews/overview-data-providers.md b/docs/overviews/overview-data-providers.md index 0216713f1..532991206 100644 --- a/docs/overviews/overview-data-providers.md +++ b/docs/overviews/overview-data-providers.md @@ -76,11 +76,11 @@ To get started, follow these steps: The following documentation resources are available for advertisers and data providers to implement UID2. -| Integration Type| Documentation | Content Description | +| Integration type| Documentation | Content description | | :--- | :--- | :--- | | Overview of integration options for organizations that collect user data and push it to other UID2 participants | [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) | This guide covers integration workflows for mapping identity for audience-building and targeting. | | Snowflake | [Snowflake integration guide](../guides/integration-snowflake.md) | This guide provides instructions for generating UID2s from emails or phone numbers within Snowflake. | -| Databricks Clean Rooms | [Databricks clean rooms integration guide](../guides/integration-databricks.md) | This guide provides instructions for generating UID2s from emails or phone numbers in a Databricks Clean Rooms environment. | +| Databricks Clean Rooms | [Databricks Clean Rooms integration guide](../guides/integration-databricks.md) | This guide provides instructions for generating UID2s from emails or phone numbers in a Databricks Clean Rooms environment. | | AWS Entity Resolution | [AWS Entity Resolution integration guide](../guides/integration-aws-entity-resolution.md) | This guide provides instructions for integrating with the UID2 framework using AWS Entity Resolution. | | Integration steps for organizations that collect user data and push it to other UID2 participants, using UID2 HTTP endpoints only | [Advertiser/data provider integration to HTTP endpoints](../guides/integration-advertiser-dataprovider-endpoints.md) | This guide covers integration steps for advertisers and data providers to integrate with UID2 by writing code to call UID2 HTTP endpoints, rather than using another implementation option such as an SDK, Snowflake, or AWS Entity Resolution. | | Integration steps for advertisers and data providers who want to use the client-side JavaScript SDK for adding a UID2 token to their tracking pixels. | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | This guide provides instructions for generating UID2 tokens (advertising tokens) using only JavaScript client-side changes. | diff --git a/docs/overviews/overview-dsps.md b/docs/overviews/overview-dsps.md index 9a6226023..85fab9c13 100644 --- a/docs/overviews/overview-dsps.md +++ b/docs/overviews/overview-dsps.md @@ -83,7 +83,7 @@ To get started, follow these steps: The following documentation resources are available for DSPs to implement UID2. -| Type| Documentation | Content Description | +| Type| Documentation | Content description | | :--- | :--- | :--- | | SDK for Java | [SDK for Java reference guide](../sdks/sdk-ref-java.md) | An SDK for anyone using Java server-side and who wants to decrypt UID2 advertising tokens to access the raw UID2.| | SDK for Python | [SDK for Python reference guide](../sdks/sdk-ref-python.md) | An SDK for anyone using Python server-side and who wants to decrypt UID2 advertising tokens to access the raw UID2.| diff --git a/docs/overviews/participants-overview.md b/docs/overviews/participants-overview.md index 8b286c003..278903a29 100644 --- a/docs/overviews/participants-overview.md +++ b/docs/overviews/participants-overview.md @@ -23,16 +23,16 @@ The following table summarizes information about key participant components of t For a diagram of how the different services work together, see [UID2 workflows](../ref-info/uid-workflows.md). -| Participant | Role Description | +| Participant | Role description | | :--- | :--- | -| **Core Administrator** | An organization (currently, The Trade Desk) that manages the UID2 Core Service and other component services. For example, it distributes encryption keys and salts to UID2 operators and sends user opt-out requests to operators and DSPs. | +| **Core administrator** | An organization (currently, The Trade Desk) that manages the UID2 Core Service and other component services. For example, it distributes encryption keys and salts to UID2 operators and sends user opt-out requests to operators and DSPs. | | **Operators** | Organizations that run the Operator Service (via the UID2 APIs). Operators periodically receive and store up-to-date encryption keys and salts from the UID2 Core Service, salt and hash directly identifying information (DII) to return raw UID2s, encrypt raw UID2s to generate UID2 tokens, and distribute UID2 token decryption keys.
    Public Operators (Open Operators) run public instances of the Operator Service. For example, The Trade Desk currently serves as a Public Operator for the UID2 framework, available to all participants. If other Public Operators are available, a participant can choose which operator to work with.
    Any participant can also choose to become a Private Operator to generate and manage UID2s. | ## UID2 external participants The following table summarizes the main types of external participant partners for UID2, with a link to the overview page for more information on each participant type. -| Participant Type | Role Description | +| Participant type | Role description | | :--- | :--- | | [Publishers](overview-publishers.md) | Organizations that propagate UID2 tokens to the bidstream via SSPs—for example, identity providers, publishers, and SSO providers. Publishers can choose to work with an SSO provider or an independent ID provider that is interoperable with UID2. Independent ID providers can handle the UID2 integration on behalf of publishers. | | [Advertisers](overview-advertisers.md) | Organizations that buy impressions across a range of publisher sites and use DSPs to decide which ad impressions to purchase and how much to bid on them. | diff --git a/docs/portal/audit-trail.md b/docs/portal/audit-trail.md index d3f48b7ed..b0dff8784 100644 --- a/docs/portal/audit-trail.md +++ b/docs/portal/audit-trail.md @@ -18,7 +18,7 @@ The Audit Trail log displays the types of information summarized in the followin | Date | Date/time that the action occurred. | | User | The user who performed the action. | | Event | The action performed. For a summary of possible values, see [Audit trail event types](#audit-trail-event-types). | -| Event Data | Details about the action. | +| Event data | Details about the action. | | Succeeded | Indicates whether or not the action was successful. | ## Audit trail event types diff --git a/docs/portal/client-side-integration.md b/docs/portal/client-side-integration.md index 91db9c9bc..6e0e5d7ce 100644 --- a/docs/portal/client-side-integration.md +++ b/docs/portal/client-side-integration.md @@ -15,11 +15,11 @@ These instructions are for client-side implementations. If your UID2 implementat In the UID2 Portal, if you want to use an implementation option that generates UID2 tokens on the client side, you'll need to define the following values that are applicable to your implementation type: -| Value | Implementation Type | Details | Documentation Link | +| Value | Implementation type | Details | Documentation link | | :--- | :--- | :---| :---| | Key pair | All (web or mobile) | At least one. In your implementation, you'll share the public key. | [Subscription ID and public key](../getting-started/gs-credentials.md#subscription-id-and-public-key) | | Domain | Web | At least one. Provide a complete list of your root-level domains. | [Client-side web integrations](../getting-started/gs-account-setup.md#client-side-web-integrations) | -| Mobile App ID | Mobile | Any IDs that apply to your mobile apps, such as Android App ID, iOS/tvOS Bundle ID, or iOS App Store ID. | [Client-side mobile integrations](../getting-started/gs-account-setup.md#client-side-mobile-integrations) | +| Mobile app ID | Mobile | Any IDs that apply to your mobile apps, such as Android App ID, iOS/tvOS Bundle ID, or iOS App Store ID. | [Client-side mobile integrations](../getting-started/gs-account-setup.md#client-side-mobile-integrations) | :::important It's important to provide a complete list of root-level domain names for your sites, and mobile app IDs for your apps. This is a security measure, for client-side implementation only. If a domain or app is not defined in the UID2 Portal, UID2 token requests from that domain or app will fail. @@ -38,11 +38,11 @@ When you go into the Client-Side Integration page, you'll be prompted to provide Client-side implementation options are shown in the following table. The options available to you depend on your role. -| Client-Side Implementation Option | Available For (Role) | Documentation Link | +| Client-side implementation option | Available for (role) | Documentation link | | :--- | :--- | :---| | UID2 JavaScript SDK | Publishers, Advertisers | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | | Prebid.js client-side integration | Publishers only |[Client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) | -| UID2 Mobile SDK | Publishers only |[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) | +| UID2 mobile SDK | Publishers only |[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) | ## Adding and managing key pairs diff --git a/docs/portal/portal-getting-started.md b/docs/portal/portal-getting-started.md index 0d7719314..ef3a0e61e 100644 --- a/docs/portal/portal-getting-started.md +++ b/docs/portal/portal-getting-started.md @@ -123,7 +123,7 @@ When you log in for the first time, you can complete the following configuration The following table includes details of the information you'll need, and a link to instructions. -| Item | Details | Link to Instructions | +| Item | Details | Link to instructions | | :--- | :--- | :--- | | Team member information | For each, provide the following:
    - First name
    - Last name
    - Email
    - Job function
    - Role | [Team members](team-members.md) | | Email contact information | For each, provide the following:
    - Email group name
    - Email alias
    - Contact type | [Email contacts](email-contacts.md) | diff --git a/docs/portal/portal-overview.md b/docs/portal/portal-overview.md index 0f1f09049..db4655827 100644 --- a/docs/portal/portal-overview.md +++ b/docs/portal/portal-overview.md @@ -11,17 +11,17 @@ import Link from '@docusaurus/Link'; The UID2 Portal is your one-stop shop for setting up and configuring your UID2 account. In this self-serve portal, you can complete all basic setup steps for UID2 participation. Click through on the links for more information about each activity. -| Activity | Documentation Link | +| Activity | Documentation link | | :--- | :--- | | Request an account, configure basic account information such as name and location, log in for the first time, and reset your password. | [Getting started with the UID2 Portal](portal-getting-started.md) | | Review your profile. | [Participant information](participant-info.md) | -| Server-side or client-server integrations: Manage API keys for your account, including adding, modifying, or deleting keys. | [API keys](api-keys.md) | -| Client-side integrations only: Set up and manage the values needed for generating UID2 tokens on the client side. | [Client-side integration](client-side-integration.md) | -| Configure permissions for individual sharing participants or groups of sharing participants.
    NOTE: Use of sharing requires an API key (see [API keys](api-keys.md)) or client-side key pair (see [Client-side integration](client-side-integration.md)). Configure these values before setting up sharing permissions. | [Sharing permissions](sharing-permissions.md) | +| Server-side or client-server integrations: manage API keys for your account, including adding, modifying, or deleting keys. | [API keys](api-keys.md) | +| Client-side integrations only: set up and manage the values needed for generating UID2 tokens on the client side. | [Client-side integration](client-side-integration.md) | +| Configure permissions for individual sharing participants or groups of sharing participants.
    note: use of sharing requires an API key (see [API keys](api-keys.md)) or client-side key pair (see [client-side integration](client-side-integration.md)). configure these values before setting up sharing permissions. | [Sharing permissions](sharing-permissions.md) | | Add team members who will have permission to manage your account. | [Team members](team-members.md) | | Set up designated email contacts who will be notified of news or updates. | [Email contacts](email-contacts.md) | | View a detailed log of all past actions performed by, or on behalf of, the current participant. | [Audit trail](audit-trail.md) | -| Change password when required by the Portal. | [Password change requirement](portal-getting-started.md#password-change-requirement) | +| Change password when required by the portal. | [Password change requirement](portal-getting-started.md#password-change-requirement) | ## Access the UID2 Portal diff --git a/docs/ref-info/deprecation-schedule.md b/docs/ref-info/deprecation-schedule.md index 6e900e21e..ad75c3e0f 100644 --- a/docs/ref-info/deprecation-schedule.md +++ b/docs/ref-info/deprecation-schedule.md @@ -32,13 +32,13 @@ If you're using an older version, refer to the applicable table, Deprecation Dat The latest ZIP file is available in the Assets section at the bottom of the linked Release Notes in the following table. -| Version Name | Version #/Release Notes | AWS Version | Date | Deprecation Date | +| Version name | Version #/release notes | AWS version | Date | Deprecation date | | ------- | ------ | ------ | ------ | ------ | | H1 2026 | [v5.70.159](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.70.159-r0) | v5.70.159-r0 | June 23, 2026 | June 30, 2027 | | Q4 2025 | [v5.62.24](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.62.24-r2) | v5.62.24-r2 | January 15, 2026 | January 15, 2027 | | Q2 2025 | [v5.55.9](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.55.9-r1) | v5.55.9-r1 | July 1, 2025 | July 1, 2026 | | Q1 2025 | [v5.49.7](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.49.7) | 5.49.7 | Mar 19, 2025 | Mar 31, 2026 | -| Q3 2024 Out-of-band | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | 5.41.0 | October 29, 2024 | Mar 31, 2026 | +| Q3 2024 out-of-band | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | 5.41.0 | October 29, 2024 | Mar 31, 2026 | | Q3 2024 | [v5.38.104](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.38.104) | 5.38.104 | September 12, 2024 | Mar 31, 2026 | | Q2 2024 | [v5.37.12](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.37.12) | 5.37.12 | June 12, 2024 | Sep 30, 2025 | @@ -48,13 +48,13 @@ For documentation, see [Private Operator for AWS integration guide](../guides/op The latest ZIP file is linked in the GCP Download column in the following table. -| Version Name | Version #/Release Notes | GCP Download | Date | Deprecation Date | +| Version name | Version #/release notes | GCP download | Date | Deprecation date | | ------- | ------ | ------ | ------ | ------ | | H1 2026 | [v5.70.159](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.70.159-r0) | [gcp-oidc-deployment-files-5.70.159-r0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.70.159-r0/gcp-oidc-deployment-files-5.70.159-r0.zip) | June 23, 2026 | June 30, 2027 | | Q4 2025 | [v5.62.24](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.62.24-r2) | [gcp-oidc-deployment-files-5.62.24-r2.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.62.24-r2/gcp-oidc-deployment-files-5.62.24-r2.zip) | January 15, 2026 | January 15, 2027 | | Q2 2025 | [v5.55.9](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.55.9-r1) | [gcp-oidc-deployment-files-5.55.9-r1.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.55.9-r1/gcp-oidc-deployment-files-5.55.9-r1.zip) | July 1, 2025 | July 1, 2026 | | Q1 2025 | [v5.49.7](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.49.7) | [gcp-oidc-deployment-files-5.49.7.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.49.7/gcp-oidc-deployment-files-5.49.7.zip) | Mar 19, 2025 | Mar 31, 2026 | -| Q3 2024 Out-of-band | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | [gcp-oidc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/gcp-oidc-deployment-files-5.41.0.zip) | October 29, 2024 | Mar 31, 2026 | +| Q3 2024 out-of-band | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | [gcp-oidc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/gcp-oidc-deployment-files-5.41.0.zip) | October 29, 2024 | Mar 31, 2026 | | Q3 2024 | [v5.38.104](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.38.104) | [gcp-oidc-deployment-files-5.38.104.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.38.104/gcp-oidc-deployment-files-5.38.104.zip) | September 12, 2024 | Mar 31, 2026 | | Q2 2024 | [v5.37.12](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.37.12) | [gcp-oidc-deployment-files-5.37.12.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.37.12/gcp-oidc-deployment-files-5.37.12.zip) | June 12, 2024 | Sep 30, 2025 | @@ -64,13 +64,13 @@ For documentation, see [Private Operator for GCP integration guide](../guides/op The latest ZIP file is linked in the Azure Download column in the following table. -| Version Name | Version #/Release Notes | Azure Download | Date | Deprecation Date | +| Version name | Version #/release notes | Azure download | Date | Deprecation date | | ------- | ------ | ------ | ------ | ------ | | H1 2026 | [v5.70.159](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.70.159-r0) | [azure-cc-deployment-files-5.70.159-r0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.70.159-r0/azure-cc-deployment-files-5.70.159-r0.zip) | June 23, 2026 | June 30, 2027 | | Q4 2025 | [v5.62.24](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.62.24-r2) | [azure-cc-deployment-files-5.62.24-r2.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.62.24-r2/azure-cc-deployment-files-5.62.24-r2.zip) | January 15, 2026 | January 15, 2027 | | Q2 2025 | [v5.55.9](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.55.9-r1) | [azure-cc-deployment-files-5.55.9-r1.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.55.9-r1/azure-cc-deployment-files-5.55.9-r1.zip) | July 1, 2025 | July 1, 2026 | | Q1 2025 | [v5.49.7](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.49.7) | [azure-cc-deployment-files-5.49.7.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.49.7/azure-cc-deployment-files-5.49.7.zip) | Mar 19, 2025 | Mar 31, 2026 | -| Q3 2024 Out-of-band | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | [azure-cc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/azure-cc-deployment-files-5.41.0.zip) | October 29, 2024 | Mar 31, 2026 | +| Q3 2024 out-of-band | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | [azure-cc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/azure-cc-deployment-files-5.41.0.zip) | October 29, 2024 | Mar 31, 2026 | | Q3 2024 | [v5.38.104](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.38.104) | [azure-cc-deployment-files-5.38.104.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.38.104/azure-cc-deployment-files-5.38.104.zip) | September 12, 2024 | Mar 31, 2026 | | Q2 2024 | [v5.37.12](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.37.12) | [azure-cc-deployment-files-5.37.12.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.37.12/azure-cc-deployment-files-5.37.12.zip) | June 12, 2024 | Sep 30, 2025 | @@ -80,7 +80,7 @@ For documentation, see [Private Operator for Azure integration guide](../guides/ The latest ZIP file is linked in the Release Notes column in the following table. -| AKS Version Name | Version #/Release Notes | AKS Download | Date | Deprecation Date | +| AKS version name | Version #/release notes | AKS download | Date | Deprecation date | | ------- | ------ | ------ | ------ | ------ | | Q2 2025 | xxx | xxx | xxx | xxx | --> diff --git a/docs/ref-info/ref-how-uid-is-created.md b/docs/ref-info/ref-how-uid-is-created.md index 490e9c343..49519ee5d 100644 --- a/docs/ref-info/ref-how-uid-is-created.md +++ b/docs/ref-info/ref-how-uid-is-created.md @@ -34,7 +34,7 @@ For an example with sample values, see [Creating a UID2 token—example](#cr - + diff --git a/docs/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md b/docs/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md index bc8e2ae4b..5d97fd481 100644 --- a/docs/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md +++ b/docs/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md @@ -35,7 +35,7 @@ If you're using a UID2 SDK, or other integration solution such as the Prebid.js - + diff --git a/docs/ref-info/ref-server-side-token-generation.md b/docs/ref-info/ref-server-side-token-generation.md index a77f3ff9e..aed185100 100644 --- a/docs/ref-info/ref-server-side-token-generation.md +++ b/docs/ref-info/ref-server-side-token-generation.md @@ -24,7 +24,7 @@ For security reasons, the API key and secret used in token generation *must* be Options are summarized in the following table. -| Integration Solution | Generate Token | Refresh Token | +| Integration solution | Generate token | Refresh token | | :--- | :--- | :--- | | [SDK for Java](../sdks/sdk-ref-java.md) | ✅ | ✅ | | [SDK for Python](../sdks/sdk-ref-python.md) | ✅ | ✅ | diff --git a/docs/ref-info/ref-token-validator.md b/docs/ref-info/ref-token-validator.md index 865ffd27a..39d79bbc3 100644 --- a/docs/ref-info/ref-token-validator.md +++ b/docs/ref-info/ref-token-validator.md @@ -64,14 +64,14 @@ When you click **Validate Tokens**, the **Validation Results** table displays a | Column | Description | |---|---| | Identifier | The DII you entered. | -| Identifier Type | `email`, `phone`, `email_hash` or `phone_hash`. | -| Normalized Hash | The Base64-encoded SHA-256 hash of the normalized DII. | +| Identifier type | `email`, `phone`, `email_hash` or `phone_hash`. | +| Normalized hash | The Base64-encoded SHA-256 hash of the normalized DII. | | Token | The token you submitted. | | Validation | The result of the validation. For details, see the following table. | The **Validation** column reflects the response from the [POST /token/validate](../endpoints/post-token-validate.md) endpoint. -| Validation Result | Meaning | +| Validation result | Meaning | |---|---| | `Token matches identifier` | The token matches the provided DII. This means that the token was generated from the correct normalized hash. | | `Failed: Token does not match identifier` | The token does not match the provided DII. The most likely cause is incorrect normalization or hashing. | diff --git a/docs/ref-info/ref-uid-verify.md b/docs/ref-info/ref-uid-verify.md index b6a646b92..322b5eee2 100644 --- a/docs/ref-info/ref-uid-verify.md +++ b/docs/ref-info/ref-uid-verify.md @@ -97,11 +97,11 @@ SDK and Prebid.js integrations include the fields shown in the following table. | Field | Description | |---|---| -| Storage Type | Indicates whether the identity is stored in a cookie or `localStorage`. | -| Storage Key | The name of the cookie or `localStorage` key. For UID2 SDK integrations: `__uid_2` or `UID2-sdk-identity`. For Prebid.js integrations: `__uid2_advertising_token`. | -| Stored Value | The raw identity JSON, including `advertising_token`, `refresh_token`, `identity_expires`, `refresh_expires`, `refresh_from`, and `refresh_response_key`. | -| Valid Identity | Indicates whether the stored identity is currently valid — that is, the advertising token has not expired and the user has not opted out. | -| Optout Identity | Indicates whether the identity reflects an opted-out user. | +| Storage type | Indicates whether the identity is stored in a cookie or `localStorage`. | +| Storage key | The name of the cookie or `localStorage` key. For UID2 SDK integrations: `__uid_2` or `UID2-sdk-identity`. For Prebid.js integrations: `__uid2_advertising_token`. | +| Stored value | The raw identity JSON, including `advertising_token`, `refresh_token`, `identity_expires`, `refresh_expires`, `refresh_from`, and `refresh_response_key`. | +| Valid identity | Indicates whether the stored identity is currently valid — that is, the advertising token has not expired and the user has not opted out. | +| Optout identity | Indicates whether the identity reflects an opted-out user. | For Google Secure Signals integrations, the tab shows the status of the secure signal and the current UID2 advertising token. If no signal has been generated yet, it indicates that neither a cached signal nor a UID2 SDK advertising token is available. When the collector function has run successfully, the extension displays a "Secure signal is cached" status message and shows the cached value stored under `_GESPSK-uidapi.com`. The cached signal is in the format `[providerId, advertisingToken, expiryTimestamp]`. The current UID2 advertising token is also displayed separately. @@ -118,7 +118,7 @@ The **Event History** tab shows a searchable, real-time log of UID2 SDK events a | Date | The date the event was recorded. | | Time | The time the event was recorded. | | Event | The event type (for example, `SdkLoaded`, `InitCompleted`, `TokenUpdated`). | -| Advertising Token | The advertising token associated with the event, if present. | +| Advertising token | The advertising token associated with the event, if present. | Use the search bar to filter by event type or token value. diff --git a/docs/ref-info/uid-components.md b/docs/ref-info/uid-components.md index 1e4b40e01..7eeeb8edb 100644 --- a/docs/ref-info/uid-components.md +++ b/docs/ref-info/uid-components.md @@ -14,7 +14,7 @@ The UID2 framework consists of the following components, all of which are curren | Component | Description | | :--- | :--- | -| **Core Service** | A centralized service that manages access to salts, encryption keys, and other relevant data in the UID2 ecosystem. | -| **Operator Service** | A service that enables the management and storage of encryption keys and salts from the UID2 Core Service, hashing of users' personal data, encryption of raw UID2s, and decryption of UID2 tokens. There can be multiple instances of the service (public or private) operated by multiple [participants](../overviews/participants-overview.md#uid2-component-services), known as operators.
    Public Operators run publicly available instances of the Operator Service and make them available to all relevant UID2 participants. There might also be Private Operators that run private instances of the Operator Service exclusively for their own use. All instances are designed with protections to keep critical UID2 data secure and interoperable, regardless of who operates the service. | -| **Opt-Out Service** | A global service that manages and stores user opt-out requests and disseminates them to publishers, operator service instances, and DSPs. | -| **Transparency and Control Portal** | A user-facing website, [https://www.transparentadvertising.com/](https://www.transparentadvertising.com/), that allows consumers to opt out of UID2 at any time. | +| **Core service** | A centralized service that manages access to salts, encryption keys, and other relevant data in the UID2 ecosystem. | +| **Operator service** | A service that enables the management and storage of encryption keys and salts from the UID2 Core Service, hashing of users' personal data, encryption of raw UID2s, and decryption of UID2 tokens. There can be multiple instances of the service (public or private) operated by multiple [participants](../overviews/participants-overview.md#uid2-component-services), known as operators.
    Public Operators run publicly available instances of the Operator Service and make them available to all relevant UID2 participants. There might also be Private Operators that run private instances of the Operator Service exclusively for their own use. All instances are designed with protections to keep critical UID2 data secure and interoperable, regardless of who operates the service. | +| **Opt-out service** | A global service that manages and stores user opt-out requests and disseminates them to publishers, operator service instances, and DSPs. | +| **Transparency and control portal** | A user-facing website, [https://www.transparentadvertising.com/](https://www.transparentadvertising.com/), that allows consumers to opt out of UID2 at any time. | diff --git a/docs/ref-info/uid-identifier-types.md b/docs/ref-info/uid-identifier-types.md index 3dbd46e19..c3d010549 100644 --- a/docs/ref-info/uid-identifier-types.md +++ b/docs/ref-info/uid-identifier-types.md @@ -12,10 +12,10 @@ import Link from '@docusaurus/Link'; UID2 is a deterministic ID that is based on directly identifying information (DII), such as email address or phone number. There are two types of UID2s: raw UID2s and UID2 tokens (also known as advertising tokens). The following table explains each type. -| ID Type | Shared in Bidstream? | Description | +| ID type | Shared in bidstream? | Description | | :--- | :--- | :--- | | **Raw UID2** | No | An unencrypted alphanumeric identifier created through the UID2 APIs or SDKs with the user's verifiable personal data, such as a hashed or unhashed email address or a phone number, as input.
    To avoid revealing the source data, the input value is hashed if it was not already hashed, and then hashed again using a secret salt value to create the raw UID2. The process that creates the raw UID2 is designed to create a secure, opaque value that can be stored by advertisers, third-party data providers, and demand-side platforms (DSPs).
    Raw UID2s are case sensitive.
    Example: A request for the raw UID2 for the fictitious email address `user@example.com` resulted in this value: `E2dxEv3oMBzNHPw5iUVmwH2Hv+60D4AXYe+2ge9U0No=`. | -| **UID2 Token (Advertising Token)** | Yes | An encrypted form of a raw UID2. UID2 tokens are generated from hashed or unhashed email addresses or phone numbers that are converted to raw UID2s and then encrypted to help ensure protection in the bidstream.
    UID2 tokens are designed to be used by publishers or publisher service providers. Supply-side platforms (SSPs) pass UID2 tokens in the bidstream and DSPs decrypt them at bid request time.
    UID2 tokens are case sensitive.
    Example: A request for a UID2 token for the fictitious email address `user@example.com` resulted in this value: `A4AAAAs6ZBcEbwAPoFhVV7CNW5W-4R-9TKDNL4RS0ctkw1U-IkNOXSnWczvwOMgCQaXHPf3Gd1o1W6IBmlZBFIloM67XOsOgwP5jUrQrclGkq1zBJJUJmOFTe6sJJA7pM1GP9gLd-hz5did6baZvcKd8DXkUYM-WALRZFnzHivu_1YEsC_CeXNdMexKDN7EwSQ6L5eZvOd1F1RkF_nLy_J0twg`. | +| **UID2 token (advertising token)** | Yes | An encrypted form of a raw UID2. UID2 tokens are generated from hashed or unhashed email addresses or phone numbers that are converted to raw UID2s and then encrypted to help ensure protection in the bidstream.
    UID2 tokens are designed to be used by publishers or publisher service providers. Supply-side platforms (SSPs) pass UID2 tokens in the bidstream and DSPs decrypt them at bid request time.
    UID2 tokens are case sensitive.
    Example: A request for a UID2 token for the fictitious email address `user@example.com` resulted in this value: `A4AAAAs6ZBcEbwAPoFhVV7CNW5W-4R-9TKDNL4RS0ctkw1U-IkNOXSnWczvwOMgCQaXHPf3Gd1o1W6IBmlZBFIloM67XOsOgwP5jUrQrclGkq1zBJJUJmOFTe6sJJA7pM1GP9gLd-hz5did6baZvcKd8DXkUYM-WALRZFnzHivu_1YEsC_CeXNdMexKDN7EwSQ6L5eZvOd1F1RkF_nLy_J0twg`. | :::note For the fictitious email address `user@example.com` used in these examples, the corresponding refresh token was: `AAAABrexFHvQVhNJqu+y/ua7rsgShF8e9NUXUJOZFmeFRD8TAsJadaLfOlLkwC5iSxcOKWFD9YwMBzbbcPa92CInba+bcPTaAFNmM2ZpIHgGy6lDcNPzvEnPQh/5fyZ3MD44SX/tHyIXa0R2OBAOLBA1A81r3jefhSsxZdyyBF58KtnaX6UbaeOEaguOfMnJdmhaPeWKj33v7vGfROWtxDWmi6wvGL5lHTX9H6iIZ9i1WSsemYPUgmoDOQeT7nzllJK968OECFj5LkCazDN3pCrYSeuJby9o0fMuSZNxzp6EVzi6XVED4ETtzpcaY0AArzzdh0IXV9MgH8jyg7bJSUWXQG+8kMPZzwbs9EB+7ddAUOLZL/GBna8Hm3Im03EjN3sJ`. diff --git a/docs/ref-info/uid-workflows.md b/docs/ref-info/uid-workflows.md index 80203926f..927c410a8 100644 --- a/docs/ref-info/uid-workflows.md +++ b/docs/ref-info/uid-workflows.md @@ -12,7 +12,7 @@ import Link from '@docusaurus/Link'; The following table lists four key workflows in the UID2 framework with links to their high-level overviews. It also provides links to the respective integration guides, which include diagrams, integration steps, FAQs, and other relevant information for each workflow. -| Workflow | Intended Primary Participants | Integration Guides | +| Workflow | Intended primary participants | Integration guides | | :--- |:--- |:--- | | [Workflow for DSPs](../overviews/overview-dsps.md#workflow-for-dsps) (buy-side) | DSPs who transact on UID2 tokens in the bidstream. | See [DSP integrations](../guides/summary-guides#dsp-integrations) | | [Workflow for advertisers](../overviews/overview-advertisers.md#workflow-for-advertisers) and [Workflow for data providers](../overviews/overview-data-providers.md#workflow-for-data-providers) | Organizations that collect user data and push it to DSPs. | See [Advertiser/data provider integrations](../guides/summary-guides#advertiserdata-provider-integrations) | diff --git a/docs/ref-info/updates-doc.md b/docs/ref-info/updates-doc.md index f5ce47eaf..76746b7ec 100644 --- a/docs/ref-info/updates-doc.md +++ b/docs/ref-info/updates-doc.md @@ -88,7 +88,7 @@ December 2, 2025 We've added an integration guide for the UID2 Databricks integration. -For details, see [Databricks clean rooms integration guide](../guides/integration-databricks.md). +For details, see [Databricks Clean Rooms integration guide](../guides/integration-databricks.md). diff --git a/docs/sdks/sdk-ref-android.md b/docs/sdks/sdk-ref-android.md index 38a9b3f10..49f588eab 100644 --- a/docs/sdks/sdk-ref-android.md +++ b/docs/sdks/sdk-ref-android.md @@ -13,10 +13,10 @@ You can use the SDK for Android to facilitate the process of generating or estab The following Android-related plugins, and associated documentation, are also available. -| Purpose | Product/Documentation | +| Purpose | Product/documentation | | :--- | :--- | -| To use the Google Mobile Ads (GMA) SDK to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | -| To use the Google Interactive Media Ads (IMA) SDK for Android to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | +| To use the Google mobile ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | +| To use the Google interactive media ads (IMA) SDK for Android to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | For FAQs relating to mobile publisher integrations, see [FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations). @@ -28,7 +28,7 @@ This SDK for Android can be used for non-mobile devices for Android platforms as This SDK simplifies integration with UID2 for any publishers who want to support UID2 for apps running on Android devices. The following table shows the functions it supports. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | Monitor Rotated Salt Buckets | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | Monitor rotated salt buckets | | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | ✅ | ✅ | — | — | diff --git a/docs/sdks/sdk-ref-cplusplus.md b/docs/sdks/sdk-ref-cplusplus.md index 38f34c38e..19159bb75 100644 --- a/docs/sdks/sdk-ref-cplusplus.md +++ b/docs/sdks/sdk-ref-cplusplus.md @@ -19,7 +19,7 @@ The functions outlined here define the information that you'll need to configure This SDK simplifies integration with UID2 for any DSPs or UID2 sharers who are using C++ for their server-side coding. The following table shows the functions it supports. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | Monitor Rotated Salt Buckets | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | Monitor rotated salt buckets | | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | — | — | — | — | @@ -55,7 +55,7 @@ Release tags are available in the following GitHub location, but you must build The initialization function configures the parameters necessary for the SDK to authenticate with the UID2 service. It also allows you to configure retry intervals in the event of errors. -| Parameter | Description | Recommended Value | +| Parameter | Description | Recommended value | | :--- | :--- | :--- | | `endpoint` | The endpoint for the UID2 service. | N/A | | `authKey` | The authentication token that belongs to the client. For access to UID2, see [Contact info](../getting-started/gs-account-setup.md#contact-info). | N/A | diff --git a/docs/sdks/sdk-ref-csharp-dotnet.md b/docs/sdks/sdk-ref-csharp-dotnet.md index e99a2a6fe..4a91f13ae 100644 --- a/docs/sdks/sdk-ref-csharp-dotnet.md +++ b/docs/sdks/sdk-ref-csharp-dotnet.md @@ -19,7 +19,7 @@ The functions outlined here define the information that you'll need to configure This SDK simplifies integration with UID2 for any DSPs or UID2 sharers who are using C# / .NET for their server-side coding. The following table shows the functions it supports. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | Monitor Rotated Salt Buckets | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | Monitor rotated salt buckets | | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | — | — | — | — | diff --git a/docs/sdks/sdk-ref-ios.md b/docs/sdks/sdk-ref-ios.md index b3d92e1bc..62f334f32 100644 --- a/docs/sdks/sdk-ref-ios.md +++ b/docs/sdks/sdk-ref-ios.md @@ -13,10 +13,10 @@ You can use the SDK for iOS to facilitate the process of generating or establish The following iOS-related plugins, and associated documentation, are also available: -| Purpose | Product/Documentation | +| Purpose | Product/documentation | | :--- | :--- | -| To use the Google Mobile Ads (GMA) SDK to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | -| To use the Google Interactive Media Ads SDK for iOS to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | +| To use the Google mobile ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | +| To use the Google interactive media ads SDK for iOS to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | ## tvOS support @@ -26,7 +26,7 @@ Although this page refers to SDK for iOS, this SDK also supports tvOS. For the r This SDK simplifies integration with UID2 for any publishers who want to support UID2 for apps running on iOS devices. The following table shows the functions it supports. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | Monitor Rotated Salt Buckets | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | Monitor rotated salt buckets | | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | ✅ | ✅ | — | — | @@ -98,9 +98,9 @@ dependencies: [ In the Xcode user interface, under Package Dependencies, add the following entry for your apps: -| Name | Location | Dependency Rule | +| Name | Location | Dependency rule | | :--- | :--- | :--- | -| uid2-ios-sdk | `git@github.com:IABTechLab/uid2-ios-sdk.git` | Up to next major version: 2.0.0 < 3.0.0 | +| UID2-iOS-SDK | `git@github.com:IABTechLab/uid2-ios-sdk.git` | Up to next major version: 2.0.0 < 3.0.0 | ### Installing with CocoaPods diff --git a/docs/sdks/sdk-ref-java.md b/docs/sdks/sdk-ref-java.md index 239e89b05..da26ca2be 100644 --- a/docs/sdks/sdk-ref-java.md +++ b/docs/sdks/sdk-ref-java.md @@ -16,7 +16,7 @@ You can use the SDK for Java on the server side to facilitate the process of gen This SDK simplifies integration with UID2 for any publishers, DSPs, advertisers, data providers, and UID2 sharers who are using Java for their server-side coding. The following table shows the functions it supports. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | Monitor Rotated Salt Buckets | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | Monitor rotated salt buckets | | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | ✅ | ✅ | ✅ | — | @@ -52,10 +52,10 @@ The binary is published on the Maven repository: The initialization step depends on the role, as shown in the following table. -| Role | Create Instance of Class | Link to Instructions | +| Role | Create instance of class | Link to instructions | |:-------------------------| :--- |:-----------------------------------------------------------------------------| | Publisher | `PublisherUid2Client` | [Usage for publishers](#usage-for-publishers) | -| Advertiser/Data Provider | `IdentityMapV3Client` | [Usage for advertisers/data providers](#usage-for-advertisersdata-providers) | +| Advertiser/data provider | `IdentityMapV3Client` | [Usage for advertisers/data providers](#usage-for-advertisersdata-providers) | | DSP | `BidstreamClient` | [Usage for DSPs](#usage-for-dsps) | | Sharer | `SharingClient` | [Usage for UID2 sharers](#usage-for-uid2-sharers) | diff --git a/docs/sdks/sdk-ref-javascript-v2.md b/docs/sdks/sdk-ref-javascript-v2.md index 0b8b792d5..26ca8c327 100644 --- a/docs/sdks/sdk-ref-javascript-v2.md +++ b/docs/sdks/sdk-ref-javascript-v2.md @@ -23,7 +23,7 @@ For integration steps for content publishers, see [Client-server integration gui This SDK simplifies integration with UID2 for any publishers who want to support UID2. The following table shows the functions it supports. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | Monitor Rotated Salt Buckets | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | Monitor rotated salt buckets | | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | — | ✅ | — | — | @@ -80,12 +80,12 @@ For web integration steps, see [Client-server integration guide for JavaScript]( The following table outlines the four main states that the SDK can be in, based on the combination of values returned by two main functions, [getAdvertisingToken()](#getadvertisingtoken-string) and [isLoginRequired()](#isloginrequired-boolean), and indicates the appropriate action that you, as a developer, can take in each state. -| Workflow State | Advertising Token | Login Required | Description| Identity Status Value | +| Workflow state | Advertising token | Login required | Description| Identity status value | | :--- | :--- | :---| :---| :---| | Initialization | `undefined`| `undefined`| Initial state until the callback is invoked. | N/A | -| Identity Is Available | available |`false` | A valid identity has been successfully established or refreshed. You can use the advertising token in targeted advertising. |`ESTABLISHED` or `REFRESHED` | -| Identity Is Temporarily Unavailable |`undefined` | `false`| The advertising token has expired, therefore automatic refresh failed. [Background auto-refresh](#background-token-auto-refresh) attempts will continue until the refresh token expires or the user opts out.
    You can do either of the following:
    - Redirect the user, asking for the email or phone number.
    - Use untargeted advertising.
    NOTE: Identity might be successfully refreshed at a later time—for example, if the UID2 service is temporarily unavailable.| `EXPIRED` | -| Identity Is Not Available | `undefined`| `false`| The identity is not available and cannot be refreshed. The SDK clears the first-party cookie.
    To use UID2-based targeted advertising again, you must obtain the email or phone number from the consumer. | `INVALID`, `NO_IDENTITY`, `REFRESH_EXPIRED`, or `OPTOUT` | +| Identity is available | available |`false` | A valid identity has been successfully established or refreshed. You can use the advertising token in targeted advertising. |`ESTABLISHED` or `REFRESHED` | +| Identity is temporarily unavailable |`undefined` | `false`| The advertising token has expired, therefore automatic refresh failed. [Background auto-refresh](#background-token-auto-refresh) attempts will continue until the refresh token expires or the user opts out.
    You can do either of the following:
    - Redirect the user, asking for the email or phone number.
    - Use untargeted advertising.
    NOTE: Identity might be successfully refreshed at a later time—for example, if the UID2 service is temporarily unavailable.| `EXPIRED` | +| Identity is not available | `undefined`| `false`| The identity is not available and cannot be refreshed. The SDK clears the first-party cookie.
    To use UID2-based targeted advertising again, you must obtain the email or phone number from the consumer. | `INVALID`, `NO_IDENTITY`, `REFRESH_EXPIRED`, or `OPTOUT` | The following diagram illustrates the four states, including the corresponding identity [status values](#identity-status-values) and possible transitions between them. The SDK invokes the [callback function](#callback-function) on each transition. @@ -166,7 +166,7 @@ The following is an example of an `init()` call that uses identity from a first- The `opts` object supports the following properties. -| Property | Data Type | Attribute | Description | Default Value | +| Property | Data type | Attribute | Description | Default value | | :--- | :--- | :--- | :--- | :--- | | `callback` | `function(object): void` | Required | The function that the SDK should invoke after validating the passed identity. For details, see [Callback function](#callback-function).| N/A | | `identity` | object | Optional | The `body` property value from a successful [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) call that has been run on the server to generate an identity.
    To use the identity from a [first-party cookie](#uid2-cookie-format), leave this property empty. | N/A | @@ -193,7 +193,7 @@ For details on when the callback function is called, see [Background token auto- The `object` parameter includes the following properties. -| Property | Data Type | Description | +| Property | Data type | Description | | :--- | :--- | :--- | | `advertisingToken` | string | The token to be passed to SSPs for targeted advertising. If the token/identity is invalid or unavailable, the value is `undefined`. | | `status` | `UID2.IdentityStatus` enum | The numeric value that indicates the status of the identity. For details, see [Identity status values](#identity-status-values). | @@ -207,7 +207,7 @@ The [callback function](#callback-function) returns the `status` field values as The following values are intended only to inform you of identity availability. Do not use them in conditional logic. ::: -| Status | Advertising Token Availability | Description | +| Status | Advertising token availability | Description | | :--- | :--- | :--- | | `ESTABLISHED` | Available | The identity is valid, was set from the passed value or the first-party cookie, and is now available for targeted advertising. | | `REFRESHED` | Available | The identity was successfully refreshed by a call to the UID2 operator, and is now available for targeted advertising. | @@ -313,7 +313,7 @@ The SDK uses a first-party cookie to store the user's identity. The following table lists the cookie properties. -| Properties | Default Value | Comments | +| Properties | Default value | Comments | | :--- | :--- | :--- | | `Name` | `__uid_2` | N/A | | `Expiry` | N/A | The value is the refresh token expiration timestamp as specified in the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) response. | diff --git a/docs/sdks/sdk-ref-javascript-v3.md b/docs/sdks/sdk-ref-javascript-v3.md index 8bbbb8862..1eba2d8e5 100644 --- a/docs/sdks/sdk-ref-javascript-v3.md +++ b/docs/sdks/sdk-ref-javascript-v3.md @@ -47,7 +47,7 @@ For integration steps for content publishers, refer to either of the following: This SDK simplifies development for publishers who want to build their own customized UID2 integration. The following table shows the functions it supports. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | Monitor Rotated Salt Buckets | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | Monitor rotated salt buckets | | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | ✅ | ✅ | — | — | @@ -321,7 +321,7 @@ The following is an example of an `init()` call that loads a previously-provided The `opts` object supports the following properties. -| Property | Data Type | Attribute | Description | Default Value | +| Property | Data type | Attribute | Description | Default value | | :--- | :--- | :--- | :--- | :--- | | `identity` | object | Optional | The `body` property value from a successful [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) call that has been run on the server to generate an identity.
    To use the identity from a first-party cookie (see [UID2 storage format](#uid2-storage-format)), leave this property empty. | N/A | | `baseUrl` | string | Optional | The custom base URL of the UID2 operator to use when invoking the [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint.
    For example: `https://my.operator.com`. | `https://prod.uidapi.com`. | @@ -519,7 +519,7 @@ Even when using local storage, the SDK checks to see if there is a newer identit If cookie storage is being used, the cookie uses the properties in the following table. -| Properties | Default Value | Comments | +| Properties | Default value | Comments | | :--- | :--- | :--- | | `Name` | `__uid_2` | N/A | | `Expiry` | N/A | The value is the refresh token expiration timestamp as specified in the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) response. | diff --git a/docs/sdks/sdk-ref-javascript.md b/docs/sdks/sdk-ref-javascript.md index 6197e2c85..8e010995c 100644 --- a/docs/sdks/sdk-ref-javascript.md +++ b/docs/sdks/sdk-ref-javascript.md @@ -47,7 +47,7 @@ Version 4 includes the following key changes from version 3: This SDK simplifies development for publishers who want to build their own customized UID2 integration. The following table shows the functions it supports. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | Monitor Rotated Salt Buckets | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | Monitor rotated salt buckets | | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | ✅ | ✅ | — | — | @@ -316,7 +316,7 @@ The following is an example of an `init()` call that loads a previously-provided The `opts` object supports the following properties. -| Property | Data Type | Attribute | Description | Default Value | +| Property | Data type | Attribute | Description | Default value | | :--- | :--- | :--- | :--- | :--- | | `identity` | object | Optional | The `body` property value from a successful [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) call that has been run on the server to generate an identity.
    To use the identity from a first-party cookie (see [UID2 storage format](#uid2-storage-format)), leave this property empty. | N/A | | `baseUrl` | string | Optional | The custom base URL of the UID2 operator to use when invoking the [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint.
    For example: `https://my.operator.com`. | `https://prod.uidapi.com`. | @@ -501,7 +501,7 @@ Even when using local storage, the SDK checks to see if there is a newer identit If cookie storage is being used, the cookie uses the properties in the following table. -| Properties | Default Value | Comments | +| Properties | Default value | Comments | | :--- | :--- | :--- | | `Name` | `__uid_2` | N/A | | `Expiry` | N/A | The value is the refresh token expiration timestamp as specified in the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) response. | diff --git a/docs/sdks/sdk-ref-python.md b/docs/sdks/sdk-ref-python.md index ad7d9bde6..f695077f9 100644 --- a/docs/sdks/sdk-ref-python.md +++ b/docs/sdks/sdk-ref-python.md @@ -15,7 +15,7 @@ You can use the SDK for Python on the server side to facilitate the process of g This SDK simplifies integration with UID2 for any DSPs or UID2 sharers who are using Python for their server-side coding. The following table shows the functions it supports. -| Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s | Monitor Rotated Salt Buckets* | +| Encrypt raw UID2 to UID2 token for sharing | Decrypt UID2 token to raw UID2 | Generate UID2 token from DII | Refresh UID2 token | Map DII to raw UID2s | Monitor rotated salt buckets* | | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | @@ -70,10 +70,10 @@ pip install uid2-client The initialization step depends on the role, as shown in the following table. -| Role | Create Instance of Class | Link to Instructions | +| Role | Create instance of class | Link to instructions | |:-------------------------|:--------------------------|:-----------------------------------------------------------------------------| | Publisher | `Uid2PublisherClient` | [Usage for publishers](#usage-for-publishers) | -| Advertiser/Data Provider | `IdentityMapV3Client` | [Usage for advertisers/data providers](#usage-for-advertisersdata-providers) | +| Advertiser/data provider | `IdentityMapV3Client` | [Usage for advertisers/data providers](#usage-for-advertisersdata-providers) | | DSP | `BidstreamClient` | [Usage for DSPs](#usage-for-dsps) | | Sharer | `SharingClient` | [Usage for sharers](#usage-for-uid2-sharers) | diff --git a/docs/sdks/summary-sdks.md b/docs/sdks/summary-sdks.md index 9e63c4774..f9b823033 100644 --- a/docs/sdks/summary-sdks.md +++ b/docs/sdks/summary-sdks.md @@ -32,18 +32,18 @@ The following table summarizes the functionality available with each SDK. - + - - - - - - - + + + + + + + @@ -130,7 +130,7 @@ The following table summarizes the functionality available with each SDK. The following SDK documentation is available for UID2 integration. Documentation links are in the first column. -| SDK/Link to Guide | Description | Audience +| SDK/link to guide | Description | Audience | :--- | :--- | :--- | | [SDK for JavaScript](sdk-ref-javascript.md) | Client-side JavaScript SDK that facilitates the process of establishing client identity using UID2 and retrieving UID2 tokens for publishers. | Publishers | | [SDK for Java](sdk-ref-java.md) | An SDK for audiences using Java server-side: | Publishers
    DSPs
    Advertisers
    Data Providers
    Sharers | diff --git a/docs/sharing/sharing-overview.md b/docs/sharing/sharing-overview.md index a26065a06..ede7bb6a8 100644 --- a/docs/sharing/sharing-overview.md +++ b/docs/sharing/sharing-overview.md @@ -25,7 +25,7 @@ There are several main sharing scenarios, summarized in the following table. For examples, see [Sharing UID2s: Use cases](sharing-use-cases.md). -| Sharing Scenario | Sender | Receiver | Sharing Approach | Sharing Route | Link for Details +| Sharing scenario | Sender | Receiver | Sharing approach | Sharing route | Link for details | :--- | :--- | :--- | :--- | :--- | :--- | | Sharing in the bidstream | Publisher | DSP | Sharing UID2 tokens (tokenized sharing) | Publisher generates UID2 token and sends it into the bidstream. | [Tokenized sharing in the bidstream](sharing-tokenized-from-data-bid-stream.md) | | Sharing via a pixel | Any authorized [participant](../ref-info/glossary-uid.md#gl-sharing-participant) | Any authorized [participant](../ref-info/glossary-uid.md#gl-sharing-participant) | Sharing UID2 tokens (tokenized sharing) | Sharing via any pixel, such as a tracking pixel or creative pixel. | [Tokenized sharing in pixels](sharing-tokenized-from-data-pixel.md) | diff --git a/docs/sharing/sharing-tokenized-from-data-bid-stream.md b/docs/sharing/sharing-tokenized-from-data-bid-stream.md index 2bf035c2f..5ab17f9c1 100644 --- a/docs/sharing/sharing-tokenized-from-data-bid-stream.md +++ b/docs/sharing/sharing-tokenized-from-data-bid-stream.md @@ -34,7 +34,7 @@ Tokenized sharing in the bidstream is applicable to the following audiences: The following approaches are available for encrypting the DII directly into a UID2 token for sending in the bidstream. -| Integration Option | Token Generated Client-Side or Server-Side? | Integration Guide | +| Integration option | Token generated client-side or server-side? | Integration guide | | :--- | :--- | :--- | | Prebid.js | Client-Side | [Client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) | | Prebid.js | Server-Side | [Client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) | @@ -54,7 +54,7 @@ For a complete SDK summary, see [SDK functionality](../sdks/summary-sdks.md#sdk- The following approaches are available for decrypting UID2 tokens. - | Scenario | Link to Doc | + | Scenario | Link to doc | | :--- | :--- | | Tokenized sharing from raw UID2s with SDK | [Implementing sharing encryption/decryption with an SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) | | Tokenized sharing from raw UID2s with Snowflake | [Implementing sharing encryption/decryption using Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake) | @@ -117,8 +117,8 @@ Publishers convert the input email address or phone number directly to a UID2 to - - + + diff --git a/docs/sharing/sharing-tokenized-from-data-pixel.md b/docs/sharing/sharing-tokenized-from-data-pixel.md index cc00d583f..de6e3182d 100644 --- a/docs/sharing/sharing-tokenized-from-data-pixel.md +++ b/docs/sharing/sharing-tokenized-from-data-pixel.md @@ -31,7 +31,7 @@ Tokenized sharing in pixels is applicable to the following audiences: Different participants might use pixels in different ways. The following table shows two common use cases for pixels in the advertising technology ecosystem. -| | Tracking Pixel | Creative Pixel | +| | Tracking pixel | Creative pixel | | :--- | :--- | :--- | | What it measures | Conversion/retargeting (user does something) | Impression (user sees an ad) | | Where | Advertiser or publisher site | Publisher site via DSP | diff --git a/docs/sharing/sharing-tokenized-from-raw.md b/docs/sharing/sharing-tokenized-from-raw.md index 9f234c116..39431564d 100644 --- a/docs/sharing/sharing-tokenized-from-raw.md +++ b/docs/sharing/sharing-tokenized-from-raw.md @@ -75,7 +75,7 @@ The following steps are for all sharing participants who are using an SDK to enc 1. Decide which SDK to use, from the following options, and review the examples in the applicable sharing documentation to see what the sharing code might look like. - | SDK/Integration Tool | Link to Sharing Section | + | SDK/integration tool | Link to sharing section | | :--- | :--- | | C# / .NET | [SDK for C# / .NET: Usage for UID2 sharers](../sdks/sdk-ref-csharp-dotnet.md#usage-for-uid2-sharers) | | C++ | [SDK for C++: Usage for UID2 sharers](../sdks/sdk-ref-cplusplus.md#usage-for-uid2-sharers) | diff --git a/docs/sharing/sharing-tokenized-overview.md b/docs/sharing/sharing-tokenized-overview.md index 8bdefd662..99e4c1449 100644 --- a/docs/sharing/sharing-tokenized-overview.md +++ b/docs/sharing/sharing-tokenized-overview.md @@ -19,7 +19,7 @@ Tokens are generated in one of the following ways: In many scenarios, UID2 data is shared in the form of a UID2 token. Key use cases are shown in the following table. -| Scenario | Sender | Receiver | Sharing Approach | +| Scenario | Sender | Receiver | Sharing approach | | :--- | :--- | :--- | :--- | | Sending a UID2 to the bidstream | Publisher | DSP | See [Tokenized sharing in the bidstream](sharing-tokenized-from-data-bid-stream.md) | | Sending a UID2 in a tracking pixel | Any sharing participant | Any sharing participant | See [Tokenized sharing in pixels](sharing-tokenized-from-data-pixel.md) | @@ -33,7 +33,7 @@ Sharing UID2s with another sharing participant via Operator Service (via the UID2 APIs). Operators periodically receive and store up-to-date encryption keys and salts from the UID2 Core Service, salt and hash directly identifying information (DII) to return raw UID2s, encrypt raw UID2s to generate UID2 tokens, and distribute UID2 token decryption keys.
    Public Operators (Open Operators) run public instances of the Operator Service. For example, The Trade Desk currently serves as a Public Operator for the UID2 framework, available to all participants. If other Public Operators are available, a participant can choose which operator to work with.
    Any participant can also choose to become a Private Operator to generate and manage UID2s. | ## UID2 external participants diff --git a/docs/sdks/sdk-ref-android.md b/docs/sdks/sdk-ref-android.md index 49f588eab..e460141fd 100644 --- a/docs/sdks/sdk-ref-android.md +++ b/docs/sdks/sdk-ref-android.md @@ -16,7 +16,7 @@ The following Android-related plugins, and associated documentation, are also av | Purpose | Product/documentation | | :--- | :--- | | To use the Google mobile ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | -| To use the Google interactive media ads (IMA) SDK for Android to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | +| To use the Google Interactive Media Ads (IMA) SDK for Android to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | For FAQs relating to mobile publisher integrations, see [FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations). diff --git a/docs/sdks/sdk-ref-ios.md b/docs/sdks/sdk-ref-ios.md index 62f334f32..8144bb443 100644 --- a/docs/sdks/sdk-ref-ios.md +++ b/docs/sdks/sdk-ref-ios.md @@ -16,7 +16,7 @@ The following iOS-related plugins, and associated documentation, are also availa | Purpose | Product/documentation | | :--- | :--- | | To use the Google mobile ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | -| To use the Google interactive media ads SDK for iOS to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | +| To use the Google Interactive Media Ads SDK for iOS to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | ## tvOS support From dc4d03b311746e84e6e1e81b5c782093b36ab68e Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 7 Jul 2026 10:18:16 -0400 Subject: [PATCH 4/9] review mods --- docs/sdks/sdk-ref-ios.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sdks/sdk-ref-ios.md b/docs/sdks/sdk-ref-ios.md index 8144bb443..d4bda5baa 100644 --- a/docs/sdks/sdk-ref-ios.md +++ b/docs/sdks/sdk-ref-ios.md @@ -100,7 +100,7 @@ In the Xcode user interface, under Package Dependencies, add the following entry | Name | Location | Dependency rule | | :--- | :--- | :--- | -| UID2-iOS-SDK | `git@github.com:IABTechLab/uid2-ios-sdk.git` | Up to next major version: 2.0.0 < 3.0.0 | +| uid2-ios-sdk | `git@github.com:IABTechLab/uid2-ios-sdk.git` | Up to next major version: 2.0.0 < 3.0.0 | ### Installing with CocoaPods From c8accd19d68d9fe22d7ed8eb7d65b0ca2f38ac4b Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 7 Jul 2026 10:27:37 -0400 Subject: [PATCH 5/9] review mods --- docs/guides/integration-aws-entity-resolution.md | 4 ++-- .../current/guides/integration-databricks.md | 2 +- .../current/guides/summary-guides.md | 2 +- .../current/overviews/overview-advertisers.md | 2 +- .../current/overviews/overview-data-providers.md | 2 +- .../current/ref-info/updates-doc.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/guides/integration-aws-entity-resolution.md b/docs/guides/integration-aws-entity-resolution.md index 9608d43ee..0a86f0412 100644 --- a/docs/guides/integration-aws-entity-resolution.md +++ b/docs/guides/integration-aws-entity-resolution.md @@ -149,7 +149,7 @@ To create the matching workflow, first sign in to the AWS Management console, op - **Description**: An optional description for the matching workflow. - **Data input**: The source for your data in AWS. From the drop-down list, select an AWS Glue database, then the AWS Glue table, and then the schema mapping. You can specify more than one data input. In the following example, email is the only type of data input: - | UniqueId | Name | Email | Date of birth | + | UniqueId | Name | Email | Date of Birth | |----------|--------|------------------|---------------| | 0001 | Test 1 | test1@uidapi.com | 1/1/90 | | 0002 | Test 2 | test2@gmail.com | 1/2/78 | @@ -194,7 +194,7 @@ To create the matching workflow, first sign in to the AWS Management console, op - Select the input fields that you want to exclude from the output, and the fields that you want to hash in the output data, as shown in the following example. - | UniqueId | Name | Email | Date of birth | UID2_identifier | UID2_advertising_id | UID2_bucket_id | + | UniqueId | Name | Email | Date of Birth | UID2_identifier | UID2_advertising_id | UID2_bucket_id | |----------|--------|------------------|---------------|------------------|------------------------------------------------|----------------| | 0001 | Test 1 | test1@uidapi.com | 1/1/90 | test1@uidapi.com | Q4A5ZBuBCYfuV3Wd8Fdsx2+i33v7jyFcQbcMG/LH4eM= | ad1ANEmVZ | | 0002 | Test 2 | test2@gmail.com | 1/2/78 | test2@gmail.com | kds8hgBuBCYfuV3Wd8Fdsx2+i33v7jyFcQbcMG/jgksuh= | kd9ANE98d | diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-databricks.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-databricks.md index 578156106..cf1ac0b71 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-databricks.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-databricks.md @@ -10,7 +10,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Databricks clean rooms integration guide +# Databricks Clean Rooms integration guide このガイドは、Databricks 環境でユーザーデータを raw UID2 に変換したい広告主およびデータプロバイダーを対象としています。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/summary-guides.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/summary-guides.md index 542f91ccc..222e9f4df 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/summary-guides.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/summary-guides.md @@ -102,7 +102,7 @@ UID2 とインテグレーションする広告主やデータプロバイダー | [Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md) | このガイドでは、ユーザーデータを収集し、他の UID2 参加者にプッシュする組織向けのインテグレーションオプションの概要を提供します。 | | [Snowflake integration guide](integration-snowflake.md) | Snowflake 内でメールアドレスから UID2 を生成する手順です。| | [AWS Entity Resolution integration guide](integration-aws-entity-resolution.md) | AWS Entity Resolution を使用して UID2 フレームワークとインテグレーションする手順です。 | -| [Databricks clean rooms integration guide](integration-databricks.md) | Databricks Clean Rooms 環境でメールアドレスまたは電話番号から UID2 を生成する手順です。 | +| [Databricks Clean Rooms integration guide](integration-databricks.md) | Databricks Clean Rooms 環境でメールアドレスまたは電話番号から UID2 を生成する手順です。 | | [Advertiser/data provider integration to HTTP endpoints](integration-advertiser-dataprovider-endpoints.md) | このガイドでは、広告主やデータプロバイダーが UID2 とインテグレーションするための手順を説明します。この手順では、SDK、Snowflake、AWS Entity Resolution、Databricks Clean Rooms などの他の実装オプションではなく、コードを書いて UID2 HTTP エンドポイントを呼び出す方法を説明します。 | | [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | トラッキングピクセルに UID2 Token を追加するためにこの SDK を使用したい広告主やデータプロバイダー向けのガイドです。 | diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-advertisers.md b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-advertisers.md index 9a8d66fa8..31f5588bf 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-advertisers.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-advertisers.md @@ -75,7 +75,7 @@ UID2 を実装する広告主およびデータプロバイダー向けに、以 | :--- | :--- | :--- | | ユーザーデータを収集し、他の UID2 参加者にプッシュする組織向けのインテグレーションオプションの概要 | [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) | このガイドでは、オーディエンス構築とターゲティングのために ID をマッピングするインテグレーションワークフローについて説明します。 | | Snowflake | [Snowflake integration guide](../guides/integration-snowflake.md) | Snowflake 内のメールアドレスまたは電話番号から UID2 を生成する手順について説明します。 | -| Databricks Clean Rooms | [Databricks clean rooms integration guide](../guides/integration-databricks.md) | Databricks Clean Rooms 環境でメールアドレスまたは電話番号から UID2 を生成する手順について説明します。 | +| Databricks Clean Rooms | [Databricks Clean Rooms integration guide](../guides/integration-databricks.md) | Databricks Clean Rooms 環境でメールアドレスまたは電話番号から UID2 を生成する手順について説明します。 | | AWS Entity Resolution | [AWS Entity Resolution integration guide](../guides/integration-aws-entity-resolution.md) | AWS Entity Resolution を使用して UID2 フレームワークとインテグレーションする手順について説明します。 | | ユーザーデータを収集し、他の UID2 参加者にプッシュする組織向けのインテグレーション手順 (UID2 HTTP エンドポイントのみを使用) | [Advertiser/data provider integration to HTTP endpoints](../guides/integration-advertiser-dataprovider-endpoints.md) | SDK、Snowflake、AWS Entity Resolution などの他の実装オプションを使用するのではなく、コードを記述して UID2 HTTP エンドポイントを呼び出すことで、UID2 とインテグレーションする広告主およびデータプロバイダー向けの手順について説明します。 | | トラッキングピクセルに UID2 Token を追加するためにクライアントサイド JavaScript SDK を使用したい広告主およびデータプロバイダー向けのインテグレーション手順。 | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | JavaScript のクライアントサイドの変更のみを使用して UID2 Token (Advertising Token) を生成する手順について説明します。 | diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-data-providers.md b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-data-providers.md index 79929a79c..6e15a36da 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-data-providers.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-data-providers.md @@ -80,7 +80,7 @@ UID2 を実装する広告主およびデータプロバイダー向けに、以 | :--- | :--- | :--- | | ユーザーデータを収集し、他の UID2 参加者にプッシュする組織向けのインテグレーションオプションの概要 | [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) | このガイドでは、オーディエンス構築とターゲティングのために ID をマッピングするインテグレーションワークフローについて説明します。 | | Snowflake | [Snowflake integration guide](../guides/integration-snowflake.md) | Snowflake 内のメールアドレスまたは電話番号から UID2 を生成する手順について説明します。 | -| Databricks Clean Rooms | [Databricks clean rooms integration guide](../guides/integration-databricks.md) | Databricks Clean Rooms 環境でメールアドレスまたは電話番号から UID2 を生成する手順について説明します。 | +| Databricks Clean Rooms | [Databricks Clean Rooms integration guide](../guides/integration-databricks.md) | Databricks Clean Rooms 環境でメールアドレスまたは電話番号から UID2 を生成する手順について説明します。 | | AWS Entity Resolution | [AWS Entity Resolution integration guide](../guides/integration-aws-entity-resolution.md) | AWS Entity Resolution を使用して UID2 フレームワークとインテグレーションする手順について説明します。 | | ユーザーデータを収集し、他の UID2 参加者にプッシュする組織向けのインテグレーション手順 (UID2 HTTP エンドポイントのみを使用) | [Advertiser/data provider integration to HTTP endpoints](../guides/integration-advertiser-dataprovider-endpoints.md) | SDK、Snowflake、AWS Entity Resolution などの他の実装オプションを使用するのではなく、コードを記述して UID2 HTTP エンドポイントを呼び出すことで、UID2 とインテグレーションする広告主およびデータプロバイダー向けの手順について説明します。 | | トラッキングピクセルに UID2 Token を追加するためにクライアントサイド JavaScript SDK を使用したい広告主およびデータプロバイダー向けのインテグレーション手順。 | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | JavaScript のクライアントサイドの変更のみを使用して UID2 Token (Advertising Token) を生成する手順について説明します。 | diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/updates-doc.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/updates-doc.md index 71a329444..1db749527 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/updates-doc.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/updates-doc.md @@ -88,7 +88,7 @@ December 2, 2025 UID2 Databricks Clean Rooms インテグレーションガイドを追加しました。 -詳細は、[Databricks clean rooms integration guide](../guides/integration-databricks.md) を参照してください。 +詳細は、[Databricks Clean Rooms integration guide](../guides/integration-databricks.md) を参照してください。 From d574b4729514e42fbeebf528a629882a1637175f Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 7 Jul 2026 10:33:37 -0400 Subject: [PATCH 6/9] review mods --- docs/guides/integration-mobile-overview.md | 10 +++++----- .../integration-snowflake-before-february-2025.md | 2 +- docs/guides/integration-snowflake-previous.md | 2 +- docs/guides/integration-snowflake.md | 2 +- docs/guides/operator-guide-aws-marketplace.md | 8 ++++---- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/guides/integration-mobile-overview.md b/docs/guides/integration-mobile-overview.md index 18a6b265e..39f7f14e1 100644 --- a/docs/guides/integration-mobile-overview.md +++ b/docs/guides/integration-mobile-overview.md @@ -127,7 +127,7 @@ The following table summarizes the options supported by UID2. | You want to use Google GMA to integrate video, banner, interstitial, or native ads into your iOS app | Both of the following, in this sequence:
    1. [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md)
    2. One of the following:
      • Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
      • Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
    | | You want to use Google IMA to integrate multimedia ads into your Android app | Both of the following, in this sequence:
    1. [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md)
    2. One of the following:
      • Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
      • Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
    | | You want to use Google IMA to integrate multimedia ads into your iOS app | Both of the following, in this sequence:
    1. [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md)
    2. One of the following:
      • Client-side: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
      • Client-server: [Optional: GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-gmaima-plugin-for-gam-secure-signals-integration)
    | -| You want to use the Prebid Mobile SDK and Prebid server to send out ad requests from your Android or iOS app | One of the following:
    • Client-side: [Optional: Integration with Prebid Mobile SDK](../guides/integration-mobile-client-side.md#optional-integration-with-prebid-mobile-sdk)
    • Client-server: [Optional: Integration with Prebid Mobile SDK](../guides/integration-mobile-client-server.md#optional-integration-with-prebid-mobile-sdk)
    | +| You want to use the Prebid Mobile SDK and Prebid Server to send out ad requests from your Android or iOS app | One of the following:
    • Client-side: [Optional: Integration with Prebid Mobile SDK](../guides/integration-mobile-client-side.md#optional-integration-with-prebid-mobile-sdk)
    • Client-server: [Optional: Integration with Prebid Mobile SDK](../guides/integration-mobile-client-server.md#optional-integration-with-prebid-mobile-sdk)
    | ### Functionality summary @@ -139,10 +139,10 @@ All options support either client-side or server-side integration. | :--- | :--- | :--- | :--- | :--- | | UID2 SDK for Android | ✅ | ✅ | Android | * | | UID2 SDK for iOS | ✅| ✅ | iOS | * | -| GMA plugin for Android
    (requires UID2 SDK for Android) | — | — | Android | ✅** | -| GMA plugin for iOS
    (requires UID2 SDK for iOS) | — | — | iOS | ✅** | -| IMA plugin for Android
    (requires UID2 SDK for Android)| — | — | Android | ✅** | -| IMA plugin for iOS
    (requires UID2 SDK for iOS)| — | — | iOS | ✅** | +| GMA Plugin for Android
    (requires UID2 SDK for Android) | — | — | Android | ✅** | +| GMA Plugin for iOS
    (requires UID2 SDK for iOS) | — | — | iOS | ✅** | +| IMA Plugin for Android
    (requires UID2 SDK for Android)| — | — | Android | ✅** | +| IMA Plugin for iOS
    (requires UID2 SDK for iOS)| — | — | iOS | ✅** | | UID2 integration with Prebid Mobile SDK | — | — | Either | ✅*** | *You can combine the SDK with the IMA/GMA Plugin or the UID2 Integration with Prebid Mobile SDK to send the token to the bidstream via Google or Prebid Server, or you can retrieve the token manually from the SDK and pass it to the bidstream in another way, according to your preference. diff --git a/docs/guides/integration-snowflake-before-february-2025.md b/docs/guides/integration-snowflake-before-february-2025.md index eb592a745..42fa0cd42 100644 --- a/docs/guides/integration-snowflake-before-february-2025.md +++ b/docs/guides/integration-snowflake-before-february-2025.md @@ -47,7 +47,7 @@ The following diagram and table illustrate the different parts of the UID2 integ |Partner Snowflake account|UID2 Snowflake account|UID2 core opt-out cloud setup| | :--- | :--- | :--- | -|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can’t access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | +|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 Share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can’t access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | |When you use shared functions and views, you pay Snowflake for transactional computation costs. |These private tables, secured in the UID2 Snowflake account, automatically synchronize with the UID2 Core/Optout Snowflake storage that holds internal data used to complete UID2-related tasks. | | ## Access the UID2 shares diff --git a/docs/guides/integration-snowflake-previous.md b/docs/guides/integration-snowflake-previous.md index 617751ab2..795a1f30e 100644 --- a/docs/guides/integration-snowflake-previous.md +++ b/docs/guides/integration-snowflake-previous.md @@ -70,7 +70,7 @@ The following diagram and table illustrate the different parts of the UID2 integ |Partner Snowflake account|UID2 Snowflake account|UID2 core opt-out cloud setup| | :--- | :--- | :--- | -|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can’t access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | +|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 Share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can’t access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | |When you use shared functions and views, you pay Snowflake for transactional computation costs. |These private tables, secured in the UID2 Snowflake account, automatically synchronize with the UID2 Core/Optout Snowflake storage that holds internal data used to complete UID2-related tasks. | | ## Access the UID2 share diff --git a/docs/guides/integration-snowflake.md b/docs/guides/integration-snowflake.md index 55e2c329a..40ef83a88 100644 --- a/docs/guides/integration-snowflake.md +++ b/docs/guides/integration-snowflake.md @@ -71,7 +71,7 @@ The following diagram and table illustrate the different parts of the UID2 integ |Partner Snowflake account|UID2 Snowflake account|UID2 core opt-out cloud setup| | :--- | :--- | :--- | -|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can't access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | +|As a partner, you set up a Snowflake account to host your data and engage in UID2 integration by consuming functions and views through the UID2 Share. | UID2 integration, hosted in a Snowflake account, grants you access to authorized functions and views that draw data from private tables. You can't access the private tables. The UID2 Share reveals only essential data needed for you to perform UID2-related tasks.
    **NOTE**: We store salts and encryption keys in the private tables. No DII is stored at any point. |ETL (Extract Transform Load) jobs constantly update the UID2 Core/Optout Snowflake storage with internal data that powers the UID2 Operator Web Services. The data used by the Operator Web Services is also available through the UID2 Share. | |When you use shared functions and views, you pay Snowflake for transactional computation costs. |These private tables, secured in the UID2 Snowflake account, automatically synchronize with the UID2 Core/Optout Snowflake storage that holds internal data used to complete UID2-related tasks. | | ## Preparing DII for processing diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index 6483b4403..43ffb5017 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -203,11 +203,11 @@ The following table explains the parameter values that you need to provide in st | :--- |:--- | |Stack name |Any name of your choice. | |OPERATOR_KEY |The Operator Key that you received from the UID2 Admin team. | -|UID2 environment |Select `prod` for production environment or `integ` for the integration test environment. | -|Instance type |`m5.2xlarge` is recommended. | +|UID2 Environment |Select `prod` for production environment or `integ` for the integration test environment. | +|Instance Type |`m5.2xlarge` is recommended. | |Instance root volume size |15 GB or more is recommended. | -|Key name for SSH |Your EC2 key pair for SSH access to the deployed EC2 instances. | -|Trusted network CIDR |The CIDR (Classless Inter-Domain Routing) value determines the IP address range that can access your operator service.
    To limit access to the UID2 Operators so that they can only be accessed through an internal network or a load balancer, specify an internal IP range as the CIDR value. | +|Key Name for SSH |Your EC2 key pair for SSH access to the deployed EC2 instances. | +|Trusted Network CIDR |The CIDR (Classless Inter-Domain Routing) value determines the IP address range that can access your operator service.
    To limit access to the UID2 Operators so that they can only be accessed through an internal network or a load balancer, specify an internal IP range as the CIDR value. | |VPC |The existing VPC ID. | |VpcSubnet1 |The existing VPC AZ1 Subnet ID. | |VpcSubnet2 |The existing VPC AZ2 Subnet ID. | From c1a781408c4b3f891741f90af6ce6cc56447c65d Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 7 Jul 2026 10:40:51 -0400 Subject: [PATCH 7/9] review mods --- docs/portal/client-side-integration.md | 4 ++-- docs/portal/portal-overview.md | 8 ++++---- docs/ref-info/ref-uid-verify.md | 10 +++++----- docs/ref-info/uid-components.md | 8 ++++---- docs/sdks/sdk-ref-android.md | 2 +- docs/sdks/sdk-ref-ios.md | 2 +- docs/sdks/sdk-ref-javascript-v2.md | 6 +++--- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/portal/client-side-integration.md b/docs/portal/client-side-integration.md index 6e0e5d7ce..fc66f76e9 100644 --- a/docs/portal/client-side-integration.md +++ b/docs/portal/client-side-integration.md @@ -19,7 +19,7 @@ In the UID2 Portal, if you want to use an implementation option that generates U | :--- | :--- | :---| :---| | Key pair | All (web or mobile) | At least one. In your implementation, you'll share the public key. | [Subscription ID and public key](../getting-started/gs-credentials.md#subscription-id-and-public-key) | | Domain | Web | At least one. Provide a complete list of your root-level domains. | [Client-side web integrations](../getting-started/gs-account-setup.md#client-side-web-integrations) | -| Mobile app ID | Mobile | Any IDs that apply to your mobile apps, such as Android App ID, iOS/tvOS Bundle ID, or iOS App Store ID. | [Client-side mobile integrations](../getting-started/gs-account-setup.md#client-side-mobile-integrations) | +| Mobile App ID | Mobile | Any IDs that apply to your mobile apps, such as Android App ID, iOS/tvOS Bundle ID, or iOS App Store ID. | [Client-side mobile integrations](../getting-started/gs-account-setup.md#client-side-mobile-integrations) | :::important It's important to provide a complete list of root-level domain names for your sites, and mobile app IDs for your apps. This is a security measure, for client-side implementation only. If a domain or app is not defined in the UID2 Portal, UID2 token requests from that domain or app will fail. @@ -42,7 +42,7 @@ Client-side implementation options are shown in the following table. The options | :--- | :--- | :---| | UID2 JavaScript SDK | Publishers, Advertisers | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | | Prebid.js client-side integration | Publishers only |[Client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) | -| UID2 mobile SDK | Publishers only |[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) | +| UID2 Mobile SDK | Publishers only |[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) | ## Adding and managing key pairs diff --git a/docs/portal/portal-overview.md b/docs/portal/portal-overview.md index db4655827..a702d8b26 100644 --- a/docs/portal/portal-overview.md +++ b/docs/portal/portal-overview.md @@ -15,13 +15,13 @@ The UID2 Portal is your one-stop shop for setting up and configuring your UID2 a | :--- | :--- | | Request an account, configure basic account information such as name and location, log in for the first time, and reset your password. | [Getting started with the UID2 Portal](portal-getting-started.md) | | Review your profile. | [Participant information](participant-info.md) | -| Server-side or client-server integrations: manage API keys for your account, including adding, modifying, or deleting keys. | [API keys](api-keys.md) | -| Client-side integrations only: set up and manage the values needed for generating UID2 tokens on the client side. | [Client-side integration](client-side-integration.md) | -| Configure permissions for individual sharing participants or groups of sharing participants.
    note: use of sharing requires an API key (see [API keys](api-keys.md)) or client-side key pair (see [client-side integration](client-side-integration.md)). configure these values before setting up sharing permissions. | [Sharing permissions](sharing-permissions.md) | +| Server-side or client-server integrations: Manage API keys for your account, including adding, modifying, or deleting keys. | [API keys](api-keys.md) | +| Client-side integrations only: Set up and manage the values needed for generating UID2 tokens on the client side. | [Client-side integration](client-side-integration.md) | +| Configure permissions for individual sharing participants or groups of sharing participants.
    NOTE: use of sharing requires an API key (see [API keys](api-keys.md)) or client-side key pair (see [Client-side integration](client-side-integration.md)). Configure these values before setting up sharing permissions. | [Sharing permissions](sharing-permissions.md) | | Add team members who will have permission to manage your account. | [Team members](team-members.md) | | Set up designated email contacts who will be notified of news or updates. | [Email contacts](email-contacts.md) | | View a detailed log of all past actions performed by, or on behalf of, the current participant. | [Audit trail](audit-trail.md) | -| Change password when required by the portal. | [Password change requirement](portal-getting-started.md#password-change-requirement) | +| Change password when required by the Portal. | [Password change requirement](portal-getting-started.md#password-change-requirement) | ## Access the UID2 Portal diff --git a/docs/ref-info/ref-uid-verify.md b/docs/ref-info/ref-uid-verify.md index 322b5eee2..5b6848f4a 100644 --- a/docs/ref-info/ref-uid-verify.md +++ b/docs/ref-info/ref-uid-verify.md @@ -97,11 +97,11 @@ SDK and Prebid.js integrations include the fields shown in the following table. | Field | Description | |---|---| -| Storage type | Indicates whether the identity is stored in a cookie or `localStorage`. | -| Storage key | The name of the cookie or `localStorage` key. For UID2 SDK integrations: `__uid_2` or `UID2-sdk-identity`. For Prebid.js integrations: `__uid2_advertising_token`. | -| Stored value | The raw identity JSON, including `advertising_token`, `refresh_token`, `identity_expires`, `refresh_expires`, `refresh_from`, and `refresh_response_key`. | -| Valid identity | Indicates whether the stored identity is currently valid — that is, the advertising token has not expired and the user has not opted out. | -| Optout identity | Indicates whether the identity reflects an opted-out user. | +| Storage Type | Indicates whether the identity is stored in a cookie or `localStorage`. | +| Storage Key | The name of the cookie or `localStorage` key. For UID2 SDK integrations: `__uid_2` or `UID2-sdk-identity`. For Prebid.js integrations: `__uid2_advertising_token`. | +| Stored Value | The raw identity JSON, including `advertising_token`, `refresh_token`, `identity_expires`, `refresh_expires`, `refresh_from`, and `refresh_response_key`. | +| Valid Identity | Indicates whether the stored identity is currently valid — that is, the advertising token has not expired and the user has not opted out. | +| Optout Identity | Indicates whether the identity reflects an opted-out user. | For Google Secure Signals integrations, the tab shows the status of the secure signal and the current UID2 advertising token. If no signal has been generated yet, it indicates that neither a cached signal nor a UID2 SDK advertising token is available. When the collector function has run successfully, the extension displays a "Secure signal is cached" status message and shows the cached value stored under `_GESPSK-uidapi.com`. The cached signal is in the format `[providerId, advertisingToken, expiryTimestamp]`. The current UID2 advertising token is also displayed separately. diff --git a/docs/ref-info/uid-components.md b/docs/ref-info/uid-components.md index 7eeeb8edb..1e4b40e01 100644 --- a/docs/ref-info/uid-components.md +++ b/docs/ref-info/uid-components.md @@ -14,7 +14,7 @@ The UID2 framework consists of the following components, all of which are curren | Component | Description | | :--- | :--- | -| **Core service** | A centralized service that manages access to salts, encryption keys, and other relevant data in the UID2 ecosystem. | -| **Operator service** | A service that enables the management and storage of encryption keys and salts from the UID2 Core Service, hashing of users' personal data, encryption of raw UID2s, and decryption of UID2 tokens. There can be multiple instances of the service (public or private) operated by multiple [participants](../overviews/participants-overview.md#uid2-component-services), known as operators.
    Public Operators run publicly available instances of the Operator Service and make them available to all relevant UID2 participants. There might also be Private Operators that run private instances of the Operator Service exclusively for their own use. All instances are designed with protections to keep critical UID2 data secure and interoperable, regardless of who operates the service. | -| **Opt-out service** | A global service that manages and stores user opt-out requests and disseminates them to publishers, operator service instances, and DSPs. | -| **Transparency and control portal** | A user-facing website, [https://www.transparentadvertising.com/](https://www.transparentadvertising.com/), that allows consumers to opt out of UID2 at any time. | +| **Core Service** | A centralized service that manages access to salts, encryption keys, and other relevant data in the UID2 ecosystem. | +| **Operator Service** | A service that enables the management and storage of encryption keys and salts from the UID2 Core Service, hashing of users' personal data, encryption of raw UID2s, and decryption of UID2 tokens. There can be multiple instances of the service (public or private) operated by multiple [participants](../overviews/participants-overview.md#uid2-component-services), known as operators.
    Public Operators run publicly available instances of the Operator Service and make them available to all relevant UID2 participants. There might also be Private Operators that run private instances of the Operator Service exclusively for their own use. All instances are designed with protections to keep critical UID2 data secure and interoperable, regardless of who operates the service. | +| **Opt-Out Service** | A global service that manages and stores user opt-out requests and disseminates them to publishers, operator service instances, and DSPs. | +| **Transparency and Control Portal** | A user-facing website, [https://www.transparentadvertising.com/](https://www.transparentadvertising.com/), that allows consumers to opt out of UID2 at any time. | diff --git a/docs/sdks/sdk-ref-android.md b/docs/sdks/sdk-ref-android.md index e460141fd..777ae3452 100644 --- a/docs/sdks/sdk-ref-android.md +++ b/docs/sdks/sdk-ref-android.md @@ -15,7 +15,7 @@ The following Android-related plugins, and associated documentation, are also av | Purpose | Product/documentation | | :--- | :--- | -| To use the Google mobile ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | +| To use the Google Mobile Ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | | To use the Google Interactive Media Ads (IMA) SDK for Android to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | For FAQs relating to mobile publisher integrations, see [FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations). diff --git a/docs/sdks/sdk-ref-ios.md b/docs/sdks/sdk-ref-ios.md index d4bda5baa..041b40a81 100644 --- a/docs/sdks/sdk-ref-ios.md +++ b/docs/sdks/sdk-ref-ios.md @@ -15,7 +15,7 @@ The following iOS-related plugins, and associated documentation, are also availa | Purpose | Product/documentation | | :--- | :--- | -| To use the Google mobile ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | +| To use the Google Mobile Ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | | To use the Google Interactive Media Ads SDK for iOS to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | ## tvOS support diff --git a/docs/sdks/sdk-ref-javascript-v2.md b/docs/sdks/sdk-ref-javascript-v2.md index 26ca8c327..1c67fed43 100644 --- a/docs/sdks/sdk-ref-javascript-v2.md +++ b/docs/sdks/sdk-ref-javascript-v2.md @@ -83,9 +83,9 @@ The following table outlines the four main states that the SDK can be in, based | Workflow state | Advertising token | Login required | Description| Identity status value | | :--- | :--- | :---| :---| :---| | Initialization | `undefined`| `undefined`| Initial state until the callback is invoked. | N/A | -| Identity is available | available |`false` | A valid identity has been successfully established or refreshed. You can use the advertising token in targeted advertising. |`ESTABLISHED` or `REFRESHED` | -| Identity is temporarily unavailable |`undefined` | `false`| The advertising token has expired, therefore automatic refresh failed. [Background auto-refresh](#background-token-auto-refresh) attempts will continue until the refresh token expires or the user opts out.
    You can do either of the following:
    - Redirect the user, asking for the email or phone number.
    - Use untargeted advertising.
    NOTE: Identity might be successfully refreshed at a later time—for example, if the UID2 service is temporarily unavailable.| `EXPIRED` | -| Identity is not available | `undefined`| `false`| The identity is not available and cannot be refreshed. The SDK clears the first-party cookie.
    To use UID2-based targeted advertising again, you must obtain the email or phone number from the consumer. | `INVALID`, `NO_IDENTITY`, `REFRESH_EXPIRED`, or `OPTOUT` | +| Identity Is Available | available |`false` | A valid identity has been successfully established or refreshed. You can use the advertising token in targeted advertising. |`ESTABLISHED` or `REFRESHED` | +| Identity Is Temporarily Unavailable |`undefined` | `false`| The advertising token has expired, therefore automatic refresh failed. [Background auto-refresh](#background-token-auto-refresh) attempts will continue until the refresh token expires or the user opts out.
    You can do either of the following:
    - Redirect the user, asking for the email or phone number.
    - Use untargeted advertising.
    NOTE: Identity might be successfully refreshed at a later time—for example, if the UID2 service is temporarily unavailable.| `EXPIRED` | +| Identity Is Not Available | `undefined`| `false`| The identity is not available and cannot be refreshed. The SDK clears the first-party cookie.
    To use UID2-based targeted advertising again, you must obtain the email or phone number from the consumer. | `INVALID`, `NO_IDENTITY`, `REFRESH_EXPIRED`, or `OPTOUT` | The following diagram illustrates the four states, including the corresponding identity [status values](#identity-status-values) and possible transitions between them. The SDK invokes the [callback function](#callback-function) on each transition. From a084b4a9446a343bf940df588acd306992d9bf27 Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 7 Jul 2026 10:55:50 -0400 Subject: [PATCH 8/9] review mods --- docs/guides/integration-prebid-client-server.md | 2 +- .../current/guides/integration-prebid-client-server.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/integration-prebid-client-server.md b/docs/guides/integration-prebid-client-server.md index e5940db25..8a2a819ff 100644 --- a/docs/guides/integration-prebid-client-server.md +++ b/docs/guides/integration-prebid-client-server.md @@ -328,7 +328,7 @@ The following parameters apply only to the UID2 Prebid User ID Module integratio In this table, CR = Client Refresh mode, SO = Server-Only mode, and N/A = not applicable. -| Param under userSync.userIds[] | Mode/scope | Type | Description | Example | +| Param under userSync.userIds[] | Mode or scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | CR: Required
    SO: Required | String | ID value for the UID2 module. Always `"uid2"`. | `"uid2"` | | value | CR: N/A
    SO: Optional | Object | An object containing the value for the advertising token. | See [Configuration parameter examples: Value](#configuration-parameter-examples-value) | diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-client-server.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-client-server.md index 1f0c5fb24..a7947fabd 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-client-server.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-client-server.md @@ -328,7 +328,7 @@ Prebid.js の設定を検証・デバッグするツールの例として、オ この表では、CR = Client Refresh mode, SO = Server-Only mode, and N/A = 該当なし。 -| Param under userSync.userIds[] | Mode/Scope | Type | Description | Example | +| Param under userSync.userIds[] | Mode or scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | CR: 必須
    SO: 必須 | String | UID2 module の ID 値。常に `"uid2"`。 | `"uid2"` | | value | CR: N/A
    SO: オプション | Object | Advertising Token の値を含むオブジェクト。 | [Configuration parameter examples: Value](#configuration-parameter-examples-value) を参照してください。 | From bf5a41689ab02a412c535b071c6aec8618016d8d Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Tue, 7 Jul 2026 11:06:30 -0400 Subject: [PATCH 9/9] review mods --- docs/portal/audit-trail.md | 2 +- docs/portal/portal-overview.md | 2 +- docs/sdks/sdk-ref-android.md | 4 ++-- docs/sdks/sdk-ref-ios.md | 4 ++-- .../current/guides/mobile-plugin-ima-android.md | 2 +- .../current/guides/mobile-plugin-ima-ios.md | 2 +- .../current/sdks/sdk-ref-android.md | 4 ++-- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/portal/audit-trail.md b/docs/portal/audit-trail.md index b0dff8784..d3f48b7ed 100644 --- a/docs/portal/audit-trail.md +++ b/docs/portal/audit-trail.md @@ -18,7 +18,7 @@ The Audit Trail log displays the types of information summarized in the followin | Date | Date/time that the action occurred. | | User | The user who performed the action. | | Event | The action performed. For a summary of possible values, see [Audit trail event types](#audit-trail-event-types). | -| Event data | Details about the action. | +| Event Data | Details about the action. | | Succeeded | Indicates whether or not the action was successful. | ## Audit trail event types diff --git a/docs/portal/portal-overview.md b/docs/portal/portal-overview.md index a702d8b26..b37c58a9f 100644 --- a/docs/portal/portal-overview.md +++ b/docs/portal/portal-overview.md @@ -17,7 +17,7 @@ The UID2 Portal is your one-stop shop for setting up and configuring your UID2 a | Review your profile. | [Participant information](participant-info.md) | | Server-side or client-server integrations: Manage API keys for your account, including adding, modifying, or deleting keys. | [API keys](api-keys.md) | | Client-side integrations only: Set up and manage the values needed for generating UID2 tokens on the client side. | [Client-side integration](client-side-integration.md) | -| Configure permissions for individual sharing participants or groups of sharing participants.
    NOTE: use of sharing requires an API key (see [API keys](api-keys.md)) or client-side key pair (see [Client-side integration](client-side-integration.md)). Configure these values before setting up sharing permissions. | [Sharing permissions](sharing-permissions.md) | +| Configure permissions for individual sharing participants or groups of sharing participants.
    NOTE: Use of sharing requires an API key (see [API keys](api-keys.md)) or client-side key pair (see [Client-side integration](client-side-integration.md)). Configure these values before setting up sharing permissions. | [Sharing permissions](sharing-permissions.md) | | Add team members who will have permission to manage your account. | [Team members](team-members.md) | | Set up designated email contacts who will be notified of news or updates. | [Email contacts](email-contacts.md) | | View a detailed log of all past actions performed by, or on behalf of, the current participant. | [Audit trail](audit-trail.md) | diff --git a/docs/sdks/sdk-ref-android.md b/docs/sdks/sdk-ref-android.md index 777ae3452..a070e0dad 100644 --- a/docs/sdks/sdk-ref-android.md +++ b/docs/sdks/sdk-ref-android.md @@ -15,8 +15,8 @@ The following Android-related plugins, and associated documentation, are also av | Purpose | Product/documentation | | :--- | :--- | -| To use the Google Mobile Ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | -| To use the Google Interactive Media Ads (IMA) SDK for Android to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | +| To use the Google Mobile Ads (GMA) SDK to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | +| To use the Google Interactive Media Ads (IMA) SDK for Android to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | For FAQs relating to mobile publisher integrations, see [FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations). diff --git a/docs/sdks/sdk-ref-ios.md b/docs/sdks/sdk-ref-ios.md index 041b40a81..e9da000e3 100644 --- a/docs/sdks/sdk-ref-ios.md +++ b/docs/sdks/sdk-ref-ios.md @@ -15,8 +15,8 @@ The following iOS-related plugins, and associated documentation, are also availa | Purpose | Product/documentation | | :--- | :--- | -| To use the Google Mobile Ads (GMA) SDK to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | -| To use the Google Interactive Media Ads SDK for iOS to send UID2 tokens as [Secure Signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | +| To use the Google Mobile Ads (GMA) SDK to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [GMA Plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | +| To use the Google Interactive Media Ads SDK for iOS to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS/tvOS apps | [IMA Plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | ## tvOS support diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-ima-android.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-ima-android.md index e2a2e62dc..b943d8ab1 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-ima-android.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-ima-android.md @@ -9,7 +9,7 @@ import Link from '@docusaurus/Link'; # IMA Plugin for Android integration guide -UID2 Interactive Media Ads (IMA) Plugin for Android は、[Google IMA SDK for Android](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side) を使用するパブリッシャーが、Android アプリからの広告リクエストで UID2 Token を [Secure Signals](https://support.google.com/admob/answer/11556288) として送信できるようにします。これは自動的に行われるため、アプリ開発者が直接コーディングする必要はありません。 +UID2 Interactive Media Ads (IMA) Plugin for Android は、[Google IMA SDK for Android](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side) を使用するパブリッシャーが、Android アプリからの広告リクエストで UID2 Token を [secure signals](https://support.google.com/admob/answer/11556288) として送信できるようにします。これは自動的に行われるため、アプリ開発者が直接コーディングする必要はありません。 ## Functionality diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-ima-ios.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-ima-ios.md index 61412b373..cbca49a72 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-ima-ios.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-ima-ios.md @@ -9,7 +9,7 @@ import Link from '@docusaurus/Link'; # IMA Plugin for iOS integration guide -UID2 Interactive Media Ads (IMA) Plugin for iOS は、[Google IMA SDK for iOS](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side) を使用するパブリッシャーが、iOS アプリからの広告リクエストで UID2 Token を [Secure Signals](https://support.google.com/admob/answer/11556288) として送信できるようにします。これは自動的に行われるため、アプリ開発者が直接コーディングする必要はありません。 +UID2 Interactive Media Ads (IMA) Plugin for iOS は、[Google IMA SDK for iOS](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side) を使用するパブリッシャーが、iOS アプリからの広告リクエストで UID2 Token を [secure signals](https://support.google.com/admob/answer/11556288) として送信できるようにします。これは自動的に行われるため、アプリ開発者が直接コーディングする必要はありません。 ## Functionality diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-android.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-android.md index 0b5cd199e..232fc9894 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-android.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-android.md @@ -15,8 +15,8 @@ Android SDK を使用すると、UID2 を使用したクライアント ID の | Purpose | Product/Documentation | | :--- | :--- | -| Google Mobile Ads (GMA) SDK を使用して、Android アプリからの広告リクエストで UID2 token を [Secure Signals](https://support.google.com/admob/answer/11556288) として送信するには、次の手順に従います。 | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | -| Google Interactive Media Ads (IMA) SDK for Android を使用して、Android アプリからの広告リクエストで UID2 token を [Secure Signals](https://support.google.com/admob/answer/11556288) として送信するには、次の手順に従います。 | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | +| Google Mobile Ads (GMA) SDK を使用して、Android アプリからの広告リクエストで UID2 token を [secure signals](https://support.google.com/admob/answer/11556288) として送信するには、次の手順に従います。 | [GMA Plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | +| Google Interactive Media Ads (IMA) SDK for Android を使用して、Android アプリからの広告リクエストで UID2 token を [secure signals](https://support.google.com/admob/answer/11556288) として送信するには、次の手順に従います。 | [IMA Plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | モバイルパブリッシャーインテグレーションに関する FAQs は、[FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations) を参照してください。
    UID2 Mobile Implementation OptionSDK DocImplementation GuideUID2 mobile implementation optionSDK docImplementation guide
    Step ActionWho Does It?Who does it? Documentation
    Type of DIIInput FormatInput format Instructions
    Audience  > > > PublisherAdvertiser / Data ProviderAdvertiser / data provider DSP
    SDK for...Client-Side or Server-SideGenerate UID2 Token from DIIRefresh UID2 TokenMap DII to Raw UID2s*Monitor Rotated Salt Buckets**Encrypt Raw UID2 to UID2 Token for SharingDecrypt UID2 Token to Raw UID2Client-side or server-sideGenerate UID2 token from DIIRefresh UID2 tokenMap DII to raw UID2s*Monitor rotated salt buckets**Encrypt raw UID2 to UID2 token for sharingDecrypt UID2 token to raw UID2
    Input ExampleProcess/UserInput exampleProcess/user Result