diff --git a/.gitignore b/.gitignore index 72dfb7711..b9dddd528 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,6 @@ npm-debug.log* yarn-debug.log* yarn-error.log* .aider* + +# Temporary exclusion for Claude project 4/10/26 +# md-sentence-case* \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1647fe74a..e82cadccf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ npm i After you've checked out the repo (and whenever you pull in new changes) you should run this command to install any new packages. -## Local Development +## Local development ``` npm start @@ -31,7 +31,7 @@ npm run build This command generates static content into the `build` directory and can be served using any static contents hosting service. -## Build All Languages +## Build all languages ``` npm run build && npm run serve diff --git a/README.md b/README.md index 2b8de705c..c7a7a17e3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# UID2 Documentation +# UID2 documentation > Note: The new location for viewing UID2 documentation content is on the Unified ID website: [Unified ID 2.0 Overview](https://unifiedid.com/docs/intro). @@ -7,7 +7,7 @@ This repository contains all the content files and supporting site infrastructur - English (US) - Japanese -For information about build tools and about contributing to this repository, see [CONTRIBUTING.md](CONTRIBUTING.md). +For information about build tools and about contributing to this repository, see [Contributing.md](CONTRIBUTING.md). ## Adding custom tags diff --git a/docs/endpoints/post-identity-buckets.md b/docs/endpoints/post-identity-buckets.md index 3b7644dd4..3e53400c4 100644 --- a/docs/endpoints/post-identity-buckets.md +++ b/docs/endpoints/post-identity-buckets.md @@ -12,35 +12,35 @@ import Link from '@docusaurus/Link'; Monitors rotated salt buckets. -Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md). +Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md). :::important If you're using the latest version (v3) of `POST /v3/identity/map`, you don't need to use `POST /identity/buckets` at all. You only need to use it if you're using the earlier version (v2) of `POST /v2/identity/map`. -If you're using the v2 version, we recommend that you upgrade as soon as possible, to take advantage of improvements. For migration guidance, see [Migration from v2 Identity Map](post-identity-map.md#migration-from-v2-identity-map). +If you're using the v2 version, we recommend that you upgrade as soon as possible, to take advantage of improvements. For migration guidance, see [Migration from v2 identity map](post-identity-map.md#migration-from-v2-identity-map). ::: -## Request Format +## Request format `POST '{environment}/v2/identity/buckets'` -For authentication details, see [Authentication and Authorization](../getting-started/gs-auth.md). +For authentication details, see [Authentication and authorization](../getting-started/gs-auth.md). :::important -You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: -### Path Parameters +### Path parameters | 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). | :::note -The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials). +The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials). ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters :::important You must include the following parameter as a key-value pair in the JSON body of a request when encrypting it. @@ -50,7 +50,7 @@ You must include the following parameter as a key-value pair in the JSON body of | :--- | :--- | :--- | :--- | :--- | | `since_timestamp` | date-time or integer | Required | Specify the date and time to which to compare the last updated UTC timestamps of the buckets to be returned. | ISO 8601 format:
`YYYY-MM-DDThh:mm:ss` | -### Request Examples +### Request examples The following is an unencrypted JSON request body example, which you should include in your identity bucket rotation requests: @@ -65,9 +65,9 @@ Here's an encrypted identity bucket rotation request example: echo '{"since_timestamp": "2023-04-19T13:00:00"}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/buckets [Your-Client-API-Key] [Your-Client-Secret] ``` -For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). -## Decrypted JSON Response Format +## Decrypted JSON response format :::note The response is encrypted only if the HTTP status code is 200. Otherwise, the response is not encrypted. @@ -94,7 +94,7 @@ A successful decrypted response returns a list of salt bucket IDs and the timest "status":"success" } ``` -### Response Body Properties +### Response body properties The response body includes the properties shown in the following table. @@ -103,7 +103,7 @@ The response body includes the properties shown in the following table. | `bucket_id` | string | The salt bucket ID. | | `last_updated` | date-time | The UTC timestamp of the last time the bucket salt was rotated. | -### Response Status Codes +### Response status codes The following table lists the `status` property values and their HTTP status code equivalents. diff --git a/docs/endpoints/post-identity-map-v2.md b/docs/endpoints/post-identity-map-v2.md index dfe44d160..aa6a93ebe 100644 --- a/docs/endpoints/post-identity-map-v2.md +++ b/docs/endpoints/post-identity-map-v2.md @@ -11,53 +11,53 @@ import Link from '@docusaurus/Link'; Maps multiple email addresses, phone numbers, or their respective hashes to their raw UID2s and salt bucket IDs. You can also use this endpoint to check for updates to opt-out information. -Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md). +Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md). -For details about the UID2 opt-out workflow and how users can opt out, see [User Opt-Out](../getting-started/gs-opt-out.md). +For details about the UID2 opt-out workflow and how users can opt out, see [User opt-out](../getting-started/gs-opt-out.md). ## Version This documentation is for version 2 of this endpoint, which is not the latest version. For the latest version, v3, see [POST /identity/map](post-identity-map.md). :::note -If you're using an earlier version, we recommend that you upgrade as soon as possible, to take advantage of improvements. For migration guidance, see [Migration from v2 Identity Map](post-identity-map.md#migration-from-v2-identity-map). For deprecation information, see [Deprecation Schedule: Endpoint Versions](../ref-info/deprecation-schedule.md#endpoint-versions). +If you're using an earlier version, we recommend that you upgrade as soon as possible, to take advantage of improvements. For migration guidance, see [Migration from v2 identity map](post-identity-map.md#migration-from-v2-identity-map). For deprecation information, see [Deprecation schedule: Endpoint versions](../ref-info/deprecation-schedule.md#endpoint-versions). ::: -## Batch Size and Request Parallelization Requirements +## Batch size and request parallelization requirements Here's what you need to know: - The maximum request size is 1MB. - To map a large number of email addresses, phone numbers, or their respective hashes, send them in batches with a maximum of 5,000 items per batch. We recommend sending no more than 20 batches in parallel. -- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.
Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of raw UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). +- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.
Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of raw UID2s need to be updated daily. See also [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). -## Rate Limiting +## Rate limiting To ensure fair usage and platform stability, the `POST /identity/map` endpoint enforces rate limits to safeguard against bursts of incoming traffic. If you send many requests in quick succession, you might receive `429` error responses. To handle rate limit errors gracefully, we recommend implementing [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) with random jitter when retrying requests. To maximize throughput within the limit, use the maximum batch size of 5,000 items per request rather than sending many small requests. -## Request Format +## Request format `POST '{environment}/v2/identity/map'` -For authentication details, see [Authentication and Authorization](../getting-started/gs-auth.md). +For authentication details, see [Authentication and authorization](../getting-started/gs-auth.md). :::important -You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: -### Path Parameters +### Path parameters | 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). | :::note -The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials). +The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials). ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters :::important You must include only **one** of the following four conditional parameters as a key-value pair in the JSON body of the request when encrypting it. @@ -70,7 +70,7 @@ You must include only **one** of the following four conditional parameters as a | `phone` | string array | Conditionally Required | The list of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. | | `phone_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. | -### Request Examples +### Request examples The following are unencrypted JSON request body examples for each parameter, one of which you should include in your requests to the `POST /identity/map` endpoint: @@ -113,9 +113,9 @@ Here's an encrypted request example to the `POST /identity/map` endpoint for a p echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map [Your-Client-API-Key] [Your-Client-Secret] ``` -For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). -## Decrypted JSON Response Format +## Decrypted JSON response format :::note The response is encrypted only if the HTTP status code is 200. Otherwise, the response is not encrypted. @@ -189,7 +189,7 @@ If some identifiers have opted out from the UID2 ecosystem, the opted-out identi } ``` -### Response Body Properties +### Response body properties The response body includes the properties shown in the following table. @@ -199,7 +199,7 @@ The response body includes the properties shown in the following table. | `advertising_id` | string | The corresponding advertising ID (raw UID2). | | `bucket_id` | string | The ID of the salt bucket used to generate the raw UID2. | -### Response Status Codes +### Response status codes The following table lists the `status` property values and their HTTP status code equivalents. diff --git a/docs/endpoints/post-identity-map.md b/docs/endpoints/post-identity-map.md index 13738bf7c..bdba993e5 100644 --- a/docs/endpoints/post-identity-map.md +++ b/docs/endpoints/post-identity-map.md @@ -13,9 +13,9 @@ import SnptPOSTIdentityMapImprovements from '../snippets/_snpt-post-identity-map Maps multiple email addresses, phone numbers, or their respective hashes to their raw UID2s. You can also use this endpoint to check for updates to opt-out information, check when a raw UID2 can be refreshed, or view the previous UID2 if the current UID2 is less than 90 days old. -Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md). +Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md). -For details about the UID2 opt-out workflow and how users can opt out, see [User Opt-Out](../getting-started/gs-opt-out.md). +For details about the UID2 opt-out workflow and how users can opt out, see [User opt-out](../getting-started/gs-opt-out.md). ## Version @@ -23,41 +23,41 @@ This documentation is for the latest version of this endpoint, version 3. If needed, documentation is also available for the previous version: see [POST /identity/map (v2)](post-identity-map-v2.md). -## Batch Size and Request Parallelization Requirements +## Batch size and request parallelization requirements Here's what you need to know: - The maximum request size is 1MB. - To map a large number of email addresses, phone numbers, or their respective hashes, send them in batches with a maximum of 5,000 items per batch. We recommend sending no more than 20 batches in parallel. -- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.
Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). +- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.
Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of UID2s need to be updated daily. See also [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). -## Rate Limiting +## Rate limiting To ensure fair usage and platform stability, the `POST /identity/map` endpoint enforces rate limits to safeguard against bursts of incoming traffic. If you send many requests in quick succession, you might receive `429` error responses. To handle rate limit errors gracefully, we recommend implementing [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) with random jitter when retrying requests. To maximize throughput within the limit, use the maximum batch size of 5,000 items per request rather than sending many small requests. -## Request Format +## Request format `POST '{environment}/v3/identity/map'` -For authentication details, see [Authentication and Authorization](../getting-started/gs-auth.md). +For authentication details, see [Authentication and authorization](../getting-started/gs-auth.md). :::important -You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: -### Path Parameters +### Path parameters | 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). | :::note -The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials). +The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials). ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters :::important Include one or more of the following four parameters as key-value pairs in the JSON body of the request when encrypting it. @@ -71,7 +71,7 @@ Include one or more of the following four parameters as key-value pairs in the J | `phone_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. | -### Request Examples +### Request examples The following are unencrypted JSON request body examples to the `POST /identity/map` endpoint: @@ -107,9 +107,9 @@ Here's an encrypted request example to the `POST /identity/map` endpoint for pho echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v3/identity/map [YOUR_CLIENT_API_KEY] [YOUR_CLIENT_SECRET] ``` -For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). -## Decrypted JSON Response Format +## Decrypted JSON response format :::note The response is encrypted only if the HTTP status code is 200. Otherwise, the response is not encrypted. @@ -163,7 +163,7 @@ Response: } ``` -### Response Body Properties +### Response body properties The response body includes one or more of the properties shown in the following table. @@ -193,7 +193,7 @@ For unsuccessfully mapped input values, the mapped object includes the propertie |:---------|:----------|:-----------------------------------------------------------------------------------------------------------------| | `e` | string | The reason for being unable to map the DII to a raw UID2. One of two possible values: | -### Response Status Codes +### Response status codes The following table lists the `status` property values and their HTTP status code equivalents. @@ -210,20 +210,20 @@ If the `status` value is anything other than `success`, the `message` field prov 429 responses do not include a JSON response body. ::: -## Migration from v2 Identity Map +## Migration from v2 identity map The following sections provide general information and guidance for migrating to version 3 from earlier versions, including: -- [Version 3 Improvements](#version-3-improvements) -- [Key Differences Between v2 and v3](#key-differences-between-v2-and-v3) -- [Required Changes](#required-changes) -- [Additional Resources](#additional-resources) +- [Version 3 improvements](#version-3-improvements) +- [Key differences between v2 and v3](#key-differences-between-v2-and-v3) +- [Required changes](#required-changes) +- [Additional resources](#additional-resources) -### Version 3 Improvements +### Version 3 improvements -### Key Differences Between v2 and v3 +### Key differences between v2 and v3 The following table shows key differences between the versions. @@ -234,15 +234,15 @@ The following table shows key differences between the versions. | 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 +### Required changes To upgrade from an earlier version to version 3, follow these steps: -1. [Update Endpoint URL](#1-update-endpoint-url) -2. [Update v3 Response Parsing Logic](#2-update-v3-response-parsing-logic) -3. [Replace Salt Bucket Monitoring with Refresh Timestamp Logic](#3-replace-salt-bucket-monitoring-with-refresh-timestamp-logic) +1. [Update endpoint URL](#1-update-endpoint-url) +2. [Update v3 response parsing logic](#2-update-v3-response-parsing-logic) +3. [Replace salt bucket monitoring with refresh timestamp logic](#3-replace-salt-bucket-monitoring-with-refresh-timestamp-logic) -#### 1. Update Endpoint URL +#### 1. update endpoint URL Update any reference to the endpoint URL so that it references the /v3/ implementation, as shown in the following example. @@ -254,7 +254,7 @@ url = '/v2/identity/map' url = '/v3/identity/map' ``` -#### 2. Update v3 Response Parsing Logic +#### 2. update v3 response parsing logic Update the logic for parsing the response, as shown in the following example. @@ -285,7 +285,7 @@ for index, item in enumerate(response['body']['email']): handle_unmapped(original_email, item['e']) ``` -#### 3. Replace Salt Bucket Monitoring with Refresh Timestamp Logic +#### 3. replace salt bucket monitoring with refresh timestamp logic Update your code for salt bucket monitoring, replacing it with code that checks the `refresh_from` timestamp to determine raw UID2s that are due for refresh. @@ -303,12 +303,12 @@ to_remap = [mapping for mapping in mappings if is_refresh_needed(mapping)] remap_identities(to_remap) ``` -### Additional Resources +### Additional resources -For general information about identity mapping, see [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md). +For general information about identity mapping, see [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md). For migration guidance for specific SDKs, see: -- SDK for Python Reference Guide, [Usage for Advertisers/Data Providers](../sdks/sdk-ref-python.md#usage-for-advertisersdata-providers) section -- SDK for Java Reference Guide, [Usage for Advertisers/Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers) section +- SDK for Python Reference Guide, [Usage for advertisers/data providers](../sdks/sdk-ref-python.md#usage-for-advertisersdata-providers) section +- SDK for Java Reference Guide, [Usage for advertisers/data providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers) section -For Snowflake information, see [Snowflake Integration Guide](../guides/integration-snowflake.md). +For Snowflake information, see [Snowflake integration guide](../guides/integration-snowflake.md). diff --git a/docs/endpoints/post-optout-status.md b/docs/endpoints/post-optout-status.md index 59bb15a04..f5b9fbee2 100644 --- a/docs/endpoints/post-optout-status.md +++ b/docs/endpoints/post-optout-status.md @@ -10,44 +10,44 @@ import Link from '@docusaurus/Link'; # POST /optout/status -Checks the opt-out status of raw UID2s. Given a list of raw UID2s, this endpoint returns the raw UID2s that have opted out, as well as the time that the opt-out took place. For more information, see [User Opt-Out](../getting-started/gs-opt-out.md). +Checks the opt-out status of raw UID2s. Given a list of raw UID2s, this endpoint returns the raw UID2s that have opted out, as well as the time that the opt-out took place. For more information, see [User opt-out](../getting-started/gs-opt-out.md). Used by: This endpoint is used by advertisers, data providers, DSPs, and sharers. More generally, this is for participants who have access to raw UID2s but do not have access to the underlying email addresses or phone numbers and want to know opt-out status. For details, refer to the following documentation, depending on your role: -- [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) -- [DSP Integration Guide](../guides/dsp-guide.md) -- [UID2 Sharing: Overview](../sharing/sharing-overview) +- [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) +- [DSP integration guide](../guides/dsp-guide.md) +- [UID2 sharing: Overview](../sharing/sharing-overview) -## Batch Size and Request Parallelization Requirements +## Batch size and request parallelization requirements The key guidelines for managing batches of requests to this endpoint are as follows: - To check the opt-out status of a large number of UID2s, send them in sequential batches with a maximum batch size of 5,000 items per batch. - Unless you are using a Private Operator, do not send batches in parallel. In other words, use a single HTTP connection and send batches of raw UID2s consecutively, without creating multiple parallel connections. -## Request Format +## Request format `POST '{environment}/v2/optout/status'` -For authentication details, see [Authentication and Authorization](../getting-started/gs-auth.md). +For authentication details, see [Authentication and authorization](../getting-started/gs-auth.md). :::important -You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: -### Path Parameters +### Path parameters | 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). | :::note -The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials). +The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials). ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters There is a single body parameter. @@ -55,7 +55,7 @@ There is a single body parameter. | :--- | :--- | :--- | :--- | | `advertising_ids` | string array | Required | The list of raw UID2s for which you want to check the opt-out status.
Include a maximum of 5,000 entries in one API call. | -### Request Example +### Request example The following is an example of an unencrypted JSON request body: @@ -75,9 +75,9 @@ The following is an encrypted opt-out status request example: echo '{"advertising_ids": ["ufv1uGRovNiJNbJqiE/xzM+aKE7jP69MgspOZoEQ3xc="]}' | python3 uid2_request.py https://prod.uidapi.com/v2/optout/status [Your-Client-API-Key] [Your-Client-Secret] ``` -For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). -## Decrypted JSON Response Format +## Decrypted JSON response format :::note The response is encrypted only if the HTTP status code is 200. Otherwise, the response is not encrypted. @@ -103,7 +103,7 @@ A successful decrypted response returns the raw UID2s that have opted out. For e } ``` -### Response Body Properties +### Response body properties The response body includes the following properties. @@ -112,7 +112,7 @@ The response body includes the following properties. | `advertising_id` | string | The advertising ID (raw UID2). | | `opted_out_since` | number | The Unix timestamp (in milliseconds) that indicates when the raw UID2 was opted out. | -### Response Status Codes +### Response status codes The following table lists the status property values and their HTTP status code equivalents. diff --git a/docs/endpoints/post-token-generate.md b/docs/endpoints/post-token-generate.md index 023d0d2d8..b3f3655aa 100644 --- a/docs/endpoints/post-token-generate.md +++ b/docs/endpoints/post-token-generate.md @@ -20,26 +20,26 @@ Used by: This endpoint is used mainly by publishers. Rather than calling this endpoint directly, you could use one of the SDKs to manage it for you. For a summary of options, see [SDKs: Summary](../sdks/summary-sdks.md). :::important -Whatever option you use, the data that you send for generating UID2s must be normalized, hashed, and encoded before sending. For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). +Whatever option you use, the data that you send for generating UID2s must be normalized, hashed, and encoded before sending. For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md). ::: -## Request Format +## Request format `POST '{environment}/v2/token/generate'` -For authentication details, see [Authentication and Authorization](../getting-started/gs-auth.md). +For authentication details, see [Authentication and authorization](../getting-started/gs-auth.md). Here's what you need to know about sending requests to this endpoint: - To ensure that the API key used to access the service remains secret, UID2 tokens must be generated only on the server side after authentication. -- You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +- You must encrypt all requests using your secret. For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). -### Path Parameters +### Path parameters | 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: | -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters :::important 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. @@ -52,10 +52,10 @@ You must include only **one** of the following four conditional parameters as ke | `phone` | string | Conditionally Required | The [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number for which to generate tokens. | | `phone_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hash of a [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number. | -### Request Examples +### Request examples :::important -To ensure that the API key used to access the service remains secret, the `POST /token/generate` endpoint must be called from the server side, unlike [POST /token/refresh](post-token-refresh.md) which does not require using an API key. If you want to generate tokens on the client side, see [Client-Side Integration Options](../guides/integration-options-publisher-web.md#client-side-integration-options) (for web-based implementations) or [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md). +To ensure that the API key used to access the service remains secret, the `POST /token/generate` endpoint must be called from the server side, unlike [POST /token/refresh](post-token-refresh.md) which does not require using an API key. If you want to generate tokens on the client side, see [Client-side integration options](../guides/integration-options-publisher-web.md#client-side-integration-options) (for web-based implementations) or [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side.md). ::: The following are unencrypted JSON request body examples for each parameter, one of which you should include in your token generation requests: @@ -86,9 +86,9 @@ Here's an encrypted token generation request example for an email hash: ```sh echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/generate [Your-Client-API-Key] [Your-Client-Secret] ``` -For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). -## Decrypted JSON Response Format +## Decrypted JSON response format :::note The response is encrypted only if the HTTP status code is 200. Otherwise, the response is not encrypted. @@ -96,10 +96,10 @@ The response is encrypted only if the HTTP status code is 200. Otherwise, the re This section includes the following sample responses: -* [Successful Response](#successful-response) +* [Successful response](#successful-response) * [Optout](#optout) -#### Successful Response +#### Successful response A successful decrypted response returns the user's advertising and refresh tokens for the specified email address, phone number, or the respective hash. @@ -115,7 +115,7 @@ Here is an example response when the user has opted out. } ``` -### Response Body Properties +### Response body properties The response body includes the properties shown in the following table. @@ -128,7 +128,7 @@ The response body includes the properties shown in the following table. | `refresh_expires` | number | The Unix timestamp (in milliseconds) that indicates when the refresh token expires. | | `refresh_response_key` | string | A key to be used in a [POST /token/refresh](post-token-refresh.md) request for response decryption. | -### Response Status Codes +### Response status codes The following table lists the `status` property values and their HTTP status code equivalents. @@ -141,7 +141,7 @@ The following table lists the `status` property values and their HTTP status cod If the `status` value is anything other than `success`, the `message` field provides additional information about the issue. -## Test Identities +## Test identities | Type | Identity | Purpose | Next Endpoint | |:------|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------| diff --git a/docs/endpoints/post-token-refresh.md b/docs/endpoints/post-token-refresh.md index 8d107284c..669259241 100644 --- a/docs/endpoints/post-token-refresh.md +++ b/docs/endpoints/post-token-refresh.md @@ -21,7 +21,7 @@ You can call this endpoint from the client side (for example, a browser or a mob Rather than calling this endpoint directly, you could use one of the UID2 SDKs to manage it for you. For a summary of options, see [SDKs: Summary](../sdks/summary-sdks.md). ::: -## Request Format +## Request format `POST '{environment}/v2/token/refresh'` @@ -34,24 +34,24 @@ Here's what you need to know about this endpoint: - Successful responses, whether the response includes a new token or opt-out information, are encrypted. Error responses are not encrypted. - To decrypt responses, use the most recent `refresh_response_key` value for this token. The `refresh_response_key` value is returned in the response to the [POST /token/generate](post-token-generate.md) and `POST /token/refresh` operations. Each time a token is refreshed, a new `refresh_response_key` is returned. Be sure to use the most recent one to decrypt the current response. -### Path Parameters +### Path parameters | 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: | -#### Testing Notes +#### Testing notes Using either of the following parameters in a [POST /token/generate](post-token-generate.md) request always generates an identity response with a `refresh_token` that results in a logout response when used with the `POST /token/refresh` endpoint: - The `refresh-optout@example.com` email address - The `+00000000002` phone number -### Request Example +### Request example -For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). -## Decrypted JSON Response Format +## Decrypted JSON response format A decrypted successful response includes a new UID2 token (`advertising_token`) and associated values for the user, or indicates that the user has opted out. @@ -61,17 +61,17 @@ The response is encrypted only if the HTTP status code is 200. Otherwise, the re This section includes the following sample responses: -* [Successful Response With Tokens](#successful-response-with-tokens) -* [Successful Response With Opt-Out](#successful-response-with-opt-out) -* [Error Response](#error-response) +* [Successful response with tokens](#successful-response-with-tokens) +* [Successful response with opt-out](#successful-response-with-opt-out) +* [Error response](#error-response) -#### Successful Response With Tokens +#### Successful response with tokens If all values are valid and the user has not opted out, the response is successful and a new UID2 token is returned, with associated values. The following example shows a decrypted successful response with tokens: -#### Successful Response With Opt-Out +#### Successful response with opt-out If the user has opted out, the response is successful but a new UID2 token is not returned. The following example shows a decrypted opt-out response: @@ -81,7 +81,7 @@ If the user has opted out, the response is successful but a new UID2 token is no } ``` -#### Error Response +#### Error response An error response might look like the following: @@ -92,7 +92,7 @@ An error response might look like the following: } ``` -### Response Body Properties +### Response body properties The response body includes the properties shown in the following table. @@ -101,11 +101,11 @@ The response body includes the properties shown in the following table. | `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. | | `identity_expires` | number | The Unix timestamp (in milliseconds) that indicates when the UID2 token expires. | -| `refresh_from` | number | The Unix timestamp (in milliseconds) that indicates when the SDK for JavaScript (see [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md)) will start refreshing the UID2 token, if the SDK is in use.
TIP: If you are not using the SDK, consider refreshing the UID2 token from this timestamp, too. | +| `refresh_from` | number | The Unix timestamp (in milliseconds) that indicates when the SDK for JavaScript (see [SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md)) will start refreshing the UID2 token, if the SDK is in use.
TIP: If you are not using the SDK, consider refreshing the UID2 token from this timestamp, too. | | `refresh_expires` | number | The Unix timestamp (in milliseconds) that indicates when the refresh token expires. | | `refresh_response_key` | string | A key to be used in a new [POST /token/refresh](post-token-refresh.md) request for response decryption. | -### Response Status Codes +### Response status codes The following table lists the `status` property values and their HTTP status code equivalents. diff --git a/docs/endpoints/post-token-validate.md b/docs/endpoints/post-token-validate.md index 91903a7fb..5720d4031 100644 --- a/docs/endpoints/post-token-validate.md +++ b/docs/endpoints/post-token-validate.md @@ -18,27 +18,27 @@ Used by: This endpoint is used mainly by publishers. This endpoint is intended primarily for testing and troubleshooting new integrations. ::: -## Request Format +## Request format `POST '{environment}/v2/token/validate'` -For authentication details, see [Authentication and Authorization](../getting-started/gs-auth.md). +For authentication details, see [Authentication and authorization](../getting-started/gs-auth.md). :::important -You must encrypt all requests using your secret key. For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +You must encrypt all requests using your secret key. For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: -### Path Parameters +### Path parameters | 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). | :::note -The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials). +The integration environment and the production environment require different API keys. For information about getting credentials for each environment, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials). ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters Here are some key points about using this endpoint: @@ -53,7 +53,7 @@ Here are some key points about using this endpoint: | `phone` | string | Conditionally Required | The phone number for token validation. You can use any valid phone number value, but it must be [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization). | | `phone_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hash of any valid [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number. | -### Request Examples +### Request examples The following are unencrypted JSON request body examples for each parameter, which you need to include in your token validation requests: @@ -92,9 +92,9 @@ Here's an encrypted token validation request example for an email hash: echo '{"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXlfWETZ3b%2FbesPFFvJxNLLySg4QEYHUAiyUrNncgnm7ppu0mi6wU2CW6hssiuEkKfstbo9XWgRUbWNTM%2BewMzXXM8G9j8Q%3D", "email_hash": "LdhtUlMQ58ZZy5YUqGPRQw5xUMS5dXG5ocJHYJHbAKI="}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/validate [Your-Client-API-Key] [Your-Client-Secret] ``` -For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). -## Decrypted JSON Response Format +## Decrypted JSON response format :::note The response is encrypted only if the HTTP status code is 200. Otherwise, the response is not encrypted. @@ -109,7 +109,7 @@ A successful decrypted response returns a boolean value that indicates the valid } ``` -## Body Response Properties +## Body response properties The following table provides information about the response body. @@ -117,7 +117,7 @@ The following table provides information about the response body. | :--- | :--- | :--- | | `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. | -### Response Status Codes +### Response status codes The following table lists the `status` property values and their HTTP status code equivalents. @@ -129,7 +129,7 @@ The following table lists the `status` property values and their HTTP status cod If the `status` value is anything other than `success`, the `message` field provides additional information about the issue. -## Using POST /token/validate to Test +## Using POST /token/validate to test You can use this endpoint to test whether the DII that you are sending through [POST /token/generate](../endpoints/post-token-generate.md) is valid. Follow these steps. diff --git a/docs/endpoints/summary-endpoints.md b/docs/endpoints/summary-endpoints.md index fbcad26d0..5609a95a4 100644 --- a/docs/endpoints/summary-endpoints.md +++ b/docs/endpoints/summary-endpoints.md @@ -8,23 +8,23 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Endpoints: Summary +# UID2 endpoints: Summary -All UID2 endpoints require a client secret for encrypting API requests (except [POST /token/refresh](post-token-refresh.md) requests) and decrypting responses. For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). +All UID2 endpoints require a client secret for encrypting API requests (except [POST /token/refresh](post-token-refresh.md) requests) and decrypting responses. For details, and code examples in different programming languages, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). -## UID2 Endpoints by Audience +## UID2 endpoints by audience The following table shows the UID2 endpoints, with the audience for each. For details, click through to the applicable sections. | Endpoint | Audience | Details | | :--- | :--- | :--- | -| [POST /token/generate](post-token-generate.md) | Publishers | [UID2 Tokens](#uid2-tokens) | -| [POST /token/validate](post-token-validate.md) | Publishers | [UID2 Tokens](#uid2-tokens) | -| [POST /token/refresh](post-token-refresh.md) | Publishers | [UID2 Tokens](#uid2-tokens) | -| [POST /identity/map](post-identity-map.md) | Advertisers, data providers | [Identity Map](#identity-map) | -| [POST /optout/status](post-optout-status.md) | Advertisers, data providers, DSPs, sharers | [Opt-Out Status](#opt-out-status)| +| [POST /token/generate](post-token-generate.md) | Publishers | [UID2 tokens](#uid2-tokens) | +| [POST /token/validate](post-token-validate.md) | Publishers | [UID2 tokens](#uid2-tokens) | +| [POST /token/refresh](post-token-refresh.md) | Publishers | [UID2 tokens](#uid2-tokens) | +| [POST /identity/map](post-identity-map.md) | Advertisers, data providers | [Identity map](#identity-map) | +| [POST /optout/status](post-optout-status.md) | Advertisers, data providers, DSPs, sharers | [Opt-out status](#opt-out-status)| -## UID2 Tokens +## UID2 tokens The following endpoints are for retrieving and managing UID2 tokens (identity tokens, advertising tokens), and are used mainly by publishers. @@ -34,11 +34,11 @@ The following endpoints are for retrieving and managing UID2 tokens (identity to | [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 | | [POST /token/refresh](post-token-refresh.md) | Generates a new token for a user for their refresh token from the [POST /token/generate](post-token-generate.md) response. | N/A | Required | -## Identity Map +## Identity map The following endpoints are used by advertisers and third-party data providers. Publishers do not need to use these endpoints. -### Latest Identity Map Endpoint (v3) +### Latest identity map endpoint (v3) In the latest identity map integration, you only need to call one endpoint, `POST /identity/map`. The `POST /identity/buckets` endpoint is not part of the workflow. @@ -52,7 +52,7 @@ The latest identity map integration uses the following endpoint: | :--- | :--- | :--- | :--- | | [POST /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 | -### Earlier Identity Map Endpoints (v2) +### Earlier identity map endpoints (v2) The following endpoints are part of the earlier identity map integration (version 2). @@ -61,11 +61,11 @@ The following endpoints are part of the earlier identity map integration (versio | [POST /identity/buckets](post-identity-buckets.md) | Monitors rotated salt buckets using their last updated timestamp. | Required | Required | | [POST /identity/map (v2)](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 | -## Opt-Out Status +## Opt-out status The following endpoint can be used by advertisers, third-party data providers, DSPs, and sharers. Publishers do not need to use this endpoint. -For details about the UID2 opt-out workflow and how users can opt out, see [User Opt-Out](../getting-started/gs-opt-out.md). +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 | | :--- | :--- | :--- | :--- | diff --git a/docs/getting-started/gs-account-setup.md b/docs/getting-started/gs-account-setup.md index 03b073302..3abb0b174 100644 --- a/docs/getting-started/gs-account-setup.md +++ b/docs/getting-started/gs-account-setup.md @@ -8,11 +8,11 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Account Setup +# Account setup This page provides general information required for you to get your account set up with UID2. -## Contact Info +## Contact info To get access to the UID2 framework, contact the appropriate team at The Trade Desk listed below. @@ -24,10 +24,10 @@ Contacting The Trade Desk for access is temporary. When the system is moved to i | 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 +## Account setup details When you've expressed interest in UID2, someone will contact you to help work out the details. @@ -40,7 +40,7 @@ As part of account setup, provide the following information: * Email address * Job title -### Client-Side Web Integrations +### Client-side web integrations If you'll be requesting UID2 tokens from the client side on the [web](../overviews/overview-publishers.md#web-integrations) rather than in [mobile](../overviews/overview-publishers.md#mobile-integrations) apps, you must also provide a list of **domain names** for your sites. This is a security measure, for client-side implementation only. @@ -48,7 +48,7 @@ If you'll be requesting UID2 tokens from the client side on the [web](../overvie Only root-level domains are required for account setup. For example, if you're going to implement UID2 to generate tokens on the client side on example.com, shop.example.com, and example.org, you only need to provide the domain names example.com and example.org. ::: -### Client-Side Mobile Integrations +### Client-side mobile integrations If you'll be requesting UID2 tokens from the client side in [mobile apps](../guides/integration-mobile-client-side.md), it's important to provide a complete list of all your mobile app IDs, including: @@ -59,6 +59,6 @@ If you'll be requesting UID2 tokens from the client side in [mobile apps](../gui When you've signed a contract for participating in UID2, we'll give you [UID2 credentials](gs-credentials.md) and additional information for getting up and running with UID2. -## API Version +## API version The current version of the UID2 API is v2. diff --git a/docs/getting-started/gs-auth.md b/docs/getting-started/gs-auth.md index d54fe3ac6..ea125f990 100644 --- a/docs/getting-started/gs-auth.md +++ b/docs/getting-started/gs-auth.md @@ -8,14 +8,14 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Authentication and Authorization +# Authentication and authorization To authenticate to the UID2 endpoints in a server-side implementation, you need the following: - A client [API key](gs-credentials.md#api-key-and-client-secret). The API key is included as a bearer token in the request's Authorization header. For example:
`Authorization: Bearer YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk=` -- A client secret for encrypting API requests and decrypting API responses. This is needed for all endpoints except [POST /token/refresh](../endpoints/post-token-refresh.md).
For details, and encryption/decryption examples in several different programming languages, see [Encrypting Requests and Decrypting Responses](gs-encryption-decryption.md). +- A client secret for encrypting API requests and decrypting API responses. This is needed for all endpoints except [POST /token/refresh](../endpoints/post-token-refresh.md).
For details, and encryption/decryption examples in several different programming languages, see [Encrypting requests and decrypting responses](gs-encryption-decryption.md). :::note -If you're a publisher and are implementing UID2 on the client side, the authentication and authorization is managed automatically by your implementation, such as Prebid.js (see [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md)) or the JavaScript SDK (see [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)). +If you're a publisher and are implementing UID2 on the client side, the authentication and authorization is managed automatically by your implementation, such as Prebid.js (see [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md)) or the JavaScript SDK (see [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md)). ::: diff --git a/docs/getting-started/gs-credentials.md b/docs/getting-started/gs-credentials.md index 13211530f..137edb214 100644 --- a/docs/getting-started/gs-credentials.md +++ b/docs/getting-started/gs-credentials.md @@ -8,25 +8,25 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Credentials +# UID2 credentials Each UID2 participant needs at least one set of unique credentials. The set of credentials you need is determined by how you are participating in UID2, as shown in the following table. | Audience | Credentials | Integration | | :--- | :--- | :--- | -| Participants using a client-side implementation | Both of the following: These two, together, are sometimes called client keypair. | Integrations using one of these: | -| Participants using a client-server implementation | Both of the following: | Integrations using one of these: | -| Participants using a server-side implementation | Both of the following: | Integrations using one of these: | +| Participants using a client-side implementation | Both of the following: These two, together, are sometimes called client keypair. | Integrations using one of these: | +| Participants using a client-server implementation | Both of the following: | Integrations using one of these: | +| Participants using a server-side implementation | Both of the following: | Integrations using one of these: | -## Separate Credentials Per Environment/Role +## Separate credentials per environment/role -If you're using the integration environment as well as the production environment, you'll get a separate set of credentials for each environment. See [Getting Your Credentials](#getting-your-credentials). +If you're using the integration environment as well as the production environment, you'll get a separate set of credentials for each environment. See [Getting your credentials](#getting-your-credentials). In addition, in some cases, we recommend, but do not require, that you have a different set of credentials for a different scenario. For example: - If you're a publisher who generates UID2 tokens (via [POST /token/generate](../endpoints/post-token-generate.md) or in some other way), but you also create/map raw UID2s on your own behalf (see [POST /identity/map](../endpoints/post-identity-map.md)), you might have separate credentials for each of these activities. - If you're an advertiser, in a scenario where you allow multiple service providers to operate using your advertiser keys, you might choose to have separate credentials for each service provider. -## Getting Your Credentials +## Getting your credentials The following table shows how you get your credentials, for each [integration approach](../ref-info/ref-integration-approaches.md) and each [environment](../getting-started/gs-environments.md). @@ -42,17 +42,17 @@ The following table shows how you get your credentials, for each [integration ap

Prod Client-Side - UID2 Portal > [Client-Side Integration](../portal/client-side-integration.md) + UID2 Portal > [Client-side integration](../portal/client-side-integration.md) Client-Server - UID2 Portal > [API Keys](../portal/api-keys.md) + UID2 Portal > [API keys](../portal/api-keys.md) Server-Side - UID2 Portal > [API Keys](../portal/api-keys.md) + UID2 Portal > [API keys](../portal/api-keys.md)

Integ @@ -77,9 +77,9 @@ For no-portal: To get your credentials, ask your UID2 contact. --> -## Subscription ID and Public Key +## Subscription ID and public key -If you're using a client-side implementation (see [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) or [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)), you'll receive the following credentials: +If you're using a client-side implementation (see [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) or [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md)), you'll receive the following credentials: - **Subscription ID**: This value identifies your site to the UID2 service. - **Public key**: This value is used for encryption. @@ -93,24 +93,24 @@ Notes: - The values are valid for a specific environment. If you're using both the integration and production environments, you'll get a set of credentials for each environment. -- Subscription ID and public key credentials can be used only to generate client-side tokens. If you need any additional roles (see [API Permissions](gs-permissions.md)), request API Key and Client Secret for those roles. +- Subscription ID and public key credentials can be used only to generate client-side tokens. If you need any additional roles (see [API permissions](gs-permissions.md)), request API Key and Client Secret for those roles. -## API Key and Client Secret +## API key and client secret -If you're using a client-server or server-side implementation (see [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) or [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), the API key and client secret allow you to connect to the Operator Service and call API endpoints. These values identify you to the service. +If you're using a client-server or server-side implementation (see [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) or [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md)), the API key and client secret allow you to connect to the Operator Service and call API endpoints. These values identify you to the service. Here is some information about API keys and client secrets: -- You must keep these values secure. For details, see [Security of API Key and Client Secret](#security-of-api-key-and-client-secret). +- You must keep these values secure. For details, see [Security of API key and client secret](#security-of-api-key-and-client-secret). - One UID2 participant can have multiple keys. - Each key has a set of [permissions](gs-permissions.md) that determine the endpoints you can use it on. - Each key has a corresponding client secret. -- Most API endpoints require both API key and client secret for authentication. For details, see [Authentication and Authorization](gs-auth.md). -- If you're using the integration environment as well as the production environment, you'll receive separate API keys for each environment. For details, see [Getting Your Credentials](#getting-your-credentials). +- Most API endpoints require both API key and client secret for authentication. For details, see [Authentication and authorization](gs-auth.md). +- If you're using the integration environment as well as the production environment, you'll receive separate API keys for each environment. For details, see [Getting your credentials](#getting-your-credentials). - The client secret is valid for a specific [environment](gs-environments.md). If you're using both the integration and production environments, you'll get a client secret for each environment. -As part of getting your UID2 account set up, we'll give you one or more API keys, each with a corresponding client secret. For details of who to talk to, see [Contact Info](gs-account-setup.md#contact-info). +As part of getting your UID2 account set up, we'll give you one or more API keys, each with a corresponding client secret. For details of who to talk to, see [Contact info](gs-account-setup.md#contact-info). -### Security of API Key and Client Secret +### Security of API key and client secret Security of keys and client secrets is very important. Follow these guidelines: @@ -120,11 +120,11 @@ Security of keys and client secrets is very important. Follow these guidelines: It's best to refresh your API key and client secret on a regular cadence—for example, yearly—to help reduce the risk of your credentials being compromised. -## Refreshing Credentials +## Refreshing credentials To request new credentials at any time, do one of the following: -- If you have UID2 Portal access, and you need new Production credentials: go to the page listed in [Getting Your Credentials](#getting-your-credentials). +- If you have UID2 Portal access, and you need new Production credentials: go to the page listed in [Getting your credentials](#getting-your-credentials). - If you don't have UID2 Portal access, or you need new credentials for the Integration environment, ask your UID2 contact. -### Honor User Opt-Outs +### Honor user opt-outs This section includes the following information for DSPs, who must honor user opt-out of UID2: -- [Opt-Out Webhook](#opt-out-webhook) -- [POST /optout/status Endpoint](#post-optoutstatus-endpoint) -- [Bidding Opt-Out Logic](#bidding-opt-out-logic) +- [Opt-out webhook](#opt-out-webhook) +- [POST /optout/status endpoint](#post-optoutstatus-endpoint) +- [Bidding opt-out logic](#bidding-opt-out-logic) -For details about the UID2 opt-out workflow and how users can opt out, see [User Opt-Out](../getting-started/gs-opt-out.md). +For details about the UID2 opt-out workflow and how users can opt out, see [User opt-out](../getting-started/gs-opt-out.md). -#### Opt-Out Webhook +#### Opt-out webhook To receive and honor user opt-outs from the UID2 service, the DSP establishes a pre-configured interface (an opt-out webhook/API endpoint) and provides it to the UID2 service during onboarding. When a user opts out, the UID2 service sends the user's raw UID2 and the corresponding opt-out timestamp to the pre-configured interface. -The UID2 service sends the following data within seconds of a user's opt-out, which the DSP records and uses the bidding logic defined in [Decrypt UID2 Tokens for RTB Use](#decrypt-uid2-tokens-for-rtb-use). +The UID2 service sends the following data within seconds of a user's opt-out, which the DSP records and uses the bidding logic defined in [Decrypt UID2 tokens for RTB use](#decrypt-uid2-tokens-for-rtb-use). | Parameter | Description | | :--- | :--- | @@ -60,11 +60,11 @@ The following example illustrates a webhook configured to receive the raw UID2 a https://dsp.example.com/optout?user=%%identity%%&optouttime=%%timestamp%% ``` -#### POST /optout/status Endpoint +#### POST /optout/status endpoint DSPs can check the opt-out status of raw UID2s using the [POST /optout/status](../endpoints/post-optout-status.md) endpoint. -#### Bidding Opt-Out Logic +#### Bidding opt-out logic Use the logic below during bidding (2-b) to honor a user's opt-out. @@ -72,20 +72,20 @@ Leverage one of the server-side SDKs (see [SDKs: Summary](../sdks/summary-sdks.m The following diagram illustrates opt-out logic. -![DSP Opt-Out Check](images/dsp-guide-optout.png) +![DSP opt-out check](images/dsp-guide-optout.png) If the user has opted out, the UID2 must not be used for RTB. In these cases, the DSP can choose to send an alternate ID for bidding or can choose not to bid. -### Decrypt UID2 Tokens for RTB Use +### Decrypt UID2 tokens for RTB use -The following table provides details for Step 2 of the workflow diagram shown in [Integration Steps](#integration-steps). +The following table provides details for Step 2 of the workflow diagram shown in [Integration steps](#integration-steps). | Step | SDK | Description | | :--- | :--- | :--- | | 2-a | Server-side SDK (see [SDKs: Summary](../sdks/summary-sdks.md)) | Leverage the provided SDK to decrypt incoming UID2 tokens. The response contains the `UID2` and the UID2 creation time. | | 2-b | | DSPs are required to honor opt-out protocol for UID2s. For details on configuring user opt-outs and honoring them during bidding, see [Honor user opt-outs](#honor-user-opt-outs). | -## Recommendations for Managing Latency +## Recommendations for managing latency :::note This section refers to the example code in [Usage for DSPs](../sdks/sdk-ref-csharp-dotnet.md#usage-for-dsps) in the *SDK for C# / .NET Reference Guide*. The method names are similar for the [Java](../sdks/sdk-ref-java.md#usage-for-dsps), [Python](../sdks/sdk-ref-python#usage-for-dsps), and [C++](../sdks/sdk-ref-cplusplus.md#interface) SDKs. diff --git a/docs/guides/integration-advertiser-dataprovider-endpoints.md b/docs/guides/integration-advertiser-dataprovider-endpoints.md index d14924918..99d2276ef 100644 --- a/docs/guides/integration-advertiser-dataprovider-endpoints.md +++ b/docs/guides/integration-advertiser-dataprovider-endpoints.md @@ -10,82 +10,82 @@ displayed_sidebar: sidebarAdvertisers import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Advertiser/Data Provider Integration to HTTP Endpoints +# Advertiser/data provider integration to HTTP endpoints 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, Databricks, or AWS Entity Resolution. :::tip -For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md). +For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md). ::: -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page: +You'll need to set up these values, in the UID2 Portal on the [API keys](../portal/api-keys.md) page: - API key, also called a client key - Client secret, a value known only to the participant and the UID2 service :::important -It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). +It's very important that you keep these values secure. For details, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). ::: -## Preparing DII for Processing +## Preparing DII for processing -## High-Level Steps +## High-level steps At a high level, the steps for advertisers and data providers integrating with UID2 are as follows: -1. [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) +1. [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) -2. [Store Raw UID2s and Refresh Timestamps](#2-store-raw-uid2s-and-refresh-timestamps) +2. [Store raw UID2s and refresh timestamps](#2-store-raw-uid2s-and-refresh-timestamps) -3. [Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s) +3. [Manipulate or combine raw UID2s](#3-manipulate-or-combine-raw-uid2s) -4. [Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) +4. [Send stored raw UID2s to DSPs to create audiences or conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) -5. [Monitor for Raw UID2 Refresh](#5-monitor-for-raw-uid2-refresh) +5. [Monitor for raw UID2 refresh](#5-monitor-for-raw-uid2-refresh) -6. [Monitor for Opt-Out Status](#6-monitor-for-opt-out-status) +6. [Monitor for opt-out status](#6-monitor-for-opt-out-status) -## Integration Diagram +## Integration diagram The following diagram outlines the steps that data collectors must complete to map DII to raw UID2s for audience building and targeting. DII refers to a user's normalized email address or phone number, or the normalized and SHA-256-hashed email address or phone number. -![Advertiser Flow](images/advertiser-flow-endpoints-mermaid-v3.png) +![Advertiser flow](images/advertiser-flow-endpoints-mermaid-v3.png) -### 1: Generate Raw UID2s from DII +### 1: Generate raw UID2s from DII | Step | Endpoint | Description | | --- | --- | --- | | 1-a | [POST /identity/map](../endpoints/post-identity-map.md) request | Send a request containing DII to the identity mapping endpoint. | -| 1-b | [POST /identity/map](../endpoints/post-identity-map.md) response | The raw UID2 (`u` field) returned in the response can be used to target audiences on relevant DSPs.
The response returns a user's raw UID2 (`u`), refresh timestamp (`r`), and optionally the previous raw UID2 (`p`) if the current UID2 was rotated within the last 90 days. Use the refresh timestamp to determine when to refresh the UID2. For details, see [5: Monitor for Raw UID2 Refresh](#5-monitor-for-raw-uid2-refresh). | +| 1-b | [POST /identity/map](../endpoints/post-identity-map.md) response | The raw UID2 (`u` field) returned in the response can be used to target audiences on relevant DSPs.
The response returns a user's raw UID2 (`u`), refresh timestamp (`r`), and optionally the previous raw UID2 (`p`) if the current UID2 was rotated within the last 90 days. Use the refresh timestamp to determine when to refresh the UID2. For details, see [5: Monitor for raw UID2 refresh](#5-monitor-for-raw-uid2-refresh). | -### 2: Store Raw UID2s and Refresh Timestamps +### 2: Store raw UID2s and refresh timestamps -The response from Step 1, [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii), contains mapping information. We recommend that you store the following information returned in Step 1: +The response from Step 1, [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii), contains mapping information. We recommend that you store the following information returned in Step 1: - Cache the mapping between DII and raw UID2 (`u` field). - Store the refresh timestamp (`r` field) to know when the raw UID2 could refresh. - Optionally store the previous raw UID2 (`p` field) if provided for users whose UID2 was refreshed within the last 90 days. -### 3: Manipulate or Combine Raw UID2s +### 3: Manipulate or combine raw UID2s Use the UID2s you received in Step 1. For example, you might do one or more of the following: - Do some manipulation: for example, combine raw UID2s you generated from DII and raw UID2s received from another participant such as an advertiser or data provider. - Add new raw UID2s into an existing audience. -### 4: Send Stored Raw UID2s to DSPs to Create Audiences or Conversions +### 4: Send stored raw UID2s to DSPs to create audiences or conversions Use the raw UID2s for some purpose such as: @@ -96,7 +96,7 @@ For example, you could send the ( -### Store Raw UID2s and Salt Bucket IDs (v2) +### Store raw UID2s and salt bucket ids (v2) :::note This step replaces Step 2 in the v3 implementation. @@ -166,7 +166,7 @@ The response from Step 1 contains mapping information. We recommend that you sto - Cache the mapping between DII (`identifier`), raw UID2 (`advertising_id`), and salt bucket (`bucket_id`). - Store the timestamp for when you received the response data. Later, you can compare this timestamp with the `last_updated` timestamp returned in Step 5. -### Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2) +### Monitor for salt bucket rotations for your stored raw UID2s (v2) :::note This step replaces Step 5 in the v3 implementation. @@ -197,4 +197,4 @@ To determine whether the salt bucket ID for a specific raw UID2 has changed, fol - The timestamp of the raw UID2 generation of the same `bucket_id`, which was returned in Step 1 and stored in Step 2. -1. If the `last_updated` timestamp is more recent than the timestamp you recorded earlier, the salt bucket has been rotated. As a result, you'll need to regenerate any raw UID2s associated with this `bucket_id`, following Step 1, [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii). +1. If the `last_updated` timestamp is more recent than the timestamp you recorded earlier, the salt bucket has been rotated. As a result, you'll need to regenerate any raw UID2s associated with this `bucket_id`, following Step 1, [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii). diff --git a/docs/guides/integration-advertiser-dataprovider-overview.md b/docs/guides/integration-advertiser-dataprovider-overview.md index 92d7c9584..381f7e472 100644 --- a/docs/guides/integration-advertiser-dataprovider-overview.md +++ b/docs/guides/integration-advertiser-dataprovider-overview.md @@ -10,11 +10,11 @@ displayed_sidebar: sidebarAdvertisers import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Advertiser/Data Provider Integration Overview +# Advertiser/data provider integration overview This guide provides an overview of integration options for organizations that collect user data and push it to other UID2 participants. Data collectors include advertisers, data on-boarders, measurement providers, identity graph providers, third-party data providers, and any other organizations that send data to other participants. -## Advertiser/Data Provider Routes to Use UID2 +## Advertiser/data provider routes to use UID2 Within the ad tech industry, advertisers use identity to build audiences, track conversions, and generate their graphs. As an advertiser, or as a data provider acting on behalf of an advertiser, the following table shows some examples of how you can accomplish some of these goals with UID2. @@ -28,44 +28,44 @@ There are other ways that you can use UID2, outside these use cases. These are j | Send in conversions | Send raw UID2s as conversion information | Use conversion information for measurement (attribution) or for retargeting via API or pixels. | | Receive graph data | Receive raw UID2s from graph/data providers via API or pixels | Build graph data. | -## Preparing DII for Processing +## Preparing DII for processing -## High-Level Steps +## High-level steps At a high level, the steps for advertisers and data providers integrating with UID2 are as follows: -1. [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) +1. [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) -2. [Store Raw UID2s and Refresh Timestamps](#2-store-raw-uid2s-and-refresh-timestamps) +2. [Store raw UID2s and refresh timestamps](#2-store-raw-uid2s-and-refresh-timestamps) -3. [Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s) +3. [Manipulate or combine raw UID2s](#3-manipulate-or-combine-raw-uid2s) -4. [Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) +4. [Send stored raw UID2s to DSPs to create audiences or conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) -5. [Monitor for Raw UID2 Refresh](#5-monitor-for-raw-uid2-refresh) +5. [Monitor for raw UID2 refresh](#5-monitor-for-raw-uid2-refresh) -6. [Monitor for Opt-Out Status](#6-monitor-for-opt-out-status) +6. [Monitor for opt-out status](#6-monitor-for-opt-out-status) :::note -If your implementation uses a version of the [POST /identity/map](../endpoints/post-identity-map.md) endpoint earlier than version 3, see [Using POST /identity/map Version 2](#using-post-identitymap-version-2). If you're using this version, we recommend you upgrade as soon as possible to take advantage of the enhancements. +If your implementation uses a version of the [POST /identity/map](../endpoints/post-identity-map.md) endpoint earlier than version 3, see [Using POST /identity/map version 2](#using-post-identitymap-version-2). If you're using this version, we recommend you upgrade as soon as possible to take advantage of the enhancements. ::: -## Summary of Implementation Options +## Summary of implementation options 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 | | --- | --- | -| [1: Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) | Use any of the following options to map DII to raw UID2s:
  • One of these UID2 SDKs:
    • Python SDK: [Map DII to Raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s)
    • Java SDK: [Usage for Advertisers/Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers)
  • Snowflake: [Map DII](integration-snowflake.md#map-dii)
  • Databricks: [Map DII](integration-databricks.md#map-dii)
  • AWS Entity Resolution: [AWS Entity Resolution Integration Guide](integration-aws-entity-resolution.md)
  • HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md)
| -| [2: Store Raw UID2s and Refresh Timestamps](#2-store-raw-uid2s-and-refresh-timestamps) | Custom (your choice). | -| [3: Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s) | Custom (your choice). | -| [4: Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) | Custom (your choice). | -| [5: Monitor for Raw UID2 Refresh](#5-monitor-for-raw-uid2-refresh) | Use the refresh timestamp (`r` field) returned from the [POST /identity/map](../endpoints/post-identity-map.md) endpoint to determine when to refresh Raw UID2s. | -| [6: Monitor for Opt-Out Status](#6-monitor-for-opt-out-status) | API call to the [POST /optout/status](../endpoints/post-optout-status.md) endpoint. | +| [1: Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) | Use any of the following options to map DII to raw UID2s:
  • One of these UID2 SDKs:
    • Python SDK: [Map DII to raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s)
    • Java SDK: [Usage for advertisers/data providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers)
  • Snowflake: [Map DII](integration-snowflake.md#map-dii)
  • Databricks: [Map DII](integration-databricks.md#map-dii)
  • AWS Entity Resolution: [AWS Entity Resolution integration guide](integration-aws-entity-resolution.md)
  • HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md)
| +| [2: Store raw UID2s and refresh timestamps](#2-store-raw-uid2s-and-refresh-timestamps) | Custom (your choice). | +| [3: Manipulate or combine raw UID2s](#3-manipulate-or-combine-raw-uid2s) | Custom (your choice). | +| [4: Send stored raw UID2s to DSPs to create audiences or conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) | Custom (your choice). | +| [5: Monitor for raw UID2 refresh](#5-monitor-for-raw-uid2-refresh) | Use the refresh timestamp (`r` field) returned from the [POST /identity/map](../endpoints/post-identity-map.md) endpoint to determine when to refresh Raw UID2s. | +| [6: Monitor for opt-out status](#6-monitor-for-opt-out-status) | API call to the [POST /optout/status](../endpoints/post-optout-status.md) endpoint. | -## Integration Diagram +## Integration diagram The following diagram outlines the steps that data collectors must complete to map DII to raw UID2s for audience building and targeting. @@ -73,13 +73,13 @@ DII refers to a user's normalized email address or phone number, or the normaliz To keep your UID2-based audience information accurate and up to date, follow these integration steps every day. -![Advertiser Flow](images/advertiser-flow-overview-mermaid-v3.png) +![Advertiser flow](images/advertiser-flow-overview-mermaid-v3.png) For details about the different parts of the diagram, refer to the following sections. -### 1: Generate Raw UID2s from DII +### 1: Generate raw UID2s from DII You can generate raw UID2s from directly identifying information (DII), or receive UID2s from another UID2 participant such as a data provider acting on your behalf. @@ -87,33 +87,33 @@ To generate raw UID2s, use one of the following options: - One of the UID2 SDKs: - - Python SDK: See [Map DII to Raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s). - - Java SDK: See [Usage for Advertisers/Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers). + - Python SDK: See [Map DII to raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s). + - Java SDK: See [Usage for advertisers/data providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers). - Snowflake: See [Map DII](integration-snowflake.md#map-dii). - Databricks: See [Map DII](integration-databricks.md#map-dii). -- AWS Entity Resolution: See [AWS Entity Resolution Integration Guide](integration-aws-entity-resolution.md). +- AWS Entity Resolution: See [AWS Entity Resolution integration guide](integration-aws-entity-resolution.md). -- HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md). For details, see [Generate Raw UID2s from DII](integration-advertiser-dataprovider-endpoints.md#1-generate-raw-uid2s-from-dii). +- HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md). For details, see [Generate raw UID2s from DII](integration-advertiser-dataprovider-endpoints.md#1-generate-raw-uid2s-from-dii). -### 2: Store Raw UID2s and Refresh Timestamps +### 2: Store raw UID2s and refresh timestamps -The response from Step 1, [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii), contains mapping information. We recommend that you store the following information returned in Step 1: +The response from Step 1, [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii), contains mapping information. We recommend that you store the following information returned in Step 1: - Cache the mapping between DII and raw UID2 (`u` field). - Store the refresh timestamp (`r` field) to know when the raw UID2 could refresh. - Optionally store the previous raw UID2 (`p` field) if provided for users whose UID2 was refreshed within the last 90 days. -### 3: Manipulate or Combine Raw UID2s +### 3: Manipulate or combine raw UID2s Use the raw UID2s you received in Step 1. For example, you might do one or more of the following: - Do some manipulation: for example, combine raw UID2s you generated from DII and raw UID2s received from another participant such as an advertiser or data provider. - Add new raw UID2s into an existing audience. -### 4: Send Stored Raw UID2s to DSPs to Create Audiences or Conversions +### 4: Send stored raw UID2s to DSPs to create audiences or conversions Use the raw UID2s for some purpose such as: @@ -124,7 +124,7 @@ For example, you could send the ( -### Store Raw UID2s and Salt Bucket IDs (v2) +### Store raw UID2s and salt bucket ids (v2) :::note This step replaces Step 2 in the v3 implementation. @@ -184,7 +184,7 @@ The response from Step 1 contains mapping information. We recommend that you sto - Cache the mapping between DII (`identifier`), raw UID2 (`advertising_id`), and salt bucket (`bucket_id`). - Store the timestamp for when you received the response data. Later, you can compare this timestamp with the `last_updated` timestamp returned in Step 5. -### Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2) +### Monitor for salt bucket rotations for your stored raw UID2s (v2) :::note This step replaces Step 5 in the v3 implementation. @@ -198,11 +198,11 @@ If the salt bucket has been rotated, regenerate the raw UID2. For details, see [ For instructions for monitoring for salt bucket rotations, refer to one of the following: -- Python SDK: [Monitor Rotated Salt Buckets](../sdks/sdk-ref-python.md#monitor-rotated-salt-buckets). +- Python SDK: [Monitor rotated salt buckets](../sdks/sdk-ref-python.md#monitor-rotated-salt-buckets). -- Snowflake: [Monitor for Salt Bucket Rotation and Regenerate Raw UID2s](integration-snowflake-previous#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s). +- Snowflake: [Monitor for salt bucket rotation and regenerate raw UID2s](integration-snowflake-previous#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s). -- HTTP endpoints: [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)](integration-advertiser-dataprovider-endpoints.md#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2). +- HTTP endpoints: [Monitor for salt bucket rotations for your stored raw UID2s (v2)](integration-advertiser-dataprovider-endpoints.md#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2). @@ -220,8 +220,8 @@ To determine whether the salt bucket ID for a specific raw UID2 has changed, fol - The timestamp of the raw UID2 generation of the same `bucket_id`, which was returned in Step 1 and stored in Step 2. -1. If the `last_updated` timestamp is more recent than the timestamp you recorded earlier, the salt bucket has been rotated. As a result, you'll need to regenerate any raw UID2s associated with this `bucket_id`, following Step 1, [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii). +1. If the `last_updated` timestamp is more recent than the timestamp you recorded earlier, the salt bucket has been rotated. As a result, you'll need to regenerate any raw UID2s associated with this `bucket_id`, following Step 1, [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii). ## FAQs -For a list of frequently asked questions for advertisers and data providers using the UID2 framework, see [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). +For a list of frequently asked questions for advertisers and data providers using the UID2 framework, see [FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). diff --git a/docs/guides/integration-aws-entity-resolution.md b/docs/guides/integration-aws-entity-resolution.md index 51572507c..d6d7b2e40 100644 --- a/docs/guides/integration-aws-entity-resolution.md +++ b/docs/guides/integration-aws-entity-resolution.md @@ -11,7 +11,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# AWS Entity Resolution Integration Guide +# AWS Entity Resolution integration guide [AWS Entity Resolution](https://aws.amazon.com/entity-resolution/) is an identity resolution product from Amazon Web Services that allows AWS customers to integrate with the UID2 framework. Through the integration, you can securely and seamlessly generate UID2s for your data without making direct calls to the UID2 operator or handling sensitive client ID and secret key values. @@ -24,7 +24,7 @@ If you're not currently part of the UID2 ecosystem, go to the [Request Access to For a video presentation about integration with UID2 by using AWS Entity Resolution, and a demo, see [Getting Started with AWS Entity Resolution Integration with Unified ID 2.0](https://www.youtube.com/watch?v=ORbSsKMgVj8) on YouTube. :::tip -For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md). +For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md). ::: ## Functionality @@ -35,22 +35,22 @@ The following table summarizes the functionality available with the AWS Entity R | :--- | :--- | :--- | :--- | :--- | | No | No | No | No | Yes | -## Integration Summary +## Integration summary The following table summarizes the steps to integrate with UID2 using AWS Entity Resolution. | Step/Link | Details | | --- | --- | -| [Initial Setup Steps](#initial-setup-steps) | Create UID2 account, create AWS account, and link them:
  • [Create UID2 Account](#create-uid2-account)
  • [Create AWS Account](#create-aws-account)
  • [Subscribe to UID2 on AWS Data Exchange](#subscribe-to-uid2-on-aws-data-exchange)
| -| [Configure AWS Account](#configure-aws-account) | Set up IAM users, data tables, and schema mapping for your data. | -| [Create a Matching Workflow](#create-a-matching-workflow) | Create the workflow for matching your data, including input location, the matching technique to be applied, and output location. | -| [Run the Matching Workflow](#run-the-matching-workflow) | Process the input data to create raw UID2s. | +| [Initial setup steps](#initial-setup-steps) | Create UID2 account, create AWS account, and link them:
  • [Create UID2 account](#create-uid2-account)
  • [Create AWS account](#create-aws-account)
  • [Subscribe to UID2 on AWS data exchange](#subscribe-to-uid2-on-aws-data-exchange)
| +| [Configure AWS account](#configure-aws-account) | Set up IAM users, data tables, and schema mapping for your data. | +| [Create a matching workflow](#create-a-matching-workflow) | Create the workflow for matching your data, including input location, the matching technique to be applied, and output location. | +| [Run the matching workflow](#run-the-matching-workflow) | Process the input data to create raw UID2s. | -## Workflow Diagram +## Workflow diagram The following diagram illustrates the end-to-end UID2 process, from signing up for the service, through the configuration steps, to receiving the raw UID2s. -![AWS Entity Resolution Workflow](images/integration-aws-entity-resolution.png) +![AWS Entity Resolution workflow](images/integration-aws-entity-resolution.png) The following table shows the sequence of steps shown in the diagram. @@ -74,44 +74,44 @@ The following table shows the sequence of steps shown in the diagram. | 16 | Amazon Data Exchange | Returns raw UID2s to AWS Entity Resolution. | | 17 | AWS Entity Resolution | Writes the output records to the S3 bucket including the raw UID2s. | -## Preparing DII for Processing +## Preparing DII for processing -## Initial Setup Steps +## Initial setup steps The following are the initial steps for setting up your UID2 integration in AWS Entity Resolution: -- [Create AWS Account](#create-aws-account) -- [Create UID2 Account](#create-uid2-account) -- [Subscribe to UID2 on AWS Data Exchange](#subscribe-to-uid2-on-aws-data-exchange) +- [Create AWS account](#create-aws-account) +- [Create UID2 account](#create-uid2-account) +- [Subscribe to UID2 on AWS data exchange](#subscribe-to-uid2-on-aws-data-exchange) -### Create AWS Account +### Create AWS account Sign up for an AWS account, or use an existing one. For details, see [Getting started: Are you a first-time AWS user?](https://docs.aws.amazon.com/accounts/latest/reference/welcome-first-time-user.html) in the AWS documentation. -### Create UID2 Account +### Create UID2 account -Ask your UID2 contact to register you as a UID2 participant. If you're not sure who to ask, see [Contact Info](../getting-started/gs-account-setup.md#contact-info). +Ask your UID2 contact to register you as a UID2 participant. If you're not sure who to ask, see [Contact info](../getting-started/gs-account-setup.md#contact-info). Send your UID2 contact the AWS account ID that you'll use for your UID2 integration on Entity Resolution. -### Subscribe to UID2 on AWS Data Exchange +### Subscribe to UID2 on AWS data exchange Visit the [Unified ID 2.0 Identity Resolution](https://aws.amazon.com/marketplace/pp/prodview-66zqls7iqsm6o?sr=0-4&ref_=beagle&applicationId=AWSMPContessa#offers) page on the AWS Data Exchange and click **Continue to Subscribe.** -![AWS Data Exchange market place screenshot](images/integration-aws-entity-resolution-public-listing.png) +![AWS data exchange market place screenshot](images/integration-aws-entity-resolution-public-listing.png) On receipt of your subscription request, the UID2 team does the following: - Reviews your subscription request. -- Matches your request with the AWS account ID that you sent in [Create UID2 Account](#create-uid2-account). +- Matches your request with the AWS account ID that you sent in [Create UID2 account](#create-uid2-account). - Approves the request. -## Configure AWS Account +## Configure AWS account -UID2 participants store their data in AWS, in an S3 bucket, and integrate with AWS Entity Resolution. The basic steps, once you've created the AWS account (see [Create AWS Account](#create-aws-account)) are as follows. +UID2 participants store their data in AWS, in an S3 bucket, and integrate with AWS Entity Resolution. The basic steps, once you've created the AWS account (see [Create AWS account](#create-aws-account)) are as follows. :::note For detailed instructions, see [Setting up AWS Entity Resolution](https://docs.aws.amazon.com/entityresolution/latest/userguide/setting-up.html) in the AWS documentation. @@ -133,7 +133,7 @@ For detailed instructions, see [Setting up AWS Entity Resolution](https://docs.a 5. Create schema mapping for the data: see [Creating a schema mapping](https://docs.aws.amazon.com/entityresolution/latest/userguide/create-schema-mapping.html) in the AWS documentation. -## Create a Matching Workflow +## Create a matching workflow When your initial account creation and setup are done, the next step is to create a matching workflow for your data. @@ -184,7 +184,7 @@ To create the matching workflow, first sign in to the AWS Management console, op - Then, under **Partner services**, choose **Unified ID2.0**. - Click **Next**. - If you completed the earlier step, see [Subscribe to UID2 on AWS Data Exchange](#subscribe-to-uid2-on-aws-data-exchange), you'll see an **Approved** message. + If you completed the earlier step, see [Subscribe to UID2 on AWS data exchange](#subscribe-to-uid2-on-aws-data-exchange), you'll see an **Approved** message. 3. Define the data output: - For **Data Output Destination**, specify the URI of the S3 bucket that you want to use for your output data. Select the data format: Normalized or Original. @@ -204,7 +204,7 @@ To create the matching workflow, first sign in to the AWS Management console, op The matching workflow is created, and you'll see a confirmation message. -## Run the Matching Workflow +## Run the matching workflow Follow these steps to run the matching workflow and view the results. diff --git a/docs/guides/integration-ctv-guide.md b/docs/guides/integration-ctv-guide.md index b125bdea3..6195c5130 100644 --- a/docs/guides/integration-ctv-guide.md +++ b/docs/guides/integration-ctv-guide.md @@ -13,64 +13,64 @@ import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; import SnptPrivateOperatorOption from '../snippets/_snpt-private-operator-option.mdx'; -# CTV Integration Guide +# CTV integration guide If you're a Connected TV (CTV) publisher, there are several ways that you can integrate with UID2 to generate and refresh identity tokens to be passed into the RTB bidstream in the context of your CTV apps. -## Key Integration Steps +## Key integration steps At a high level, to integrate with UID2, you'll implement these three key steps: 1. Generate the UID2 token. 1. Refresh or regenerate the UID2 token frequently to ensure the token stays current. - For details, see [Keeping the Token Current](../ref-info/ref-tokens.md#keeping-the-token-current) and [Recommended Token Refresh Frequency](../ref-info/ref-tokens.md#recommended-token-refresh-frequency). + For details, see [Keeping the token current](../ref-info/ref-tokens.md#keeping-the-token-current) and [Recommended token refresh frequency](../ref-info/ref-tokens.md#recommended-token-refresh-frequency). 1. Pass the UID2 token into the bidstream. -To determine how you'll implement these steps, choose from the [CTV Integration Options](#ctv-integration-options). +To determine how you'll implement these steps, choose from the [CTV integration options](#ctv-integration-options). -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Private Operator Option +## Private Operator option -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). The specific values you set up will depend on which of the [CTV integration options](#ctv-integration-options) you choose: -- For a client-server or server-side implementation, you'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page: +- For a client-server or server-side implementation, you'll need to set up these values, in the UID2 Portal on the [API keys](../portal/api-keys.md) page: - API key, also called a client key - Client secret, a value known only to the participant and the UID2 service :::important - It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). + It's very important that you keep these values secure. For details, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). ::: -- For a client-side implementation, you'll need to set up these values, in the UID2 Portal on the [Client-Side Integration](../portal/client-side-integration.md) page: - - Subscription ID and Public Key: See [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) - - A list of **domain names** for any sites on which you'll be using this SDK: See [Adding and Managing Root-Level Domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) - - Mobile App IDs (any that apply): See [Adding and Managing Mobile App IDs](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) +- For a client-side implementation, you'll need to set up these values, in the UID2 Portal on the [Client-side integration](../portal/client-side-integration.md) page: + - Subscription ID and Public Key: See [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) + - A list of **domain names** for any sites on which you'll be using this SDK: See [Adding and managing root-level domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) + - Mobile App IDs (any that apply): See [Adding and managing mobile app ids](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) -## CTV Integration Options +## CTV integration options You can decide on the integration option that's best for you based on where you want to generate and refresh the UID2 token. There are three options, as shown in the following table. | Option | Details | | :--- | :--- | -| [Client-Side Integration](#client-side-integration-for-ctv-apps) | The token is generated and refreshed on the client side. | -| [Server-Side Integration](#server-side-integration-for-ctv-apps) | The token is generated and refreshed on the server side. | -| [Client-Server Integration](#client-server-integration-for-ctv-apps) | The token is generated on the server side and refreshed on the client side. | +| [Client-side integration](#client-side-integration-for-ctv-apps) | The token is generated and refreshed on the client side. | +| [Server-side integration](#server-side-integration-for-ctv-apps) | The token is generated and refreshed on the server side. | +| [Client-server integration](#client-server-integration-for-ctv-apps) | The token is generated on the server side and refreshed on the client side. | -### Client-Side Integration for CTV Apps +### Client-side integration for CTV apps The client-side option is for publishers who want to manage the UID2 token entirely on the client side: @@ -79,16 +79,16 @@ The client-side option is for publishers who want to manage the UID2 token entir This setup requires that all code changes are done within the CTV app. -To implement using this approach, follow the instructions in the [UID2 Client-Side Integration Guide for Mobile](integration-mobile-client-side.md). +To implement using this approach, follow the instructions in the [UID2 client-side integration guide for mobile](integration-mobile-client-side.md). The following table shows supported operating systems, with links to applicable documentation resources. | Operating System | Integration Guide | Link to SDK Guide | | :--- | :--- | :--- | -| [Apple tvOS](https://developer.apple.com/tvos/) | [UID2 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/) | [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md) | [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) | +| [Apple tvOS](https://developer.apple.com/tvos/) | [UID2 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/) | [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side.md) | [SDK for Android reference guide](../sdks/sdk-ref-android.md) | -### Server-Side Integration for CTV Apps +### Server-side integration for CTV apps The server-side option is for publishers who want to manage the UID2 token entirely on the server side: @@ -99,30 +99,30 @@ This setup requires that most of the code changes are done on the server side, w Another advantage of this approach is that if you're dealing with multiple platforms (Web / CTV / mobile), doing everything on the server side can reduce platform-specific efforts. -To implement using this approach, follow the instructions in [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md). +To implement using this approach, follow the instructions in [Publisher integration guide, server-side](integration-publisher-server-side.md). If your server-side code is in Java or Python, you can use one of the UID2 SDKs to make the HTTP requests to UID2, instead of writing your own source code. For details, refer to one of the following SDK guides: -- [SDK for Java Reference Guide: Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers) -- [SDK for Python Reference Guide: Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers) +- [SDK for Java reference guide: Usage for publishers](../sdks/sdk-ref-java.md#usage-for-publishers) +- [SDK for Python reference guide: Usage for publishers](../sdks/sdk-ref-python.md#usage-for-publishers) -### Client-Server Integration for CTV Apps +### Client-server integration for CTV apps This option is for publishers who want to manage the UID2 tokens with a client-server approach: - The token is generated on the server side. - The token is refreshed as needed on the client side, from within the CTV app. -To implement using this approach, follow the instructions in the [UID2 Client-Server Integration Guide for Mobile](integration-mobile-client-server.md). +To implement using this approach, follow the instructions in the [UID2 client-server integration guide for mobile](integration-mobile-client-server.md). The following table shows supported operating systems, with links to applicable documentation resources. | Operating System | Integration Guide | Link to SDK Guide | | :--- | :--- | :--- | -| [Apple tvOS](https://developer.apple.com/tvos/) | [UID2 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/) | [UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md) | [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) | +| [Apple tvOS](https://developer.apple.com/tvos/) | [UID2 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/) | [UID2 client-server integration guide for mobile](../guides/integration-mobile-client-server.md) | [SDK for Android reference guide](../sdks/sdk-ref-android.md) | -## Best Practices +## Best practices The following points are best practices for CTV integrations: diff --git a/docs/guides/integration-databricks.md b/docs/guides/integration-databricks.md index 30c90c86b..e93c3948b 100644 --- a/docs/guides/integration-databricks.md +++ b/docs/guides/integration-databricks.md @@ -11,18 +11,18 @@ 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. -## Integration Overview +## Integration overview This solution enables you to securely share consumer identifier data without exposing sensitive directly identifying information (DII), by processing your data in an instance of the [Databricks Clean Rooms](https://docs.databricks.com/aws/en/clean-rooms/) feature. This feature provides a secure and privacy-protecting environment for working on sensitive data. When you've set up the Databricks Clean Rooms environment, you establish a trust relationship with the UID2 service and allow the service to convert your data, which you share in the clean room, to raw UID2s. @@ -35,7 +35,7 @@ The following table summarizes the functionality available with the UID2 Databri | :--- | :--- | :--- | :--- | :--- | | — | — | — | — | ✅ | -## Key Benefits +## Key benefits Here are some key benefits of integrating with Databricks for your UID2 processing: @@ -45,30 +45,30 @@ Here are some key benefits of integrating with Databricks for your UID2 processi - Streamlined integration between UID2 identifiers and The Trade Desk activation ecosystem. - Self-service support for marketers and advertisers through Databricks. -## Preparing DII for Processing +## Preparing DII for processing -## Integration Steps +## Integration steps At a high level, the following are the steps to set up your Databricks integration and process your data: 1. [Create a clean room for UID2 collaboration](#create-clean-room-for-uid2-collaboration). -1. [Send your Databricks sharing identifier to your UID2 contact](#send-sharing-identifier-to-uid2-contact). +1. [Send your databricks sharing identifier to your UID2 contact](#send-sharing-identifier-to-uid2-contact). 1. [Add data to the clean room](#add-data-to-the-clean-room). 1. [Map DII](#map-dii) by running the clean room notebook. -### Create Clean Room for UID2 Collaboration +### Create clean room for UID2 collaboration As a starting point, create a Databricks Clean Rooms environment—a secure environment for you to collaborate with UID2 to process your data. -Follow the steps in [Create clean rooms](https://docs.databricks.com/aws/en/clean-rooms/create-clean-room) in the Databricks documentation. Use the correct sharing identifier based on the [UID2 environment](../getting-started/gs-environments) you want to connect to: see [UID2 Sharing Identifiers](#uid2-sharing-identifiers). +Follow the steps in [Create clean rooms](https://docs.databricks.com/aws/en/clean-rooms/create-clean-room) in the Databricks documentation. Use the correct sharing identifier based on the [UID2 environment](../getting-started/gs-environments) you want to connect to: see [UID2 sharing identifiers](#uid2-sharing-identifiers). :::important After you've created a clean room, you cannot change its collaborators. If you have the option to set clean room collaborator aliases—for example, if you’re using the Databricks Python SDK to create the clean room—your collaborator alias must be `creator` and the UID2 collaborator alias must be `collaborator`. If you’re creating the clean room using the Databricks web UI, the correct collaborator aliases are set for you. ::: -### Send Sharing Identifier to UID2 Contact +### Send sharing identifier to UID2 contact Before you can use the clean room notebook, you'll need to send your Databricks sharing identifier to your UID2 contact. @@ -78,30 +78,30 @@ Follow these steps: 1. Find the sharing identifier for the Unity Catalog metastore that is attached to the Databricks workspace where you’ll work with the clean room. - For information on how to find this value, see [Finding a Sharing Identifier](#finding-a-sharing-identifier). + For information on how to find this value, see [Finding a sharing identifier](#finding-a-sharing-identifier). 1. Send the sharing identifier to your UID2 contact. -### Add Data to the Clean Room +### Add data to the clean room -Add one or more tables or views to the clean room. You can use any names for the schema, tables, and views. Tables and views must follow the schema detailed in [Input Table](#input-table ). +Add one or more tables or views to the clean room. You can use any names for the schema, tables, and views. Tables and views must follow the schema detailed in [Input table](#input-table ). ### Map DII Run the `identity_map_v3` Databricks Clean Rooms [notebook](https://docs.databricks.com/aws/en/notebooks/) to map email addresses, phone numbers, or their respective hashes to raw UID2s. -A successful notebook run results in raw UID2s populated in the output table. For details, see [Output Table](#output-table). +A successful notebook run results in raw UID2s populated in the output table. For details, see [Output table](#output-table). -## Running the Clean Rooms Notebook +## Running the clean rooms notebook This section provides details to help you use your Databricks Clean Rooms environment to process your DII into raw UID2s, including the following: -- [Notebook Parameters](#notebook-parameters) -- [Input Table](#input-table) -- [DII Format and Normalization](#dii-format-and-normalization) -- [Output Table](#output-table) -- [Output Table Schema](#output-table-schema) +- [Notebook parameters](#notebook-parameters) +- [Input table](#input-table) +- [DII format and normalization](#dii-format-and-normalization) +- [Output table](#output-table) +- [Output table schema](#output-table-schema) -### Notebook Parameters +### Notebook parameters You can use the `identity_map_v3` notebook to map DII in any table or view that you've added to the `creator` catalog of the clean room. @@ -114,7 +114,7 @@ For example, to map DII in the clean room table named `creator.default.emails`, | `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. | -### Input Table +### Input table 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. @@ -123,20 +123,20 @@ The input table or view must have the two columns shown in the following table. | `INPUT` | string | The DII to map. | | `INPUT_TYPE` | string | The type of DII to map. Allowed values: `email`, `email_hash`, `phone`, and `phone_hash`. | -### DII Format and Normalization +### DII format and normalization The normalization requirements depend on the type of DII you're processing, as follows: -- **Email address**: The notebook automatically normalizes the data using the UID2 [Email Address Normalization](../getting-started/gs-normalization-encoding#email-address-normalization) rules. -- **Phone number**: You must normalize the phone number before mapping it with the notebook, using the UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding#phone-number-normalization) rules. +- **Email address**: The notebook automatically normalizes the data using the UID2 [Email address normalization](../getting-started/gs-normalization-encoding#email-address-normalization) rules. +- **Phone number**: You must normalize the phone number before mapping it with the notebook, using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding#phone-number-normalization) rules. -### Output Table +### Output table If the clean room has an output catalog, the mapped DII is written to a table in the output catalog. Output tables are stored for 30 days. For details, see [Overview of output tables](https://docs.databricks.com/aws/en/clean-rooms/output-tables#overview-of-output-tables) in the Databricks documentation. -### Output Table Schema +### Output table schema The following table provides information about the structure of the output data, including field names and values. @@ -145,13 +145,13 @@ The following table provides information about the structure of the output data, | `UID` | string | The value is one of the following:
  • **DII was successfully mapped**: The UID2 associated with the DII.
  • **Otherwise**: `NULL`.
| | `PREV_UID` | string | The value is one of the following:
  • **DII was successfully mapped and the current raw UID2 was rotated in the last 90 days**: the previous raw UID2.
  • **Otherwise**: `NULL`.
| | `REFRESH_FROM` | timestamp | The value is one of the following:
  • **DII was successfully mapped**: The timestamp indicating when this UID2 should be refreshed.
  • **Otherwise**: `NULL`.
| -| `UNMAPPED` | string | The value is one of the following:
  • **DII was successfully mapped**: `NULL`.
  • **Otherwise**: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.
    For details, see [Values for the UNMAPPED Column](#values-for-the-unmapped-column).
| +| `UNMAPPED` | string | The value is one of the following:
  • **DII was successfully mapped**: `NULL`.
  • **Otherwise**: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.
    For details, see [Values for the unmapped column](#values-for-the-unmapped-column).
| :::note The raw UID2 does not change before the refresh timestamp. After the refresh timestamp, remapping the DII returns a new refresh timestamp, but the raw UID2 might or might not change. It is possible for the raw UID2 to remain unchanged for multiple refresh intervals. ::: -#### Values for the UNMAPPED Column +#### Values for the unmapped column The following table shows possible values for the `UNMAPPED` column in the output table schema. @@ -162,7 +162,7 @@ The following table shows possible values for the `UNMAPPED` column in the outpu | `INVALID IDENTIFIER` | The email address or phone number is invalid. | | `INVALID INPUT TYPE` | The value of `INPUT_TYPE` is invalid. Valid values for `INPUT_TYPE` are: `email`, `email_hash`, `phone`, `phone_hash`. | -## Testing in the Integ Environment +## Testing in the integ environment If you'd like to test the Databricks Clean Rooms implementation before signing a UID2 POC, you can ask your UID2 contact for access in the integ (integration) environment. This environment is for testing only, and has no production data. @@ -172,7 +172,7 @@ While you're waiting to hear back, you can complete the following actions: - Create the clean room, using the UID2 sharing identifier for the integration environment. - Put your assets into the clean room. -For details, see [Integration Steps](#integration-steps). +For details, see [Integration steps](#integration-steps). When your access is ready, your UID2 contact notifies you. @@ -180,10 +180,10 @@ When your access is ready, your UID2 contact notifies you. This section includes the following reference information: -- [UID2 Sharing Identifiers](#uid2-sharing-identifiers) -- [Finding a Sharing Identifier](#finding-a-sharing-identifier) +- [UID2 sharing identifiers](#uid2-sharing-identifiers) +- [Finding a sharing identifier](#finding-a-sharing-identifier) -### UID2 Sharing Identifiers +### UID2 sharing identifiers UID2 sharing identifiers can change. Before creating a new clean room, check this section to make sure you have the latest sharing identifier. @@ -192,7 +192,7 @@ UID2 sharing identifiers can change. Before creating a new clean room, check thi | 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` | -### Finding a Sharing Identifier +### Finding a sharing identifier To find the sharing identifier for your UID2 contact, follow these steps: diff --git a/docs/guides/integration-dsp-no-sdk.md b/docs/guides/integration-dsp-no-sdk.md index e1a0e83e2..0ec51d831 100644 --- a/docs/guides/integration-dsp-no-sdk.md +++ b/docs/guides/integration-dsp-no-sdk.md @@ -9,7 +9,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# DSP Direct Integration Instructions +# DSP direct integration instructions This document provides instructions for DSPs who want to integrate with UID2 but who are using a programming language not supported by an existing UID2 SDK. @@ -27,7 +27,7 @@ An example implementation, in the [UID2 SDK for C# / .NET](https://git This document refers to additional code sections from the C# / .NET SDK as examples. -## Retrieve/Refresh Encryption Keys +## Retrieve/refresh encryption keys To retrieve or refresh the encryption keys, so that you can decrypt UID2 tokens into raw UID2s, you'll need to write code to do the following: @@ -46,15 +46,15 @@ Refresh the keys once at startup, and then periodically (recommended refresh int The UID2 SDK for C# / .NET uses a `Refresh` function. For details, see [BidstreamClient.cs, line 26](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/BidstreamClient.cs#L26). -For an implementation example that shows encrypting the request and decrypting the response, see [Encryption and Decryption Code Examples](../getting-started/gs-encryption-decryption.md#encryption-and-decryption-code-examples). +For an implementation example that shows encrypting the request and decrypting the response, see [Encryption and decryption code examples](../getting-started/gs-encryption-decryption.md#encryption-and-decryption-code-examples). The decrypted API response is in JSON format, and includes `site_data`, the list of domains or app names that are allowed for the site. To see how all the fields are parsed, refer to the UID2 SDK for C# / .NET parse function: see [KeyParser.cs, lines 41-74](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/KeyParser.cs#L41-L74). -After decrypting the token into a raw UID2, if the token was generated on the client side, you must use the information in `site_data` to verify that a specific domain or app name is on the list of names allowed for it. For details, see [Verify the Domain or App Name](#for-tokens-generated-on-the-client-side-verify-the-domain-or-app-name). +After decrypting the token into a raw UID2, if the token was generated on the client side, you must use the information in `site_data` to verify that a specific domain or app name is on the list of names allowed for it. For details, see [Verify the domain or app name](#for-tokens-generated-on-the-client-side-verify-the-domain-or-app-name). -## Decrypt UID2 Tokens into Raw UID2s +## Decrypt UID2 tokens into raw UID2s When you have current keys, you'll be able to decrypt a UID2 token into a raw UID2. You also need to check several conditions to make sure that the token is eligible for use in the bidstream. @@ -69,29 +69,29 @@ You'll need to complete the following steps: The UID2 SDK for C# / .NET uses a `DecryptTokenIntoRawUid` function to perform these steps: see [BidstreamClient.cs, line 15](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/BidstreamClient.cs#L15). -### Decrypt the Token +### Decrypt the token Use the master key and site key to decrypt the token. For a code example, refer to the `Decrypt` function: see [UID2Encryption.cs, line 29](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/UID2Encryption.cs#L29). This function decrypts UID2 tokens into raw UID2s as part of the UID2 SDK for C# / .NET. -### Make Sure Token Lifetime and Expiration Are Valid +### Make sure token lifetime and expiration are valid For use in the bidstream, a token must be valid and current. You must do two things: @@ -107,7 +107,7 @@ To make sure that the token lifetime has a valid value, check these two conditio For an example of how this is done, review the code for the `DoesTokenHaveValidLifetimeImpl` function: see [UID2Encryption.cs, line 237](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/UID2Encryption.cs#L237). -#### Calculating Token Lifetime +#### Calculating token lifetime The calculation to make sure that the token lifetime is valid for bidstream use is as follows: @@ -119,7 +119,7 @@ time until token generation = token generated - current time The token includes a **Token Generated** field, which is updated if the token is refreshed, so we use this to calculate the token lifetime. -### For Tokens Generated on the Client Side: Verify the Domain or App Name +### For tokens generated on the client side: Verify the domain or app name For tokens generated on the client side, after decrypting the token, you must verify that the domain name or app name is valid. To do this, make sure the `domainOrAppName` value is included in the `domain_names` list of the site ID, within the `site_data` section of the response from the `/v2/key/bidstream` API endpoint. @@ -127,12 +127,12 @@ For an example of code that does this, refer to the `IsDomainOrAppNameAllowedFor For more information about client-side UID2 integration, refer to one of these integration guides: -- [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) -- [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) -- [UID2 Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) +- [Client-side integration guide for JavaScript](integration-javascript-client-side.md) +- [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) +- [UID2 client-side integration guide for mobile](integration-mobile-client-side.md) -## Honor User Opt-Out After Token Decryption +## Honor user opt-out after token decryption After decrypting the token, you must check the resulting raw UID2 against your opt-out records. If it appears in your opt-out records, you must honor the user's opt-out preference, including by not using the UID2 for bidding. -For more information, refer to [Honor User Opt-Outs](dsp-guide.md#honor-user-opt-outs) in the *DSP Integration Guide*. +For more information, refer to [Honor user opt-outs](dsp-guide.md#honor-user-opt-outs) in the *DSP Integration Guide*. diff --git a/docs/guides/integration-google-ss.md b/docs/guides/integration-google-ss.md index 3fcc4ff1b..88ecc0eff 100644 --- a/docs/guides/integration-google-ss.md +++ b/docs/guides/integration-google-ss.md @@ -12,12 +12,12 @@ import Link from '@docusaurus/Link'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Google Ad Manager Secure Signals Integration Guide +# Google Ad Manager Secure Signals integration guide This guide covers integration steps for publishers using UID2 with the Google Ad Manager secure signals feature (previously known as Encrypted Signals for Publishers, ESP). :::note -To use the UID2 Google Ad Manager secure signals integration, if you are using an SDK you must have your UID2 integration already set up. This does not apply if you are using server-side integration. For a summary of all the integration options available, see [UID2 Integration Guides: Summary](summary-guides.md). +To use the UID2 Google Ad Manager secure signals integration, if you are using an SDK you must have your UID2 integration already set up. This does not apply if you are using server-side integration. For a summary of all the integration options available, see [UID2 integration guides: Summary](summary-guides.md). ::: ## Overview @@ -30,27 +30,27 @@ With this framework, the following steps occur: 2. The secure signals feature caches them on the client side and then transparently passes them to Google Ad Manager. 3. Google Ad Manager uses the UID2 tokens to make bid requests, forwarding the tokens to approved bidders within Google AdX based on the publisher's preferences. -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). The specific values you set up will depend on which of the [publisher integration options](#publisher-integration-options) you choose: -- For a client-server or server-side implementation, you'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page: +- For a client-server or server-side implementation, you'll need to set up these values, in the UID2 Portal on the [API keys](../portal/api-keys.md) page: - API key, also called a client key - Client secret, a value known only to the participant and the UID2 service :::important - It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). + It's very important that you keep these values secure. For details, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). ::: -- For a client-side implementation, you'll need to set up these values, in the UID2 Portal on the [Client-Side Integration](../portal/client-side-integration.md) page: - - Subscription ID and Public Key: See [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) - - A list of **domain names** for any sites on which you'll be using this SDK: See [Adding and Managing Root-Level Domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) - - Mobile App IDs (any that apply): See [Adding and Managing Mobile App IDs](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) +- For a client-side implementation, you'll need to set up these values, in the UID2 Portal on the [Client-side integration](../portal/client-side-integration.md) page: + - Subscription ID and Public Key: See [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) + - A list of **domain names** for any sites on which you'll be using this SDK: See [Adding and managing root-level domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) + - Mobile App IDs (any that apply): See [Adding and managing mobile app ids](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) -## Allow Secure Signals Sharing +## Allow Secure Signals sharing For your Google Ad Manager account to be eligible to receive encrypted UID2 tokens, you must make sure that encrypted signals are properly shared with third-party bidders on your Google Ad Manager account. @@ -83,17 +83,17 @@ If you want to use Secure Signals with Prebid.js, you must complete both these a For details, see [ESP Configurations](https://docs.prebid.org/dev-docs/modules/userId.html#esp-configurations) in the Prebid documentation. -A sample implementation for Prebid.js with Secure Signals is also available. For details, see [Sample Implementations](#sample-implementations). +A sample implementation for Prebid.js with Secure Signals is also available. For details, see [Sample implementations](#sample-implementations). -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Publisher Integration +## Publisher integration When an encrypted signal is cached, the secure signals feature does not execute the handler to generate a new signal. Because of this, it is necessary to clear the cache before and after data capture. @@ -110,14 +110,14 @@ window.googletag.cmd.push(function () { }); ``` -## Publisher Integration Options +## Publisher integration options There are three integration options for Google Secure Signals publisher integration with UID2: -- [Server-Side Integration](#server-side-integration) -- [SDK for JavaScript Client-Server Integration](#sdk-for-javascript-client-server-integration) -- [SDK for JavaScript Client-Side Integration](#sdk-for-javascript-client-side-integration) +- [Server-side integration](#server-side-integration) +- [SDK for JavaScript client-server integration](#sdk-for-javascript-client-server-integration) +- [SDK for JavaScript client-side integration](#sdk-for-javascript-client-side-integration) -### Server-Side Integration +### Server-side integration So that it can share encrypted signals, the hosted auto-loaded secure signals script must be able to make an asynchronous call to the `window.getUid2AdvertisingToken` function and, in response, receive `advertising_token` as a string. @@ -133,31 +133,31 @@ window.getUid2AdvertisingToken = async () => { } ``` -For details, see [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md). +For details, see [Publisher integration guide, server-side](integration-publisher-server-side.md). -A sample implementation is also available for server-side integration. See [Sample Implementations](#sample-implementations). +A sample implementation is also available for server-side integration. See [Sample implementations](#sample-implementations). -### SDK for JavaScript Client-Server Integration +### SDK for JavaScript client-server integration If you're using the SDK for JavaScript version 3.0.0 or later, the UID2 secure signals script uses the `getAdvertisingTokenAsync` function provided in the SDK to get the fresh advertising token, and then pushes the token to Google Ad Manager. This script is hosted on CDN, and GPT automatically loads it with the secure signals feature. -For details, see [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md). +For details, see [Client-server integration guide for JavaScript](integration-javascript-client-server.md). -A sample implementation is also available for integration using the SDK for JavaScript. See [Sample Implementations](#sample-implementations). +A sample implementation is also available for integration using the SDK for JavaScript. See [Sample implementations](#sample-implementations). -### SDK for JavaScript Client-Side Integration +### SDK for JavaScript client-side integration If you're using the SDK for JavaScript version 3.0.0 or later, the UID2 secure signals script uses the `getAdvertisingTokenAsync` function provided in the SDK to get the fresh advertising token, and then pushes the token to Google Ad Manager. This script is hosted on CDN, and GPT automatically loads it with the secure signals feature. -For details, see [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md). +For details, see [Client-side integration guide for JavaScript](integration-javascript-client-side.md). - + -## Sample Implementations +## Sample implementations The following sample implementations are available to illustrate how to integrate with the Google Ad Manager secure signals feature: @@ -191,4 +191,4 @@ In some cases, after choosing Secure Signals within Google Ad Manager, successfu If your UID2s are not being passed through Google, make sure that you chose the correct Web Signal Deployment Method during setup. -For details, see the **Important** note in [Allow Secure Signals Sharing](#allow-secure-signals-sharing). +For details, see the **Important** note in [Allow Secure Signals sharing](#allow-secure-signals-sharing). diff --git a/docs/guides/integration-javascript-client-server.md b/docs/guides/integration-javascript-client-server.md index 580fa28d4..b746ab096 100644 --- a/docs/guides/integration-javascript-client-server.md +++ b/docs/guides/integration-javascript-client-server.md @@ -13,75 +13,75 @@ import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; import SnptExampleClientServerSendUid2ToSdk from '../snippets/_snpt-example-client-server-send-uid2-to-sdk.mdx'; -# Client-Server Integration Guide for JavaScript +# Client-server integration guide for JavaScript This guide is for publishers with web assets who want to generate identity tokens using UID2 for the RTB bidstream, generating UID2 tokens on the server side and passing them to the publishers' web pages, and refreshing the tokens on the client side using the SDK for JavaScript. This is called client-server integration because the JavaScript integration steps are client-side and some other steps are server-side. -If you prefer to integrate with UID2 via **only** client-side JavaScript changes, see [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md). +If you prefer to integrate with UID2 via **only** client-side JavaScript changes, see [Client-side integration guide for JavaScript](integration-javascript-client-side.md). -For technical details about the SDK, see [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md). +For technical details about the SDK, see [SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md). ## Introduction This guide outlines the basic steps that you need to consider if you are building an integration without using an SDK. For example, you need to decide how to implement user authentication and data capture, how to manage UID2 identity information and use it for targeted advertising, and how to refresh tokens, deal with missing identities, and handle user opt-outs. -For a workflow diagram, see [Integration Steps](#integration-steps). See also [FAQs](#faqs). +For a workflow diagram, see [Integration steps](#integration-steps). See also [FAQs](#faqs). -For details about the UID2 opt-out workflow and how users can opt out, see [User Opt-Out](../getting-started/gs-opt-out.md). +For details about the UID2 opt-out workflow and how users can opt out, see [User opt-out](../getting-started/gs-opt-out.md). -To facilitate the process of establishing client identity using UID2 and retrieving advertising tokens, the web integration steps provided in this guide rely on the SDK for JavaScript. For an example, see [Sample Implementation](#sample-implementation). +To facilitate the process of establishing client identity using UID2 and retrieving advertising tokens, the web integration steps provided in this guide rely on the SDK for JavaScript. For an example, see [Sample implementation](#sample-implementation). :::tip -The first-party cookie and local storage implementation details might change in the future. To avoid potential issues, be sure to rely on the functionality documented in the [SDK for JavaScript API Reference](../sdks/sdk-ref-javascript.md#api-reference) for your identity management. +The first-party cookie and local storage implementation details might change in the future. To avoid potential issues, be sure to rely on the functionality documented in the [SDK for JavaScript API reference](../sdks/sdk-ref-javascript.md#api-reference) for your identity management. ::: -For integration scenarios for publishers that do not use the SDK for JavaScript, see [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md). +For integration scenarios for publishers that do not use the SDK for JavaScript, see [Publisher integration guide, server-side](integration-publisher-server-side.md). :::note -If you are using Google Ad Manager and want to use the secure signals feature, first follow the steps in this guide and then follow the additional steps in the [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md). +If you are using Google Ad Manager and want to use the secure signals feature, first follow the steps in this guide and then follow the additional steps in the [Google Ad Manager Secure Signals integration guide](integration-google-ss.md). ::: -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -For a client-server integration you'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page: +For a client-server integration you'll need to set up these values, in the UID2 Portal on the [API keys](../portal/api-keys.md) page: - API key, also called a client key - Client secret, a value known only to the participant and the UID2 service :::important -It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). +It's very important that you keep these values secure. For details, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). ::: -## Integration Steps +## Integration steps The following diagram outlines the steps required for establishing a user's UID2 token with a publisher and how the UID2 token integrates with the RTB bidstream. -![Publisher Flow](images/integration-javascript-client-server-mermaid.png) +![Publisher flow](images/integration-javascript-client-server-mermaid.png) The following sections provide additional details for each step in the diagram: 1. [Establish identity: capture user data](#establish-identity-capture-user-data) - 2. [Bid Using UID2 Tokens](#bid-using-uid2-tokens) - 3. [Refresh Tokens](#refresh-tokens) - 4. [Clear Identity: User Logout](#clear-identity-user-logout) + 2. [Bid using UID2 tokens](#bid-using-uid2-tokens) + 3. [Refresh tokens](#refresh-tokens) + 4. [Clear identity: User logout](#clear-identity-user-logout) -### Establish Identity: Capture User Data +### Establish identity: Capture user data After authentication in step 1-c, which allows the publisher to validate the user's email address or phone number, a UID2 token must be generated on the server side. The following table details the token generation steps. @@ -92,19 +92,19 @@ After authentication in step 1-c, which allows the publisher to validate the use | 1-f | SDK for JavaScript | The SDK sends the returned UID2 token from step 1-e to the SDK in the `identity` property of its [init() function](../sdks/sdk-ref-javascript.md#initopts-object-void). | | 1-g | SDK for JavaScript | Provide the SDK a callback function that will receive identity updates from the SDK and use them to initiate targeted advertising. | -#### Generating a UID2 Token on the Server +#### Generating a UID2 token on the server The first step is to generate the UID2 token on your server. -For details, including instructions and examples, see [Server-Side Token Generation](../ref-info/ref-server-side-token-generation.md). +For details, including instructions and examples, see [Server-side token generation](../ref-info/ref-server-side-token-generation.md). -You will need to pass the `Identity` response to the SDK. See [Sending the UID2 Token to the SDK](#sending-the-uid2-token-to-the-sdk). +You will need to pass the `Identity` response to the SDK. See [Sending the UID2 token to the SDK](#sending-the-uid2-token-to-the-sdk). :::warning -For security reasons, the API key and secret used in token generation must be called server-side. Do not store these values on the client side. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). +For security reasons, the API key and secret used in token generation must be called server-side. Do not store these values on the client side. For details, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). ::: -#### Sending the UID2 Token to the SDK +#### Sending the UID2 token to the SDK The following code examples illustrate steps 1-f and 1-g, in JavaScript and TypeScript. @@ -116,7 +116,7 @@ The SDK invokes the specified [callback function](../sdks/sdk-ref-javascript.md# Depending on the structure of your code, it might be convenient to combine the callbacks for steps 1-f and 1-g into a single callback function. ::: -### Bid Using UID2 Tokens +### Bid using UID2 tokens Based on the status and availability of a valid identity, the SDK does the following: @@ -141,14 +141,14 @@ For an example of what a UID2 token might look like in the bidstream, when it's ``` :::info -You need to consider how you pass the returned advertising token to SSPs. With some other approaches to client-side UID2 implementation, such as using `Prebid.js` (see [UID2 Integration Overview for Prebid](integration-prebid.md)) or Google Ad Manager Secure Signals (see [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md)), the implementation includes functions that manage passing the returned advertising token. If you're using the SDK for JavaScript you'll need to manage this yourself. +You need to consider how you pass the returned advertising token to SSPs. With some other approaches to client-side UID2 implementation, such as using `Prebid.js` (see [UID2 integration overview for Prebid](integration-prebid.md)) or Google Ad Manager Secure Signals (see [Google Ad Manager Secure Signals integration guide](integration-google-ss.md)), the implementation includes functions that manage passing the returned advertising token. If you're using the SDK for JavaScript you'll need to manage this yourself. ::: :::tip Instead of calling `__uid2.getAdvertisingToken()`, you can use the `advertising_token` property of the identity passed to the callback that you set up for step 1-g. The callback will be called every time the identity changes. ::: -### Refresh Tokens +### Refresh tokens As part of its initialization, the SDK sets up a [token auto-refresh](../sdks/sdk-ref-javascript.md#background-token-auto-refresh) for the identity, which is triggered in the background by the timestamps on the identity or by failed refresh attempts due to intermittent errors. @@ -158,7 +158,7 @@ As part of its initialization, the SDK sets up a [token auto-refresh](../sdks/sd | 3-b | [SDK for JavaScript](../sdks/sdk-ref-javascript.md) | If the user hasn't opted out, the [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint automatically returns new identity tokens. | -### Clear Identity: User Logout +### Clear identity: User logout The client lifecycle is complete when the user decides to log out from the publisher's site (not UID2). This closes the client's identity session and clears the first-party cookie information. @@ -174,7 +174,7 @@ The client lifecycle is complete when the user decides to log out from the publi ``` -## Sample Implementation +## Sample implementation A sample implementation is available for client-server integration using the UID2 SDK for JavaScript: @@ -183,4 +183,4 @@ A sample implementation is available for client-server integration using the UID ## FAQs -For a list of frequently asked questions for the publisher audience, see [FAQs for Publishers](../getting-started/gs-faqs.md#faqs-for-publishers). +For a list of frequently asked questions for the publisher audience, see [FAQs for publishers](../getting-started/gs-faqs.md#faqs-for-publishers). diff --git a/docs/guides/integration-javascript-client-side.md b/docs/guides/integration-javascript-client-side.md index ebeec6342..349f421a8 100644 --- a/docs/guides/integration-javascript-client-side.md +++ b/docs/guides/integration-javascript-client-side.md @@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Client-Side Integration Guide for JavaScript +# Client-side integration guide for JavaScript This guide is for all participants who want to integrate with UID2 and generate UID2 tokens (advertising tokens) using only JavaScript client-side changes on their website with minimum effort. @@ -22,16 +22,16 @@ This guide is for all participants who want to integrate with UID2 and generate This approach is used by the following participant types: - **Publishers**: Most notably, this workflow is for publishers wanting to send UID2 tokens into the bidstream. -- **Advertisers** and **Data Providers**: In addition, advertisers and data providers would use this for adding a UID2 token to their tracking pixels (see [Tokenized Sharing in Pixels](sharing/sharing-tokenized-from-data-pixel.md)). +- **Advertisers** and **Data Providers**: In addition, advertisers and data providers would use this for adding a UID2 token to their tracking pixels (see [Tokenized sharing in pixels](sharing/sharing-tokenized-from-data-pixel.md)). -This guide does not apply to publishers who want to use a Private Operator, or who want to generate tokens server-side. Those publishers should follow the [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md). +This guide does not apply to publishers who want to use a Private Operator, or who want to generate tokens server-side. Those publishers should follow the [Client-server integration guide for JavaScript](integration-javascript-client-server.md). -UID2 provides an SDK for JavaScript (see [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md)) with the following features: +UID2 provides an SDK for JavaScript (see [SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md)) with the following features: - UID2 token generation - Automatic refreshing of UID2 tokens @@ -44,7 +44,7 @@ To implement, you'll need to complete the following steps: 3. [Configure the SDK for JavaScript](#configure-the-sdk-for-javascript) 4. [Check that the token was successfully generated](#check-that-the-token-was-successfully-generated) -## SDK for JavaScript Version +## SDK for JavaScript version Support for client-side token generation is available in version 3.4.5 and above of the SDK. @@ -58,43 +58,43 @@ If you want to use a debug build of the SDK, use the following URL instead: - [https://cdn.integ.uidapi.com/uid2-sdk-4.0.1.js](https://cdn.integ.uidapi.com/uid2-sdk-4.0.1.js) -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values that you'll need to provide. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values that you'll need to provide. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -For a client-side integration you'll need to set up these values, in the UID2 Portal on the [Client-Side Integration](../portal/client-side-integration.md) page: +For a client-side integration you'll need to set up these values, in the UID2 Portal on the [Client-side integration](../portal/client-side-integration.md) page: -- Subscription ID and Public Key: See [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) +- Subscription ID and Public Key: See [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) -- A list of **domain names** for the sites on which you'll be using this SDK: See [Adding and Managing Root-Level Domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) +- A list of **domain names** for the sites on which you'll be using this SDK: See [Adding and managing root-level domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) -- Mobile App IDs (any that apply): See [Adding and Managing Mobile App IDs](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) +- Mobile App IDs (any that apply): See [Adding and managing mobile app ids](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) :::tip Only root-level domains are required for account setup. For example, if you're going to use SDK for JavaScript on example.com, shop.example.com, and example.org, you only need to provide the domain names example.com and example.org. ::: -## Add SDK for JavaScript to Your Site +## Add SDK for JavaScript to your site The following code snippet provides an overview of the code you will need to add to your website. It also illustrates the different events that the SDK can trigger. -For a more detailed code snippet, see [Example Integration Code and When to Pass DII to the UID2 SDK](#example-integration-code-and-when-to-pass-dii-to-the-uid2-sdk). +For a more detailed code snippet, see [Example integration code and when to pass DII to the UID2 SDK](#example-integration-code-and-when-to-pass-dii-to-the-uid2-sdk). -For the `UID2_JS_SDK_URL` value, see [SDK for JavaScript Version](#sdk-for-javascript-version). +For the `UID2_JS_SDK_URL` value, see [SDK for JavaScript version](#sdk-for-javascript-version). ```js @@ -127,11 +127,11 @@ window.__uid2.callbacks.push((eventType, payload) => { ``` -For more information about the SDK, see [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md). +For more information about the SDK, see [SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md). -### Using the UID2 Integration Environment +### Using the UID2 integration environment -By default, the SDK is configured to work with the UID2 production environment `https://prod.uidapi.com`. If you want to use the UID2 integration environment instead (for credentials, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials)), provide the following URL in your call to `init`: +By default, the SDK is configured to work with the UID2 production environment `https://prod.uidapi.com`. If you want to use the UID2 integration environment instead (for credentials, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials)), provide the following URL in your call to `init`: ```js __uid2.init({ @@ -139,10 +139,10 @@ __uid2.init({ }); ``` :::note -Tokens from the UID2 integration environment are not valid for passing to the bidstream. For the integration environment, you will have different **Subscription ID** and **public key** values. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials). +Tokens from the UID2 integration environment are not valid for passing to the bidstream. For the integration environment, you will have different **Subscription ID** and **public key** values. For information about getting credentials for each environment, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials). ::: -### Optional: Specifying the API Base URL to Reduce Latency +### Optional: Specifying the API base URL to reduce latency By default, this SDK makes calls to a UID2 production environment server in the USA. @@ -173,7 +173,7 @@ To configure the SDK, call one of the following methods, with an object containi * `__uid2.setIdentityFromPhoneHash` :::important -For `__uid2.setIdentityFromEmailHash` or `__uid2.setIdentityFromPhoneHash`, the `emailHash` or `PhoneHash` argument must be the Base64-encoded value. For details, see [Email Address Hash Encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) and [Phone Number Hash Encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding). +For `__uid2.setIdentityFromEmailHash` or `__uid2.setIdentityFromPhoneHash`, the `emailHash` or `PhoneHash` argument must be the Base64-encoded value. For details, see [Email address hash encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) and [Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding). ::: The following sections include coding examples for each scenario. @@ -183,9 +183,9 @@ Once it's configured, the UID2 SDK takes care of the following: - Stores the token in the user's browser. - Automatically refreshes the token as required while your site is open in the user's browser. -You can pass the user's DII to the UID2 SDK either hashed or unhashed. If you pass the DII unhashed, the UID2 SDK hashes it for you. If you want to pass the DII to the SDK already hashed, you must normalize it before hashing. For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). +You can pass the user's DII to the UID2 SDK either hashed or unhashed. If you pass the DII unhashed, the UID2 SDK hashes it for you. If you want to pass the DII to the SDK already hashed, you must normalize it before hashing. For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md). -## Format Examples for DII +## Format examples for DII The SDK encrypts the hashed DII before sending it to the UID2 service. @@ -200,7 +200,7 @@ The following examples demonstrate the different ways that you can configure the If the SDK is configured multiples times, it uses the most recent configuration values. -For an example of how to generate email and phone hashes in JavaScript, see [Example Code: Hashing and Base64 Encoding](#example-code-hashing-and-base64-encoding). +For an example of how to generate email and phone hashes in JavaScript, see [Example code: Hashing and Base64 encoding](#example-code-hashing-and-base64-encoding). @@ -238,7 +238,7 @@ await __uid2.setIdentityFromEmailHash( ``` In this scenario: -- **The publisher is responsible for normalizing and hashing the email address**. For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). +- **The publisher is responsible for normalizing and hashing the email address**. For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md). - The UID2 SDK encrypts the hash before sending it to the UID2 service. @@ -257,7 +257,7 @@ await __uid2.setIdentityFromPhone( ``` In this scenario: -- **The publisher is responsible for normalizing the phone number**. For details, see [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization). +- **The publisher is responsible for normalizing the phone number**. For details, see [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization). - The UID2 SDK hashes the phone number before sending the encrypted hash to the UID2 service. @@ -276,13 +276,13 @@ await __uid2.setIdentityFromPhoneHash( ``` In this scenario: -- **The publisher is responsible for normalizing, hashing, and Base64-encoding the phone number**. For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). +- **The publisher is responsible for normalizing, hashing, and Base64-encoding the phone number**. For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md). - The UID2 SDK encrypts the hash before sending it to the UID2 service. -## Token Storage and Refresh +## Token storage and refresh After calling one of the methods listed in [Configure the SDK for JavaScript](#configure-the-sdk-for-javascript) successfully, an identity is generated and stored in local storage, under the key `UID2-sdk-identity`. The SDK refreshes the UID2 token periodically. @@ -290,16 +290,16 @@ After calling one of the methods listed in [Configure the SDK for JavaScript](#c The format of the object stored in local storage could change without notice. We recommend that you do **not** read or update the object in local storage directly. ::: -## Example Integration Code and When to Pass DII to the UID2 SDK +## Example integration code and when to pass DII to the UID2 SDK If you're a publisher and this is the first page load with no identity, to start the token generation call you'll need to call one of the `setIdentity` methods with DII. Once an identity is generated, the advertising token (UID2 token) that you would send to the bidstream will be available by waiting for the `IdentityUpdated` event from the SDK. For an example, see how the value for `advertising_token_to_use` is set in the following code snippet. In some cases, the user's DII is not available on page load, and getting the DII has some associated cost. For example, an API call might be required to fetch the DII, or the user has to be prompted to provide it. You can potentially avoid that cost by checking for an existing token that you can use or refresh. To do this, call -[__uid2.isLoginRequired](../sdks/sdk-ref-javascript#isloginrequired-boolean) which returns a Boolean value. If it returns `true`, this means that the UID2 SDK cannot create a new advertising token with the existing resource and DII is required to generate a brand new UID2 token. +[__UID2.isloginrequired](../sdks/sdk-ref-javascript#isloginrequired-boolean) which returns a Boolean value. If it returns `true`, this means that the UID2 SDK cannot create a new advertising token with the existing resource and DII is required to generate a brand new UID2 token. -It is possible that when you provide DII, [__uid2.isLoginRequired](../sdks/sdk-ref-javascript#isloginrequired-boolean) still returns a `false` value. This happens if the user has opted out of UID2. The UID2 SDK for JavaScript respects the user's optout and does not generate UID2 tokens, even if you call any of the `setIdentity` method calls with the same DII again. Optionally, you might want to avoid making such calls repeatedly. +It is possible that when you provide DII, [__UID2.isloginrequired](../sdks/sdk-ref-javascript#isloginrequired-boolean) still returns a `false` value. This happens if the user has opted out of UID2. The UID2 SDK for JavaScript respects the user's optout and does not generate UID2 tokens, even if you call any of the `setIdentity` method calls with the same DII again. Optionally, you might want to avoid making such calls repeatedly. The following code snippet demonstrates how you might integrate with the UID2 SDK for JavaScript for these two scenarios—starting with no token, or reusing/refreshing an existing UID2 token. @@ -376,17 +376,17 @@ window.__uid2.callbacks.push(async (eventType, payload) => { ``` -## Check that the Token Was Successfully Generated +## Check that the token was successfully generated To check that the token was successfully generated, use the browser's developer tools to look for the token in local storage. -![Publisher Workflow](images/TokenDebugger-uid2.png) +![Publisher workflow](images/TokenDebugger-uid2.png) If there was a problem generating the token, find the request in the **Network** tab. You can find the request by filtering for the string `client-generate`. Information about why the request failed should be available in the response. -![Publisher Workflow](images/NetworkTraffic.png) +![Publisher workflow](images/NetworkTraffic.png) -## Example Code: Hashing and Base64 Encoding +## Example code: Hashing and Base64 encoding The following code example demonstrates how to generate email and phone hashes in JavaScript. @@ -405,7 +405,7 @@ function bytesToBase64(bytes) { } ``` -## Sample Implementation +## Sample implementation A sample implementation is available for client-side integration using the UID2 SDK for JavaScript: diff --git a/docs/guides/integration-javascript.md b/docs/guides/integration-javascript.md index 5d3fce750..034c94f6b 100644 --- a/docs/guides/integration-javascript.md +++ b/docs/guides/integration-javascript.md @@ -12,11 +12,11 @@ import Link from '@docusaurus/Link'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# UID2 Integration Overview for JavaScript +# UID2 integration overview for JavaScript This guide is an overview of integration options for publishers who want to integrate with UID2 and generate UID2 tokens (advertising tokens) using the SDK for JavaScript. -For a summary of all web options, including Prebid.js and additional SDK options, see [Publisher Web Integration Overview](integration-options-publisher-web.md). +For a summary of all web options, including Prebid.js and additional SDK options, see [Publisher web integration overview](integration-options-publisher-web.md). ## Introduction @@ -28,55 +28,55 @@ UID2 provides an SDK for JavaScript that supports the following: For additional flexibility, UID2 also provides alternative methods for some of the features and complementary products, such as a Prebid integration. -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Client-Side or Client-Server Integration +## Client-side or client-server integration 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 | | :--- | :--- | :--- | -| 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) | +| 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) | -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. -## Generating the UID2 Token +## Generating the UID2 token Depending on access to DII, there are two methods to generate UID2 tokens using the SDK for JavaScript: client-side or server-side. -From the table in [Client-Side or Client-Server Integration](#client-side-or-client-server-integration), determine which option is best for you, and then follow the applicable integration guide. +From the table in [Client-side or client-server integration](#client-side-or-client-server-integration), determine which option is best for you, and then follow the applicable integration guide. -## Refreshing the UID2 Token +## Refreshing the UID2 token The SDK for JavaScript includes automated token refresh. -## Storing the UID2 Token in the Browser +## Storing the UID2 token in the browser -The client-side option stores data using local storage. The client-server option uses local storage by default, but you can also choose to use a cookie instead. For details, see [UID2 Storage Format](../sdks/sdk-ref-javascript.md#uid2-storage-format) in the *SDK for JavaScript Reference Guide*. +The client-side option stores data using local storage. The client-server option uses local storage by default, but you can also choose to use a cookie instead. For details, see [UID2 storage format](../sdks/sdk-ref-javascript.md#uid2-storage-format) in the *SDK for JavaScript Reference Guide*. The cookie size can be significant, which could be a problem. However, if local storage is not an option, this is one possible approach. -## Passing the UID2 Token to the Bidstream +## Passing the UID2 token to the bidstream The JavaScript SDK manages generating, refreshing, and storing the UID2 token, but it does not manage passing the token to the bidstream. -You can pass the token into the bidstream using any option you choose—for example, Prebid.js. For some suggestions, see [Pass the UID2 Token Into the Bidstream](integration-options-publisher-web.md#pass-the-uid2-token-into-the-bidstream) in the *Publisher Web Integration Overview*. +You can pass the token into the bidstream using any option you choose—for example, Prebid.js. For some suggestions, see [Pass the UID2 token into the bidstream](integration-options-publisher-web.md#pass-the-uid2-token-into-the-bidstream) in the *Publisher Web Integration Overview*. -## JavaScript Integration Overview: High-Level Steps +## JavaScript integration overview: High-level steps At a high level, to integrate your site with UID2 using the SDK for JavaScript, you'll need to complete the following steps: @@ -86,5 +86,5 @@ At a high level, to integrate your site with UID2 using the SDK for JavaScript, For detailed instructions, refer to one of the following integration guides: -- [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) -- [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) +- [Client-side integration guide for JavaScript](integration-javascript-client-side.md) +- [Client-server integration guide for JavaScript](integration-javascript-client-server.md) diff --git a/docs/guides/integration-liveramp-tips.md b/docs/guides/integration-liveramp-tips.md index 415bda3e8..171da21a9 100644 --- a/docs/guides/integration-liveramp-tips.md +++ b/docs/guides/integration-liveramp-tips.md @@ -10,34 +10,34 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# LiveRamp Integration Tips +# LiveRamp integration tips Publishers who are using LiveRamp's Authenticated Traffic Solution (ATS) can leverage their integration to generate a UID2 token to be passed in the bid request. If you want to generate UID2 tokens using LiveRamp ATS, reach out to your LiveRamp representative and also make sure you've addressed the following integration points: -- [Enable UID2 as an Interoperable ID](#enable-uid2-as-an-interoperable-id) -- [Implement the UID2 Hashing Methodology](#implement-the-uid2-hashing-methodology) -- [Set Envelope Refresh to 1800 Seconds](#set-envelope-refresh-to-1800-seconds) +- [Enable UID2 as an interoperable ID](#enable-uid2-as-an-interoperable-id) +- [Implement the UID2 hashing methodology](#implement-the-uid2-hashing-methodology) +- [Set envelope refresh to 1800 seconds](#set-envelope-refresh-to-1800-seconds) -## Enable UID2 as an Interoperable ID +## Enable UID2 as an interoperable ID In your LiveRamp configuration, you must make sure that the Interoperable IDs feature is enabled. Interoperable IDs is a LiveRamp feature that enables other identity solutions, such as UID2, to embed their identifiers in ATS envelopes. If UID2 is not enabled as an interoperable ID, UID2 tokens will not be appended to the envelope. To complete this step, contact your LiveRamp representative. -## Implement the UID2 Hashing Methodology +## Implement the UID2 hashing methodology To add a valid UID2 token to the ATS envelope, a publisher must provide plain text emails, indicate the SHA-256 hashing methodology, or supply an SHA-256 hashed version of the email directly into the LiveRamp Library. You must use the SHA-256 hashing methodology, which is supported by both UID2 and LiveRamp. Using any other hashing methodology, or missing any step, results in either no UID2 token added to the ATS envelope or an invalid token added. -For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). +For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md). -## Set Envelope Refresh to 1800 Seconds +## Set envelope refresh to 1800 seconds When enabling ATS within `Prebid.js`, make sure that `storage.refreshInSeconds` is set to **1800 seconds** (30 minutes). To avoid sending expired envelopes into the bidstream, or passing envelopes where an opt-out has occurred, LiveRamp checks for a new ATS envelope (containing the UID2) every 30 minutes. -## Troubleshooting Assistance +## Troubleshooting assistance For more information, or LiveRamp troubleshooting assistance, check the [LiveRamp support page](https://docs.liveramp.com/connect/en/support.html) for help resources or contact your LiveRamp representative. diff --git a/docs/guides/integration-mobile-client-server.md b/docs/guides/integration-mobile-client-server.md index dc92d48eb..e80fc8254 100644 --- a/docs/guides/integration-mobile-client-server.md +++ b/docs/guides/integration-mobile-client-server.md @@ -19,13 +19,13 @@ import SnptGMAIMA_Plugins from '../snippets/_snpt-mobile_docs_gmaima-plugin-gss. import SnptPrebidMobileSDK from '../snippets/_snpt-mobile_docs_prebid-mobile.mdx'; import SnptErrorResponseStates from '../snippets/_snpt-mobile-docs-error-response-states.mdx'; -# UID2 Client-Server Integration Guide for Mobile +# UID2 client-server integration guide for mobile This guide is for mobile app publishers who want to integrate with UID2 by generating UID2 tokens server-side via a Public Operator or Private Operator and then passing the tokens and user identities into their mobile apps, which will in turn pass the tokens for bidstream use.   This is called client-server integration because some integration steps are client-side and some are server-side. -If you want to integrate with UID2 via client-side only changes (that is, all integration changes required are within the mobile apps), refer to the [UID2 Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) instead. +If you want to integrate with UID2 via client-side only changes (that is, all integration changes required are within the mobile apps), refer to the [UID2 client-side integration guide for mobile](integration-mobile-client-side.md) instead. This page provides a high-level overview of integration steps and links to additional documentation. @@ -38,64 +38,64 @@ UID2 provides mobile SDKs for [Android](../sdks/sdk-ref-android.md) and [iOS](.. This guide uses the group term **UID2 mobile SDKs** to include both the SDK for Android and the SDK for iOS. ::: -For FAQs relating to mobile publisher integrations, see [FAQs for Mobile Integrations](integration-mobile-overview.md#faqs-for-mobile-integrations). +For FAQs relating to mobile publisher integrations, see [FAQs for mobile integrations](integration-mobile-overview.md#faqs-for-mobile-integrations). You'll need to complete the following steps: 1. [Complete UID2 account setup and configure account](#complete-uid2-account-setup-and-configure-account). 2. [Implement server-side token generation](#implement-server-side-token-generation). -3. [Add the UID2 mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). -4. [Configure the UID2 mobile SDK](#configure-the-uid2-mobile-sdk). +3. [Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). +4. [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk). 5. [Check that the token was successfully generated and then pass it for bidstream use](#pass-generated-token-for-bidstream-use). -6. [Optionally, integrate the UID2 GMA/IMA Plugin for GAM Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration). +6. [Optionally, integrate the UID2 GMA/IMA plugin for gam Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration). -## Mobile SDK Version +## Mobile SDK version This guide provides instructions for using either of these UID2 mobile SDKs: - SDK for Android (version 1.6.0 or later) - SDK for iOS (version 1.7.0 or later) -For instructions for installing the correct SDK/version into your mobile app, see [Add the UID2 Mobile SDK to Your Mobile App](#add-the-uid2-mobile-sdk-to-your-mobile-app). +For instructions for installing the correct SDK/version into your mobile app, see [Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -For a client-server integration you'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page: +For a client-server integration you'll need to set up these values, in the UID2 Portal on the [API keys](../portal/api-keys.md) page: - API key, also called a client key - Client secret, a value known only to the participant and the UID2 service :::important -It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). +It's very important that you keep these values secure. For details, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). ::: -## Client-Server Mobile Integration Data Flow Overview +## Client-server mobile integration data flow overview The following diagram shows the data flow that the publisher must implement for UID2 client-server mobile integration. This example uses the [SDK for Android](../sdks/sdk-ref-android.md) in the client-side mobile app and the [SDK for Java](../sdks/sdk-ref-java.md) on the server side. -![Mobile Client-Server Integration Example](images/integration-mobile-client-server-uid2.png) +![Mobile client-server integration example](images/integration-mobile-client-server-uid2.png) -## Implement Server-Side Token Generation +## Implement server-side token generation For a client-server UID2 integration for mobile, the first step is to be able to generate the UID2 token on your server. Then, you can pass the token into your mobile apps for sending to the RTB bidstream. -For details, including instructions and examples, see [Server-Side Token Generation](../ref-info/ref-server-side-token-generation.md). +For details, including instructions and examples, see [Server-side token generation](../ref-info/ref-server-side-token-generation.md). You will need to pass the `Identity` response into the mobile app: see [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk). @@ -103,7 +103,7 @@ You will need to pass the `Identity` response into the mobile app: see [Configur For security reasons, the API key and secret used in token generation must be called server-side. Do not store these values inside a mobile app. ::: -## Server-Side Token Refresh +## Server-side token refresh Token refresh is automatically enabled inside the UID2 mobile SDKs; you don't need to manage it explicitly on the server side. @@ -114,24 +114,24 @@ If you want to manage token refresh on the server side and not the client/mobile - Call the [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint. - Use one of the Publisher Client classes, in one of the UID2 server-side SDKs. These classes simplify the request into a single method call. - For instructions, see [SDK for Java, Usage for Publishers, Basic Usage Server-Side Integration section](../sdks/sdk-ref-java.md#basic-usage-server-side-integration) or [SDK for Python, Usage for Publishers, Server-Side Integration section](../sdks/sdk-ref-python.md#server-side-integration). + For instructions, see [SDK for Java, usage for publishers, basic usage server-side integration section](../sdks/sdk-ref-java.md#basic-usage-server-side-integration) or [SDK for Python, usage for publishers, server-side integration section](../sdks/sdk-ref-python.md#server-side-integration). Then, pass the newly refreshed `Identity` value to the mobile app by following the rest of this guide. -## Add the UID2 Mobile SDK to Your Mobile App +## Add the UID2 Mobile SDK to your mobile app For installation instructions, refer to one of the following: -- [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) -- [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) +- [SDK for Android reference guide](../sdks/sdk-ref-android.md) +- [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) At this point, you are ready to use the UID2 Identity generated server-side in the mobile SDK. -### Using the UID2 Integration Environment +### Using the UID2 integration environment -By default, the SDK is configured to work with the UID2 production environment: `https://prod.uidapi.com`. If you want to use the UID2 integration environment instead (for credentials, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials)), provide the following URL in your call to UID2Manager initialization. +By default, the SDK is configured to work with the UID2 production environment: `https://prod.uidapi.com`. If you want to use the UID2 integration environment instead (for credentials, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials)), provide the following URL in your call to UID2Manager initialization. -For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials). +For information about getting credentials for each environment, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials). @@ -162,7 +162,7 @@ Bear in mind the following differences between environments: - You'll have a different set of API key and client secret values for each environment (integration and production). Be sure to use the correct values for each environment. ::: -### Optional: Specifying the API Base URL to Reduce Latency +### Optional: Specifying the API base URL to reduce latency By default, this SDK makes calls to a UID2 production environment server in the USA. @@ -220,7 +220,7 @@ UID2Manager.shared.setIdentity() -## Token Storage +## Token storage After you call the `setIdentity` method, the UID2 identity is persisted in local file storage. @@ -228,7 +228,7 @@ After you call the `setIdentity` method, the UID2 identity is persisted in local The format of the file stored in the local file storage, or the filename itself, could change without notice. We recommend that you do not read or update the file directly. ::: -## Pass Generated Token for Bidstream Use +## Pass generated token for bidstream use To retrieve the token, in your mobile app, call the following: @@ -263,12 +263,12 @@ If the `getAdvertisingToken()` method call returns `null`, there was no identity - **Android Java**: `UID2Manager.getInstance().getCurrentIdentityStatus()` - **Android Kotlin**: `UID2Manager.getInstance().currentIdentityStatus()` - **iOS**: `UID2Manager.shared.identityStatus` -- You could enable logging (set `isLoggingEnabled` to `true`) to get more information: see [Enable Logging](#enable-logging). +- You could enable logging (set `isLoggingEnabled` to `true`) to get more information: see [Enable logging](#enable-logging). - The advertising token inside the UID2 identity has expired, and the refresh token has also expired, so the SDK cannot refresh the token. -If there is no identity, follow the instructions in [Implement Server-Side Token Generation](#implement-server-side-token-generation) again, generate a new identity, and pass the result into your mobile app's UID2Manager again. +If there is no identity, follow the instructions in [Implement server-side token generation](#implement-server-side-token-generation) again, generate a new identity, and pass the result into your mobile app's UID2Manager again. -## When to Pass a new UID2 Identity/Token into the SDK +## When to pass a new UID2 identity/token into the SDK The best way to determine whether a new UID2 identity is required by the UID2 SDK again is to call the `getAdvertisingToken()` method in all cases: @@ -289,13 +289,13 @@ UID2Manager.shared.getAdvertisingToken() -On startup/resumption of the app, if `getAdvertisingToken()` returns `null`, it is time to generate new identity on the server by following the instructions in [Implement Server-Side Token Generation](#implement-server-side-token-generation). Then, pass the result into the mobile app’s UID2Manager again: see [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk). +On startup/resumption of the app, if `getAdvertisingToken()` returns `null`, it is time to generate new identity on the server by following the instructions in [Implement server-side token generation](#implement-server-side-token-generation). Then, pass the result into the mobile app’s UID2Manager again: see [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk). -## Enable Logging +## Enable logging -## Enable Automatic Token Refresh in Mobile App/Client Side +## Enable automatic token refresh in mobile app/client side By default, after a valid UID2 identity has been passed into the UID2Manager, it performs automatic token refresh. If for any reason token refresh was disabled, you can enable it with the following method call: @@ -324,11 +324,11 @@ UID2Manager.shared.automaticRefreshEnabled = false -## Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration +## Optional: UID2 GMA/IMA plugin for gam Secure Signals integration -## Optional: UID2 Integration with Prebid Mobile SDK +## Optional: UID2 integration with Prebid Mobile SDK :::important The UID2 integration with Prebid Mobile SDK v2 requires version 1.6.0 of the UID2 SDK for Android, or version 1.7.0 of the UID2 SDK for iOS. @@ -338,6 +338,6 @@ If you are using Prebid Mobile SDK v3, version 2.0.0 of the UID2 SDK for Android -## Error Response States +## Error response states diff --git a/docs/guides/integration-mobile-client-side.md b/docs/guides/integration-mobile-client-side.md index ca5b04a62..bfb8b71ad 100644 --- a/docs/guides/integration-mobile-client-side.md +++ b/docs/guides/integration-mobile-client-side.md @@ -19,11 +19,11 @@ import SnptGMAIMA_Plugins from '../snippets/_snpt-mobile_docs_gmaima-plugin-gss. import SnptPrebidMobileSDK from '../snippets/_snpt-mobile_docs_prebid-mobile.mdx'; import SnptErrorResponseStates from '../snippets/_snpt-mobile-docs-error-response-states.mdx'; -# UID2 Client-Side Integration Guide for Mobile +# UID2 client-side integration guide for mobile This guide is for mobile app publishers who want to integrate with UID2 with changes only within their mobile app. -These instructions do not apply to publishers who want to use a Private Operator, or who want to generate tokens server-side. Those publishers should follow the [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md). +These instructions do not apply to publishers who want to use a Private Operator, or who want to generate tokens server-side. Those publishers should follow the [Client-server integration guide for mobile](integration-mobile-client-server.md). This page provides a high-level overview of integration steps and links to additional documentation. @@ -36,30 +36,30 @@ UID2 provides mobile SDKs for [Android](../sdks/sdk-ref-android.md) and [iOS](.. This guide uses the group term **UID2 mobile SDKs** to include both the SDK for Android and the SDK for iOS. ::: -For FAQs relating to mobile publisher integrations, see [FAQs for Mobile Integrations](integration-mobile-overview.md#faqs-for-mobile-integrations). +For FAQs relating to mobile publisher integrations, see [FAQs for mobile integrations](integration-mobile-overview.md#faqs-for-mobile-integrations). To integrate with UID2 client-side, you'll need to complete the following steps: 1. [Complete the UID2 account setup and configure account](#complete-uid2-account-setup-and-configure-account). -1. [Add the UID2 mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). +1. [Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). -1. [Configure the UID2 mobile SDK](#configure-the-uid2-mobile-sdk). +1. [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk). 1. [Check that the token was successfully generated and then pass it for bidstream use](#pass-generated-token-for-bidstream-use). -1. [Optionally, integrate the UID2 GMA/IMA Plugin for GAM Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration). +1. [Optionally, integrate the UID2 GMA/IMA plugin for gam Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration). -## Mobile SDK Version +## Mobile SDK version This guide provides instructions for using either of these UID2 mobile SDKs: - SDK for Android (version 1.6.0 or later) - SDK for iOS (version 1.7.0 or later) -For instructions for installing the correct SDK/version into your mobile app, see [Add the UID2 Mobile SDK to Your Mobile App](#add-the-uid2-mobile-sdk-to-your-mobile-app). +For instructions for installing the correct SDK/version into your mobile app, see [Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). -## Client-Side Integration Example +## Client-side integration example For an example of how to configure a UID2 mobile SDK, and how to generate tokens using client-side integration for mobile, you can try out the UID2 development app. @@ -69,7 +69,7 @@ Follow the applicable instructions, for Android or iOS: 1. Check out the main branch of the [SDK for Android source code repository on GitHub](https://github.com/IABTechLab/uid2-android-sdk/tree/main). -1. In Android Studio (check the version required in the [Minimum Requirements](../sdks/sdk-ref-android.md#minimum-requirements) section in the SDK for Android Reference Guide), open the directory that you checked out. +1. In Android Studio (check the version required in the [Minimum requirements](../sdks/sdk-ref-android.md#minimum-requirements) section in the SDK for Android Reference Guide), open the directory that you checked out. 1. In [AndroidManifest.xml](https://github.com/IABTechLab/uid2-android-sdk/blob/main/dev-app/src/main/AndroidManifest.xml), set `uid2_environment_euid` to `false`. 2. Run the **dev-app** app. 1. When you've started the app, make sure that the **Client Side** checkbox is checked. @@ -149,9 +149,9 @@ UID2Manager.shared.getAdvertisingToken() -This method call returns the value that you need to make an ad request: see [Pass Generated Token for Bidstream Use](#pass-generated-token-for-bidstream-use). +This method call returns the value that you need to make an ad request: see [Pass generated token for bidstream use](#pass-generated-token-for-bidstream-use). -### Testing With Your Own Configuration +### Testing with your own configuration By default, the development app uses default values for Subscription ID and public key, which are stored in the following object: @@ -191,25 +191,25 @@ see UID2SDKDevelopmentApp/UID2SDKDevelopmentApp/Info.plist -If necessary, you can also change the default Subscription ID and public key to values assigned to you, and connect to the UID2 Production environment. For details, see [Optional: Specifying the API Base URL to Reduce Latency](#optional-specifying-the-api-base-url-to-reduce-latency). +If necessary, you can also change the default Subscription ID and public key to values assigned to you, and connect to the UID2 Production environment. For details, see [Optional: Specifying the API base URL to reduce latency](#optional-specifying-the-api-base-url-to-reduce-latency). -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values that you'll need to provide. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values that you'll need to provide. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -For a mobile client-side integration you'll need to set up these values, in the UID2 Portal on the [Client-Side Integration](../portal/client-side-integration.md) page: +For a mobile client-side integration you'll need to set up these values, in the UID2 Portal on the [Client-side integration](../portal/client-side-integration.md) page: -- Subscription ID and Public Key: See [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) +- Subscription ID and Public Key: See [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) - Mobile App IDs: any of these values that apply: @@ -217,24 +217,24 @@ For a mobile client-side integration you'll need to set up these values, in the - iOS Bundle Identifier - iOS App Store ID - For details, see [Adding and Managing Mobile App IDs](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) + For details, see [Adding and managing mobile app ids](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) -## Add the UID2 Mobile SDK to Your Mobile App +## Add the UID2 Mobile SDK to your mobile app To add the mobile SDK to your app, follow the applicable documentation: -- [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) -- [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) +- [SDK for Android reference guide](../sdks/sdk-ref-android.md) +- [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) At this point, you are ready to start generating UID2 tokens using the SDK. -### Using the UID2 Integration Environment +### Using the UID2 integration environment -By default, the SDK is configured to work with the UID2 production environment: `https://prod.uidapi.com`. If you want to use the UID2 integration environment instead (for credentials, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials)), provide the following URL in your call to initialize `UID2Manager`: +By default, the SDK is configured to work with the UID2 production environment: `https://prod.uidapi.com`. If you want to use the UID2 integration environment instead (for credentials, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials)), provide the following URL in your call to initialize `UID2Manager`: @@ -265,7 +265,7 @@ Bear in mind the following differences between environments: - You'll have a different set of Subscription ID and public key values for each environment (integration and production). Be sure to use the correct values for each environment. ::: -### Optional: Specifying the API Base URL to Reduce Latency +### Optional: Specifying the API base URL to reduce latency By default, this SDK makes calls to a UID2 production environment server in the USA. @@ -348,10 +348,10 @@ Once it's configured, the UID2 mobile SDK does the following: - Automatically refreshes the token as required while your app is open. :::tip -You can pass the user’s DII to the UID2 mobile SDK either hashed or unhashed. If you pass the DII unhashed, the SDK hashes it for you. If you want to pass the DII to the SDK already hashed, you must normalize it before hashing. For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). +You can pass the user’s DII to the UID2 mobile SDK either hashed or unhashed. If you pass the DII unhashed, the SDK hashes it for you. If you want to pass the DII to the SDK already hashed, you must normalize it before hashing. For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md). ::: -### Format Examples for DII +### Format examples for DII The SDK encrypts the hashed DII before sending it to the UID2 service. @@ -463,7 +463,7 @@ Task { In this scenario: -- The publisher is responsible for normalizing and hashing the email address. For details, see [Email Address Normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization). +- The publisher is responsible for normalizing and hashing the email address. For details, see [Email address normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization). - The UID2 mobile SDK encrypts the hashed DII before sending it to the UID2 service. @@ -515,7 +515,7 @@ Task { In this scenario: -- The publisher is responsible for normalizing the phone number. For details, see [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization). +- The publisher is responsible for normalizing the phone number. For details, see [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization). - The UID2 mobile SDK hashes the phone number before sending the encrypted hash to the UID2 service. @@ -563,21 +563,21 @@ Task { In this scenario: -- The publisher is responsible for normalizing and hashing the phone number. For details, see [Phone Number Hash Encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding). +- The publisher is responsible for normalizing and hashing the phone number. For details, see [Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding). - The UID2 mobile SDK encrypts the hashed DII before sending it to the UID2 service. -## Token Storage and Refresh +## Token storage and refresh -After a call to the applicable method listed in [Format Examples for DII](#format-examples-for-dii) is successful, an identity is generated and stored in local file storage. The UID2 mobile SDK refreshes the UID2 token periodically. +After a call to the applicable method listed in [Format examples for DII](#format-examples-for-dii) is successful, an identity is generated and stored in local file storage. The UID2 mobile SDK refreshes the UID2 token periodically. :::warning The format of the file stored in the local file storage, or the filename itself, could change without notice. We recommend that you do not read or update the file directly. ::: -## Pass Generated Token for Bidstream Use +## Pass generated token for bidstream use In your mobile app, if the call to `generateIdentity` was successful, it returned an identity. The next step is to call the `getAdvertisingToken()` method, as follows: @@ -615,15 +615,15 @@ Some possible reasons for this, and some things you could do to troubleshoot, ar - **Android Kotlin**: `UID2Manager.getInstance().currentIdentityStatus()` - **iOS**: `UID2Manager.shared.identityStatus` - It's possible that the DII has been opted out of UID2: for details, see [When to Pass DII into the SDK](#when-to-pass-dii-into-the-sdk). -- You could enable logging (set `isLoggingEnabled` to `true`) to get more information: see [Enable Logging](#enable-logging). + It's possible that the DII has been opted out of UID2: for details, see [When to pass DII into the SDK](#when-to-pass-dii-into-the-sdk). +- You could enable logging (set `isLoggingEnabled` to `true`) to get more information: see [Enable logging](#enable-logging). - The advertising token inside the UID2 identity has expired, and the refresh token has also expired, so the SDK cannot refresh the token. If there is no identity, you'll need to call the `generateIdentity` method again: see [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk). -For more information, see [When to Pass DII into the SDK](#when-to-pass-dii-into-the-sdk) (next section). +For more information, see [When to pass DII into the SDK](#when-to-pass-dii-into-the-sdk) (next section). -## When to Pass DII into the SDK +## When to pass DII into the SDK The first time a new user opens the app, no UID2 identity exists. You'll need to call the `generateIdentity` method, with the DII, to start the token generation: @@ -704,7 +704,7 @@ UID2Manager.shared.getAdvertisingToken() -If `getAdvertisingToken()` returns null, and the identity status is not `OPT_OUT`/`optOut`, you'll need to generate a new token. To do this, pass the DII into the `generateIdentity` method again. For details, see [Configure the UID2 mobile SDK](#configure-the-uid2-mobile-sdk). +If `getAdvertisingToken()` returns null, and the identity status is not `OPT_OUT`/`optOut`, you'll need to generate a new token. To do this, pass the DII into the `generateIdentity` method again. For details, see [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk). -## Enable Logging +## Enable logging -## Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration +## Optional: UID2 GMA/IMA plugin for gam Secure Signals integration -## Optional: UID2 Integration with Prebid Mobile SDK +## Optional: UID2 integration with Prebid Mobile SDK :::important The UID2 integration with Prebid Mobile SDK v2 requires version 1.6.0 of the UID2 SDK for Android, or version 1.7.0 of the UID2 SDK for iOS. @@ -749,6 +749,6 @@ If you are using Prebid Mobile SDK v3, version 2.0.0 of the UID2 SDK for Android -## Error Response States +## Error response states diff --git a/docs/guides/integration-mobile-overview.md b/docs/guides/integration-mobile-overview.md index 13600d015..5a9399ea8 100644 --- a/docs/guides/integration-mobile-overview.md +++ b/docs/guides/integration-mobile-overview.md @@ -12,7 +12,7 @@ import Link from '@docusaurus/Link'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# UID2 Mobile Integration Overview for Android and iOS +# UID2 mobile integration overview for Android and iOS This guide is an overview of integration options for mobile app publishers who want to integrate with UID2 using the SDK for Android or the SDK for iOS. @@ -28,17 +28,17 @@ UID2 provides SDKs for Android/iOS that support the following: - Refreshing the UID2 token - Storing the UID2 token -For additional flexibility, UID2 also provides alternative methods for some of the features and complementary products, such as UID2 Google GMA/IMA Plugins. Available options are described in the individual guides: see [Integration Overview: High-Level Steps](#integration-overview-high-level-steps). +For additional flexibility, UID2 also provides alternative methods for some of the features and complementary products, such as UID2 Google GMA/IMA Plugins. Available options are described in the individual guides: see [Integration overview: High-level steps](#integration-overview-high-level-steps). -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Integration Overview: High-Level Steps +## Integration overview: High-level steps At a high level, to integrate your mobile app with UID2 using the UID2 mobile SDKs, you'll need to complete the following steps: @@ -56,41 +56,41 @@ At a high level, to integrate your mobile app with UID2 using the UID2 mobile SD For details, refer to one of the following guides: -- [Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) -- [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) -- [Server-Side Integration Guide for Mobile](integration-mobile-server-side.md) +- [Client-side integration guide for mobile](integration-mobile-client-side.md) +- [Client-server integration guide for mobile](integration-mobile-client-server.md) +- [Server-side integration guide for mobile](integration-mobile-server-side.md) -## Mobile Integration Paths +## Mobile integration paths To determine the best integration path for your mobile scenario, consider these points: -1. Do you want to retrieve the UID2 token on the client side or on the server side? See [Client-Side, Client-Server, or Server-Side Integration?](#client-side-client-server-or-server-side-integration) +1. Do you want to retrieve the UID2 token on the client side or on the server side? See [Client-side, client-server, or server-side integration?](#client-side-client-server-or-server-side-integration) -1. What do you want to use to retrieve and refresh the UID2 token? See [Generating, Storing, and Refreshing the UID2 Token](#generating-storing-and-refreshing-the-uid2-token). +1. What do you want to use to retrieve and refresh the UID2 token? See [Generating, storing, and refreshing the UID2 token](#generating-storing-and-refreshing-the-uid2-token). -1. How do you want to use the UID2 tokens? See [Sending the Token to the Bidstream](#sending-the-token-to-the-bidstream). +1. How do you want to use the UID2 tokens? See [Sending the token to the bidstream](#sending-the-token-to-the-bidstream). -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-Side, Client-Server, or Server-Side Integration?](#client-side-client-server-or-server-side-integration) +The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-side, client-server, or server-side integration?](#client-side-client-server-or-server-side-integration) -### Client-Side, Client-Server, or Server-Side Integration? +### Client-side, client-server, or server-side integration? The options for integrating with UID2 using the UID2 mobile SDKs are summarized in the following table. Choose the integration approach that's best for you. -For details, see [Integration Approaches](../ref-info/ref-integration-approaches.md). +For details, see [Integration approaches](../ref-info/ref-integration-approaches.md). | 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 | [UID2 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 | [UID2 Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) | -| You have access to DII on the server side only and can do the necessary development to generate UID2 tokens server-side, or you are using a Private Operator. | Server-Side Integration | [UID2 Server-Side Integration Guide for Mobile](integration-mobile-server-side.md) | +| 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 | [UID2 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 | [UID2 client-server integration guide for mobile](integration-mobile-client-server.md) | +| You have access to DII on the server side only and can do the necessary development to generate UID2 tokens server-side, or you are using a Private Operator. | Server-Side Integration | [UID2 server-side integration guide for mobile](integration-mobile-server-side.md) | -### Generating, Storing, and Refreshing the UID2 Token +### Generating, storing, and refreshing the UID2 token The following table summarizes the mobile integration options for managing the UID2 token, including generating, storing, and refreshing the token, with links to the documentation for each option. @@ -105,18 +105,18 @@ The following table summarizes the mobile integration options for managing the U UID2 Android SDK - [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) - One of the following:
  • [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md)
  • [UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md)
+ [SDK for Android reference guide](../sdks/sdk-ref-android.md) + One of the following:
  • [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side.md)
  • [UID2 client-server integration guide for mobile](../guides/integration-mobile-client-server.md)
UID2 iOS SDK - [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) - One of the following:
  • [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md)
  • [UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md)
+ [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) + One of the following:
  • [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side.md)
  • [UID2 client-server integration guide for mobile](../guides/integration-mobile-client-server.md)
-### Sending the Token to the Bidstream +### Sending the token to the bidstream There are many options for sending your UID2 tokens to the bidstream. @@ -124,13 +124,13 @@ The following table summarizes the options supported by UID2. | 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. [UID2 GMA Plugin for Android Integration Guide](../guides/mobile-plugin-gma-android.md)
  2. One of the following:
    • Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-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. [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios.md)
  2. One of the following:
    • Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-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. [UID2 IMA Plugin for Android Integration Guide](../guides/mobile-plugin-ima-android.md)
  2. One of the following:
    • Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-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. [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios.md)
  2. One of the following:
    • Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-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: UID2 Integration with Prebid Mobile SDK](../guides/integration-mobile-client-side.md#optional-uid2-integration-with-prebid-mobile-sdk)
  • Client-server: [Optional: UID2 Integration with Prebid Mobile SDK](../guides/integration-mobile-client-server.md#optional-uid2-integration-with-prebid-mobile-sdk)
| +| 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. [UID2 GMA plugin for Android integration guide](../guides/mobile-plugin-gma-android.md)
  2. One of the following:
    • Client-side: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-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. [UID2 GMA plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md)
  2. One of the following:
    • Client-side: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-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. [UID2 IMA plugin for Android integration guide](../guides/mobile-plugin-ima-android.md)
  2. One of the following:
    • Client-side: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-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. [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md)
  2. One of the following:
    • Client-side: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-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: UID2 integration with Prebid Mobile SDK](../guides/integration-mobile-client-side.md#optional-uid2-integration-with-prebid-mobile-sdk)
  • Client-server: [Optional: UID2 integration with Prebid Mobile SDK](../guides/integration-mobile-client-server.md#optional-uid2-integration-with-prebid-mobile-sdk)
| -### Functionality Summary +### Functionality summary The following table summarizes the functionality available with the various integration options. @@ -154,7 +154,7 @@ All options support either client-side or server-side integration. -## FAQs for Mobile Integrations +## FAQs for mobile integrations Here is some FAQ information relating to UID2 mobile integrations: @@ -180,13 +180,13 @@ Therefore, if you already have GMA installed and want to install UID2, be sure t Podspec is the name of the file in CocoaPods that defines the libraries to be integrated with the app. ::: -## Troubleshooting Tips for Mobile Integrations +## Troubleshooting tips for mobile integrations Here's some additional information to help you troubleshoot your UID2 mobile integrations: -- [Android SDK Cannot Connect in Production Environment](#android-sdk-cannot-connect-in-production-environment) +- [Android SDK cannot connect in production environment](#android-sdk-cannot-connect-in-production-environment) -#### Android SDK Cannot Connect in Production Environment +#### Android SDK cannot connect in production environment A good first step in troubleshooting is to look at the health check endpoint. @@ -204,4 +204,4 @@ Some error responses indicate a networking problem resulting in your app not be The SDK tries to refresh the UID2 token in the background. If an error such as an IOException occurs, the SDK retries multiple times. If retry is not successful, this exception is displayed. -Another good troubleshooting step is to enable logging. For details, see [Enable Logging](integration-mobile-client-side.md#enable-logging). +Another good troubleshooting step is to enable logging. For details, see [Enable logging](integration-mobile-client-side.md#enable-logging). diff --git a/docs/guides/integration-mobile-server-side.md b/docs/guides/integration-mobile-server-side.md index dec495856..68d5b303a 100644 --- a/docs/guides/integration-mobile-server-side.md +++ b/docs/guides/integration-mobile-server-side.md @@ -10,7 +10,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Server-Side Integration Guide for Mobile +# UID2 server-side integration guide for mobile This guide is for mobile app publishers who want to manage the UID2 token entirely on the server side: @@ -21,9 +21,9 @@ This setup requires that most of the code changes are done on the server side, w One advantage of this approach is that if you're dealing with multiple platforms (Web / CTV / mobile), doing everything on the server side can reduce platform-specific efforts. -To implement using this approach, follow the instructions in [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md). +To implement using this approach, follow the instructions in [Publisher integration guide, server-side](integration-publisher-server-side.md). If your server-side code is in Java or Python, you can use one of the UID2 SDKs to make the HTTP requests to UID2, instead of writing your own source code. For details, refer to one of the following SDK guides: -- [SDK for Java Reference Guide: Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers) -- [SDK for Python Reference Guide: Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers) +- [SDK for Java reference guide: Usage for publishers](../sdks/sdk-ref-java.md#usage-for-publishers) +- [SDK for Python reference guide: Usage for publishers](../sdks/sdk-ref-python.md#usage-for-publishers) diff --git a/docs/guides/integration-options-private-operator.md b/docs/guides/integration-options-private-operator.md index e7724ddbf..c8a6ffc42 100644 --- a/docs/guides/integration-options-private-operator.md +++ b/docs/guides/integration-options-private-operator.md @@ -10,7 +10,7 @@ import SnptUpgradePolicy from '../snippets/_snpt-private-operator-upgrade-policy import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# UID2 Private Operator Integration Overview +# UID2 Private Operator integration overview UID2 participants that host their own Private Operator send their own first-party directly identifying information (DII) to their own local UID2 Operator service, running in a private environment. @@ -24,7 +24,7 @@ Learn about what the UID2 framework offers for Private Operators, including bene This page is about Private Operators. For information about Public Operators, or if you're not sure what the difference is or what an Operator is, see [The UID2 Operator](../ref-info/ref-operators-public-private.md). ::: -## Private Operator Benefits +## Private Operator benefits Here are some of the intended benefits of participating in UID2 as a Private Operator: - You can maintain privacy-conscious workflows for your customer data to be encrypted and activated across chosen partners. @@ -39,17 +39,17 @@ Here are some of the intended benefits of participating in UID2 as a Private Ope If you have significant latency concerns, or your security requirements dictate that data stays within your systems, and you also have extensive engineering resources to both build and maintain your UID2 implementation, you might consider the Private Operator solution. -## Private Operator Requirements +## Private Operator requirements The participant must host, configure, maintain, and update the Private Operator instance, and must conform to strict security measures. Engineering resources are required to integrate and to make ongoing updates. -The participant must sign a contract (see [Account Setup](../getting-started/gs-account-setup.md)) to host a Private Operator instance. +The participant must sign a contract (see [Account setup](../getting-started/gs-account-setup.md)) to host a Private Operator instance. :::note A Private Operator has no visibility into the raw UID2s or UID2 tokens processed by a Public Operator or another Private Operator. Each Private Operator is isolated from all other Operators. ::: -## Hosting Options for Private Operators +## Hosting options for Private Operators If you choose to be a Private Operator, several implementation options are available. UID2 supports hosting UID2 in an enclave on the following cloud service providers (medium level of effort to implement): - [Nitro Enclave](https://aws.amazon.com/ec2/nitro/) from AWS @@ -57,7 +57,7 @@ If you choose to be a Private Operator, several implementation options are avail - [Confidential Containers](https://learn.microsoft.com/en-us/azure/confidential-computing/confidential-containers), a confidential computing option from Microsoft Azure - [Azure Kubernetes Service (AKS)](https://learn.microsoft.com/en-us/azure/aks/what-is-aks), a confidential computing solution that runs on virtual nodes on Microsoft Azure container instances and uses Kubernetes. -## Private Operator Workflow +## Private Operator workflow The basic workflow for a Private Operator is as follows: @@ -65,66 +65,66 @@ The basic workflow for a Private Operator is as follows: 1. When the Operator passes the attestation process, the Core service gives the Private Operator secure S3 URLs for retrieving the information it needs for startup. -1. The Private Operator retrieves the security information from Amazon S3 that it needs to process UID2s, such as salts, encryption keys, and user opt-out records. For security details, see [Private Operator Security](#private-operator-security). +1. The Private Operator retrieves the security information from Amazon S3 that it needs to process UID2s, such as salts, encryption keys, and user opt-out records. For security details, see [Private Operator security](#private-operator-security). 1. If an Operator is restarted, it goes through the attestation process again, and retrieves a fresh set of security information. 1. The Operator re-attests periodically with the Core service to ensure that it is still running in a protected environment. If attestation fails, the Operator shuts down. -## Private Operator Security +## Private Operator security Each supported Private Operator implementation must meet rigorous security standards. Some security points include: -- The Private Operator runs in a hardware-based trusted execution environment (TEE) hosted by a supported cloud provider listed in [Hosting Options for Private Operators](#hosting-options-for-private-operators). +- The Private Operator runs in a hardware-based trusted execution environment (TEE) hosted by a supported cloud provider listed in [Hosting options for Private Operators](#hosting-options-for-private-operators). - The Private Operator must complete an attestation process before accessing the information needed to process UID2s. - The information on S3 is encrypted at rest and also encrypted in transit through TLS. In addition, access is limited to only correctly authorized and attested Private Operators. - The information retrieved at startup is not stored locally at any point. It is only ever held in memory, and the Private Operator is running in a protected environment that makes it difficult for anyone running the Operator (such as an Administrator), as well as any external players, to see the data that's in memory. - The Private Operator never stores DII that is sent for processing (email addresses and/or phone numbers). The data is only used within the enclave, to generate UID2s, and is discarded immediately after processing. -## Private Operator Limitations +## Private Operator limitations There are a couple of limitations to Private Operator functionality: - Private Operators do not currently support client-side integration. - Private Operator updates are released three times per year; Public Operator updates are released on a more frequent cadence. -## Private Operator Deprecation Schedule +## Private Operator deprecation schedule -For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions). +For information about supported versions and deprecation dates, see [Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions). -## Private Operator Upgrade Policy +## Private Operator upgrade policy -## Keeping the Operator Key Secure +## Keeping the operator key secure -## Preparing DII for Processing +## Preparing DII for processing -## Getting Started +## Getting started To get started as a Private Operator, follow these steps: -1. Request access to UID2 by filling out the form on the [Request Access](/request-access) page. +1. Request access to UID2 by filling out the form on the [Request access](/request-access) page. 2. Decide which implementation option you want to use. - For details about available options, see [Hosting Options for Private Operators](#hosting-options-for-private-operators). + For details about available options, see [Hosting options for Private Operators](#hosting-options-for-private-operators). 3. If you're using an SDK, download the SDK. Refer to the applicable SDK guide. 4. Follow the instructions in the implementation guide for the option you chose. :::note - Be sure to encrypt request messages to UID2. For details, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). + Be sure to encrypt request messages to UID2. For details, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: 5. Test. 6. Go live. :::important -Whatever option you use, the data that you send for generating UID2s must be normalized, hashed, and encoded before sending. For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). +Whatever option you use, the data that you send for generating UID2s must be normalized, hashed, and encoded before sending. For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md). ::: -## Implementation Resources +## Implementation resources The following documentation resources are available for Private Operators to implement UID2. @@ -132,7 +132,7 @@ There is no functional difference between the Private Operator versions. | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| AWS | [UID2 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 | [UID2 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. | -| Azure | [UID2 Private Operator for Azure Integration Guide](../guides/operator-guide-azure-enclave.md) | Instructions for setting up the UID2 Operator Service in an instance of Confidential Containers, a confidential computing option from Microsoft Azure. | -| AKS | [UID2 Private Operator for AKS Integration Guide](../guides/operator-guide-aks-enclave.md) | Instructions for setting up the UID2 Operator Service in an instance of AKS, a confidential computing solution that runs on virtual nodes on Microsoft Azure container instances and uses Kubernetes. | +| AWS | [UID2 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 | [UID2 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. | +| Azure | [UID2 Private Operator for Azure integration guide](../guides/operator-guide-azure-enclave.md) | Instructions for setting up the UID2 Operator Service in an instance of Confidential Containers, a confidential computing option from Microsoft Azure. | +| AKS | [UID2 Private Operator for AKS integration guide](../guides/operator-guide-aks-enclave.md) | Instructions for setting up the UID2 Operator Service in an instance of AKS, a confidential computing solution that runs on virtual nodes on Microsoft Azure container instances and uses Kubernetes. | diff --git a/docs/guides/integration-options-publisher-all.md b/docs/guides/integration-options-publisher-all.md index 625a9a713..d375ef685 100644 --- a/docs/guides/integration-options-publisher-all.md +++ b/docs/guides/integration-options-publisher-all.md @@ -9,6 +9,6 @@ displayed_sidebar: sidebarPublishers import Link from '@docusaurus/Link'; import SnptPublisherImplementationResources from '../snippets/_snpt-publisher-implementation-resources.mdx'; -# Publisher Integration Resources +# Publisher integration resources diff --git a/docs/guides/integration-options-publisher-web.md b/docs/guides/integration-options-publisher-web.md index 76dc04d11..2e9fc6456 100644 --- a/docs/guides/integration-options-publisher-web.md +++ b/docs/guides/integration-options-publisher-web.md @@ -9,13 +9,13 @@ displayed_sidebar: sidebarPublishers import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Publisher Web Integration Overview +# Publisher web integration overview As a publisher, there are many ways that you can integrate with UID2 to generate identity tokens to be passed into the RTB bidstream in the context of your web pages. On this page, you'll find a high-level overview of integration steps and integration options, with links to additional information for each option. -## Key Integration Steps +## Key integration steps At a high level, to integrate with UID2, you'll implement these three key activities: @@ -25,7 +25,7 @@ At a high level, to integrate with UID2, you'll implement these three key activi There are many ways you can accomplish these key steps. The simplest and fastest implementation is a full client-side implementation using Prebid.js 8.21.0 or later. -## Integration Options Summary +## Integration options summary The following table summarizes the solutions available for each integration step. @@ -44,27 +44,27 @@ To accomplish all steps, you can combine solutions. For example, you could use t -## Preparing DII for Processing +## Preparing DII for processing -## Publisher Web Options Workflow +## Publisher web options workflow To choose your implementation and get started, follow these steps: 1. Review the summary of options to generate a UID2 token: - - [Client-Side Integration Options](#client-side-integration-options) - - [Server-Side Integration Options](#server-side-integration-options) + - [Client-side integration options](#client-side-integration-options) + - [Server-side integration options](#server-side-integration-options) 1. Review the options to [refresh the UID2 token](#refresh-the-uid2-token). 1. Review the options to [pass the token into the bidstream](#pass-the-uid2-token-into-the-bidstream). 1. Choose the option that's best for you, and then click through to the implementation documentation. -## Generate the UID2 Token +## Generate the UID2 token There are two main paths that you can choose to generate a UID2 token—you can choose to initiate the UID2 token generate request: -- On the client side (in the user's browser): see [Client-Side Integration Options](#client-side-integration-options). -- On the server side: see [Server-Side Integration Options](#server-side-integration-options). +- On the client side (in the user's browser): see [Client-side integration options](#client-side-integration-options). +- On the server side: see [Server-side integration options](#server-side-integration-options). Each option has different advantages. We recommend client-side integration using Prebid.js 8.21.0 or later as the easiest and fastest integration option. @@ -72,23 +72,23 @@ Each option has different advantages. We recommend client-side integration using For all integration options, you can choose to store the UID2 token in local storage or cookie storage. ::: -### Client-Side Integration Options +### Client-side integration options Generating the UID2 token on the client side has the following advantages: - The code runs on the client side, on the consumer's web page, and no server-side coding is required. - There is a Prebid.js integration that handles all functions for you—token generation, token refresh, and passing the token into the bidstream. If you use Prebid.js 8.21.0 or later, this is the simplest and fastest implementation option. -If you choose a client-side integration, you'll need to provide a list of your root-level domains, for security purposes, as part of account setup. For details, see [Client-Side Web Integrations](../getting-started/gs-account-setup.md#client-side-web-integrations) on the Account Setup page. +If you choose a client-side integration, you'll need to provide a list of your root-level domains, for security purposes, as part of account setup. For details, see [Client-side web integrations](../getting-started/gs-account-setup.md#client-side-web-integrations) on the Account Setup page. The following table summarizes the options for publishers who want to generate the UID2 token on the client side, via the web page, with corresponding documentation resources. | Option | Documentation | | :--- | :--- | -| Prebid.js client-side implementation (8.21.0 or later) | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | -| SDK for JavaScript, client-side implementation | [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | +| Prebid.js client-side implementation (8.21.0 or later) | [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) | +| SDK for JavaScript, client-side implementation | [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | -### Server-Side Integration Options +### Server-side integration options Generating the UID2 token on the server side has the following advantages: @@ -100,12 +100,12 @@ The following table summarizes the options for publishers who want to generate t | Option | Documentation | | :--- | :--- | -| SDK for JavaScript, client-server implementation | [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) | -| SDK for Java | - [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)
- [SDK for Java](../sdks/sdk-ref-java.md) | -| SDK for Python | - [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)
- [SDK for Python](../sdks/sdk-ref-python.md) | -| Direct integration (API endpoints) | [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | +| SDK for JavaScript, client-server implementation | [Client-server integration guide for JavaScript](integration-javascript-client-server.md) | +| SDK for Java | - [Publisher integration guide, server-side](integration-publisher-server-side.md)
- [SDK for Java](../sdks/sdk-ref-java.md) | +| SDK for Python | - [Publisher integration guide, server-side](integration-publisher-server-side.md)
- [SDK for Python](../sdks/sdk-ref-python.md) | +| Direct integration (API endpoints) | [Publisher integration guide, server-side](integration-publisher-server-side.md) | -## Refresh the UID2 Token +## Refresh the UID2 token For security reasons, the UID2 token has a limited life, but there is a built-in mechanism to refresh the token so that you can still use it. @@ -115,15 +115,15 @@ The following table shows the integration options that support refreshing the UI | Option | Documentation | | :--- | :--- | -| Prebid.js client-side implementation (8.21.0 or later) | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | -| Prebid.js client-server implementation (7.53.0 or later) | [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) | -| SDK for JavaScript, client-side implementation | [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | -| SDK for JavaScript, client-server implementation | [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) | -| SDK for Java | - [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)
- [SDK for Java](../sdks/sdk-ref-java.md) | -| SDK for Python | - [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)
- [SDK for Python](../sdks/sdk-ref-python.md) | -| Direct integration (API endpoints) | [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | +| Prebid.js client-side implementation (8.21.0 or later) | [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) | +| Prebid.js client-server implementation (7.53.0 or later) | [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) | +| SDK for JavaScript, client-side implementation | [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | +| SDK for JavaScript, client-server implementation | [Client-server integration guide for JavaScript](integration-javascript-client-server.md) | +| SDK for Java | - [Publisher integration guide, server-side](integration-publisher-server-side.md)
- [SDK for Java](../sdks/sdk-ref-java.md) | +| SDK for Python | - [Publisher integration guide, server-side](integration-publisher-server-side.md)
- [SDK for Python](../sdks/sdk-ref-python.md) | +| Direct integration (API endpoints) | [Publisher integration guide, server-side](integration-publisher-server-side.md) | -## Pass the UID2 Token Into the Bidstream +## Pass the UID2 token into the bidstream Publishers use UID2s by encrypting DII (email addresses or phone numbers) into UID2 tokens and then sending the UID2 tokens into the bidstream. @@ -131,9 +131,9 @@ The following table shows integration options that support passing UID2 token in | Option | Documentation | | :--- | :--- | -| Prebid.js client-side implementation (8.21.0 or later) | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | -| Prebid.js client-server implementation (7.53.0 or later) | [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) | -| Google Ad Manager Secure Signals| [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | +| Prebid.js client-side implementation (8.21.0 or later) | [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) | +| Prebid.js client-server implementation (7.53.0 or later) | [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) | +| Google Ad Manager Secure Signals| [Google Ad Manager Secure Signals integration guide](integration-google-ss.md) | :::note As long as you generate the token and keep it refreshed, you can also use other options for passing the UID2 token into the bidstream. diff --git a/docs/guides/integration-prebid-client-server.md b/docs/guides/integration-prebid-client-server.md index 0092483a9..db2a9cb49 100644 --- a/docs/guides/integration-prebid-client-server.md +++ b/docs/guides/integration-prebid-client-server.md @@ -14,7 +14,7 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai import SnptAddPrebidjsToYourSite from '../snippets/_snpt-prebid-add-prebidjs-to-your-site.mdx'; import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx'; -# UID2 Client-Server Integration Guide for Prebid.js +# UID2 client-server integration guide for Prebid.js This guide is for publishers who have access to DII (email address or phone number) on the server side and want to integrate with UID2 and generate UID2 tokens (advertising tokens) to be passed by Prebid.js in the RTB bidstream. @@ -25,27 +25,27 @@ To integrate with UID2 using Prebid.js, you'll need to: - Make changes to the HTML and JavaScript on your site. - Make server-side changes for token generation (and, optionally, token refresh). -## Prebid.js Version +## Prebid.js version This implementation requires Prebid.js version 7.53.0 or later. For version information, see [https://github.com/prebid/Prebid.js/releases](https://github.com/prebid/Prebid.js/releases). -## UID2 Prebid Module Page +## UID2 Prebid module page Information about how to integrate Prebid with UID2 is also in the following locations: - On the Prebid site, on the [Unified ID 2.0](https://docs.prebid.org/dev-docs/modules/userid-submodules/unified2.html) page for the Prebid User ID submodule. - In the Prebid GitHub repository, on the [UID2 User ID Submodule](https://github.com/prebid/Prebid.js/blob/master/modules/uid2IdSystem.md) page. -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Integration Overview: High-Level Steps +## Integration overview: High-level steps You'll need to complete the following steps: @@ -53,86 +53,86 @@ You'll need to complete the following steps: 2. [Add Prebid.js to your site](#add-prebidjs-to-your-site). 3. [Configure the UID2 module](#configure-the-uid2-module). -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2 using Prebid.js, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2 using Prebid.js, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -For a client-server integration you'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page: +For a client-server integration you'll need to set up these values, in the UID2 Portal on the [API keys](../portal/api-keys.md) page: - API key, also called a client key - Client secret, a value known only to the participant and the UID2 service :::important -It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). +It's very important that you keep these values secure. For details, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). ::: -## Add Prebid.js to Your Site +## Add Prebid.js to your site -## Configure the UID2 Module +## Configure the UID2 module You'll need to configure the UID2 Prebid module to complete the following two actions: | 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) | +| 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) | -### Generating a UID2 Token on the Server +### Generating a UID2 token on the server For a client-server UID2 integration for Prebid, the first step is to generate the UID2 token on your server. Then, you can pass the token to Prebid for sending to the RTB bidstream. -For details, including instructions and examples, see [Server-Side Token Generation](../ref-info/ref-server-side-token-generation.md). +For details, including instructions and examples, see [Server-side token generation](../ref-info/ref-server-side-token-generation.md). -To generate a token, call one of the SDKs or the [POST /token/generate](../endpoints/post-token-generate.md) endpoint. For an example of the API response, showing the token, see [Sample Token Response Object](#sample-token-response-object). You will need to pass the `Identity` response to Prebid. +To generate a token, call one of the SDKs or the [POST /token/generate](../endpoints/post-token-generate.md) endpoint. For an example of the API response, showing the token, see [Sample token response object](#sample-token-response-object). You will need to pass the `Identity` response to Prebid. :::warning For security reasons, the API key and secret used in token generation must be called server-side. Do not store these values as part of your Prebid implementation. ::: -### Refreshing a UID2 Token +### Refreshing a UID2 token There are two ways to refresh a UID2 token, as shown in the following table. | 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:
  • If you want to use the [SDK for JavaScript](../sdks/sdk-ref-javascript.md) to refresh the token, and Prebid.js to send the token to the bidstream.
  • If you want to send the token to the bidstream via multiple avenues (such as Prebid.js and also Google).
| [Server-Only Mode](#server-only-mode) | +| 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:
  • If you want to use the [SDK for JavaScript](../sdks/sdk-ref-javascript.md) to refresh the token, and Prebid.js to send the token to the bidstream.
  • If you want to send the token to the bidstream via multiple avenues (such as Prebid.js and also Google).
| [Server-only mode](#server-only-mode) | -### Client Refresh Mode +### Client refresh mode You must provide the Prebid module with the full JSON response body from the applicable endpoint: - [POST /token/generate](../endpoints/post-token-generate.md) for a new UID2 token. - [POST /token/refresh](../endpoints/post-token-refresh.md) for a refreshed UID2 token. -For an example, see [Sample Token Response Object](#sample-token-response-object). +For an example, see [Sample token response object](#sample-token-response-object). As long as the refresh token remains valid, the UID2 Prebid module refreshes the UID2 token as needed. This section includes the following information: -- [Client Refresh Mode Response Configuration Options](#client-refresh-mode-response-configuration-options) -- [Client Refresh Mode Cookie Example](#client-refresh-mode-cookie-example) -- [Client Refresh Mode uid2Token Example](#client-refresh-mode-uid2token-example) -- [Passing a New Token: Client Refresh Mode](#passing-a-new-token-client-refresh-mode) +- [Client refresh mode response configuration options](#client-refresh-mode-response-configuration-options) +- [Client refresh mode cookie example](#client-refresh-mode-cookie-example) +- [Client refresh mode uid2token example](#client-refresh-mode-uid2token-example) +- [Passing a new token: Client refresh mode](#passing-a-new-token-client-refresh-mode) -#### Client Refresh Mode Response Configuration Options +#### Client refresh mode response configuration options 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 | | --- | --- | --- | -| 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:
  • If you are already storing a lot of data in the cookie and adding the response body might exceed the cookie size limit.
  • If you prefer to have the Prebid module store the token value for you.
| +| 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:
  • If you are already storing a lot of data in the cookie and adding the response body might exceed the cookie size limit.
  • If you prefer to have the Prebid module store the token value for you.
| -#### Client Refresh Mode Cookie Example +#### Client refresh mode cookie example In Client Refresh mode, Prebid.js takes care of refreshing the token. To do this, you must configure it to store the token. The following example shows the cookie and also the configuration for storing the token in a cookie called `uid2_pub_cookie`. @@ -157,11 +157,11 @@ pbjs.setConfig({ }); ``` -For an example of the token, see [Sample Token Response Object](#sample-token-response-object). +For an example of the token, see [Sample token response object](#sample-token-response-object). -#### Client Refresh Mode uid2Token Example +#### Client refresh mode uid2token example -The following example shows a sample configuration. For the contents of the token, see [Sample Token Response Object](#sample-token-response-object). +The following example shows a sample configuration. For the contents of the token, see [Sample token response object](#sample-token-response-object). ```js pbjs.setConfig({ @@ -180,13 +180,13 @@ pbjs.setConfig({ }); ``` -#### Passing a New Token: Client Refresh Mode +#### Passing a new token: Client refresh mode If the refresh token expires, you'll need to supply a new token response so that a new advertising token and a new refresh token are available for future refreshes. -For information on how to determine if you need to provide a new token, see [Determining Whether the Module Has a Valid Token](#determining-whether-the-module-has-a-valid-token). +For information on how to determine if you need to provide a new token, see [Determining whether the module has a valid token](#determining-whether-the-module-has-a-valid-token). -### Server-Only Mode +### Server-only mode In server-only mode, only the advertising token is provided to the module. The module cannot refresh the token. You are responsible for implementing a way to refresh the token. @@ -194,17 +194,17 @@ To configure the module to use server-only mode, do **one** of the following: | 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) | +| 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) | This section includes the following information: -- [Server-Only Mode Cookie Example](#server-only-mode-cookie-example) -- [Server-Only Mode Value Example](#server-only-mode-value-example) -- [Passing a New Token: Server-Only Mode](#passing-a-new-token-server-only-mode) +- [Server-only mode cookie example](#server-only-mode-cookie-example) +- [Server-only mode value example](#server-only-mode-value-example) +- [Passing a new token: Server-only mode](#passing-a-new-token-server-only-mode) -#### Server-Only Mode Cookie Example +#### Server-only mode cookie example -The following example stores the advertising token value in a cookie named `__uid2_advertising_token`. The value of the cookie is the value returned in the token response object (see [Sample Token Response Object](#sample-token-response-object)). +The following example stores the advertising token value in a cookie named `__uid2_advertising_token`. The value of the cookie is the value returned in the token response object (see [Sample token response object](#sample-token-response-object)). The configuration allows the UID2 module to retrieve the advertising token value from the cookie. @@ -226,7 +226,7 @@ pbjs.setConfig({ }); ``` -#### Server-Only Mode Value Example +#### Server-only mode value example The following example sets the `value` field to an ID block containing the advertising token without storing it in a cookie. @@ -245,13 +245,13 @@ pbjs.setConfig({ }); ``` -#### Passing a New Token: Server-Only Mode +#### Passing a new token: Server-only mode In server-only mode, since the Prebid.js UID2 module receives only the advertising token, the token is only valid for a short period of time. For this reason, it's best to provide an advertising token on each page load. -If needed, to determine if you need to provide a new token, see [Determining Whether the Module Has a Valid Token](#determining-whether-the-module-has-a-valid-token). +If needed, to determine if you need to provide a new token, see [Determining whether the module has a valid token](#determining-whether-the-module-has-a-valid-token). -## Prebid Implementation Notes and Tips +## Prebid implementation notes and tips In planning your Prebid implementation, consider the following: @@ -259,7 +259,7 @@ In planning your Prebid implementation, consider the following: - If you provide a new token that doesn't match the original token used to generate any refreshed tokens, the module discards all stored tokens and uses the new token instead, and keeps it refreshed. -- During integration testing, set `params.uid2ApiBase` to `"https://operator-integ.uidapi.com"`. You must set this value to the same environment (production or integration) that you use for generating tokens (for credentials, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials)). +- During integration testing, set `params.uid2ApiBase` to `"https://operator-integ.uidapi.com"`. You must set this value to the same environment (production or integration) that you use for generating tokens (for credentials, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials)). - For a Prebid.js client-server integration, you can create a smaller Prebid.js build by disabling client-side integration functionality. To do this, pass the `--disable UID2_CSTG` flag: @@ -267,11 +267,11 @@ In planning your Prebid implementation, consider the following: $ gulp build --modules=uid2IdSystem --disable UID2_CSTG ``` -## Storing the UID2 Token in the Browser +## Storing the UID2 token in the browser -## Determining Whether the Module Has a Valid Token +## Determining whether the module has a valid token You can do a check to determine whether the Prebid.js module has a valid token or you need to provide a new one. @@ -302,7 +302,7 @@ if (!pbjs.getUserIds().uid2) { If you configure a user ID by calling `setConfig` (or any similar function) twice, you will need to call `refreshUserIds` for the user ID submodules, to reinitialize their ID values. ::: -## Checking the Integration +## Checking the integration To check that the UID2 module has a valid UID2 token, call `pbjs.getUserIds().uid2`. If a value is returned, a valid UID2 token exists in the UID2 module. @@ -318,7 +318,7 @@ An example of a tool for validating and debugging Prebid.js configuration is Pro - Chrome web store download location: [Professor Prebid](https://chromewebstore.google.com/detail/professor-prebid/kdnllijdimhbledmfdbljampcdphcbdc) - Documentation on prebid.org: [Professor Prebid User Guide](https://docs.prebid.org/tools/professor-prebid.html) -## Configuration Parameters for userSync +## Configuration parameters for usersync The following parameters apply only to the UID2 Prebid User ID Module integration. @@ -327,13 +327,13 @@ In this table, CR = client refresh mode, SO = server-only mode, and N/A = not ap | 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) | -| params.uid2Token | CR: Optional
SO: N/A | Object | The initial UID2 token. This should be the `body` element of the decrypted response from a call to the `/token/generate` or `/token/refresh` endpoint. | See [Sample Token Response Object](#sample-token-response-object) | -| params.uid2Cookie | CR: Optional
SO: N/A | String | The name of a cookie that holds the initial UID2 token, set by the server. The cookie should contain JSON in the same format as the uid2Token param. If `uid2Token` is supplied, this parameter is ignored. | See [Sample Token Response Object](#sample-token-response-object) | -| params.uid2ApiBase | CR: Optional
SO: Optional | String | Overrides the default UID2 API endpoint. For details, and an example, see [Optional: Specifying the API Base URL to Reduce Latency](#optional-specifying-the-api-base-url-to-reduce-latency). | `"https://prod.uidapi.com"` (the default)| +| 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) | +| params.uid2Token | CR: Optional
SO: N/A | Object | The initial UID2 token. This should be the `body` element of the decrypted response from a call to the `/token/generate` or `/token/refresh` endpoint. | See [Sample token response object](#sample-token-response-object) | +| params.uid2Cookie | CR: Optional
SO: N/A | String | The name of a cookie that holds the initial UID2 token, set by the server. The cookie should contain JSON in the same format as the uid2Token param. If `uid2Token` is supplied, this parameter is ignored. | See [Sample token response object](#sample-token-response-object) | +| params.uid2ApiBase | CR: Optional
SO: Optional | String | Overrides the default UID2 API endpoint. For details, and an example, see [Optional: Specifying the API base URL to reduce latency](#optional-specifying-the-api-base-url-to-reduce-latency). | `"https://prod.uidapi.com"` (the default)| | params.storage | CR: Optional
SO: Optional | String | Specify the module internal storage method: `cookie` or `localStorage`. We recommend that you do not provide this parameter. Instead, allow the module to use the default. | `"localStorage"` (the default) | -### Configuration Parameter Examples: Value +### Configuration parameter examples: Value The following code snippet shows an example of the `value` UID2 configuration parameter. @@ -352,7 +352,7 @@ pbjs.setConfig({ }); ``` -### Sample Token Response Object +### Sample token response object The following sample is fictitious, but shows what the token response object, returned from either the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint, looks like: @@ -367,7 +367,7 @@ The following sample is fictitious, but shows what the token response object, re } ``` -## Optional: Specifying the API Base URL to Reduce Latency +## Optional: Specifying the API base URL to reduce latency By default, the UID2 module makes calls to a UID2 production environment server in the USA. @@ -389,14 +389,14 @@ pbjs.setConfig({ }); ``` -## Optional: Prebid.js Integration with Google Secure Signals +## Optional: Prebid.js integration with Google Secure Signals if you're using Prebid.js, and you're planning to pass UID2 tokens to Google using Google Secure Signals, there are a couple of additional configuration steps: -- In your Google Ad Manager account, make sure that encrypted signals are properly shared with third-party bidders: see [Allow Secure Signals Sharing](integration-google-ss.md#allow-secure-signals-sharing). +- In your Google Ad Manager account, make sure that encrypted signals are properly shared with third-party bidders: see [Allow Secure Signals sharing](integration-google-ss.md#allow-secure-signals-sharing). - Update your Prebid.js configuration: see [Optional: Enable Secure Signals in Prebid.js](integration-google-ss.md#optional-enable-secure-signals-in-prebidjs). -## Sample Implementation +## Sample implementation The following sample implementation is available to illustrate how to integrate UID2 with Prebid.js using client-server integration: diff --git a/docs/guides/integration-prebid-client-side.md b/docs/guides/integration-prebid-client-side.md index c730dbb6a..b82931912 100644 --- a/docs/guides/integration-prebid-client-side.md +++ b/docs/guides/integration-prebid-client-side.md @@ -14,29 +14,29 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai import SnptAddPrebidjsToYourSite from '../snippets/_snpt-prebid-add-prebidjs-to-your-site.mdx'; import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx'; -# UID2 Client-Side Integration Guide for Prebid.js +# UID2 client-side integration guide for Prebid.js This guide is for publishers who have access to DII (email address or phone number) on the client side and want to integrate with UID2 and generate UID2 tokens (advertising tokens) to be passed by Prebid.js in the RTB bidstream. To integrate with UID2 using Prebid.js, you'll need to make changes to the HTML and JavaScript on your site. No server-side work is required if you follow this guide. -## Prebid.js Version +## Prebid.js version This implementation requires Prebid.js version 8.21.0 or later. For version information, see [https://github.com/prebid/Prebid.js/releases](https://github.com/prebid/Prebid.js/releases). -If you need to use an earlier version of Prebid.js, use the implementation solution presented in the [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) instead. +If you need to use an earlier version of Prebid.js, use the implementation solution presented in the [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) instead. -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Integration Overview: High-Level Steps +## Integration overview: High-level steps You'll need to complete the following steps: @@ -44,31 +44,31 @@ You'll need to complete the following steps: 2. [Add Prebid.js to your site](#add-prebidjs-to-your-site) 3. [Configure the UID2 module](#configure-the-uid2-module) -### Complete UID2 Account Setup and Configure Account +### Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production [environment](../getting-started/gs-environments.md) and configure additional values that you'll need to provide. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production [environment](../getting-started/gs-environments.md) and configure additional values that you'll need to provide. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -For a client-side integration you'll need to set up these values, in the UID2 Portal on the [Client-Side Integration](../portal/client-side-integration.md) page: +For a client-side integration you'll need to set up these values, in the UID2 Portal on the [Client-side integration](../portal/client-side-integration.md) page: -- Subscription ID and Public Key: See [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) +- Subscription ID and Public Key: See [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) -- A list of **domain names** for the sites on which you'll be using Prebid.js: See [Adding and Managing Root-Level Domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) +- A list of **domain names** for the sites on which you'll be using Prebid.js: See [Adding and managing root-level domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) :::tip Only root-level domains are required for account setup. For example, if you're going to use UID2 with Prebid.js on example.com, shop.example.com, and example.org, you only need to provide the domain names example.com and example.org. ::: -### Add Prebid.js to Your Site +### Add Prebid.js to your site -### Configure the UID2 Module +### Configure the UID2 module To configure the UID2 module, call `pbjs.setConfig` with an object containing the **public key** and **Subscription ID** that you received during account setup, as well as the user's hashed or unhashed email address or phone number. @@ -89,11 +89,11 @@ Notes: 1. Then hash the result using the SHA-256 hashing algorithm. 1. Then encode the resulting bytes of the hash value using Base64 encoding. - For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). For an example, see [Configuring the UID2 Module: Code Example](#configuring-the-uid2-module-code-example). + For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md). For an example, see [Configuring the UID2 module: Code example](#configuring-the-uid2-module-code-example). - The UID2 module encrypts the hashed DII before sending it to the UID2 service. - If the module is configured multiple times, it uses the most recent configuration values. -#### Configuring the UID2 Module: Code Example +#### Configuring the UID2 module: Code example The following code snippet demonstrates the different ways that you can configure the UID2 module. @@ -117,14 +117,14 @@ const baseConfig = { ``` :::note -This example assumes that you're using the UID2 production environment. During integration testing, use the UID2 integration environment by setting `params.uid2ApiBase` to `'https://operator-integ.uidapi.com'`. Tokens from the UID2 integration environment are not valid for passing to the bidstream. For the integration environment, you will need to request separate **Subscription ID** and **public key** values; you cannot create those in the UID2 Portal. For details, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials). +This example assumes that you're using the UID2 production environment. During integration testing, use the UID2 integration environment by setting `params.uid2ApiBase` to `'https://operator-integ.uidapi.com'`. Tokens from the UID2 integration environment are not valid for passing to the bidstream. For the integration environment, you will need to request separate **Subscription ID** and **public key** values; you cannot create those in the UID2 Portal. For details, see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials). ::: -## Storing the UID2 Token in the Browser +## Storing the UID2 token in the browser -## When to Pass DII to the UID2 Module +## When to pass DII to the UID2 module When the UID2 module is configured, it checks for an existing UID2 token in the user's browser. If there is a token that was generated from the same DII, and either it's still valid or it can be refreshed, the module uses it, and refreshes if needed. @@ -180,7 +180,7 @@ The following example shows the decoded UID2 userId object: } ``` -## Checking the Integration +## Checking the integration To check that the UID2 module has successfully generated a UID2 token, call `pbjs.getUserIds().uid2`. If a value is returned, a valid UID2 token exists in the UID2 module. @@ -189,7 +189,7 @@ If there are problems with the integration, here are some steps you can take: - Check the browser console logs. - Check the values for **Subscription ID** (**subscriptionId** value) and **public key** (**serverPublicKey** value): - Make sure they are exactly the same values that you received from the UID2 team. - - Check that you have the correct values for the environment you're using. You'll have different **Subscription ID** and **public key** values for each environment: see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials). + - Check that you have the correct values for the environment you're using. You'll have different **Subscription ID** and **public key** values for each environment: see [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials). - Check that you provided the domain name of the site to the UID2 team during account setup. If needed, to confirm, ask your UID2 contact. - Use the browser developer tools to inspect the API calls to the UID2 service. @@ -200,7 +200,7 @@ An example of a tool for validating and debugging Prebid.js configuration is Pro - Chrome web store download location: [Professor Prebid](https://chromewebstore.google.com/detail/professor-prebid/kdnllijdimhbledmfdbljampcdphcbdc) - Documentation on prebid.org: [Professor Prebid User Guide](https://docs.prebid.org/tools/professor-prebid.html) -## Optional: Specifying the API Base URL to Reduce Latency +## Optional: Specifying the API base URL to reduce latency By default, the UID2 module makes calls to a UID2 production environment server in the USA. @@ -222,7 +222,7 @@ pbjs.setConfig({ }); ``` -## Optional: Deferred Client-Side UID2 Configuration with mergeConfig +## Optional: Deferred client-side UID2 configuration with mergeconfig If you already have Prebid.js configured but didn't include UID2 in the initial setup, you can still add the UID2 module using two functions provided by Prebid.js: @@ -260,18 +260,18 @@ Once you add UID2 to your configuration, Prebid does not provide functionality t If you are managing the UID2 SDK separately, use `window.__uid2.disconnect()` which handles all logout functionality—clearing both memory and storage—without requiring a page refresh. ::: -A sample implementation for deferred configuration is also available. For details, see [Sample Implementations](#sample-implementations). +A sample implementation for deferred configuration is also available. For details, see [Sample implementations](#sample-implementations). -## Optional: Prebid.js Integration with Google Secure Signals +## Optional: Prebid.js integration with Google Secure Signals if you're using Prebid.js, and you're planning to pass UID2 tokens to Google using Google Secure Signals, there are a couple of additional configuration steps: -- In your Google Ad Manager account, make sure that encrypted signals are properly shared with third-party bidders: see [Allow Secure Signals Sharing](integration-google-ss.md#allow-secure-signals-sharing). +- In your Google Ad Manager account, make sure that encrypted signals are properly shared with third-party bidders: see [Allow Secure Signals sharing](integration-google-ss.md#allow-secure-signals-sharing). - Update your Prebid.js configuration: see [Optional: Enable Secure Signals in Prebid.js](integration-google-ss.md#optional-enable-secure-signals-in-prebidjs). -A sample implementation for Prebid.js with Secure Signals is also available. For details, see [Sample Implementations](#sample-implementations). +A sample implementation for Prebid.js with Secure Signals is also available. For details, see [Sample implementations](#sample-implementations). -## Sample Implementations +## Sample implementations The following sample implementations are available to illustrate how to integrate UID2 with Prebid.js on the client side: diff --git a/docs/guides/integration-prebid-mobile-summary.md b/docs/guides/integration-prebid-mobile-summary.md index 3c9b9fa0f..01dc4fbfc 100644 --- a/docs/guides/integration-prebid-mobile-summary.md +++ b/docs/guides/integration-prebid-mobile-summary.md @@ -10,11 +10,11 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Mobile Integration with Prebid Mobile SDK +# UID2 mobile integration with Prebid Mobile SDK UID2 integration with Prebid is also supported for Android and iOS mobile devices, using the UID2 integration with Prebid Mobile SDK option. For details, see the following sections of the mobile integration guides: -- [UID2 Client-Side Integration Guide for Mobile: UID2 Integration with Prebid Mobile SDK](integration-mobile-client-side#optional-uid2-integration-with-prebid-mobile-sdk) -- [UID2 Client-Server Integration Guide for Mobile: UID2 Integration with Prebid Mobile SDK](integration-mobile-client-server#optional-uid2-integration-with-prebid-mobile-sdk) +- [UID2 client-side integration guide for mobile: UID2 integration with Prebid Mobile SDK](integration-mobile-client-side#optional-uid2-integration-with-prebid-mobile-sdk) +- [UID2 client-server integration guide for mobile: UID2 integration with Prebid Mobile SDK](integration-mobile-client-server#optional-uid2-integration-with-prebid-mobile-sdk) diff --git a/docs/guides/integration-prebid.md b/docs/guides/integration-prebid.md index 42c320d02..0708e14a1 100644 --- a/docs/guides/integration-prebid.md +++ b/docs/guides/integration-prebid.md @@ -13,19 +13,19 @@ import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx'; -# UID2 Integration Overview for Prebid +# UID2 integration overview for Prebid This guide is an overview of integration options for publishers who want to integrate with UID2 and generate UID2 tokens (advertising tokens) to be passed by Prebid.js or the Prebid Mobile SDK in the RTB bidstream. -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Prebid.js Support for Web +## Prebid.js support for web UID2 provides a Prebid.js module that supports the following: @@ -42,7 +42,7 @@ UID2 is not designed to be used where UID2 tokens (advertising tokens) for the RTB bidstream, with all integration activity on the server side. The following options are available for publishers to integrate with UID2 on the server side: -- SDK for Java (see [Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers) section). -- SDK for Python (see [Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers) section). +- SDK for Java (see [Usage for publishers](../sdks/sdk-ref-java.md#usage-for-publishers) section). +- SDK for Python (see [Usage for publishers](../sdks/sdk-ref-python.md#usage-for-publishers) section). - Custom server code to generate and refresh the UID2 token by calling the [POST /token/generate](../endpoints/post-token-generate.md) and [POST /token/refresh](../endpoints/post-token-refresh.md) endpoints. -There is also a sample implementation that demonstrates the workflow. See [Sample Implementation](#sample-implementation). +There is also a sample implementation that demonstrates the workflow. See [Sample implementation](#sample-implementation). -For a complete summary of publisher integration options, see [Publisher Integrations](summary-guides.md#publisher-integrations). +For a complete summary of publisher integration options, see [Publisher integrations](summary-guides.md#publisher-integrations). :::tip -To facilitate the process of establishing client identity using UID2 and retrieving UID2 tokens, consider using the SDK for JavaScript. For details, see [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md). +To facilitate the process of establishing client identity using UID2 and retrieving UID2 tokens, consider using the SDK for JavaScript. For details, see [Client-server integration guide for JavaScript](integration-javascript-client-server.md). ::: ## Introduction @@ -42,36 +42,36 @@ The guide outlines the [basic steps](#integration-steps) that you need to consid See also [FAQs](#faqs). -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -For a server-side integration you'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page: +For a server-side integration you'll need to set up these values, in the UID2 Portal on the [API keys](../portal/api-keys.md) page: - API key, also called a client key - Client secret, a value known only to the participant and the UID2 service :::important -It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). +It's very important that you keep these values secure. For details, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). ::: -## Integration Steps +## Integration steps The following diagram outlines the steps required for a user to establish a UID2 token with a publisher and how the UID2 token integrates with the RTB bidstream. If you're using a server-side SDK, the SDK takes care of all the steps that mention endpoints: for example, step 1-d, the publisher sends the user's DII to the token generation service. -![Publisher Flow](images/integration-publisher-server-side-mermaid.png) +![Publisher flow](images/integration-publisher-server-side-mermaid.png) @@ -80,9 +80,9 @@ The following sections provide additional details for each step in the diagram: 1. [Establish identity: capture user data](#establish-identity-capture-user-data) 2. [Bid using a UID2 token](#bid-using-a-uid2-token) 3. [Refresh a UID2 token](#refresh-a-uid2-token) - 4. [Clear Identity: user logout](#clear-identity-user-logout) + 4. [Clear identity: user logout](#clear-identity-user-logout) -### Establish Identity: Capture User Data +### Establish identity: Capture user data After authentication in step 1-c, which allows the publisher to validate the user's email address or phone number, the publisher can send a request to generate a UID2 token, on the server side. The following table details the token generation steps. @@ -96,7 +96,7 @@ Rather than calling this endpoint directly, you could use one of the SDKs to man | 1-e | [POST /token/generate](../endpoints/post-token-generate.md) | Return a UID2 token generated from the user's hashed or unhashed email address or phone number, plus associated values such as the refresh token. | | 1-f | N/A | Place the returned `advertising_token` and `refresh_token` in a store tied to a user. You might consider client-side storage, such as a first-party cookie, or server-side storage. | -### Bid Using a UID2 Token +### Bid using a UID2 token Consider how you want to manage UID2 identity information and use it for targeted advertising; for example, to pass the returned UID2 token to SSPs. @@ -108,11 +108,11 @@ Consider how you want to manage UID2 identity information and use it for targete For an example of what a UID2 token might look like in the bidstream, when it's sent from an SSP to a DSP, see [What does a UID2 token look like in the bidstream?](../getting-started/gs-faqs.md#what-does-a-uid2-token-look-like-in-the-bidstream). ::: -### Refresh a UID2 Token +### Refresh a UID2 token Use the `POST /token/refresh` endpoint to make sure you always have a valid and up-to-date UID2 token. The UID2 token must be refreshed to sync with the UID2 rotation. In addition, the token refresh process checks the user's opt-out status, and if the user has opted out, no new token is sent. This ends the token refresh chain, and you must not use that UID2 token again. -For details about the UID2 opt-out workflow and how users can opt out, see [User Opt-Out](../getting-started/gs-opt-out.md). +For details about the UID2 opt-out workflow and how users can opt out, see [User opt-out](../getting-started/gs-opt-out.md). | Step | Endpoint | Description | | :--- | :--- | :--- | @@ -125,7 +125,7 @@ For details about the UID2 opt-out workflow and how users can opt out, see [User Refresh tokens starting from the `refresh_from` timestamp, which is part of the identity returned by the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) endpoints. ::: -### Clear Identity: User Logout +### Clear identity: User logout If the user logs out, do not use the UID2 token. @@ -134,7 +134,7 @@ If the user logs out, do not use the UID2 token. | 4-a | N/A | The user logs out from a publisher asset. | | 4-b | N/A | Remove the UID2 token you've stored for that user. No interaction with the UID2 service is required. | -## Sample Implementation +## Sample implementation A sample implementation is available for server-side integration: @@ -143,4 +143,4 @@ A sample implementation is available for server-side integration: ## FAQs -For a list of frequently asked questions for the publisher audience, see [FAQs for Publishers](../getting-started/gs-faqs.md#faqs-for-publishers). +For a list of frequently asked questions for the publisher audience, see [FAQs for publishers](../getting-started/gs-faqs.md#faqs-for-publishers). diff --git a/docs/guides/integration-snowflake-before-february-2025.md b/docs/guides/integration-snowflake-before-february-2025.md index 465deb823..549e6af60 100644 --- a/docs/guides/integration-snowflake-before-february-2025.md +++ b/docs/guides/integration-snowflake-before-february-2025.md @@ -10,20 +10,20 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Snowflake Integration Guide (Pre-Feb 2025) +# Snowflake integration guide (pre-Feb 2025) [Snowflake](https://www.snowflake.com/) is a cloud data warehousing solution, where you as a partner can store your data and integrate with the UID2 framework. Using Snowflake, UID2 enables you to securely share consumer identifier data without exposing sensitive directly identifying information (DII). Even though you have the option to query the Operator Web Services directly for the consumer identifier data, the Snowflake UID2 integration offers a more seamless experience. :::important -This document is for anyone using the separate advertiser and data provider Snowflake marketplace listings published prior to February 2025. For documentation on the latest version, see [Snowflake Integration Guide](integration-snowflake.md). If you're using any earlier implementation, we recommend that you migrate to the latest version to take advantage of the updates and enhancements. For migration information, see [Migration Guide](integration-snowflake.md#migration-guide). +This document is for anyone using the separate advertiser and data provider Snowflake marketplace listings published prior to February 2025. For documentation on the latest version, see [Snowflake integration guide](integration-snowflake.md). If you're using any earlier implementation, we recommend that you migrate to the latest version to take advantage of the updates and enhancements. For migration information, see [Migration guide](integration-snowflake.md#migration-guide). ::: The Snowflake marketplace listings for this implementation were separate for advertisers and for data providers. Those listings were removed following the publication of the updated version in February 2025. -If you have a working implementation, you can use this documentation to maintain it; however, we recommend upgrading to the latest version. See [Snowflake Integration Guide](integration-snowflake.md). +If you have a working implementation, you can use this documentation to maintain it; however, we recommend upgrading to the latest version. See [Snowflake integration guide](integration-snowflake.md). :::tip -For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md). +For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md). ::: ## Functionality @@ -37,21 +37,21 @@ The following table summarizes the functionality available with the UID2 Snowfla *You cannot use Snowflake to generate a UID2 token directly from DII. However, you can convert DII to a raw UID2, and then encrypt the raw UID2 into a UID2 token. :::note -If you are a publisher who is sharing UID2 tokens in the bidstream, see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +If you are a publisher who is sharing UID2 tokens in the bidstream, see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: -## Workflow Diagram +## Workflow diagram The following diagram and table illustrate the different parts of the UID2 integration process in Snowflake, and the workflow. -![Snowflake Integration Architecture](images/uid2-snowflake-integration-architecture-drawio.png) +![Snowflake integration architecture](images/uid2-snowflake-integration-architecture-drawio.png) |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. | |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 +## Access the UID2 shares Access to the UID2 Share is available through the [Snowflake Data Marketplace](https://www.snowflake.com/data-marketplace/), where you can request specific data sets based on the UID2 personalized listing you select. @@ -75,7 +75,7 @@ To request access to a UID2 Share, complete the following steps: After your request is received, a UID2 administrator will contact you with the appropriate access instructions. For details about managing data requests in Snowflake, see the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/data-marketplace-consumer.html). -## Shared Objects +## Shared objects Regardless of the UID2 solution you choose, you can map DII to UID2s by using the following function: @@ -87,18 +87,18 @@ The following functions are deprecated in favor of `FN_T_UID2_IDENTITY_MAP`. You - `FN_T_UID2_IDENTITY_MAP_EMAIL_HASH` (deprecated) :::note -If you are using the deprecated functions, and need help migrating to the newer function, see [Migration Guide](#migration-guide). +If you are using the deprecated functions, and need help migrating to the newer function, see [Migration guide](#migration-guide). ::: -To identify the UID2s that you must regenerate, use the `UID2_SALT_BUCKETS` view from the UID2 Share. For details, see [Monitor for Salt Bucket Rotation and Regenerate Raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s). +To identify the UID2s that you must regenerate, use the `UID2_SALT_BUCKETS` view from the UID2 Share. For details, see [Monitor for salt bucket rotation and regenerate raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s). The following functions are also available, for UID2 sharing participants: -- `FN_T_UID2_ENCRYPT` (See [Encrypt Tokens](#encrypt-tokens)) -- `FN_T_UID2_DECRYPT` (See [Decrypt Tokens](#decrypt-tokens)) +- `FN_T_UID2_ENCRYPT` (See [Encrypt tokens](#encrypt-tokens)) +- `FN_T_UID2_DECRYPT` (See [Decrypt tokens](#decrypt-tokens)) -For details, see [Usage for UID2 Sharers](#usage-for-uid2-sharers). +For details, see [Usage for UID2 sharers](#usage-for-uid2-sharers). -### Database and Schema Names +### Database and schema names The following sections include query examples for each solution, which are identical except for the database and schema name variables: @@ -121,9 +121,9 @@ All query examples use the following default values for each name variable: To map all types of DII, use the `FN_T_UID2_IDENTITY_MAP` function. -If the DII is an email address, the service normalizes the data using the UID2 [Email Address Normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) rules. +If the DII is an email address, the service normalizes the data using the UID2 [Email address normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) rules. -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. +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| | :--- | :--- | :--- | @@ -136,9 +136,9 @@ A successful query returns the following information for the specified DII. | :--- | :--- | :--- | | `UID2` | TEXT | The value is one of the following:
  • DII was successfully mapped: The UID2 associated with the DII.
  • DII was not successfully mapped: `NULL`.
| | `BUCKET_ID` | TEXT | The value is one of the following:
  • DII was successfully mapped: The ID of the salt bucket used to generate the UID2. This ID maps to the bucket ID in the `UID2_SALT_BUCKETS` view.
  • DII was not successfully mapped: `NULL`.
| -| `UNMAPPED` | TEXT | The value is one of the following:
  • DII was successfully mapped: `NULL`.
  • DII was not successfully mapped: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.
    For details, see [Values for the UNMAPPED Column](#values-for-the-unmapped-column).
| +| `UNMAPPED` | TEXT | The value is one of the following:
  • DII was successfully mapped: `NULL`.
  • DII was not successfully mapped: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.
    For details, see [Values for the unmapped column](#values-for-the-unmapped-column).
| -#### Values for the UNMAPPED Column +#### Values for the unmapped column The following table shows possible values for the `UNMAPPED` column. @@ -153,20 +153,20 @@ The following table shows possible values for the `UNMAPPED` column. Mapping request examples in this section: -- [Single Unhashed Email](#mapping-request-example---single-unhashed-email) -- [Multiple Unhashed Emails](#mapping-request-example---multiple-unhashed-emails) -- [Single Unhashed Phone Number](#mapping-request-example---single-unhashed-phone-number) -- [Multiple Unhashed Phone Numbers](#mapping-request-example---multiple-unhashed-phone-numbers) -- [Single Hashed Email](#mapping-request-example---single-hashed-email) -- [Multiple Hashed Emails](#mapping-request-example---multiple-hashed-emails) -- [Single Hashed Phone Number](#mapping-request-example---single-hashed-phone-number) -- [Multiple Hashed Phone Numbers](#mapping-request-example---multiple-hashed-phone-numbers) +- [Single unhashed email](#mapping-request-example---single-unhashed-email) +- [Multiple unhashed emails](#mapping-request-example---multiple-unhashed-emails) +- [Single unhashed phone number](#mapping-request-example---single-unhashed-phone-number) +- [Multiple unhashed phone numbers](#mapping-request-example---multiple-unhashed-phone-numbers) +- [Single hashed email](#mapping-request-example---single-hashed-email) +- [Multiple hashed emails](#mapping-request-example---multiple-hashed-emails) +- [Single hashed phone number](#mapping-request-example---single-hashed-phone-number) +- [Multiple hashed phone numbers](#mapping-request-example---multiple-hashed-phone-numbers) :::note The input and output data in these examples is fictitious, for illustrative purposes only. The values provided are not real values. ::: -#### Mapping Request Example - Single Unhashed Email +#### Mapping request example - single unhashed email The following queries illustrate how to map a single email address, using the [default database and schema names](#database-and-schema-names). @@ -192,7 +192,7 @@ Query results for a single email: +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Emails +#### Mapping request example - multiple unhashed emails The following queries illustrate how to map multiple email addresses, using the [default database and schema names](#database-and-schema-names). @@ -227,11 +227,11 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Unhashed Phone Number +#### Mapping request example - single unhashed phone number The following queries illustrate how to map a phone number, using the [default database and schema names](#database-and-schema-names). -You must normalize phone numbers using the UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. +You must normalize phone numbers using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. Advertiser solution query for a single phone number: @@ -255,11 +255,11 @@ Query results for a single phone number: +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Phone Numbers +#### Mapping request example - multiple unhashed phone numbers The following queries illustrate how to map multiple phone numbers, using the [default database and schema names](#database-and-schema-names). -You must normalize phone numbers using the UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. +You must normalize phone numbers using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. Advertiser solution query for multiple phone numbers: @@ -292,7 +292,7 @@ The following table identifies each item in the response, including `NULL` value +----+--------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Email +#### Mapping request example - single hashed email The following queries illustrate how to map a single email address hash, using the [default database and schema names](#database-and-schema-names). @@ -318,7 +318,7 @@ Query results for a single hashed email: +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Emails +#### Mapping request example - multiple hashed emails The following queries illustrate how to map multiple email address hashes, using the [default database and schema names](#database-and-schema-names). @@ -352,7 +352,7 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Phone Number +#### Mapping request example - single hashed phone number The following queries illustrate how to map a single phone number hash, using the [default database and schema names](#database-and-schema-names). @@ -378,7 +378,7 @@ Query results for a single hashed phone number: +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Phone Numbers +#### Mapping request example - multiple hashed phone numbers The following queries illustrate how to map multiple phone number hashes, using the [default database and schema names](#database-and-schema-names). @@ -412,7 +412,7 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+----------------------------------------------+------------+--------------------+ ``` -### Monitor for Salt Bucket Rotation and Regenerate Raw UID2s +### Monitor for salt bucket rotation and regenerate raw UID2s The `UID2_SALT_BUCKETS` view query returns the date and time when the salt buckets were last updated. Salt is used when generating UID2s. When the salt in the bucket is updated, the previously generated UID2 becomes outdated and doesn’t match the UID2 generated by other parties for the same user. @@ -425,7 +425,7 @@ To determine which UID2s need regeneration, compare the timestamps of when they The following example shows an input table and the query used to find the UID2s in the table that must be regenerated because the salt was updated. -#### Targeted Input Table +#### Targeted input table In this example scenario, the advertiser/data provider has stored the UID2s in a table named `AUDIENCE_WITH_UID2`. The last column, `LAST_UID2_UPDATE_UTC`, is used to record the time at which a UID2 was generated. If no UID2 has been generated, the value is `NULL`, as shown in the third example. The advertiser/data provider can use this timestamp value to determine which UID2s need to be regenerated. @@ -475,7 +475,7 @@ The following table identifies each item in the response. The result includes an +----+----------------------+----------------------------------------------+------------+-------------------------+-------------------------+ ``` -## Migration Guide +## Migration guide If you are using the `FN_T_UID2_IDENTITY_MAP_EMAIL` and `FN_T_UID2_IDENTITY_MAP_EMAIL_HASH` functions, it's best to migrate to the `FN_T_UID2_IDENTITY_MAP` function as soon as possible. This function does everything that the other two functions do, and has other built-in improvements. @@ -483,14 +483,14 @@ Advantages of the `FN_T_UID2_IDENTITY_MAP` function: - It supports mapping both phone numbers and hashed phone numbers. - It supports user opt-out. -- It adds a new column, `UNMAPPED`. In any scenario where the DII cannot be mapped to a UID2 for any reason, this column includes information about the reason.
For details, see [Values for the UNMAPPED Column](#values-for-the-unmapped-column) +- It adds a new column, `UNMAPPED`. In any scenario where the DII cannot be mapped to a UID2 for any reason, this column includes information about the reason.
For details, see [Values for the unmapped column](#values-for-the-unmapped-column) This section includes the following information to help you upgrade to the new function: -- [Changing Existing Code](#changing-existing-code) -- [Using the Values for the UNMAPPED Column](#using-the-values-for-the-unmapped-column) +- [Changing existing code](#changing-existing-code) +- [Using the values for the unmapped column](#using-the-values-for-the-unmapped-column) -### Changing Existing Code +### Changing existing code The code snippets in this section are before/after examples of how the earlier functions might be implemented, and how you could update to use the new function. @@ -522,29 +522,29 @@ After: FN_T_UID2_IDENTITY_MAP(EMAIL_HASH, 'email_hash') ``` -### Using the Values for the UNMAPPED Column +### Using the values for the unmapped column When you have the new function implemented, you can check the `UNMAPPED` column returned by the `FN_T_UID2_IDENTITY_MAP`. If any DII could not be mapped to a UID2, this column gives the reason. -For details about the values and their explanations, see [Values for the UNMAPPED Column](#values-for-the-unmapped-column). +For details about the values and their explanations, see [Values for the unmapped column](#values-for-the-unmapped-column). -## Usage for UID2 Sharers +## Usage for UID2 sharers A UID2 sharing participant is a company that takes part in sharing, either as a sender or a receiver, to share UID2s with another participant. -Advertisers and data providers can share UID2s with other authorized UID2 sharing participants via Snowflake (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels within Snowflake, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +Advertisers and data providers can share UID2s with other authorized UID2 sharing participants via Snowflake (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels within Snowflake, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). :::caution -The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: -If you are not sending data in pixels or in the bidstream within Snowflake, you can also take part in raw UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +If you are not sending data in pixels or in the bidstream within Snowflake, you can also take part in raw UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). The following activities support tokenized sharing: -- [Encrypt Tokens](#encrypt-tokens) -- [Decrypt Tokens](#decrypt-tokens) +- [Encrypt tokens](#encrypt-tokens) +- [Decrypt tokens](#decrypt-tokens) -### Encrypt Tokens +### Encrypt tokens To encrypt raw UID2s to UID2 tokens, use the `FN_T_UID2_ENCRYPT` function. Use the applicable prefix to indicate your role: - For advertisers: `ADV.FN_T_UID2_ENCRYPT` @@ -559,9 +559,9 @@ A successful query returns the following information for the specified raw UID2. |Column Name|Data Type|Description| | :--- | :--- | :--- | | `UID2_TOKEN` | TEXT | The value is one of the following:
  • Encryption successful: The UID2 token containing the raw UID2.
  • Encryption not successful: `NULL`.
| -| `ENCRYPTION_STATUS` | TEXT | The value is one of the following:
  • Encryption successful: `NULL`.
  • Encryption not successful: The reason why the raw UID2 was not encrypted. For example: `INVALID_RAW_UID2` or `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.
    For details, see [Values for the ENCRYPTION_STATUS Column](#values-for-the-encryption_status-column).
| +| `ENCRYPTION_STATUS` | TEXT | The value is one of the following:
  • Encryption successful: `NULL`.
  • Encryption not successful: The reason why the raw UID2 was not encrypted. For example: `INVALID_RAW_UID2` or `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.
    For details, see [Values for the encryption_status column](#values-for-the-encryption_status-column).
| -#### Values for the ENCRYPTION_STATUS Column +#### Values for the encryption_status column The following table shows possible values for the `ENCRYPTION_STATUS` column. @@ -574,7 +574,7 @@ The following table shows possible values for the `ENCRYPTION_STATUS` column. | `NOT_AUTHORIZED_FOR_MASTER_KEY` | The caller does not have access to the required encryption keys. Contact the UID2 administrator. | | `NOT_AUTHORIZED_FOR_SITE_KEY` | The caller does not have access to the required encryption keys. Contact the UID2 administrator. | -#### Encrypt Token Request Example - Single Raw UID2 +#### Encrypt token request example - single raw UID2 The following queries illustrate how to encrypt a single raw UID2 to a UID2 token, using the [default database and schema names](#database-and-schema-names). @@ -600,7 +600,7 @@ Query results for a single raw UID2: +--------------------------------------------+ ``` -#### Encrypt Token Request Example - Multiple Raw UID2s +#### Encrypt token request example - multiple raw UID2s The following queries illustrate how to encrypt multiple raw UID2s, using the [default database and schema names](#database-and-schema-names). @@ -630,7 +630,7 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+-----------------------+-----------------------------+ ``` -### Decrypt Tokens +### Decrypt tokens To decrypt UID2 tokens to raw UID2s, use the `FN_T_UID2_DECRYPT` function. Use the applicable prefix to indicate your role: - For advertisers: `ADV.FN_T_UID2_DECRYPT` @@ -646,13 +646,13 @@ A successful query returns the following information for the specified UID2 toke | :--- | :--- | :--- | | `UID2` | TEXT | The value is one of the following:
  • Decryption successful: The raw UID2 corresponding to the UID2 token.
  • Decryption not successful: `NULL`.
| | `SITE_ID` | INT | The value is one of the following:
  • Decryption successful: The identifier of the UID2 participant that encrypted the token.
  • Decryption not successful: `NULL`.
| -| `DECRYPTION_STATUS` | TEXT | The value is one of the following:
  • Decryption successful: `NULL`.
  • Decryption not successful: The reason why the UID2 token was not decrypted; for example, `EXPIRED_TOKEN`.
    For details, see [Values for the DECRYPTION_STATUS Column](#values-for-the-decryption_status-column).
| +| `DECRYPTION_STATUS` | TEXT | The value is one of the following:
  • Decryption successful: `NULL`.
  • Decryption not successful: The reason why the UID2 token was not decrypted; for example, `EXPIRED_TOKEN`.
    For details, see [Values for the decryption_status column](#values-for-the-decryption_status-column).
| :::note In most circumstances where UID2 token cannot be successfully decrypted, the function will not return any rows at all. ::: -#### Values for the DECRYPTION_STATUS Column +#### Values for the decryption_status column Possible values for `DECRYPTION_STATUS` are: @@ -661,7 +661,7 @@ Possible values for `DECRYPTION_STATUS` are: | `NULL` | The UID2 token was successfully decrypted. | | `EXPIRED_TOKEN` | The UID2 token is beyond its designated lifetime—the token has expired. | -#### Decrypt Token Request Example—Single UID2 Token +#### Decrypt token request example—single UID2 token The following queries illustrate how to decrypt a single UID2 token to a raw UID2, using the [default database and schema names](#database-and-schema-names). @@ -687,7 +687,7 @@ Query results for a single UID2 token: +----------------------------------------------+-------------------+ ``` -#### Decrypt Token Request Example—Multiple UID2 Tokens +#### Decrypt token request example—multiple UID2 tokens The following queries illustrate how to decrypt multiple UID2 tokens, using the [default database and schema names](#database-and-schema-names). @@ -725,12 +725,12 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+----------+-------------------+ ``` -### UID2 Sharing Example +### UID2 sharing example The following instructions provide an example of how sharing works for a sender and a receiver both using Snowflake. In this example scenario an advertiser (the sender) has an audience table with raw UID2s (`AUDIENCE_WITH_UID2`) and wants to make data in the table available to a data provider (the receiver) using the [Snowflake Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro) feature. -#### Sender Instructions +#### Sender instructions 1. Create a new table named `AUDIENCE_WITH_UID2_TOKENS`. 2. Encrypt the raw UID2s in the `AUDIENCE_WITH_UID2S` table and store the result in the `AUDIENCE_WITH_UID2_TOKENS` table. For example, the following query could help achieve this task: @@ -744,7 +744,7 @@ The following instructions provide an example of how sharing works for a sender To help prevent UID2 tokens from expiring during sharing, send the newly encrypted UID2 tokens to the receiver as soon as possible. ::: -#### Receiver Instructions +#### Receiver instructions 1. Create a database from the secure share that the sender provided access to. 2. Create a new table named `RECEIVED_AUDIENCE_WITH_UID2`. diff --git a/docs/guides/integration-snowflake-previous.md b/docs/guides/integration-snowflake-previous.md index 6d71e6167..ad1b64721 100644 --- a/docs/guides/integration-snowflake-previous.md +++ b/docs/guides/integration-snowflake-previous.md @@ -10,21 +10,21 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Snowflake Integration Guide (Pre-July 2025) +# Snowflake integration guide (pre-July 2025) [Snowflake](https://www.snowflake.com/) is a cloud data warehousing solution, where you as a partner can store your data and integrate with the UID2 framework. Using Snowflake, UID2 enables you to securely share consumer identifier data without exposing sensitive directly identifying information (DII). Even though you have the option to query the Operator Web Services directly for the consumer identifier data, the Snowflake UID2 integration offers a more seamless experience. :::important -This document is for anyone using the Snowflake marketplace listing published prior to July 2025. For documentation on the newer version of identity map published in July 2025, see [Snowflake Integration Guide](integration-snowflake.md). If you're using the earlier implementation, we recommend that you upgrade as soon as possible, to take advantage of improvements. For migration information, see [Migration Guide](integration-snowflake.md#migration-guide). +This document is for anyone using the Snowflake marketplace listing published prior to July 2025. For documentation on the newer version of identity map published in July 2025, see [Snowflake integration guide](integration-snowflake.md). If you're using the earlier implementation, we recommend that you upgrade as soon as possible, to take advantage of improvements. For migration information, see [Migration guide](integration-snowflake.md#migration-guide). ::: -## Snowflake Marketplace Listing +## Snowflake marketplace listing The following listing for UID2 is available on the Snowflake marketplace: - [Unified ID 2.0: Advertiser and Data Provider Identity Solution](https://app.snowflake.com/marketplace/listing/GZT0ZRYXTN8/unified-id-2-0-unified-id-2-0-advertiser-and-data-provider-identity-solution) :::tip -For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md). +For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md). ::: ## Functionality @@ -38,15 +38,15 @@ The following table summarizes the functionality available with the UID2 Snowfla *You cannot use Snowflake to generate a UID2 token directly from DII. However, you can convert DII to a raw UID2, and then encrypt the raw UID2 into a UID2 token. :::note -If you're a publisher who is sharing UID2 tokens in the bidstream, see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +If you're a publisher who is sharing UID2 tokens in the bidstream, see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: -## Changes from Previous Version +## Changes from previous version The February 2025 update to the UID2 Snowflake Marketplace integration includes updates and enhancements. One key change is that it includes a single listing and data share that combines the capabilities of the two previous data shares, one for Advertisers and one for Data Providers. This simplifies the integration for all participants. :::note -These changes assume that your code integration uses the version of Snowflake functions published before February 2025: see [Snowflake Integration (Pre-Feb 2025)](integration-snowflake-before-february-2025.md). If you're using an even earlier version, that uses the `FN_T_UID2_IDENTITY_MAP_EMAIL` and `FN_T_UID2_IDENTITY_MAP_EMAIL_HASH` functions, you could follow the instructions in the [Migration Guide section in the earlier guide](integration-snowflake-before-february-2025.md#migration-guide), and then upgrade again to the current version. However, in this scenario we recommend that you follow the instructions in this guide and upgrade in one step. For details, see [Migration Guide](#migration-guide). +These changes assume that your code integration uses the version of Snowflake functions published before February 2025: see [Snowflake integration (pre-Feb 2025)](integration-snowflake-before-february-2025.md). If you're using an even earlier version, that uses the `FN_T_UID2_IDENTITY_MAP_EMAIL` and `FN_T_UID2_IDENTITY_MAP_EMAIL_HASH` functions, you could follow the instructions in the [Migration guide section in the earlier guide](integration-snowflake-before-february-2025.md#migration-guide), and then upgrade again to the current version. However, in this scenario we recommend that you follow the instructions in this guide and upgrade in one step. For details, see [Migration guide](#migration-guide). ::: The following table shows details of the changes to the Snowflake functions, from the previous version. @@ -54,27 +54,27 @@ The following table shows details of the changes to the Snowflake functions, fro | Old function | New function | Fields in old function | Fields in new function | Comments | | :-- | :-- | :-- | :-- | :-- | | `FN_T_UID2_IDENTITY_MAP` | `FN_T_IDENTITY_MAP` | `UID2` | `UID` | For details, see [Map DII](#map-dii).| -| `FN_T_UID2_ENCRYPT` | `FN_T_ENCRYPT` | `UID2_TOKEN` | `UID_TOKEN` | For details, see [Encrypt Tokens](#encrypt-tokens).| -| `FN_T_UID2_DECRYPT` | `FN_T_DECRYPT` | `UID2_TOKEN` | `UID_TOKEN` | For details, see [Decrypt Tokens](#decrypt-tokens).| +| `FN_T_UID2_ENCRYPT` | `FN_T_ENCRYPT` | `UID2_TOKEN` | `UID_TOKEN` | For details, see [Encrypt tokens](#encrypt-tokens).| +| `FN_T_UID2_DECRYPT` | `FN_T_DECRYPT` | `UID2_TOKEN` | `UID_TOKEN` | For details, see [Decrypt tokens](#decrypt-tokens).| The following table shows details of the changes to the Snowflake views, from the previous version. | Old view | New view | Comments | | :-- | :-- | :-- | -| `UID2_SALT_BUCKETS` | `SALT_BUCKETS` | For details, see [Monitor for Salt Bucket Rotation and Regenerate Raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s). | +| `UID2_SALT_BUCKETS` | `SALT_BUCKETS` | For details, see [Monitor for salt bucket rotation and regenerate raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s). | -## Workflow Diagram +## Workflow diagram The following diagram and table illustrate the different parts of the UID2 integration process in Snowflake, and the workflow. -![Snowflake Integration Architecture](images/uid2-snowflake-integration-architecture-drawio.png) +![Snowflake integration architecture](images/uid2-snowflake-integration-architecture-drawio.png) |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. | |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 +## Access the UID2 share Access to the UID2 Share is available through the following listing on the [Snowflake Data Marketplace](https://www.snowflake.com/data-marketplace/): @@ -95,29 +95,29 @@ To request access to the UID2 Share, complete the following steps: After your request is received, a UID2 administrator will contact you with the appropriate access instructions. For details about managing data requests in Snowflake, see the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/data-marketplace-consumer.html). -## Shared Objects +## Shared objects You can map DII to UID2s by using the following function: - `FN_T_IDENTITY_MAP` (for details, see [Map DII](#map-dii)) -The following function is deprecated in favor of `FN_T_IDENTITY_MAP`. You can still use it if you are on the previous Snowflake version (see [Snowflake Integration (Pre-Feb 2025)](integration-snowflake-before-february-2025.md)), but we recommend upgrading as soon as possible: +The following function is deprecated in favor of `FN_T_IDENTITY_MAP`. You can still use it if you are on the previous Snowflake version (see [Snowflake integration (pre-Feb 2025)](integration-snowflake-before-february-2025.md)), but we recommend upgrading as soon as possible: - `FN_T_UID2_IDENTITY_MAP` (deprecated) :::note -If you are using the deprecated function, and need help migrating to the newer function, see [Migration Guide](#migration-guide). +If you are using the deprecated function, and need help migrating to the newer function, see [Migration guide](#migration-guide). ::: -To identify the UID2s that you must regenerate, use the `SALT_BUCKETS` view from the UID2 Share. For details, see [Monitor for Salt Bucket Rotation and Regenerate Raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s). +To identify the UID2s that you must regenerate, use the `SALT_BUCKETS` view from the UID2 Share. For details, see [Monitor for salt bucket rotation and regenerate raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s). The following functions are also available, for UID2 sharing participants: -- `FN_T_ENCRYPT` (See [Encrypt Tokens](#encrypt-tokens)) -- `FN_T_DECRYPT` (See [Decrypt Tokens](#decrypt-tokens)) +- `FN_T_ENCRYPT` (See [Encrypt tokens](#encrypt-tokens)) +- `FN_T_DECRYPT` (See [Decrypt tokens](#decrypt-tokens)) -For details, see [Usage for UID2 Sharers](#usage-for-uid2-sharers). +For details, see [Usage for UID2 sharers](#usage-for-uid2-sharers). -### Database and Schema Names +### Database and schema names The following sections include query examples for each solution, which are identical except for the database and schema name variables: @@ -142,9 +142,9 @@ All query examples use the following default values for each name variable: To map all types of DII, use the `FN_T_IDENTITY_MAP` function. -If the DII is an email address, the service normalizes the data using the UID2 [Email Address Normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) rules. +If the DII is an email address, the service normalizes the data using the UID2 [Email address normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) rules. -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. +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 | |:-------------|:-------------|:------------------------------------------------------------------------------------------| @@ -157,9 +157,9 @@ A successful query returns the following information for the specified DII. |:------------|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `UID` | TEXT | The value is one of the following:
  • DII was successfully mapped: The UID2 associated with the DII.
  • DII was not successfully mapped: `NULL`.
| | `BUCKET_ID` | TEXT | The value is one of the following:
  • DII was successfully mapped: The ID of the salt bucket used to generate the UID2. This ID maps to the bucket ID in the `SALT_BUCKETS` view.
  • DII was not successfully mapped: `NULL`.
| -| `UNMAPPED` | TEXT | The value is one of the following:
  • DII was successfully mapped: `NULL`.
  • DII was not successfully mapped: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.
    For details, see [Values for the UNMAPPED Column](#values-for-the-unmapped-column).
| +| `UNMAPPED` | TEXT | The value is one of the following:
  • DII was successfully mapped: `NULL`.
  • DII was not successfully mapped: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.
    For details, see [Values for the unmapped column](#values-for-the-unmapped-column).
| -#### Values for the UNMAPPED Column +#### Values for the unmapped column The following table shows possible values for the `UNMAPPED` column. @@ -174,20 +174,20 @@ The following table shows possible values for the `UNMAPPED` column. Mapping request examples in this section: -- [Single Unhashed Email](#mapping-request-example---single-unhashed-email) -- [Multiple Unhashed Emails](#mapping-request-example---multiple-unhashed-emails) -- [Single Unhashed Phone Number](#mapping-request-example---single-unhashed-phone-number) -- [Multiple Unhashed Phone Numbers](#mapping-request-example---multiple-unhashed-phone-numbers) -- [Single Hashed Email](#mapping-request-example---single-hashed-email) -- [Multiple Hashed Emails](#mapping-request-example---multiple-hashed-emails) -- [Single Hashed Phone Number](#mapping-request-example---single-hashed-phone-number) -- [Multiple Hashed Phone Numbers](#mapping-request-example---multiple-hashed-phone-numbers) +- [Single unhashed email](#mapping-request-example---single-unhashed-email) +- [Multiple unhashed emails](#mapping-request-example---multiple-unhashed-emails) +- [Single unhashed phone number](#mapping-request-example---single-unhashed-phone-number) +- [Multiple unhashed phone numbers](#mapping-request-example---multiple-unhashed-phone-numbers) +- [Single hashed email](#mapping-request-example---single-hashed-email) +- [Multiple hashed emails](#mapping-request-example---multiple-hashed-emails) +- [Single hashed phone number](#mapping-request-example---single-hashed-phone-number) +- [Multiple hashed phone numbers](#mapping-request-example---multiple-hashed-phone-numbers) :::note The input and output data in these examples is fictitious, for illustrative purposes only. The values provided are not real values. ::: -#### Mapping Request Example - Single Unhashed Email +#### Mapping request example - single unhashed email The following query illustrates how to map a single email address, using the [default database and schema names](#database-and-schema-names). @@ -205,7 +205,7 @@ Query results for a single email: +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Emails +#### Mapping request example - multiple unhashed emails The following query illustrates how to map multiple email addresses, using the [default database and schema names](#database-and-schema-names). @@ -230,11 +230,11 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Unhashed Phone Number +#### Mapping request example - single unhashed phone number The following query illustrates how to map a phone number, using the [default database and schema names](#database-and-schema-names). -You must normalize phone numbers using the UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. +You must normalize phone numbers using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. ```sql select UID, BUCKET_ID, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_T_IDENTITY_MAP('+12345678901', 'phone')); @@ -250,11 +250,11 @@ Query results for a single phone number: +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Phone Numbers +#### Mapping request example - multiple unhashed phone numbers The following query illustrates how to map multiple phone numbers, using the [default database and schema names](#database-and-schema-names). -You must normalize phone numbers using the UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. +You must normalize phone numbers using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. ```sql select a.ID, a.PHONE, m.UID, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT JOIN( @@ -277,7 +277,7 @@ The following table identifies each item in the response, including `NULL` value +----+--------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Email +#### Mapping request example - single hashed email The following query illustrates how to map a single email address hash, using the [default database and schema names](#database-and-schema-names). @@ -295,7 +295,7 @@ Query results for a single hashed email: +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Emails +#### Mapping request example - multiple hashed emails The following query illustrates how to map multiple email address hashes, using the [default database and schema names](#database-and-schema-names). @@ -319,7 +319,7 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Phone Number +#### Mapping request example - single hashed phone number The following query illustrates how to map a single phone number hash, using the [default database and schema names](#database-and-schema-names). @@ -337,7 +337,7 @@ Query results for a single hashed phone number: +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Phone Numbers +#### Mapping request example - multiple hashed phone numbers The following query illustrates how to map multiple phone number hashes, using the [default database and schema names](#database-and-schema-names). @@ -361,7 +361,7 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+----------------------------------------------+------------+--------------------+ ``` -### Monitor for Salt Bucket Rotation and Regenerate Raw UID2s +### Monitor for salt bucket rotation and regenerate raw UID2s The `SALT_BUCKETS` view query returns the date and time when the salt buckets for the raw UID2s were last updated. A salt value is used when generating UID2s. When the salt in the bucket is updated, the previously generated UID2 becomes outdated and doesn’t match the UID2 generated by other parties for the same user. @@ -374,7 +374,7 @@ To determine which UID2s need regeneration, compare the timestamps of when they The following example shows an input table and the query used to find the UID2s in the table that must be regenerated because the salt bucket was updated. -#### Targeted Input Table +#### Targeted input table In this example scenario, the advertiser/data provider has stored the UID2s in a table named `AUDIENCE_WITH_UID2`. The last column, `LAST_UID2_UPDATE_UTC`, is used to record the time at which a UID2 was generated. If no UID2 has been generated, the value is `NULL`, as shown in the third example. The advertiser/data provider can use this timestamp value to determine which UID2s need to be regenerated. @@ -413,24 +413,24 @@ The following table identifies each item in the response. The result includes an +----+----------------------+----------------------------------------------+------------+-------------------------+-------------------------+ ``` -## Usage for UID2 Sharers +## Usage for UID2 sharers A UID2 sharing participant is a company that takes part in sharing, either as a sender or a receiver, to share UID2s with another participant. -Advertisers and data providers can share UID2s with other authorized UID2 sharing participants via Snowflake (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels within Snowflake, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +Advertisers and data providers can share UID2s with other authorized UID2 sharing participants via Snowflake (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels within Snowflake, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). :::caution -The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: -If you are not sending data in pixels or in the bidstream within Snowflake, you can also take part in raw UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +If you are not sending data in pixels or in the bidstream within Snowflake, you can also take part in raw UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). The following activities support tokenized sharing: -- [Encrypt Tokens](#encrypt-tokens) -- [Decrypt Tokens](#decrypt-tokens) +- [Encrypt tokens](#encrypt-tokens) +- [Decrypt tokens](#decrypt-tokens) -### Encrypt Tokens +### Encrypt tokens To encrypt raw UID2s to UID2 tokens, use the `FN_T_ENCRYPT` function. @@ -443,9 +443,9 @@ A successful query returns the following information for the specified raw UID2. |Column Name|Data Type|Description| | :--- | :--- | :--- | | `UID_TOKEN` | TEXT | The value is one of the following:
  • Encryption successful: The UID2 token containing the raw UID2.
  • Encryption not successful: `NULL`.
| -| `ENCRYPTION_STATUS` | TEXT | The value is one of the following:
  • Encryption successful: `NULL`.
  • Encryption not successful: The reason why the raw UID2 was not encrypted. For example: `INVALID_RAW_UID2` or `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.
    For details, see [Values for the ENCRYPTION_STATUS Column](#values-for-the-encryption_status-column).
| +| `ENCRYPTION_STATUS` | TEXT | The value is one of the following:
  • Encryption successful: `NULL`.
  • Encryption not successful: The reason why the raw UID2 was not encrypted. For example: `INVALID_RAW_UID2` or `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.
    For details, see [Values for the encryption_status column](#values-for-the-encryption_status-column).
| -#### Values for the ENCRYPTION_STATUS Column +#### Values for the encryption_status column The following table shows possible values for the `ENCRYPTION_STATUS` column. @@ -458,7 +458,7 @@ The following table shows possible values for the `ENCRYPTION_STATUS` column. | `NOT_AUTHORIZED_FOR_MASTER_KEY` | The caller does not have access to the required encryption keys. Contact the UID2 administrator. | | `NOT_AUTHORIZED_FOR_SITE_KEY` | The caller does not have access to the required encryption keys. Contact the UID2 administrator. | -#### Encrypt Token Request Example - Single Raw UID2 +#### Encrypt token request example - single raw UID2 The following query illustrates how to encrypt a single raw UID2 to a UID2 token, using the [default database and schema names](#database-and-schema-names). @@ -476,7 +476,7 @@ Query results for a single raw UID2: +--------------------------------------------+ ``` -#### Encrypt Token Request Example - Multiple Raw UID2s +#### Encrypt token request example - multiple raw UID2s The following query illustrates how to encrypt multiple raw UID2s, using the [default database and schema names](#database-and-schema-names). @@ -498,7 +498,7 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+-----------------------+-----------------------------+ ``` -### Decrypt Tokens +### Decrypt tokens To decrypt UID2 tokens to raw UID2s, use the `FN_T_DECRYPT` function. @@ -512,13 +512,13 @@ A successful query returns the following information for the specified UID2 toke |:--------------------| :--- | :--- | | `UID` | TEXT | The value is one of the following:
  • Decryption successful: The raw UID2 corresponding to the UID2 token.
  • Decryption not successful: `NULL`.
| | `SITE_ID` | INT | The value is one of the following:
  • Decryption successful: The identifier of the UID2 participant that encrypted the token.
  • Decryption not successful: `NULL`.
| -| `DECRYPTION_STATUS` | TEXT | The value is one of the following:
  • Decryption successful: `NULL`.
  • Decryption not successful: The reason why the UID2 token was not decrypted; for example, `EXPIRED_TOKEN`.
    For details, see [Values for the DECRYPTION_STATUS Column](#values-for-the-decryption_status-column).
| +| `DECRYPTION_STATUS` | TEXT | The value is one of the following:
  • Decryption successful: `NULL`.
  • Decryption not successful: The reason why the UID2 token was not decrypted; for example, `EXPIRED_TOKEN`.
    For details, see [Values for the decryption_status column](#values-for-the-decryption_status-column).
| :::note In most circumstances where UID2 token cannot be successfully decrypted, the function will not return any rows at all. ::: -#### Values for the DECRYPTION_STATUS Column +#### Values for the decryption_status column Possible values for `DECRYPTION_STATUS` are: @@ -527,7 +527,7 @@ Possible values for `DECRYPTION_STATUS` are: | `NULL` | The UID2 token was successfully decrypted. | | `EXPIRED_TOKEN` | The UID2 token is beyond its designated lifetime—the token has expired. | -#### Decrypt Token Request Example—Single UID2 Token +#### Decrypt token request example—single UID2 token The following query illustrates how to decrypt a single UID2 token to a raw UID2, using the [default database and schema names](#database-and-schema-names). @@ -545,7 +545,7 @@ Query results for a single UID2 token: +----------------------------------------------+-------------------+ ``` -#### Decrypt Token Request Example—Multiple UID2 Tokens +#### Decrypt token request example—multiple UID2 tokens The following query illustrates how to decrypt multiple UID2 tokens, using the [default database and schema names](#database-and-schema-names). @@ -572,12 +572,12 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+----------+-------------------+ ``` -### UID2 Sharing Example +### UID2 sharing example The following instructions provide an example of how sharing works for a sender and a receiver both using Snowflake. In this example scenario an advertiser (the sender) has an audience table with raw UID2s (`AUDIENCE_WITH_UID2S`) and wants to make data in the table available to a data provider (the receiver) using the [Snowflake Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro) feature. -#### Sender Instructions +#### Sender instructions 1. Create a new table named `AUDIENCE_WITH_UID2_TOKENS`. 2. Encrypt the raw UID2s in the `AUDIENCE_WITH_UID2S` table and store the result in the `AUDIENCE_WITH_UID2_TOKENS` table. For example, the following query could help achieve this task: @@ -591,7 +591,7 @@ The following instructions provide an example of how sharing works for a sender To help prevent UID2 tokens from expiring during sharing, send the newly encrypted UID2 tokens to the receiver as soon as possible. ::: -#### Receiver Instructions +#### Receiver instructions 1. Create a database from the secure share that the sender provided access to. 2. Create a new table named `RECEIVED_AUDIENCE_WITH_UID2`. @@ -608,22 +608,22 @@ To help prevent UID2 tokens from expiring during sharing, send the newly encrypt To help prevent UID2 tokens from expiring, decrypt the UID2 tokens as soon as they become available from the sender. ::: -## Migration Guide +## Migration guide This section includes the following information to help you upgrade to the new UID2 Snowflake Marketplace functionality: -- [Accessing the New Data Share](#accessing-the-new-data-share) -- [Changing Existing Code](#changing-existing-code) +- [Accessing the new data share](#accessing-the-new-data-share) +- [Changing existing code](#changing-existing-code) -### Accessing the New Data Share +### Accessing the new data share -To access the new data share, follow the instructions in [Access the UID2 Share](#access-the-uid2-share). +To access the new data share, follow the instructions in [Access the UID2 share](#access-the-uid2-share). -### Changing Existing Code +### Changing existing code -For a summary of changes, see [Changes from Previous Version](#changes-from-previous-version). The code snippets in this section are before/after examples of how the earlier functions might be implemented, and how you could update to use the new function. +For a summary of changes, see [Changes from previous version](#changes-from-previous-version). The code snippets in this section are before/after examples of how the earlier functions might be implemented, and how you could update to use the new function. -#### Example for Mapping Unhashed Emails +#### Example for mapping unhashed emails Before: @@ -637,7 +637,7 @@ After: select UID, BUCKET_ID, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_IDENTITY_MAP(EMAIL, 'email')); ``` -#### Example for Mapping Unhashed Phone Numbers +#### Example for mapping unhashed phone numbers Before: @@ -651,9 +651,9 @@ After: select UID, BUCKET_ID, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_IDENTITY_MAP(PHONE_NUMBER, 'phone')); ``` -#### Example for Monitoring Salt Bucket Rotation and Regenerating Raw UID2s +#### Example for monitoring salt bucket rotation and regenerating raw UID2s -The following queries use the same example table, `AUDIENCE_WITH_UID2`, that we used in [Targeted Input Table](#targeted-input-table). +The following queries use the same example table, `AUDIENCE_WITH_UID2`, that we used in [Targeted input table](#targeted-input-table). Before: @@ -673,7 +673,7 @@ select a.*, b.LAST_SALT_UPDATE_UTC where a.LAST_UID2_UPDATE_UTC < b.LAST_SALT_UPDATE_UTC or a.UID2 IS NULL; ``` -#### Example for Token Encryption +#### Example for token encryption Before: @@ -687,7 +687,7 @@ After: select UID_TOKEN, ENCRYPTION_STATUS from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_ENCRYPT('2ODl112/VS3x2vL+kG1439nPb7XNngLvOWiZGaMhdcU=')); ``` -#### Example for Token Decryption +#### Example for token decryption Before: diff --git a/docs/guides/integration-snowflake.md b/docs/guides/integration-snowflake.md index 6078093e9..f53c26b9b 100644 --- a/docs/guides/integration-snowflake.md +++ b/docs/guides/integration-snowflake.md @@ -11,21 +11,21 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Snowflake Integration Guide +# Snowflake integration guide [Snowflake](https://www.snowflake.com/) is a cloud data warehousing solution, where you as a partner can store your data and integrate with the UID2 framework. Using Snowflake, UID2 enables you to securely share consumer identifier data without exposing sensitive directly identifying information (DII). Even though you have the option to query the Operator Web Services directly for the consumer identifier data, the Snowflake UID2 integration offers a more seamless experience. :::important -This document is for those using the latest [Snowflake marketplace listing](#snowflake-marketplace-listing). If you're using an earlier version, see [Snowflake Integration Guide (Pre-July 2025)](integration-snowflake-previous.md). If you're using the earlier implementation, we recommend that you migrate to the newer version to take advantage of the updates and enhancements: for details, see [Changes from Previous Version](#changes-from-previous-version). For migration information, see [Migration Guide](#migration-guide). +This document is for those using the latest [Snowflake marketplace listing](#snowflake-marketplace-listing). If you're using an earlier version, see [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md). If you're using the earlier implementation, we recommend that you migrate to the newer version to take advantage of the updates and enhancements: for details, see [Changes from previous version](#changes-from-previous-version). For migration information, see [Migration guide](#migration-guide). ::: -## Snowflake Marketplace Listing +## Snowflake marketplace listing The following listing for UID2 is available on the Snowflake marketplace: - [Unified ID 2.0: Advertiser and Data Provider Identity Solution](https://app.snowflake.com/marketplace/listing/GZT0ZRYXTN8/unified-id-2-0-unified-id-2-0-advertiser-and-data-provider-identity-solution) :::tip -For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md). +For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md). ::: ## Functionality @@ -39,47 +39,47 @@ The following table summarizes the functionality available with the UID2 Snowfla *You cannot use Snowflake to generate a UID2 token directly from DII. However, you can convert DII to a raw UID2, and then encrypt the raw UID2 into a UID2 token. :::note -If you're a publisher who is sharing UID2 tokens in the bidstream, see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +If you're a publisher who is sharing UID2 tokens in the bidstream, see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: -## Changes from Previous Version +## Changes from previous version The July 2025 update to the UID2 Snowflake Marketplace integration introduces a new identity mapping function that simplifies UID2 refresh management and allows accessing previous raw UID2s for 90 days after rotation. :::note -These changes assume that your code integration uses the version of Snowflake functions published before July 2025: see [Snowflake Integration Guide (Pre-July 2025)](integration-snowflake-previous.md). For details on migrating to this version, see [Migration Guide](#migration-guide). +These changes assume that your code integration uses the version of Snowflake functions published before July 2025: see [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md). For details on migrating to this version, see [Migration guide](#migration-guide). ::: The following table shows the differences between the old and new identity mapping functions. | 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` | 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).| -### Key Benefits +### Key benefits This update provides two major benefits: - **Simplified Refresh Management**: You can monitor for UID2s reaching `REFRESH_FROM` timestamps instead of polling salt buckets for rotation. - **Previous UID2 Access**: You have access to previous raw UID2s for 90 days after rotation for campaign measurement. -## Workflow Diagram +## Workflow diagram The following diagram and table illustrate the different parts of the UID2 integration process in Snowflake, and the workflow. -![Snowflake Integration Architecture](images/uid2-snowflake-integration-architecture-drawio.png) +![Snowflake integration architecture](images/uid2-snowflake-integration-architecture-drawio.png) |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. | |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 +## Preparing DII for processing -## Summary of Integration Steps +## Summary of integration steps :::important To be able to request data, you must use the `ACCOUNTADMIN` role or another role with the `CREATE DATABASE` and `IMPORT SHARE` privileges in your Snowflake account. @@ -88,24 +88,24 @@ To be able to request data, you must use the `ACCOUNTADMIN` role or another role The following list summarizes the integration steps for UID2 mapping in Snowflake in the production environment: :::note -If you want to try out an integration before using the production environment, see [Testing in the Integ Environment](#testing-in-the-integ-environment). +If you want to try out an integration before using the production environment, see [Testing in the integ environment](#testing-in-the-integ-environment). ::: -1. Make sure that the UID2 POC paperwork is signed with your UID2 contact. If you're not sure who to ask, see [Contact Info](../getting-started/gs-account-setup.md#contact-info). +1. Make sure that the UID2 POC paperwork is signed with your UID2 contact. If you're not sure who to ask, see [Contact info](../getting-started/gs-account-setup.md#contact-info). 1. Request access to the UID2 share: - - Request access through the [Snowflake Marketplace Listing](#snowflake-marketplace-listing). In your request, include your Snowflake account number and the region. + - Request access through the [Snowflake marketplace listing](#snowflake-marketplace-listing). In your request, include your Snowflake account number and the region. - Let your UID2 contact know that you've requested access. 1. Your UID2 contact arranges for your Snowflake account to be provisioned with access to the UID2 mapping share. :::note -If you did any initial testing (see [Testing in the Integ Environment](#testing-in-the-integ-environment)), be sure to update the functions to reflect the production UID2 share, along with your own relevant table names. +If you did any initial testing (see [Testing in the integ environment](#testing-in-the-integ-environment)), be sure to update the functions to reflect the production UID2 share, along with your own relevant table names. ::: -## Testing in the Integ Environment +## Testing in the integ environment If you'd like to test the mapping share before signing a UID2 POC, you can ask your UID2 contact for access to the Snowflake share in the integ (integration) environment. This environment is for testing only, and has no production data. In the request, be sure to include your account number and region. @@ -117,29 +117,29 @@ In this scenario, the following steps occur: 3. When you've requested access, your UID2 contact provisions the integ share to your account. -## Shared Objects +## Shared objects You can map DII to UID2s by using the following function: - `FN_T_IDENTITY_MAP_V3` (for details, see [Map DII](#map-dii)) -The following function is deprecated in favor of `FN_T_IDENTITY_MAP_V3`. You can still use it if you are on the previous Snowflake version (see [Snowflake Integration Guide (Pre-July 2025)](integration-snowflake-previous.md)), but we recommend upgrading as soon as possible: +The following function is deprecated in favor of `FN_T_IDENTITY_MAP_V3`. You can still use it if you are on the previous Snowflake version (see [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md)), but we recommend upgrading as soon as possible: - `FN_T_IDENTITY_MAP` (deprecated) :::note -If you are using the deprecated function, and need help migrating to the newer function, see [Migration Guide](#migration-guide). +If you are using the deprecated function, and need help migrating to the newer function, see [Migration guide](#migration-guide). ::: -To identify the UID2s that you must regenerate, monitor the `REFRESH_FROM` timestamps returned by the `FN_T_IDENTITY_MAP_V3` function. For details, see [Monitor Raw UID2 Refresh and Regenerate Raw UID2s](#monitor-raw-uid2-refresh-and-regenerate-raw-uid2s). +To identify the UID2s that you must regenerate, monitor the `REFRESH_FROM` timestamps returned by the `FN_T_IDENTITY_MAP_V3` function. For details, see [Monitor raw UID2 refresh and regenerate raw UID2s](#monitor-raw-uid2-refresh-and-regenerate-raw-uid2s). The following functions are also available, for UID2 sharing participants: -- `FN_T_ENCRYPT` (See [Encrypt Tokens](#encrypt-tokens)) -- `FN_T_DECRYPT` (See [Decrypt Tokens](#decrypt-tokens)) +- `FN_T_ENCRYPT` (See [Encrypt tokens](#encrypt-tokens)) +- `FN_T_DECRYPT` (See [Decrypt tokens](#decrypt-tokens)) -For details, see [Usage for UID2 Sharers](#usage-for-uid2-sharers). +For details, see [Usage for UID2 sharers](#usage-for-uid2-sharers). -### Database and Schema Names +### Database and schema names The following sections include query examples for each solution, which are identical except for the database and schema name variables: @@ -164,9 +164,9 @@ All query examples use the following default values for each name variable: To map all types of DII, use the `FN_T_IDENTITY_MAP_V3` function. -If the DII is an email address, the service normalizes the data using the UID2 [Email Address Normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) rules. +If the DII is an email address, the service normalizes the data using the UID2 [Email address normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) rules. -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. +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 | |:-------------|:-------------|:--------------------------------------------------------------------------------------------| @@ -180,9 +180,9 @@ A successful query returns the following information for the specified DII. | `UID` | TEXT | The value is one of the following:
  • DII was successfully mapped: The UID2 associated with the DII.
  • Otherwise: `NULL`.
| | `PREV_UID` | TEXT | The value is one of the following:
  • DII was successfully mapped and the current raw UID2 was rotated in the last 90 days: the previous raw UID2.
  • Otherwise: `NULL`.
| | `REFRESH_FROM` | NUMBER | The value is one of the following:
  • DII was successfully mapped: The timestamp (in epoch seconds) indicating when this UID2 should be refreshed.
  • Otherwise: `NULL`.
| -| `UNMAPPED` | TEXT | The value is one of the following:
  • DII was successfully mapped: `NULL`.
  • Otherwise: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.
    For details, see [Values for the UNMAPPED Column](#values-for-the-unmapped-column).
| +| `UNMAPPED` | TEXT | The value is one of the following:
  • DII was successfully mapped: `NULL`.
  • Otherwise: The reason why the identifier was not mapped: `OPTOUT`, `INVALID IDENTIFIER`, or `INVALID INPUT TYPE`.
    For details, see [Values for the unmapped column](#values-for-the-unmapped-column).
| -#### Values for the UNMAPPED Column +#### Values for the unmapped column The following table shows possible values for the `UNMAPPED` column. @@ -197,20 +197,20 @@ The following table shows possible values for the `UNMAPPED` column. Mapping request examples in this section: -- [Single Unhashed Email](#mapping-request-example---single-unhashed-email) -- [Multiple Unhashed Emails](#mapping-request-example---multiple-unhashed-emails) -- [Single Unhashed Phone Number](#mapping-request-example---single-unhashed-phone-number) -- [Multiple Unhashed Phone Numbers](#mapping-request-example---multiple-unhashed-phone-numbers) -- [Single Hashed Email](#mapping-request-example---single-hashed-email) -- [Multiple Hashed Emails](#mapping-request-example---multiple-hashed-emails) -- [Single Hashed Phone Number](#mapping-request-example---single-hashed-phone-number) -- [Multiple Hashed Phone Numbers](#mapping-request-example---multiple-hashed-phone-numbers) +- [Single unhashed email](#mapping-request-example---single-unhashed-email) +- [Multiple unhashed emails](#mapping-request-example---multiple-unhashed-emails) +- [Single unhashed phone number](#mapping-request-example---single-unhashed-phone-number) +- [Multiple unhashed phone numbers](#mapping-request-example---multiple-unhashed-phone-numbers) +- [Single hashed email](#mapping-request-example---single-hashed-email) +- [Multiple hashed emails](#mapping-request-example---multiple-hashed-emails) +- [Single hashed phone number](#mapping-request-example---single-hashed-phone-number) +- [Multiple hashed phone numbers](#mapping-request-example---multiple-hashed-phone-numbers) :::note The input and output data in these examples is fictitious, for illustrative purposes only. The values provided are not real values. ::: -#### Mapping Request Example - Single Unhashed Email +#### Mapping request example - single unhashed email The following query illustrates how to map a single email address, using the [default database and schema names](#database-and-schema-names). @@ -228,7 +228,7 @@ Query results for a single email: +----------------------------------------------+--------------------------------------------------+--------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Emails +#### Mapping request example - multiple unhashed emails The following query illustrates how to map multiple email addresses, using the [default database and schema names](#database-and-schema-names). @@ -254,11 +254,11 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------+----------------------------------------------+----------------------------------------------+--------------+--------------------+ ``` -#### Mapping Request Example - Single Unhashed Phone Number +#### Mapping request example - single unhashed phone number The following query illustrates how to map a phone number, using the [default database and schema names](#database-and-schema-names). -You must normalize phone numbers using the UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. +You must normalize phone numbers using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. ```sql select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_T_IDENTITY_MAP_V3('+12345678901', 'phone')); @@ -274,11 +274,11 @@ Query results for a single phone number: +----------------------------------------------+----------+--------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Phone Numbers +#### Mapping request example - multiple unhashed phone numbers The following query illustrates how to map multiple phone numbers, using the [default database and schema names](#database-and-schema-names). -You must normalize phone numbers using the UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. +You must normalize phone numbers using the UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) rules. ```sql select a.ID, a.PHONE, m.UID, m.PREV_UID, m.REFRESH_FROM, m.UNMAPPED from AUDIENCE a LEFT JOIN( @@ -302,7 +302,7 @@ The following table identifies each item in the response, including `NULL` value +----+--------------+----------------------------------------------+----------------------------------------------+--------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Email +#### Mapping request example - single hashed email The following query illustrates how to map a single email address hash, using the [default database and schema names](#database-and-schema-names). @@ -320,7 +320,7 @@ Query results for a single hashed email: +----------------------------------------------+----------------------------------------------+--------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Emails +#### Mapping request example - multiple hashed emails The following query illustrates how to map multiple email address hashes, using the [default database and schema names](#database-and-schema-names). @@ -345,7 +345,7 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+----------------------------------------------+----------------------------------------------+--------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Phone Number +#### Mapping request example - single hashed phone number The following query illustrates how to map a single phone number hash, using the [default database and schema names](#database-and-schema-names). @@ -363,7 +363,7 @@ Query results for a single hashed phone number: +----------------------------------------------+----------------------------------------------+--------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Phone Numbers +#### Mapping request example - multiple hashed phone numbers The following query illustrates how to map multiple phone number hashes, using the [default database and schema names](#database-and-schema-names). @@ -388,7 +388,7 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+----------------------------------------------+----------------------------------------------+--------------+--------------------+ ``` -### Monitor Raw UID2 Refresh and Regenerate Raw UID2s +### Monitor raw UID2 refresh and regenerate raw UID2s The `FN_T_IDENTITY_MAP_V3` function returns refresh timestamps (`REFRESH_FROM`) that indicate when each UID2 should be refreshed. @@ -405,7 +405,7 @@ To determine which UID2s need regeneration, compare the current time to the `REF The following example shows an input table and the query used to find the UID2s in the table that must be regenerated because their refresh time has been reached. -#### Targeted Input Table +#### Targeted input table In this example scenario, the advertiser/data provider has stored the UID2s in a table named `AUDIENCE_WITH_UID2`. The `REFRESH_FROM` column contains the timestamp when each UID2 should be refreshed. If no UID2 has been generated, the value is `NULL`, as shown in the third example. The advertiser/data provider can compare these timestamps to the current time to determine which UID2s need to be regenerated. @@ -442,24 +442,24 @@ The following table identifies each item in the response. The result includes UI +----+----------------------+----------------------------------------------+--------------+ ``` -## Usage for UID2 Sharers +## Usage for UID2 sharers A UID2 sharing participant is a company that takes part in sharing, either as a sender or a receiver, to share UID2s with another participant. -Advertisers and data providers can share UID2s with other authorized UID2 sharing participants via Snowflake (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels within Snowflake, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +Advertisers and data providers can share UID2s with other authorized UID2 sharing participants via Snowflake (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels within Snowflake, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). :::caution -The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: -If you are not sending data in pixels or in the bidstream within Snowflake, you can also take part in raw UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +If you are not sending data in pixels or in the bidstream within Snowflake, you can also take part in raw UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). The following activities support tokenized sharing: -- [Encrypt Tokens](#encrypt-tokens) -- [Decrypt Tokens](#decrypt-tokens) +- [Encrypt tokens](#encrypt-tokens) +- [Decrypt tokens](#decrypt-tokens) -### Encrypt Tokens +### Encrypt tokens To encrypt raw UID2s to UID2 tokens, use the `FN_T_ENCRYPT` function. @@ -472,9 +472,9 @@ A successful query returns the following information for the specified raw UID2. |Column Name|Data Type|Description| | :--- | :--- | :--- | | `UID_TOKEN` | TEXT | The value is one of the following:
  • Encryption successful: The UID2 token containing the raw UID2.
  • Encryption not successful: `NULL`.
| -| `ENCRYPTION_STATUS` | TEXT | The value is one of the following:
  • Encryption successful: `NULL`.
  • Encryption not successful: The reason why the raw UID2 was not encrypted. For example: `INVALID_RAW_UID2` or `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.
    For details, see [Values for the ENCRYPTION_STATUS Column](#values-for-the-encryption_status-column).
| +| `ENCRYPTION_STATUS` | TEXT | The value is one of the following:
  • Encryption successful: `NULL`.
  • Encryption not successful: The reason why the raw UID2 was not encrypted. For example: `INVALID_RAW_UID2` or `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.
    For details, see [Values for the encryption_status column](#values-for-the-encryption_status-column).
| -#### Values for the ENCRYPTION_STATUS Column +#### Values for the encryption_status column The following table shows possible values for the `ENCRYPTION_STATUS` column. @@ -487,7 +487,7 @@ The following table shows possible values for the `ENCRYPTION_STATUS` column. | `NOT_AUTHORIZED_FOR_MASTER_KEY` | The caller does not have access to the required encryption keys. Contact the UID2 administrator. | | `NOT_AUTHORIZED_FOR_SITE_KEY` | The caller does not have access to the required encryption keys. Contact the UID2 administrator. | -#### Encrypt Token Request Example - Single Raw UID2 +#### Encrypt token request example - single raw UID2 The following query illustrates how to encrypt a single raw UID2 to a UID2 token, using the [default database and schema names](#database-and-schema-names). @@ -505,7 +505,7 @@ Query results for a single raw UID2: +--------------------------------------------+ ``` -#### Encrypt Token Request Example - Multiple Raw UID2s +#### Encrypt token request example - multiple raw UID2s The following query illustrates how to encrypt multiple raw UID2s, using the [default database and schema names](#database-and-schema-names). @@ -527,7 +527,7 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+-----------------------+-----------------------------+ ``` -### Decrypt Tokens +### Decrypt tokens To decrypt UID2 tokens to raw UID2s, use the `FN_T_DECRYPT` function. @@ -541,13 +541,13 @@ A successful query returns the following information for the specified UID2 toke |:--------------------| :--- | :--- | | `UID` | TEXT | The value is one of the following:
  • Decryption successful: The raw UID2 corresponding to the UID2 token.
  • Decryption not successful: `NULL`.
| | `SITE_ID` | INT | The value is one of the following:
  • Decryption successful: The identifier of the UID2 participant that encrypted the token.
  • Decryption not successful: `NULL`.
| -| `DECRYPTION_STATUS` | TEXT | The value is one of the following:
  • Decryption successful: `NULL`.
  • Decryption not successful: The reason why the UID2 token was not decrypted; for example, `EXPIRED_TOKEN`.
    For details, see [Values for the DECRYPTION_STATUS Column](#values-for-the-decryption_status-column).
| +| `DECRYPTION_STATUS` | TEXT | The value is one of the following:
  • Decryption successful: `NULL`.
  • Decryption not successful: The reason why the UID2 token was not decrypted; for example, `EXPIRED_TOKEN`.
    For details, see [Values for the decryption_status column](#values-for-the-decryption_status-column).
| :::note In most circumstances where UID2 token cannot be successfully decrypted, the function will not return any rows at all. ::: -#### Values for the DECRYPTION_STATUS Column +#### Values for the decryption_status column Possible values for `DECRYPTION_STATUS` are: @@ -556,7 +556,7 @@ Possible values for `DECRYPTION_STATUS` are: | `NULL` | The UID2 token was successfully decrypted. | | `EXPIRED_TOKEN` | The UID2 token is beyond its designated lifetime—the token has expired. | -#### Decrypt Token Request Example—Single UID2 Token +#### Decrypt token request example—single UID2 token The following query illustrates how to decrypt a single UID2 token to a raw UID2, using the [default database and schema names](#database-and-schema-names). @@ -574,7 +574,7 @@ Query results for a single UID2 token: +----------------------------------------------+-------------------+ ``` -#### Decrypt Token Request Example—Multiple UID2 Tokens +#### Decrypt token request example—multiple UID2 tokens The following query illustrates how to decrypt multiple UID2 tokens, using the [default database and schema names](#database-and-schema-names). @@ -601,12 +601,12 @@ The following table identifies each item in the response, including `NULL` value +----+----------------------------------------------+----------+-------------------+ ``` -### UID2 Sharing Example +### UID2 sharing example The following instructions provide an example of how sharing works for a sender and a receiver both using Snowflake. In this example scenario an advertiser (the sender) has an audience table with raw UID2s (`AUDIENCE_WITH_UID2S`) and wants to make data in the table available to a data provider (the receiver) using the [Snowflake Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro) feature. -#### Sender Instructions +#### Sender instructions 1. Create a new table named `AUDIENCE_WITH_UID2_TOKENS`. 2. Encrypt the raw UID2s in the `AUDIENCE_WITH_UID2S` table and store the result in the `AUDIENCE_WITH_UID2_TOKENS` table. For example, the following query could help achieve this task: @@ -620,7 +620,7 @@ The following instructions provide an example of how sharing works for a sender To help prevent UID2 tokens from expiring during sharing, send the newly encrypted UID2 tokens to the receiver as soon as possible. ::: -#### Receiver Instructions +#### Receiver instructions 1. Create a database from the secure share that the sender provided access to. 2. Create a new table named `RECEIVED_AUDIENCE_WITH_UID2`. @@ -637,19 +637,19 @@ To help prevent UID2 tokens from expiring during sharing, send the newly encrypt To help prevent UID2 tokens from expiring, decrypt the UID2 tokens as soon as they become available from the sender. ::: -## Migration Guide +## Migration guide This section provides information to help you upgrade from the previous version to the new UID2 Snowflake functionality with v3 functions. :::note -If you're upgrading from a version earlier than February 2025, see [Migration Guide](integration-snowflake-previous.md#migration-guide) in the documentation for the previous version. +If you're upgrading from a version earlier than February 2025, see [Migration guide](integration-snowflake-previous.md#migration-guide) in the documentation for the previous version. ::: -### Changing Existing Code +### Changing existing code -For a summary of changes, see [Changes from Previous Version](#changes-from-previous-version). The code snippets in this section are before/after examples of how the earlier functions might be implemented, and how you could update to use the new function. The key change is migrating from `FN_T_IDENTITY_MAP` to `FN_T_IDENTITY_MAP_V3`, which provides refresh timestamps instead of salt bucket IDs and includes previous UID2 access. +For a summary of changes, see [Changes from previous version](#changes-from-previous-version). The code snippets in this section are before/after examples of how the earlier functions might be implemented, and how you could update to use the new function. The key change is migrating from `FN_T_IDENTITY_MAP` to `FN_T_IDENTITY_MAP_V3`, which provides refresh timestamps instead of salt bucket IDs and includes previous UID2 access. -#### Example for Mapping Unhashed Emails +#### Example for mapping unhashed emails Before: @@ -663,7 +663,7 @@ After: select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_IDENTITY_MAP_V3(EMAIL, 'email')); ``` -#### Example for Mapping Unhashed Phone Numbers +#### Example for mapping unhashed phone numbers Before: @@ -677,7 +677,7 @@ After: select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_IDENTITY_MAP_V3(PHONE_NUMBER, 'phone')); ``` -#### Example for Monitoring UID2 Refresh and Regenerating Raw UID2s +#### Example for monitoring UID2 refresh and regenerating raw UID2s The v3 function provides refresh timestamps directly, eliminating the need to monitor salt buckets. Instead of joining with salt bucket views, you can compare the current timestamp against the `REFRESH_FROM` timestamp returned by the function. diff --git a/docs/guides/mobile-plugin-gma-android.md b/docs/guides/mobile-plugin-gma-android.md index 7ebff7653..64a014be2 100644 --- a/docs/guides/mobile-plugin-gma-android.md +++ b/docs/guides/mobile-plugin-gma-android.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 GMA Plugin for Android Integration Guide +# UID2 GMA plugin for Android integration guide The UID2 Google Mobile Ads (GMA) Plugin for Android enables publishers that use the [Google Mobile Ads (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. This is done automatically, with no direct coding needed from the app developer. @@ -22,19 +22,19 @@ This plugin simplifies integration with Google Mobile Ads (GMA) for any publishe This documentation is for the UID2 GMA Plugin for Android version 2.0.0 and later. -## GitHub Repository +## Github repository This plugin is in the following open-source GitHub repository: - [https://github.com/IABTechLab/uid2-android-sdk/tree/main/securesignals-gma](https://github.com/IABTechLab/uid2-android-sdk/tree/main/securesignals-gma) -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-Side, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) +The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-side, client-server, or server-side integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) ## Requirements @@ -45,9 +45,9 @@ To run this plugin, install the following: - [Release notes](https://developers.google.com/admob/android/rel-notes) 1. SDK for Android v2.0.0 or later: - [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk) - - [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) + - [SDK for Android reference guide](../sdks/sdk-ref-android.md) 1. [UID2 Android GMA Plugin v2.0.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-gma/) -1. If you are using R8 or Proguard, add the applicable option specified in [Notes for Using R8 or ProGuard](#notes-for-using-r8-or-proguard) +1. If you are using R8 or Proguard, add the applicable option specified in [Notes for using r8 or ProGuard](#notes-for-using-r8-or-proguard) ## Installation @@ -78,7 +78,7 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file: ``` -## Notes for Using R8 or ProGuard +## Notes for using r8 or ProGuard If you are using R8, the shrinking and obfuscation rules are included automatically. diff --git a/docs/guides/mobile-plugin-gma-ios.md b/docs/guides/mobile-plugin-gma-ios.md index f30cb3f56..ebe5421b1 100644 --- a/docs/guides/mobile-plugin-gma-ios.md +++ b/docs/guides/mobile-plugin-gma-ios.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 GMA Plugin for iOS Integration Guide +# UID2 GMA plugin for iOS integration guide The UID2 Google Mobile Ads (GMA) Plugin for iOS enables publishers that use the [Google Mobile Ads (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 iOS apps. This is done automatically, with no direct coding needed from the app developer. @@ -22,19 +22,19 @@ This plugin simplifies integration with Google Mobile Ads (GMA) for any publishe This documentation is for the UID2 GMA Plugin for iOS version 1.0.0 or later. -## GitHub Repository +## Github repository This plugin is in the following open-source GitHub repository: - [https://github.com/IABTechLab/uid2-ios-plugin-google-gma](https://github.com/IABTechLab/uid2-ios-plugin-google-gma) -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-Side, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) +The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-side, client-server, or server-side integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) ## Requirements @@ -45,7 +45,7 @@ To run this plugin, install the following: - [Release Notes](https://developers.google.com/admob/ios/rel-notes) 1. SDK for iOS v1.7.0 or later: - [SDK](https://github.com/IABTechLab/uid2-ios-sdk) - - [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) + - [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) 1. [UID2 GMA Plugin for iOS v1.0.0](https://github.com/IABTechLab/uid2-ios-plugin-google-gma) ## Installation @@ -56,11 +56,11 @@ Install the UID2 iOS GMA Plugin via Swift Package Manager or CocoaPods to an exi There are three installation options: -- [Package.swift](#installing-with-packageswift) +- [Package.Swift](#installing-with-packageswift) - [Xcode](#installing-with-xcode) -- [CocoaPods](#installing-with-cocoapods) +- [Cocoapods](#installing-with-cocoapods) -### Installing with Package.swift +### Installing with package.Swift Add the following dependency to Package.swift: @@ -70,7 +70,7 @@ dependencies: [ ] ``` -### Installing with Xcode +### Installing with xcode In the XCode user interface, under Package Dependencies, add the following entry for your apps: @@ -78,7 +78,7 @@ In the XCode user interface, under Package Dependencies, add the following entry | :--- | :--- | :--- | | uid2-ios-plugin-google-gma | `git@github.com:IABTechLab/uid2-ios-plugin-google-gma.git` | Exact Version: 1.0.0 | -### Installing with CocoaPods +### Installing with cocoapods Add the following entry in your `Podfile`: diff --git a/docs/guides/mobile-plugin-ima-android.md b/docs/guides/mobile-plugin-ima-android.md index 8572cb1da..93ad334ab 100644 --- a/docs/guides/mobile-plugin-ima-android.md +++ b/docs/guides/mobile-plugin-ima-android.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 IMA Plugin for Android Integration Guide +# UID2 IMA plugin for Android integration guide The UID2 Interactive Media Ads (IMA) Plugin for Android enables publishers that use the [Google IMA SDK for Android](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side) to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps. This is done automatically, with no direct coding needed from the app developer. @@ -22,19 +22,19 @@ This plugin simplifies integration with Google Interactive Media Ads (IMA) for a This documentation is for the UID2 IMA Plugin for Android version 2.0.0 and later. -## GitHub Repository +## Github repository This plugin is in the following open-source GitHub repository: - [https://github.com/IABTechLab/uid2-android-sdk/tree/main/securesignals-ima](https://github.com/IABTechLab/uid2-android-sdk/tree/main/securesignals-ima) -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-Side, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) +The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-side, client-server, or server-side integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) ## Requirements @@ -45,9 +45,9 @@ To run this plugin, install the following: - [Release history](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side/history) 1. SDK for Android v2.0.0 or later: - [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk) - - [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) + - [SDK for Android reference guide](../sdks/sdk-ref-android.md) 1. [UID2 IMA Plugin for Android v2.0.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-ima) -1. If you are using R8 or Proguard, add the applicable option specified in [Notes for Using R8 or ProGuard](#notes-for-using-r8-or-proguard) +1. If you are using R8 or Proguard, add the applicable option specified in [Notes for using r8 or ProGuard](#notes-for-using-r8-or-proguard) ## Installation @@ -78,7 +78,7 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file: ``` -## Notes for Using R8 or ProGuard +## Notes for using r8 or ProGuard If you are using R8, the shrinking and obfuscation rules are included automatically. diff --git a/docs/guides/mobile-plugin-ima-ios.md b/docs/guides/mobile-plugin-ima-ios.md index 162244d23..e80d1ea5a 100644 --- a/docs/guides/mobile-plugin-ima-ios.md +++ b/docs/guides/mobile-plugin-ima-ios.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 IMA Plugin for iOS Integration Guide +# UID2 IMA plugin for iOS integration guide The UID2 Interactive Media Ads (IMA) Plugin for iOS enables publishers that use the [Google IMA SDK for iOS](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side) to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS apps. This is done automatically, with no direct coding needed from the app developer. @@ -22,19 +22,19 @@ This plugin simplifies integration with Google Interactive Media Ads (IMA) for a This documentation is for the UID2 IMA Plugin for iOS version 1.0.0 or later. -## GitHub Repository +## Github repository This plugin is in the following open-source GitHub repository: - [https://github.com/IABTechLab/uid2-ios-plugin-google-ima](https://github.com/IABTechLab/uid2-ios-plugin-google-ima) -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md). +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting started with the UID2 portal](../portal/portal-getting-started.md). -The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-Side, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) +The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-side, client-server, or server-side integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) ## Requirements @@ -45,7 +45,7 @@ To run this plugin, install the following: - [Release history](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side/history) 1. SDK for iOS v1.7.0 or later: - [SDK](https://github.com/IABTechLab/uid2-ios-sdk) - - [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) + - [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) 1. [UID2 IMA Plugin for iOS v1.0.0](https://github.com/IABTechLab/uid2-ios-plugin-google-ima) ## Installation @@ -56,11 +56,11 @@ Install the UID2 iOS IMA Plugin via Swift Package Manager or CocoaPods to an exi There are three installation options: -- [Package.swift](#installing-with-packageswift) +- [Package.Swift](#installing-with-packageswift) - [Xcode](#installing-with-xcode) -- [CocoaPods](#installing-with-cocoapods) +- [Cocoapods](#installing-with-cocoapods) -### Installing with Package.swift +### Installing with package.Swift Add the following dependency to Package.swift: @@ -70,7 +70,7 @@ dependencies: [ ] ``` -### Installing with Xcode +### Installing with xcode In the XCode user interface, under Package Dependencies, add the following entry for your apps: @@ -78,7 +78,7 @@ In the XCode user interface, under Package Dependencies, add the following entry | :--- | :--- | :--- | | uid2-ios-plugin-google-ima | `git@github.com:IABTechLab/uid2-ios-plugin-google-ima.git` | Exact Version: 1.0.0 | -### Installing with CocoaPods +### Installing with cocoapods Add the following entry in your `Podfile`: diff --git a/docs/guides/operator-guide-aks-enclave.md b/docs/guides/operator-guide-aks-enclave.md index b73df1bac..0aa45a3e2 100644 --- a/docs/guides/operator-guide-aks-enclave.md +++ b/docs/guides/operator-guide-aks-enclave.md @@ -14,12 +14,12 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure.mdx'; import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; -# UID2 Private Operator for AKS Integration Guide +# UID2 Private Operator for AKS integration guide The UID2 Operator is the API server in the UID2 ecosystem. For details, see [The UID2 Operator](../ref-info/ref-operators-public-private.md). :::note - if you want to set up a Private Operator using AKS, ask your UID2 contact. For details, see [Contact Info](../getting-started/gs-account-setup.md#contact-info). + if you want to set up a Private Operator using AKS, ask your UID2 contact. For details, see [Contact info](../getting-started/gs-account-setup.md#contact-info). ::: This guide provides information for setting up the UID2 Operator Service as a Private Operator in an Azure Kubernetes Service (AKS) cluster, running on [virtual nodes on Azure Container Instances](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-virtual-nodes) (ACI). Virtual nodes on Azure Container Instances enable us to take advantage of confidential containers, which run in a hardware-backed Trusted Execution Environment (TEE) that provides intrinsic capabilities such as data integrity, data confidentiality, and code integrity. @@ -41,10 +41,10 @@ The latest ZIP file is linked in the AKS Download column in the following table. | Q2 2025 | xxx | xxx | xxx | xxx | :::note -For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions). +For information about supported versions and deprecation dates, see [Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions). ::: --> -## Private Operator Upgrade Policy +## Private Operator upgrade policy @@ -52,15 +52,15 @@ For information about supported versions and deprecation dates, see [Private Ope Before deploying the UID2 Private Operator for AKS, complete these prerequisite steps: -- [Set Up the UID2 Operator Account](#set-up-the-uid2-operator-account) +- [Set up the UID2 Operator account](#set-up-the-uid2-operator-account) - [Install the Azure CLI](#install-the-azure-cli) -- [Get the Required Azure Permissions](#get-the-required-azure-permissions) +- [Get the required Azure permissions](#get-the-required-azure-permissions) - [Install the kubectl CLI](#install-the-kubectl-cli) -- [Install the Helm CLI](#install-the-helm-cli) +- [Install the helm CLI](#install-the-helm-cli) -### Set Up the UID2 Operator Account +### Set up the UID2 Operator account -Ask your UID2 contact to register your organization as a UID2 Operator. If you're not sure who to ask, see [Contact Info](../getting-started/gs-account-setup.md#contact-info). +Ask your UID2 contact to register your organization as a UID2 Operator. If you're not sure who to ask, see [Contact info](../getting-started/gs-account-setup.md#contact-info). When the registration process is complete, you'll receive an operator key, exclusive to you, that identifies you with the UID2 service as a Private Operator. During configuration, use this as the value for `OPERATOR_KEY`. This value is both your unique identifier and a password; store it securely and do not share it. @@ -72,7 +72,7 @@ You'll receive a separate operator key for each deployment environment. Install the Azure command-line interface. For details, see [How to install the Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) in the Azure documentation. -### Get the Required Azure Permissions +### Get the required Azure permissions You'll need to have subscription owner permission so that you can create a resource group. @@ -86,15 +86,15 @@ When all prerequisite steps are complete, you're ready to deploy the UID2 Privat Install the Kubernetes `kubectl` command-line interface. For details, see [Install Tools](https://kubernetes.io/docs/tasks/tools/) in the Kubernetes documentation. -### Install the Helm CLI +### Install the helm CLI Install the `helm` command-line interface. For details, see [Installing Helm](https://helm.sh/docs/intro/install/) in the Helm documentation. -## Preparing DII for Processing +## Preparing DII for processing -## Deployment Environments +## Deployment environments The following environments are available. As a best practice, we recommend that you test and verify your implementation in the integration environment before deploying in the production environment. @@ -111,14 +111,14 @@ You'll receive separate `{OPERATOR_KEY}` values for each environment. Be sure to To deploy a new UID2 Private Operator for AKS, you'll need to complete the following high-level steps: -- [Download ZIP File and Extract Files](#download-zip-file-and-extract-files) -- [Prepare Environment Variables](#prepare-environment-variables) -- [Set Up AKS and Node Pool](#set-up-aks-and-node-pool) -- [Set Up AKS Cluster](#set-up-aks-cluster) -- [Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup) -- [Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup) +- [Download ZIP file and extract files](#download-zip-file-and-extract-files) +- [Prepare environment variables](#prepare-environment-variables) +- [Set up AKS and node pool](#set-up-aks-and-node-pool) +- [Set up AKS cluster](#set-up-aks-cluster) +- [Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup) +- [Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup) -### Download ZIP File and Extract Files +### Download ZIP file and extract files To get set up with the installation files, follow these steps: @@ -132,7 +132,7 @@ To get set up with the installation files, follow these steps: - `operator.yaml` --> -### Prepare Environment Variables +### Prepare environment variables Run the following commands to prepare environment variables that you'll use later. Choose variable names to suit your needs. @@ -151,22 +151,22 @@ export SUBSCRIPTION_ID="$(az account show --query id --output tsv)" export DEPLOYMENT_ENV="integ" ``` -### Set Up AKS and Node Pool +### Set up AKS and node pool To set up AKS and the node pool, complete the following steps: -- [Create Resource Group](#create-resource-group) -- [Create Virtual Network](#create-virtual-network) -- [Create Subnets](#create-subnets) -- [Create Public IP Address](#create-public-ip-address) -- [Create NAT Gateway](#create-nat-gateway) -- [Configure NAT Service for Source Subnet](#configure-nat-service-for-source-subnet) +- [Create resource group](#create-resource-group) +- [Create virtual network](#create-virtual-network) +- [Create subnets](#create-subnets) +- [Create public ip address](#create-public-ip-address) +- [Create nat gateway](#create-nat-gateway) +- [Configure nat service for source Subnet](#configure-nat-service-for-source-subnet) - [Get the AKS Subnet ID](#get-the-aks-subnet-id) -- [Create an AKS Service](#create-an-aks-service) -- [Get the Principal ID of the Managed Identity](#get-the-principal-id-of-the-managed-identity) -- [Create Contributor Role for the Two Resource Groups](#create-contributor-role-for-the-two-resource-groups) +- [Create an AKS service](#create-an-aks-service) +- [Get the principal ID of the managed identity](#get-the-principal-id-of-the-managed-identity) +- [Create contributor role for the two resource groups](#create-contributor-role-for-the-two-resource-groups) -#### Create Resource Group +#### Create resource group In Azure, run the following command to create a resource group to run the UID2 Private Operator: ``` @@ -188,7 +188,7 @@ There are some limitations with regard to location: az account list-locations -o table ``` -#### Create Virtual Network +#### Create virtual network To create the virtual network, run the following command, using your own values as needed: @@ -200,7 +200,7 @@ az network vnet create \ --address-prefixes 10.0.0.0/8 ``` -#### Create Subnets +#### Create subnets To create the subnets, run the following command, using your own values as needed: @@ -228,7 +228,7 @@ az network vnet subnet create \ --delegations Microsoft.ContainerInstance/containerGroups ``` -#### Create Public IP Address +#### Create public ip address To create the public IP address, run the following command, using your own values as needed: @@ -236,7 +236,7 @@ To create the public IP address, run the following command, using your own value az network public-ip create --name ${PUBLIC_IP_ADDRESS_NAME} --resource-group ${RESOURCE_GROUP} --sku standard --allocation static ``` -#### Create NAT Gateway +#### Create nat gateway To create the [Azure Network Address Translation (NAT) gateway](https://learn.microsoft.com/en-us/azure/nat-gateway/nat-overview), run the following command, using your own values as needed: @@ -248,7 +248,7 @@ az network nat gateway create \ --idle-timeout 4 ``` -#### Configure NAT Service for Source Subnet +#### Configure nat service for source Subnet To configure the NAT service, run the following command, using your own values as needed: @@ -273,7 +273,7 @@ export AKS_SUBNET_ID=$(az network vnet subnet show \ --output tsv) ``` -#### Create an AKS Service +#### Create an AKS service To create the AKS service, run the following command, using your own values as needed: @@ -303,7 +303,7 @@ az aks create \ Be sure to use the latest supported Kubernetes version, using the `--kubernetes-version` flag. If you use an earlier version, you must enable Long-Term Support (LTS). For details, see [Long-term support for Azure Kubernetes Service (AKS) versions](https://learn.microsoft.com/en-us/azure/aks/long-term-support) in the Microsoft documentation. ::: -#### Get the Principal ID of the Managed Identity +#### Get the principal ID of the managed identity To get the Principal ID, run the following command, using your own values as needed: @@ -313,7 +313,7 @@ export MANAGED_IDENTITY_PRINCIPAL_ID="$(az aks show --resource-group ${RESOURCE_ For details, see [Get the principal ID of the system-assigned managed identity](https://learn.microsoft.com/en-us/azure/aks/use-managed-identity#get-the-principal-id-of-the-system-assigned-managed-identity) in the Microsoft Azure documentation. -#### Create Contributor Role for the Two Resource Groups +#### Create contributor role for the two resource groups To create the contributor role for each group, run the following commands, using your own values as needed: @@ -333,7 +333,7 @@ Additional reference information in external documentation: - [Tutorial: Deploy virtual nodes on Azure Container Instances in your Azure Kubernetes Service cluster](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-tutorial-virtual-nodes-helm) - [Setting up a virtual node Environment](https://github.com/microsoft/VirtualNodesOnAzureContainerInstances?tab=readme-ov-file#setting-up-a-virtual-node-environment) -### Set Up AKS Cluster +### Set up AKS cluster To set up the AKS cluster, run the following command, using your own values as needed: @@ -350,7 +350,7 @@ helm install virtualnode virtualnodesOnAzureContainerInstances/Helm/virtualnode kubectl get nodes ``` -### Complete Key Vault and Managed Identity Setup +### Complete key vault and managed identity setup The next step is to set up a [key vault](https://learn.microsoft.com/en-us/azure/key-vault/general/overview) and save the operator key in it. When you've created the key vault, you can create a [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview) and grant it permission to access the key vault. @@ -372,14 +372,14 @@ export IDENTITY_PRINCIPAL_ID="$(az identity show --name "${MANAGED_IDENTITY}" -- az role assignment create --assignee-object-id "${IDENTITY_PRINCIPAL_ID}" --role "Key Vault Secrets User" --scope "${KEYVAULT_RESOURCE_ID}" --assignee-principal-type ServicePrincipal ``` -### Complete the UID2 Private Operator Setup +### Complete the UID2 Private Operator setup To complete the Private Operator setup, follow these steps: -- [Update Placeholder Values](#update-placeholder-values) -- [Deploy Operator](#deploy-operator) +- [Update placeholder values](#update-placeholder-values) +- [Deploy operator](#deploy-operator) -#### Update Placeholder Values +#### Update placeholder values After completing the previous steps, follow these steps to update placeholder values: @@ -423,7 +423,7 @@ After completing the previous steps, follow these steps to update placeholder va ``` -#### Deploy Operator +#### Deploy operator Follow these steps to deploy the Private Operator: @@ -439,7 +439,7 @@ Follow these steps to deploy the Private Operator: kubectl apply -f operator.yaml ``` -## Running the Health Check +## Running the health check Call the health check endpoint to test the health of your implementation. @@ -457,7 +457,7 @@ Follow these steps: An HTTP 200 with a response body of `OK` indicates healthy status. -### Private Operator Attestation Failure +### Private Operator attestation failure @@ -467,9 +467,9 @@ When a new version of UID2 Private Operator for AKS is released, participants ho To upgrade, complete the following steps: -1. Follow the instructions in [Download ZIP File and Extract Files](#download-zip-file-and-extract-files) to download the deployment file for the new version and then unzip it. +1. Follow the instructions in [Download ZIP file and extract files](#download-zip-file-and-extract-files) to download the deployment file for the new version and then unzip it. -2. Follow the instructions in [Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup), using the new files, to deploy your AKS implementation with the new versions. +2. Follow the instructions in [Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup), using the new files, to deploy your AKS implementation with the new versions. 3. Check the health of the new AKS deployment and make sure the status is healthy. @@ -479,6 +479,6 @@ To upgrade, complete the following steps: kubectl get pods ``` -## Keeping the Operator Key Secure +## Keeping the operator key secure diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index 9a4f87955..cb06a091c 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -15,7 +15,7 @@ import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; import SnptRuntimeErrors from '../snippets/_snpt-private-operator-runtime-errors.mdx'; -# UID2 Private Operator for AWS Integration Guide +# UID2 Private Operator for AWS integration guide The UID2 Operator is the API server in the UID2 ecosystem. For details, see [The UID2 Operator](../ref-info/ref-operators-public-private.md). @@ -32,7 +32,7 @@ By subscribing to UID2 Private Operator for AWS, you gain access to the followin - [CloudFormation](https://aws.amazon.com/cloudformation/) template:
The template deploys the UID2 Operator AMI. -## Operator Version +## Operator version The latest ZIP file is linked in the Release Notes column in the following table. @@ -41,10 +41,10 @@ The latest ZIP file is linked in the Release Notes column in the following table | Q4 2025 | [v5.62.24](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.62.24-r2) | v5.62.24-r2 | January 15, 2026 | :::note -For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions). +For information about supported versions and deprecation dates, see [Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions). ::: -## Private Operator Upgrade Policy +## Private Operator upgrade policy @@ -55,7 +55,7 @@ To subscribe and deploy one or more UID2 Operators on AWS, complete the followin 1. Register your organization as a UID2 Operator. 2. Create an AWS account with an [IAM](https://aws.amazon.com/iam/) role that has the [minimal privileges](#minimal-iam-role-privileges). -#### Minimal IAM Role Privileges +#### Minimal iam role privileges To succeed in a one-click deployment, your AWS account **must** have the privileges to run the following actions: @@ -120,7 +120,7 @@ To succeed in a one-click deployment, your AWS account **must** have the privile } ``` -### Resources Created +### Resources created The following table lists all resources that are created during the [deployment](#deployment). @@ -131,11 +131,11 @@ The following table lists all resources that are created during the [deployment] | `TokenSecret` | `AWS::SecretsManager::Secret` | A Secrets Manager secret to store the operator key. | | `WorkerRole` | `AWS::IAM::Role` | The IAM role that your UID2 Operators run as. The role provides access to AWS Secrets Manager to retrieve operator keys. | | `WorkerInstanceProfile` | `AWS::IAM::InstanceProfile` | The instance profile with Worker Role to attach to Operator EC2 instances. | -| `SecurityGroup` | `AWS::EC2::SecurityGroup` | A security group policy that provides rules for operator instances. See also [Security Group Policy](#security-group-policy).| +| `SecurityGroup` | `AWS::EC2::SecurityGroup` | A security group policy that provides rules for operator instances. See also [Security group policy](#security-group-policy).| | `LaunchTemplate` | `AWS::EC2::LaunchTemplate` | A launch template with all configurations in place. You can spawn new UID2 Operator instances from it. | | `AutoScalingGroup` | `AWS::AutoScaling::AutoScalingGroup` | An auto-scaling group (ASG) to which the launch template is attached. You can use this to update the desired number of instances later, if needed. | -### Customization Options +### Customization options Here's what you can customize during or after the [deployment](#deployment): @@ -144,7 +144,7 @@ Here's what you can customize during or after the [deployment](#deployment): - SSH key: This is the SSH key that you use to access the UID2 Operator EC2 instances. - [Instance type](https://aws.amazon.com/ec2/instance-types/): m5.2xlarge, m5.4xlarge, and so on. If there is no customization, the default value, m5.2xlarge, is recommended. -### Security Group Policy +### Security group policy :::note 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. @@ -152,17 +152,17 @@ To avoid passing certificates associated with your domain into the enclave, inbo | 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). | +| 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`). | | 443 | Outbound | HTTPS | Calls the UID2 Core Service, AWS S3, to download files for opt-out data and key store. | -### VPC Chart +### VPC chart The following diagram illustrates the virtual private cloud that hosts private operators. -![UID2 Operator VPC Chart](images/aws-vpc-chart-uid2.png) +![UID2 Operator VPC chart](images/aws-vpc-chart-uid2.png) -## Preparing DII for Processing +## Preparing DII for processing @@ -173,7 +173,7 @@ To deploy UID2 Operator on AWS Marketplace, complete the following steps: 1. Subscribe to [Unified ID 2.0 Operator on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-wdbccsarov5la). It might take several minutes before AWS completes your subscription. 2. Click **Configuration** and then specify configuration values. - For software version, see [Operator Version](#operator-version) and choose the value in the AWS Version column. + For software version, see [Operator version](#operator-version) and choose the value in the AWS Version column. 3. On the Configuration page, click **Launch** and then select the **Launch CloudFormation** action. 4. In the Create Stack wizard, specify the template and then click **Next**. The S3 path for the template file is automatically filled in. 5. Fill in the [stack details](#stack-details) and then click **Next**. @@ -184,15 +184,15 @@ To deploy UID2 Operator on AWS Marketplace, complete the following steps: It takes several minutes for the stack to be created. When you see an Auto Scaling Group (ASG) created, you can select it and check the EC2 instances. By default, there is only one instance to start with. -### Stack Details +### Stack details The following images show the **Specify stack details** page in the Create stack wizard ([deployment](#deployment) step 5). The table that follows provides a parameter value reference. -![Application Configuration](images/cloudformation-step-2.png) +![Application configuration](images/cloudformation-step-2.png) Lower part of the page: -![Infrastructure Configuration](images/cloudformation-step-2-2.png) +![Infrastructure configuration](images/cloudformation-step-2-2.png) The following table explains the parameter values that you need to provide in step 5 during the [deployment](#deployment). @@ -209,11 +209,11 @@ The following table explains the parameter values that you need to provide in st |VpcSubnet1 |The existing VPC AZ1 Subnet ID. | |VpcSubnet2 |The existing VPC AZ2 Subnet ID. | -### Stack Configuration Options +### Stack configuration options The following image shows the **Configure stack options** page in the Create stack wizard ([deployment](#deployment) step 6). -![Configure Stack Options](images/cloudformation-step-3.png) +![Configure stack options](images/cloudformation-step-3.png) The following table explains the parameter values that you need to provide in step 6 during the [deployment](#deployment). @@ -224,7 +224,7 @@ The following table explains the parameter values that you need to provide in st |Stack failure options |Choose what happens when deployment fails. The `Roll back all stack resources` option is recommended. | |Advanced options | These are optional. | -## Creating a Load Balancer +## Creating a load balancer To create a load balancer and a target operator auto-scaling group, complete the following steps: @@ -248,16 +248,16 @@ To create a load balancer and a target operator auto-scaling group, complete the 10. Go back to the Load Balancer page, and under **Listeners and routing**, select `UID2ALBTG` as the target group to forward to as a default action. Note that you may have to refresh the target groups for your newly created target group to appear. Change the listener **Port** value to `443`. 11. Set up an HTTPS listener by following the instructions in the [AWS user guide](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html). 12. Click **Create load balancer**. -13. To verify the status of this load balancer, please continue in the below section: [Checking UID2 Operator Status](#checking-uid2-operator-status) +13. To verify the status of this load balancer, please continue in the below section: [Checking UID2 Operator status](#checking-uid2-operator-status) -## Checking UID2 Operator Status +## Checking UID2 Operator status To check the UID2 Operator status of your Load Balancer, complete the following steps: 1. Identify the DNS name of your load balancer by going to **EC2 > Load balancers** and looking at the **DNS name** column of your load balancer. 2. In your browser, go to `https://{dns-name-of-your-load-balancer}/ops/healthcheck`. A response of `OK` indicates good operator status. -### Private Operator Attestation Failure +### Private Operator attestation failure @@ -274,30 +274,30 @@ Here's what you need to know about upgrading: For a smooth transition, create the new stack first. After the new stack is bootstrapped and ready to serve, delete the old stack. If you are using a load balancer, first get the new instances up and running and then convert the DNS name from the previous one to the new one. ::: -## Managing the Logs +## Managing the logs Use the following sections to help you make the best use of your logs: -- [Where to Read Logs](#where-to-read-logs) -- [Default Log Settings](#default-log-settings) -- [Changing the Log Rotation Schedule](#changing-the-log-rotation-schedule) -- [Additional Commands for Logging](#additional-commands-for-logging) +- [Where to read logs](#where-to-read-logs) +- [Default log settings](#default-log-settings) +- [Changing the log rotation schedule](#changing-the-log-rotation-schedule) +- [Additional commands for logging](#additional-commands-for-logging) -### Where to Read Logs +### Where to read logs To access the logs, ssh into the EC2 instance. The logs are located at `/var/logs/` and are in the format `operator.log-`. -### Default Log Settings +### Default log settings The UID2 system uses `syslog-ng` for log generation and employs `logrotate` with cron jobs to manage log rotation and prevent excessive log size. The following sections provide information on the default settings and the reasons behind them, and give guidance for customizing the log rotation configuration to meet your specific requirements: -- [Log Rotation Configuration](#log-rotation-configuration) -- [Log Rotation Default Settings](#log-rotation-default-settings) +- [Log rotation configuration](#log-rotation-configuration) +- [Log rotation default settings](#log-rotation-default-settings) - [cronjob Configuration](#cronjob-configuration) -#### Log Rotation Configuration +#### Log rotation configuration When the operator instance has been deployed, the default log rotation settings are applied, as follows: - Logs are rotated daily and 30 log entries are kept, so the log history is equivalent to 30 days of data if the log entries are not abnormally large. - If log entries are very large, and the log size reaches 30 MB within a 24-hour period, the log is rotated at that point. -#### Log Rotation Default Settings +#### Log rotation default settings The following are the default logrotate settings, defined in `/etc/logrotate.d/operator-logrotate.conf`: @@ -346,7 +346,7 @@ These are the default settings for the following reasons: - The script ensure that the `maxsize` condition is checked frequently. - The command refers to `/var/lib/logrotate/logrotate.status` to check the log status and see if it has reached the rotation condition, so that it won't make extra rotations when `logrotate` is run every minute. -### Changing the Log Rotation Schedule +### Changing the log rotation schedule To change the log rotation schedule, update the `etc/logrotate.d/operator-logrotate.conf` file. @@ -356,7 +356,7 @@ Follow the instructions in the logrotate documentation: see [logrotate(8) - Linu The service does NOT need to be restarted to pick up the change. ::: -### Additional Commands for Logging +### Additional commands for logging The following table includes some additional commands that might help you manage logs. @@ -366,11 +366,11 @@ The following table includes some additional commands that might help you manage | Runs one iteration of `logrotate` manually, without changing the scheduled interval. | `sudo logrotate -f /etc/logrotate.conf --force` | | Reloads `syslog-ng`. | `sudo /usr/sbin/syslog-ng-ctl reload` | -## Keeping the Operator Key Secure +## Keeping the operator key secure -## UID2 Operator Error Codes +## UID2 Operator error codes The following sections list error codes that might occur during a Private Operator's startup or runtime. @@ -378,7 +378,7 @@ The following sections list error codes that might occur during a Private Operat Error codes for Private Operator issues are applicable only to release v5.49.7 and later. ::: -### Startup Errors +### Startup errors The following errors might occur during operator startup: @@ -391,12 +391,12 @@ The following errors might occur during operator startup: | E05 | OperatorKeyValidationError | Ensure the operator key is correct for the environment and matches the one provided to you. | | E06 | UID2ServicesUnreachableError | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. | -### Runtime Errors +### Runtime errors The following errors might occur during operator runtime: -## Technical Support +## Technical support If you have trouble subscribing to the product, or deploying, [contact us](mailto:aws-mktpl-uid@thetradedesk.com). diff --git a/docs/guides/operator-guide-azure-enclave.md b/docs/guides/operator-guide-azure-enclave.md index 407d53250..cd40f0741 100644 --- a/docs/guides/operator-guide-azure-enclave.md +++ b/docs/guides/operator-guide-azure-enclave.md @@ -15,7 +15,7 @@ import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; import SnptRuntimeErrors from '../snippets/_snpt-private-operator-runtime-errors.mdx'; -# UID2 Private Operator for Azure Integration Guide +# UID2 Private Operator for Azure integration guide The UID2 Operator is the API server in the UID2 ecosystem. For details, see [The UID2 Operator](../ref-info/ref-operators-public-private.md). @@ -29,7 +29,7 @@ When the attestation is successful, the UID2 Core Service provides seed informat UID2 Private Operator for Azure is not supported in these areas: Europe, China. ::: -## Operator Version +## Operator version The latest ZIP file is linked in the Azure Download column in the following table. @@ -38,10 +38,10 @@ The latest ZIP file is linked in the Azure Download column in the following tabl | Q4 2025 | v5.62.24 | [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 | :::note -For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions). +For information about supported versions and deprecation dates, see [Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions). ::: -## Private Operator Upgrade Policy +## Private Operator upgrade policy @@ -49,13 +49,13 @@ For information about supported versions and deprecation dates, see [Private Ope Before deploying the UID2 Private Operator for Azure, complete these prerequisite steps: -- [Set Up UID2 Operator Account](#set-up-uid2-operator-account) +- [Set up UID2 Operator account](#set-up-uid2-operator-account) - [Install Azure CLI](#install-azure-cli) -- [Get the Required Azure Permissions](#install-azure-cli) +- [Get the required Azure permissions](#install-azure-cli) -### Set Up UID2 Operator Account +### Set up UID2 Operator account -Ask your UID2 contact to register your organization as a UID2 Operator. If you're not sure who to ask, see [Contact Info](../getting-started/gs-account-setup.md#contact-info). +Ask your UID2 contact to register your organization as a UID2 Operator. If you're not sure who to ask, see [Contact info](../getting-started/gs-account-setup.md#contact-info). When the registration process is complete, you'll receive an operator key, exclusive to you, that identifies you with the UID2 service as a Private Operator. During configuration, use this as the value for `OPERATOR_KEY`. This value is both your unique identifier and a password; store it securely and do not share it. @@ -67,7 +67,7 @@ You'll receive a separate operator key for each deployment environment. Install the Azure command-line interface. For details, see [How to install the Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) in the Azure documentation. -### Get the Required Azure Permissions +### Get the required Azure permissions You'll need to have subscription owner permission so that you can create a resource group. @@ -77,11 +77,11 @@ For details, see [Azure roles](https://learn.microsoft.com/en-us/azure/role-base When all prerequisite steps are complete, you're ready to deploy the UID2 Private Operator. See [Deployment](#deployment). -## Preparing DII for Processing +## Preparing DII for processing -## Deployment Environments +## Deployment environments The following environments are available. As a best practice, we recommend that you test and verify your implementation in the integration environment before deploying in the production environment. @@ -98,14 +98,14 @@ You'll receive separate `{OPERATOR_KEY}` values for each environment. Be sure to To deploy a new UID2 Private Operator for Azure, you'll need to complete the following high-level steps: -- [Download ZIP File and Extract Files](#download-zip-file-and-extract-files) -- [Create Resource Group](#create-resource-group) -- [Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup) -- [Set Up the VPC Network](#set-up-the-vpc-network) -- [Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup) -- [Set Up the Gateway Load Balancer](#set-up-the-gateway-load-balancer) +- [Download ZIP file and extract files](#download-zip-file-and-extract-files) +- [Create resource group](#create-resource-group) +- [Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup) +- [Set up the VPC network](#set-up-the-vpc-network) +- [Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup) +- [Set up the gateway load balancer](#set-up-the-gateway-load-balancer) -### Download ZIP File and Extract Files +### Download ZIP file and extract files The first step is to get set up with the deployment files you'll need: @@ -118,7 +118,7 @@ The first step is to get set up with the deployment files you'll need: - `operator.json` and `operator.parameters.json` - `gateway.json` and `gateway.parameters.json` -### Create Resource Group +### Create resource group In Azure, run the following command to create a resource group to run the UID2 operator: @@ -141,7 +141,7 @@ There are some limitations with regard to location: az account list-locations -o table ``` -### Complete Key Vault and Managed Identity Setup +### Complete key vault and managed identity setup The next step is to set up a [key vault](https://learn.microsoft.com/en-us/azure/key-vault/general/overview) and save the operator key in it. @@ -156,7 +156,7 @@ Follow these steps: | Parameter | Description | | :--- | :--- | | `vaultName` | The name of the key vault for hosting the operator key secret. The name you choose must be globally unique. | - | `operatorKeyValue` | The `OPERATOR_KEY` secret value, which you received from the UID team as part of account setup (see [Set Up UID2 Operator Account](#set-up-uid2-operator-account)). This value is unique to you, and acts as a password: keep it secure and secret. | + | `operatorKeyValue` | The `OPERATOR_KEY` secret value, which you received from the UID team as part of account setup (see [Set up UID2 Operator account](#set-up-uid2-operator-account)). This value is unique to you, and acts as a password: keep it secure and secret. | 2. (Optional) If you don't want to accept the defaults, update the `vault.parameters.json` file with the following values. These parameters have default values and in most cases you won't need to make any updates. @@ -171,13 +171,13 @@ Follow these steps: az deployment group create --name vault --resource-group {RESOURCE_GROUP_NAME} --parameters vault.parameters.json --template-file vault.json ``` -### Set Up the VPC Network +### Set up the VPC network The next step is to set up the VPC network. The following diagram illustrates the virtual private cloud that hosts a UID2 Private Operator in Microsoft Azure. -![VPC Network](images/operator-azure-drawio.png) +![VPC network](images/operator-azure-drawio.png) Follow these steps: @@ -198,7 +198,7 @@ Follow these steps: az deployment group create --name vnet --resource-group {RESOURCE_GROUP_NAME} --parameters vnet.parameters.json --template-file vnet.json ``` -### Complete the UID2 Private Operator Setup +### Complete the UID2 Private Operator setup The next step is to bring up multiple Azure Container Instances (ACIs) in the VPC subnetwork that you created. @@ -208,17 +208,17 @@ Follow these steps: | Parameter | Description | | :--- | :--- | - | `vaultName` | The name of the key vault for hosting the operator key secret. The value must match the name you created in [Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup). | - | `deploymentEnvironment` | Indicates the environment you're deploying to: `integ` or `prod`. For details, see [Deployment Environments](#deployment-environments). | + | `vaultName` | The name of the key vault for hosting the operator key secret. The value must match the name you created in [Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup). | + | `deploymentEnvironment` | Indicates the environment you're deploying to: `integ` or `prod`. For details, see [Deployment environments](#deployment-environments). | 2. (Optional) If you don't want to accept the defaults, update the `operator.parameters.json` file with the following values. These parameters have default values and in most cases you won't need to make any updates. Parameter | Description | | :--- | :--- | - | `operatorKeyName` | The operator key secret name. The value must match the value specified in [Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup). If you accepted the default, the value is `operator-key`. | - | `operatorIdentifier` | The name of the managed identity that will launch the container. The value must match the value specified in [Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup). If you accepted the default, the value is `uid-operator`. | - | `vnetName` | The virtual network name. The value must match the value specified in [Set Up the VPC Network](#set-up-the-vpc-network). If you accepted the default, the value is `unified-id-network`. | - | `computeSubnetName` | The name of the subnet that will run the Private Operator. The value must match the value specified in [Set Up the VPC Network](#set-up-the-vpc-network). If you accepted the default, the value is `unified-id-subnet-operators`. | + | `operatorKeyName` | The operator key secret name. The value must match the value specified in [Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup). If you accepted the default, the value is `operator-key`. | + | `operatorIdentifier` | The name of the managed identity that will launch the container. The value must match the value specified in [Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup). If you accepted the default, the value is `uid-operator`. | + | `vnetName` | The virtual network name. The value must match the value specified in [Set up the VPC network](#set-up-the-vpc-network). If you accepted the default, the value is `unified-id-network`. | + | `computeSubnetName` | The name of the subnet that will run the Private Operator. The value must match the value specified in [Set up the VPC network](#set-up-the-vpc-network). If you accepted the default, the value is `unified-id-subnet-operators`. | | `count` | The count for the number of instances you want to bring up. The default is `2`. | 2. Run the following command to deploy the ACIs: @@ -239,7 +239,7 @@ Follow these steps: { "ipAddress": { "type": "Array", "value": [ "10.0.0.5", "10.0.0.4" ] } } ``` -### Set Up the Gateway Load Balancer +### Set up the gateway load balancer The next step is to set up the [Gateway Load Balancer](https://learn.microsoft.com/en-us/azure/load-balancer/gateway-overview), which takes the private IP addresses of the ACIs you created and uses them as a [backend pool](https://learn.microsoft.com/en-us/azure/load-balancer/backend-pool-management). @@ -249,7 +249,7 @@ Follow these steps: | Parameter | Description | | :--- | :--- | - | `containerGroupIPs` | The IP addresses of the ACI instances you created—the values output as a result of [Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup) Step 4. | + | `containerGroupIPs` | The IP addresses of the ACI instances you created—the values output as a result of [Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup) Step 4. | For example, the updated file might look something like the following: @@ -266,8 +266,8 @@ Follow these steps: Parameter | Description | | :--- | :--- | - | `vnetName` | The virtual network name. The value must match the value specified in [Set Up the VPC Network](#set-up-the-vpc-network). If you accepted the default, the value is `unified-id-network`. | - | `gatewaySubnetName` | The name of the subnet that runs the UID2 Gateway. The value must match the value specified in [Set Up the VPC Network](#set-up-the-vpc-network). If you accepted the default, the value is `unified-id-subnet-gateway`. | + | `vnetName` | The virtual network name. The value must match the value specified in [Set up the VPC network](#set-up-the-vpc-network). If you accepted the default, the value is `unified-id-network`. | + | `gatewaySubnetName` | The name of the subnet that runs the UID2 Gateway. The value must match the value specified in [Set up the VPC network](#set-up-the-vpc-network). If you accepted the default, the value is `unified-id-subnet-gateway`. | 2. Run the following command: @@ -295,7 +295,7 @@ If you update the container, the Azure backend pool is not automatically updated This example deploys a Gateway Load Balancer with HTTP. We strongly recommend you set up SSL. For instructions, see [Tutorial: Configure an Application Gateway with TLS termination using the Azure portal](https://learn.microsoft.com/en-us/azure/application-gateway/create-ssl-portal) in the Azure documentation. ::: -## Running the Health Check +## Running the health check Call the health check endpoint to test the health of your implementation. @@ -303,22 +303,22 @@ Running the health check is the same for the integration and production environm Follow these steps: -1. Get the public IP address for the Gateway Load Balancer—the value output as a result of [Set Up the Gateway Load Balancer](#set-up-the-gateway-load-balancer) Step 4. +1. Get the public IP address for the Gateway Load Balancer—the value output as a result of [Set up the gateway load balancer](#set-up-the-gateway-load-balancer) Step 4. 2. To test operator status, in your browser, go to the health check endpoint: `http://{LB_IP}/ops/healthcheck`. An HTTP 200 with a response body of `OK` indicates healthy status. -### Private Operator Attestation Failure +### Private Operator attestation failure -### Scraping Metrics +### Scraping metrics The Private Operator for Azure exposes [Prometheus-formatted metrics](https://prometheus.io/docs/concepts/data_model/) on port 9080 through the `/metrics` endpoint. You can use a Prometheus-compatible scraper to collect and aggregate these metrics for your own needs. The scraper must have access to the VNet that the Private Operator is running in. We do not recommend giving the load balancer access to the `/metrics` endpoint. -## Network Security Group Policy +## Network security group policy :::note To avoid passing certificates associated with your domain into the enclave, only inbound HTTP is allowed. Inbound HTTPS is not allowed. This also avoids the extra cost of another secure layer in a network that's already private and internal to your organization. @@ -328,8 +328,8 @@ The following table provides information about supported protocols. | 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). | +| 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). | | 443 | Outbound | HTTPS | Calls the UID2 Core Service and Azure Blob Storage, to download files for opt-out data and key store. | ## Upgrading @@ -338,11 +338,11 @@ When a new version of UID2 Azure Confidential Containers is released, private op To upgrade, complete the following steps: -1. Follow the instructions in [Download ZIP File and Extract Files](#download-zip-file-and-extract-files) to download the deployment file for the new version and then unzip it. +1. Follow the instructions in [Download ZIP file and extract files](#download-zip-file-and-extract-files) to download the deployment file for the new version and then unzip it. -1. Follow the instructions in [Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup), using the new files, to deploy ACIs with new versions. +1. Follow the instructions in [Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup), using the new files, to deploy ACIs with new versions. -2. Follow the instructions in [Set Up the Gateway Load Balancer](#set-up-the-gateway-load-balancer) to add the new ACIs to the backend pool. +2. Follow the instructions in [Set up the gateway load balancer](#set-up-the-gateway-load-balancer) to add the new ACIs to the backend pool. 3. Check the health of the new ACIs and make sure the status is healthy, as shown in the following example: @@ -350,7 +350,7 @@ To upgrade, complete the following steps: az network application-gateway show-backend-health --resource-group {RESOURCE_GROUP_NAME} --name uid-operator-gateway ``` -4. Clean up old ACIs from the Gateway Load Balancer: Follow the instructions in [Set Up the Gateway Load Balancer](#set-up-the-gateway-load-balancer) to remove the old ACIs from the backend pool. +4. Clean up old ACIs from the Gateway Load Balancer: Follow the instructions in [Set up the gateway load balancer](#set-up-the-gateway-load-balancer) to remove the old ACIs from the backend pool. 5. Shut down old ACIs by running the following command: @@ -358,11 +358,11 @@ To upgrade, complete the following steps: for i in {0..COUNT}; az container delete --name uid-operator-OLD-VERSION-$i --resource-group {RESOURCE_GROUP} --yes ``` -## Keeping the Operator Key Secure +## Keeping the operator key secure -## UID2 Operator Error Codes +## UID2 Operator error codes The following sections list error codes that might occur during a Private Operator's startup or runtime. @@ -370,7 +370,7 @@ The following sections list error codes that might occur during a Private Operat Error codes for Private Operator issues are applicable only to release v5.49.7 and later. ::: -### Startup Errors +### Startup errors The following errors might occur during operator startup: @@ -383,7 +383,7 @@ The following errors might occur during operator startup: | E06 | UID2ServicesUnreachableError | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. | | E08 | OperatorKeyPermissionError | The managed identity (specified via the `operatorIdentifier` parameter) that launches the container must have access to the key vault where the operator key is stored. The value of `operatorIdentifier` must be identical across all configuration JSON files. | -### Runtime Errors +### Runtime errors The following errors might occur during operator runtime: diff --git a/docs/guides/operator-private-gcp-confidential-space.md b/docs/guides/operator-private-gcp-confidential-space.md index 259dd3746..faa1f19df 100644 --- a/docs/guides/operator-private-gcp-confidential-space.md +++ b/docs/guides/operator-private-gcp-confidential-space.md @@ -15,7 +15,7 @@ import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; import SnptRuntimeErrors from '../snippets/_snpt-private-operator-runtime-errors.mdx'; -# UID2 Private Operator for GCP Integration Guide +# UID2 Private Operator for GCP integration guide The UID2 Operator is the API server in the UID2 ecosystem. For details, see [The UID2 Operator](../ref-info/ref-operators-public-private.md). @@ -31,7 +31,7 @@ When the Docker container for the UID2 Operator Confidential Space starts up, it When the attestation is successful, the UID2 Core Service provides seed information such as salts and keys to bootstrap the UID2 Operator in the secure Confidential Space container. -## Operator Version +## Operator version The latest ZIP file is linked in the GCP Download column in the following table. @@ -40,14 +40,14 @@ The latest ZIP file is linked in the GCP Download column in the following table. | 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 | :::note -For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions). +For information about supported versions and deprecation dates, see [Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions). ::: -## Private Operator Upgrade Policy +## Private Operator upgrade policy -## Setup Overview +## Setup overview At a high level, the setup steps are as follows: @@ -59,10 +59,10 @@ At a high level, the setup steps are as follows: We recommend the Terraform template option. 1. Follow the applicable instructions for the deployment option you chose, out of the following: - - [Terraform Template](#deployterraform-template) + - [Terraform template](#deployterraform-template) - [gcloud CLI](#deploygcloud-cli) 1. Enable egress rule if required. - - See [Confidential Space Account Setup](#confidential-space-account-setup), Step 4. + - See [Confidential space account setup](#confidential-space-account-setup), Step 4. When all steps are complete, your implementation should be up and running. @@ -70,10 +70,10 @@ When all steps are complete, your implementation should be up and running. Before setting up your UID2 Operator Service in the Google Cloud Platform using Confidential Space, complete these prerequisite steps: -- [Confidential Space Account Setup](#confidential-space-account-setup) -- [UID2 Operator Account Setup](#uid2-operator-account-setup) +- [Confidential space account setup](#confidential-space-account-setup) +- [UID2 Operator account setup](#uid2-operator-account-setup) -### Confidential Space Account Setup +### Confidential space account setup You can run the UID2 Operator Service on any GCP account and project. However, to support attestation, you'll need to create a service account that you can use to run Confidential Space virtual machines (VMs). @@ -90,9 +90,9 @@ Before choosing your deployment option, complete these Google Cloud setup steps: 1. Enable egress rule. If your VPC infrastructure only allows egress to known endpoints, you will need to enable an egress rule to allow the operator to retrieve the certificates required for attestation. To enable this, follow the details in this document from Google: [VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products#table_confidential_space). -### UID2 Operator Account Setup +### UID2 Operator account setup -Ask your UID2 contact to register your organization as a UID2 Operator. If you're not sure who to ask, see [Contact Info](../getting-started/gs-account-setup.md#contact-info). +Ask your UID2 contact to register your organization as a UID2 Operator. If you're not sure who to ask, see [Contact info](../getting-started/gs-account-setup.md#contact-info). :::tip It's a good idea to set up an internal email distribution list of individuals who should be kept informed about new versions and any other technical notifications or requests, and provide that as the email contact. @@ -109,11 +109,11 @@ When UID2 account registration is complete, and you've installed the gcloud CLI, - Review information about [deployment environments](#deployment-environments). - Review information about the [deployment options](#deployment-options) available, including the benefits of each, and decide which to use. -## Preparing DII for Processing +## Preparing DII for processing -## Deployment Environments +## Deployment environments The following environments are available, and both [deployment options](#deployment-options) support both environments. @@ -126,9 +126,9 @@ You'll receive separate `{OPERATOR_KEY}` values for each environment. Be sure to | Environment | Details | | :--- | :--- | | Integration (`integ`) | For testing only. Debug mode is available in the integration environment. | -| Production (`prod`) | For managing production traffic. For this environment, we recommend deploying via the Terraform template, with load balancing, and with HTTPS enabled. See [Deployment Options](#deployment-options). | +| Production (`prod`) | For managing production traffic. For this environment, we recommend deploying via the Terraform template, with load balancing, and with HTTPS enabled. See [Deployment options](#deployment-options). | -## Deployment Options +## Deployment options There are two deployment options: @@ -140,10 +140,10 @@ There are two deployment options: Both deployment options support both deployment environments. To determine your next steps, choose the deployment option you want to use. Then, follow the applicable instructions: -- [Deploy—Terraform Template](#deployterraform-template) +- [Deploy—Terraform template](#deployterraform-template) - [Deploy—gcloud CLI](#deploygcloud-cli) -### Deploy—Terraform Template +### Deploy—Terraform template For ease of deployment and upgrade, you can use a Terraform template to deploy a UID2 Private Operator implementation with load balancing and auto-scaling features. In this scenario, all VM instances run on Confidential Space VMs, and are deployed in multiple availability zones (AZs). @@ -159,29 +159,29 @@ The Terraform template does the following: - If HTTPS is enabled, provides your HTTPS certificate to Terraform. :::note -The Terraform template uses the gcloud CLI that you installed in [Confidential Space Account Setup](#confidential-space-account-setup) Step 3. +The Terraform template uses the gcloud CLI that you installed in [Confidential space account setup](#confidential-space-account-setup) Step 3. ::: To deploy a new UID2 Operator in the GCP Confidential Space Enclave, using the Terraform template, follow these steps: 1. [Install Terraform](#install-terraform) -1. [Set Up the Terraform Environment](#set-up-the-terraform-environment) -1. [Download the Template Files](#download-the-template-files) -1. [Provide Input Values](#provide-input-values) +1. [Set up the Terraform environment](#set-up-the-terraform-environment) +1. [Download the template files](#download-the-template-files) +1. [Provide input values](#provide-input-values) 1. [Run Terraform](#run-terraform) -1. [Test Terraform Using the Health Check Endpoint](#test-terraform-using-the-health-check-endpoint) +1. [Test Terraform using the health check endpoint](#test-terraform-using-the-health-check-endpoint) For additional information, see: -- [Delete All Created Resources](#delete-all-created-resources) +- [Delete all created resources](#delete-all-created-resources) - [Outputs](#outputs) #### Install Terraform Install Terraform if it is not already installed: visit [terraform.io](https://www.terraform.io/). -#### Set Up the Terraform Environment +#### Set up the Terraform environment -1. Create a new project or select an existing one, replacing the `{PROJECT_ID}` placeholder with your own project ID (see [Confidential Space Account Setup](#confidential-space-account-setup)): +1. Create a new project or select an existing one, replacing the `{PROJECT_ID}` placeholder with your own project ID (see [Confidential space account setup](#confidential-space-account-setup)): ``` gcloud config set project {PROJECT_ID} @@ -193,9 +193,9 @@ Install Terraform if it is not already installed: visit [terraform.io](https://w gcloud auth application-default login ``` -#### Download the Template Files +#### Download the template files -Download the ZIP file listed in [Operator Version](#operator-version) in the GCP Download column. Be sure to select the latest version. Unzip the files to a convenient location. You will have the files listed in the following table. +Download the ZIP file listed in [Operator version](#operator-version) in the GCP Download column. Be sure to select the latest version. Unzip the files to a convenient location. You will have the files listed in the following table. | File | Details | | :--- | :--- | @@ -204,7 +204,7 @@ Download the ZIP file listed in [Operator Version](#operator-version) in the GCP | `outputs.tf` | Includes output definitions. | | `terraform.tfvars` | Contains the values for the template input variables. | -#### Provide Input Values +#### Provide input values Provide values for the input parameters, as needed, in the `terraform.tfvars` file that you downloaded. Some are required, others are optional. @@ -215,7 +215,7 @@ Provide values for the input parameters, as needed, in the `terraform.tfvars` fi | `project_id` | `string` | `uid2-test` | yes | The ID of the GCP project that you want the UID2 Operator to run in; for example, `UID2-Operator-Production`. | | `service_account_name` | `string` | `tf-test` | yes | The name of the service account that you want to use for your UID2 Operator instance in GCP Confidential Space. | | `uid_operator_image` | `string` | `us-docker.pkg.dev/uid2-prod-project/iabtechlab/uid2-operator:{version_number}` | yes | The Docker image URL for the UID2 Private Operator for GCP, used in configuration. The version number changes depending on the version being deployed. | - | `uid_operator_key` | `string` | n/a | yes | The UID2 operator key, which you received as part of [UID2 Operator Account Setup](#uid2-operator-account-setup). | + | `uid_operator_key` | `string` | n/a | yes | The UID2 operator key, which you received as part of [UID2 Operator account setup](#uid2-operator-account-setup). | | `uid_operator_key_secret_name` | `string` | `secret-operator-key` | yes | The name of the key to create in Secret Manager. | | `uid_deployment_env` | `string` | `integ` | yes | Valid values: `integ` for integration environment, `prod` for production environment.
Machine type is determined by the deployment environment: `integ` uses `n2d-standard-2` and `prod` uses `n2d-standard-16`. | | `debug_mode` | `bool` | `true` | yes | Set to `true` to enable more diagnostic information. For the production environment, this must be set to `false` or the operator will not start. | @@ -253,13 +253,13 @@ When you run `terraform apply`, the following file is generated in the same fold Be sure to follow the recommended practices for Terraform `state` files: they are required for maintaining the deployed infrastructure, and they might contain sensitive information. For details, see [state](https://developer.hashicorp.com/terraform/language/state) in the Terraform documentation. ::: -#### Test Terraform Using the Health Check Endpoint +#### Test Terraform using the health check endpoint Call the health check endpoint to test the health of your implementation. The expected result is HTTP 200 with a response body of `OK`. -For instructions, see [Health Check—Terraform Template](#health-checkterraform-template). +For instructions, see [Health check—Terraform template](#health-checkterraform-template). -#### Delete All Created Resources +#### Delete all created resources In a scenario where you want to clean up, you can remove the resources created by the template. For example, you might want to test `integ` and remove the whole stack later. @@ -285,17 +285,17 @@ To deploy a new UID2 Operator in the GCP Confidential Space Enclave using the gc For deployment to the production environment we do not recommend this option. We recommend deploying via the Terraform template, with load balancing, and with HTTPS enabled. ::: - 1. [Set Up Service Account Rules and Permissions](#set-up-service-account-rules-and-permissions) - 1. [Create Secret for the Operator Key in Secret Manager](#create-secret-for-the-operator-key-in-secret-manager) - 1. [Update the Script with Valid Values](#update-the-script-with-valid-values) - 1. [Run the Script](#run-the-script) - 1. [Test gcloud Using the Health Check Endpoint](#test-gcloud-using-the-health-check-endpoint) + 1. [Set up service account rules and permissions](#set-up-service-account-rules-and-permissions) + 1. [Create secret for the operator key in secret manager](#create-secret-for-the-operator-key-in-secret-manager) + 1. [Update the script with valid values](#update-the-script-with-valid-values) + 1. [Run the script](#run-the-script) + 1. [Test gcloud using the health check endpoint](#test-gcloud-using-the-health-check-endpoint) -#### Set Up Service Account Rules and Permissions +#### Set up service account rules and permissions To set up and configure the account that you created when you installed the gcloud CLI, complete the following steps. Replace the placeholder values with your own valid values. -1. Switch to the project that you created in [Confidential Space Account Setup](#confidential-space-account-setup): +1. Switch to the project that you created in [Confidential space account setup](#confidential-space-account-setup): ``` $ gcloud config set project {PROJECT_ID} ``` @@ -368,11 +368,11 @@ To set up and configure the account that you created when you installed the gclo `source-ranges` specifies the range of IP addresses from which your clients will call the Private Operator. It is in CIDR notation, and you can use comma-separated values to provide multiple ranges. Example: `--source-ranges="10.0.0.0/8,10.10.0.0/16"`. Make sure the ranges are accurate and include only IP addresses that belong to you. ::: -#### Create Secret for the Operator Key in Secret Manager +#### Create secret for the operator key in secret manager -As part of setting up your UID2 account (see [UID2 Operator Account Setup](#uid2-operator-account-setup)), you'll receive an operator key for each environment. +As part of setting up your UID2 account (see [UID2 Operator account setup](#uid2-operator-account-setup)), you'll receive an operator key for each environment. -The next step is to store the `{OPERATOR_KEY}` value in GCP Secret Manager and get a full secret name for it, which you later use to replace the `{OPERATOR_KEY_SECRET_FULL_NAME}` placeholder in the deployment script (see [Update the Script with Valid Values](#update-the-script-with-valid-values)). +The next step is to store the `{OPERATOR_KEY}` value in GCP Secret Manager and get a full secret name for it, which you later use to replace the `{OPERATOR_KEY_SECRET_FULL_NAME}` placeholder in the deployment script (see [Update the script with valid values](#update-the-script-with-valid-values)). Follow these steps: 1. Run the following script, which creates a new secret, first customizing with your own values: @@ -401,15 +401,15 @@ Follow these steps: In this example, the full secret name might be: `projects/111111111111/secrets/uid2-operator-operator-key-secret-integ/versions/1`. This is the value that you would use to replace the `{OPERATOR_KEY_SECRET_FULL_NAME}` placeholder in the next section. -#### Update the Script with Valid Values +#### Update the script with valid values Update the example script, using your own valid values instead of the placeholder values. This section includes: -- [Placeholder Values and Definitions](#placeholder-values-and-definitions) -- [Sample Deployment Script—Integ](#sample-deployment-scriptinteg) -- [Sample Deployment Script—Prod](#sample-deployment-scriptprod) +- [Placeholder values and definitions](#placeholder-values-and-definitions) +- [Sample deployment script—integ](#sample-deployment-scriptinteg) +- [Sample deployment script—prod](#sample-deployment-scriptprod) ##### Placeholder Values and Definitions @@ -420,9 +420,9 @@ Placeholder values are defined in the following table. | `{INSTANCE_NAME}` | Your own valid VM name. | | `{ZONE}` | The Google Cloud zone that the VM instance will be deployed on. | | `{IMAGE_FAMILY}` | Use `confidential-space` for Integration and Production, `confidential-space-debug` for debugging purposes in Integration only. Note that `confidential-space-debug` will not work in Production. | -| `{SERVICE_ACCOUNT}` | The service account email that you created as part of creating your account, in this format: `{SERVICE_ACCOUNT_NAME}@{PROJECT_ID}.iam.gserviceaccount.com`.
For details, see [Set Up Service Account Rules and Permissions](#set-up-service-account-rules-and-permissions) (Step 4). | -| `{OPERATOR_IMAGE}` | The Docker image URL for the UID2 Private Operator for GCP, used in configuration.
This can be found in the `terraform.tfvars` file in the GCP download file (see [Operator Version](#operator-version)). | -| `{OPERATOR_KEY_SECRET_FULL_NAME}` | The full name that you specified for the Operator Key secret (see [Create Secret for the Operator Key in Secret Manager](#create-secret-for-the-operator-key-in-secret-manager)), including the path, in the format `projects//secrets//versions/`. For example: `projects/111111111111/secrets/uid2-operator-operator-key-secret-integ/versions/1`. | +| `{SERVICE_ACCOUNT}` | The service account email that you created as part of creating your account, in this format: `{SERVICE_ACCOUNT_NAME}@{PROJECT_ID}.iam.gserviceaccount.com`.
For details, see [Set up service account rules and permissions](#set-up-service-account-rules-and-permissions) (Step 4). | +| `{OPERATOR_IMAGE}` | The Docker image URL for the UID2 Private Operator for GCP, used in configuration.
This can be found in the `terraform.tfvars` file in the GCP download file (see [Operator version](#operator-version)). | +| `{OPERATOR_KEY_SECRET_FULL_NAME}` | The full name that you specified for the Operator Key secret (see [Create secret for the operator key in secret manager](#create-secret-for-the-operator-key-in-secret-manager)), including the path, in the format `projects//secrets//versions/`. For example: `projects/111111111111/secrets/uid2-operator-operator-key-secret-integ/versions/1`. | ##### Sample Deployment Script—Integ @@ -464,17 +464,17 @@ $ gcloud compute instances create {INSTANCE_NAME} \ --metadata ^~^tee-image-reference={OPERATOR_IMAGE}~tee-container-log-redirect=true~tee-restart-policy=Never~tee-env-DEPLOYMENT_ENVIRONMENT=prod~tee-env-API_TOKEN_SECRET_NAME={OPERATOR_KEY_SECRET_FULL_NAME}~tee-env-CORE_BASE_URL=https://core-prod.uidapi.com~tee-env-OPTOUT_BASE_URL=https://optout-prod.uidapi.com ``` -#### Run the Script +#### Run the script When the script is ready, with the additional valid values, run it. -#### Test gcloud Using the Health Check Endpoint +#### Test gcloud using the health check endpoint Call the health check endpoint to test the health of your implementation. The expected result is HTTP 200 with a response body of `OK`. -For instructions, see [Health Check—gcloud CLI](#health-checkgcloud-cli). +For instructions, see [Health check—gcloud CLI](#health-checkgcloud-cli). -## Running the Health Check +## Running the health check Call the health check endpoint to test the health of your implementation. @@ -482,10 +482,10 @@ Running the health check is the same for the integration and production environm Follow the applicable instructions depending on the deployment option you chose: -- [Health Check—Terraform Template](#health-checkterraform-template) -- [Health Check—gcloud CLI](#health-checkgcloud-cli) +- [Health check—Terraform template](#health-checkterraform-template) +- [Health check—gcloud CLI](#health-checkgcloud-cli) -### Health Check—Terraform Template +### Health check—Terraform template The following example shows the health check for the Terraform template option: @@ -500,7 +500,7 @@ The following example shows the health check for the Terraform template option: An HTTP 200 with a response body of `OK` indicates healthy status. -### Health Check—gcloud CLI +### Health check—gcloud CLI The following example shows the health check for the `gcloud` command line option: 1. Get the public IP address of the deployed instance: @@ -514,7 +514,7 @@ The following example shows the health check for the `gcloud` command line optio An HTTP 200 with a response body of `OK` indicates healthy status. -### Private Operator Attestation Failure +### Private Operator attestation failure @@ -524,10 +524,10 @@ When a new version of UID2 Google Cloud Platform Confidential Space is released, If you're upgrading to a new version, the upgrade process depends on the deployment option you chose. Follow the applicable steps: -- [Upgrading—Terraform Template](#upgradingterraform-template) +- [Upgrading—Terraform template](#upgradingterraform-template) - [Upgrading—gcloud CLI](#upgradinggcloud-cli) -### Upgrading—Terraform Template +### Upgrading—Terraform template If you previously deployed the Private Operator for GCP using the Terraform template, compare the latest version of the template with the one you used when you deployed. If there are changes, make sure to redeploy to include all the updates. @@ -537,14 +537,14 @@ If you deployed using the gcloud CLI, you must manually bring up new instances t If you previously set up a load balancer manually, you'll also need to update the mapping for the load balancer. -## Scraping Metrics +## Scraping metrics The Private Operator for GCP exposes [Prometheus-formatted metrics](https://prometheus.io/docs/concepts/data_model/) on port 9080 through the /metrics endpoint. You can use a Prometheus-compatible scraper to collect and aggregate these metrics for your own needs. -## Keeping the Operator Key Secure +## Keeping the operator key secure -## UID2 Operator Error Codes +## UID2 Operator error codes The following sections list error codes that might occur during a Private Operator's startup or runtime. @@ -552,7 +552,7 @@ The following sections list error codes that might occur during a Private Operat Error codes for Private Operator issues are applicable only to release v5.49.7 and later. ::: -### Startup Errors +### Startup errors The following errors might occur during operator startup: @@ -565,7 +565,7 @@ The following errors might occur during operator startup: | E06 | UID2ServicesUnreachableError | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. | | E08 | OperatorKeyPermissionError | Attach a service account to the Compute Engine instance template. The UID2 Operator needs these permissions to access the operator key from the GCP Secret Manager. | -### Runtime Errors +### Runtime errors The following errors might occur during operator runtime: diff --git a/docs/guides/summary-guides.md b/docs/guides/summary-guides.md index 8111111ca..3f3b26929 100644 --- a/docs/guides/summary-guides.md +++ b/docs/guides/summary-guides.md @@ -10,113 +10,113 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Integration Guides: Summary +# UID2 integration guides: Summary The following guides provide integration instructions based on the needs and requirements of your organization and its primary role as a publisher, DSP, or data provider/advertiser. As a UID2 participant, you can also integrate via Enterprise Partners that enable engaging with an Open Operator service and hosting of a Private Operator service. Integrations fall into these categories: -- [Publisher Integrations](#publisher-integrations) -- [Advertiser/Data Provider Integrations](#advertiserdata-provider-integrations) -- [DSP Integrations](#dsp-integrations) -- [Private Operator Service Integrations](#private-operator-service-integrations) +- [Publisher integrations](#publisher-integrations) +- [Advertiser/data provider integrations](#advertiserdata-provider-integrations) +- [DSP integrations](#dsp-integrations) +- [Private Operator service integrations](#private-operator-service-integrations) -## Publisher Integrations +## Publisher integrations Publisher integrations fall into the following main categories: -- [Web Integrations](#web-integrations) -- [Mobile Integrations](#mobile-integrations) -- [CTV Integrations](#ctv-integrations) -- [Prebid Integrations](#prebid-integrations) -- [Google Ad Manager Integrations](#google-ad-manager-integrations) +- [Web integrations](#web-integrations) +- [Mobile integrations](#mobile-integrations) +- [CTV integrations](#ctv-integrations) +- [Prebid integrations](#prebid-integrations) +- [Google Ad Manager integrations](#google-ad-manager-integrations) -To explore live, working examples of UID2 implementations with source code, see [UID2 Integration Samples](../ref-info/integration-sample-sites.md). +To explore live, working examples of UID2 implementations with source code, see [UID2 integration samples](../ref-info/integration-sample-sites.md). -### Web Integrations +### Web integrations The following documentation resources are available for publisher web integrations. :::tip -For a detailed summary of web integration options, see [Publisher Web Integration Overview](integration-options-publisher-web.md). +For a detailed summary of web integration options, see [Publisher web integration overview](integration-options-publisher-web.md). ::: | Integration Guide | Content Description | | :--- | :--- | -| [UID2 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. | -| [UID2 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. | -| [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) | An integration guide for publishers who want to integrate with UID2 and generate identity tokens to be passed by Prebid.js in the RTB bidstream. This guide is for publishers who are using a Private Operator or who want to generate tokens server-side. | -| [UID2 Integration Overview for JavaScript](integration-javascript.md) | An overview of options for publishers who want to integrate with UID2 using the JavaScript SDK. | -| [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | A guide for publishers who want to integrate with UID2 using only client-side JavaScript changes, which is the easiest implementation approach.
The SDK for JavaScript manages token generation and token refresh automatically. | -| [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) | This integration guide for publishers covers standard web integration scenarios that use the SDK for JavaScript and requires the token to be generated on the server side and passed to the publishers' web pages. | -| [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | This integration guide is for publishers that do not use the [SDK for JavaScript](../sdks/sdk-ref-javascript.md). | -| [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). | +| [UID2 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. | +| [UID2 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. | +| [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) | An integration guide for publishers who want to integrate with UID2 and generate identity tokens to be passed by Prebid.js in the RTB bidstream. This guide is for publishers who are using a Private Operator or who want to generate tokens server-side. | +| [UID2 integration overview for JavaScript](integration-javascript.md) | An overview of options for publishers who want to integrate with UID2 using the JavaScript SDK. | +| [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | A guide for publishers who want to integrate with UID2 using only client-side JavaScript changes, which is the easiest implementation approach.
The SDK for JavaScript manages token generation and token refresh automatically. | +| [Client-server integration guide for JavaScript](integration-javascript-client-server.md) | This integration guide for publishers covers standard web integration scenarios that use the SDK for JavaScript and requires the token to be generated on the server side and passed to the publishers' web pages. | +| [Publisher integration guide, server-side](integration-publisher-server-side.md) | This integration guide is for publishers that do not use the [SDK for JavaScript](../sdks/sdk-ref-javascript.md). | +| [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). | -### Mobile Integrations +### Mobile integrations The following documentation resources are available for publishers integrating with Android or iOS devices. | 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). | -| [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) | An integration guide for mobile app publishers who want to integrate with UID2 by doing the following:
  1. Generating UID2 tokens server-side via either a Public or Private Operator.
  2. Passing the resulting identities to a mobile app for passing into the bidstream.
| -| [Server-Side Integration Guide for Mobile](../guides/integration-mobile-server-side.md) | An integration guide for mobile app publishers who want to manage the UID2 token entirely on the server side. | +| [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). | +| [Client-server integration guide for mobile](integration-mobile-client-server.md) | An integration guide for mobile app publishers who want to integrate with UID2 by doing the following:
  1. Generating UID2 tokens server-side via either a Public or Private Operator.
  2. Passing the resulting identities to a mobile app for passing into the bidstream.
| +| [Server-side integration guide for mobile](../guides/integration-mobile-server-side.md) | An integration guide for mobile app publishers who want to manage the UID2 token entirely on the server side. | -### CTV Integrations +### CTV integrations The following documentation resources are available for publisher integrations supporting CTV. | Integration Guide | Content Description | | :--- | :--- | -| [CTV Integration Guide](integration-ctv-guide.md) | A summary of CTV integration options, with links to additional information and instructions. | +| [CTV integration guide](integration-ctv-guide.md) | A summary of CTV integration options, with links to additional information and instructions. | -### Prebid Integrations +### Prebid integrations The following resources are available for publishers integrating with Prebid. | Integration Guide | Content Description | | :--- | :--- | -| [UID2 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. | -| [UID2 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. | -| [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) | An integration guide for publishers who want to integrate with UID2 and generate identity tokens to be passed by Prebid.js in the RTB bidstream. This guide is for publishers who are using a Private Operator or who want to generate tokens server-side. | -| [UID2 Mobile Integration for Prebid.js](integration-prebid-mobile-summary.md) | A summary of information resources for UID2 integration with Prebid.js on mobile devices. | +| [UID2 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. | +| [UID2 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. | +| [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) | An integration guide for publishers who want to integrate with UID2 and generate identity tokens to be passed by Prebid.js in the RTB bidstream. This guide is for publishers who are using a Private Operator or who want to generate tokens server-side. | +| [UID2 mobile integration for Prebid.js](integration-prebid-mobile-summary.md) | A summary of information resources for UID2 integration with Prebid.js on mobile devices. | -### Google Ad Manager Integrations +### Google Ad Manager integrations The following resources are available for publishers integrating with Google Ad Manager. | 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). | -| [UID2 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. | -| [UID2 GMA Plugin for iOS Integration Guide](mobile-plugin-gma-ios.md) | The UID2 Google Mobile Ads (GMA) Plugin for iOS 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 iOS apps. | -| [UID2 IMA Plugin for Android Integration Guide](mobile-plugin-ima-android.md) | The UID2 Interactive Media Ads (IMA) Plugin for Android enables publishers that use the [Google IMA SDK for Android](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side) to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps. | -| [UID2 IMA Plugin for iOS Integration Guide](mobile-plugin-ima-ios.md) | The UID2 Interactive Media Ads (IMA) Plugin for iOS enables publishers that use the [Google IMA SDK for iOS](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side) to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS apps. | +| [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). | +| [UID2 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. | +| [UID2 GMA plugin for iOS integration guide](mobile-plugin-gma-ios.md) | The UID2 Google Mobile Ads (GMA) Plugin for iOS 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 iOS apps. | +| [UID2 IMA plugin for Android integration guide](mobile-plugin-ima-android.md) | The UID2 Interactive Media Ads (IMA) Plugin for Android enables publishers that use the [Google IMA SDK for Android](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side) to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from Android apps. | +| [UID2 IMA plugin for iOS integration guide](mobile-plugin-ima-ios.md) | The UID2 Interactive Media Ads (IMA) Plugin for iOS enables publishers that use the [Google IMA SDK for iOS](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side) to send UID2 tokens as [secure signals](https://support.google.com/admob/answer/11556288) in ad requests from iOS apps. | -## Advertiser/Data Provider Integrations +## Advertiser/data provider integrations The following documentation resources are available for advertisers and data providers integrating with UID2. | 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. | -| [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. | +| [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. | +| [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. | -## DSP Integrations +## DSP integrations The following documentation resources are available for DSPs integrating with UID2. | 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. | +| [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. | -## Private Operator Service Integrations +## Private Operator service integrations The following resources are available for Private Operator integrations. diff --git a/docs/intro.md b/docs/intro.md index 2371370c1..597c55924 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Unified ID 2.0 Overview +# Unified ID 2.0 overview UID2 is a framework that enables deterministic identity for advertising opportunities on the open internet for many [participants](overviews/participants-overview.md#uid2-external-participants) across the advertising ecosystem. The UID2 framework enables publisher websites, mobile apps, and Connected TV (CTV) apps to monetize through programmatic workflows. Built as an open-source, standalone solution with its own unique namespace, the framework offers privacy controls designed to help participants meet local market requirements. @@ -16,7 +16,7 @@ UID2 is a framework that enables deterministic identity for advertising opportun The term "UID2" can refer to either the framework or an actual identifier. Unless otherwise indicated, this page provides an overview of the UID2 framework. ::: -## Guiding Principles +## Guiding principles The UID2 framework has the following principles as its foundation: @@ -24,7 +24,7 @@ The UID2 framework has the following principles as its foundation: - **Non-proprietary (universal) standard**: All [participants](overviews/participants-overview.md#uid2-external-participants) in the advertising ecosystem who execute an appropriate participation agreement can access UID2. -- **Open source**: The source code for the [UID2 Component Services](overviews/participants-overview.md#uid2-component-services) is publicly available. +- **Open source**: The source code for the [UID2 component services](overviews/participants-overview.md#uid2-component-services) is publicly available. - **Interoperable**: The framework allows other identity solutions (commercial and proprietary) to integrate and provide UID2 tokens with their offerings. @@ -32,7 +32,7 @@ The UID2 framework has the following principles as its foundation: - **Consumer control**: Consumers can opt out of UID2 at any time through the [Transparency and Control Portal](https://www.transparentadvertising.com/). -## Technical Design Principles +## Technical design principles The UID2 framework is built on the following technical principles: @@ -46,18 +46,18 @@ The UID2 framework is built on the following technical principles: - **Self-reliant**: UID2 does not rely on external services for the processing of real-time bidding (RTB) data. -## Elements of the UID2 Infrastructure +## Elements of the UID2 infrastructure For information about key elements of the UID2 infrastructure, and other aspects of UID2, refer to the following pages: -- [UID2 Identifier Types](ref-info/uid-identifier-types.md) -- [UID2 Components](ref-info/uid-components.md) -- [UID2 Participants](overviews/participants-overview.md) +- [UID2 identifier types](ref-info/uid-identifier-types.md) +- [UID2 components](ref-info/uid-components.md) +- [UID2 participants](overviews/participants-overview.md) - [Workflows](ref-info/uid-workflows.md) ## FAQs -See [Frequently Asked Questions](getting-started/gs-faqs.md). +See [Frequently asked questions](getting-started/gs-faqs.md). ## License All work and artifacts are licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt). diff --git a/docs/overviews/overview-advertisers.md b/docs/overviews/overview-advertisers.md index c9a9b5eb1..376d4efa3 100644 --- a/docs/overviews/overview-advertisers.md +++ b/docs/overviews/overview-advertisers.md @@ -21,10 +21,10 @@ As an advertiser, you can upgrade your first-party data tactics with Unified ID Learn about benefits, workflow, documentation, and other resources for advertisers adopting UID2, as well as instructions for getting started. :::note -If you want access in the left sidebar to the full set of UID2 documentation, see [Unified ID 2.0 Overview](../intro.md). +If you want access in the left sidebar to the full set of UID2 documentation, see [Unified ID 2.0 overview](../intro.md). ::: -## Benefits of UID2 for Advertisers +## Benefits of UID2 for advertisers Here are just some of the intended benefits of using UID2 as part of your advertising strategy: - Use a privacy-conscious form of CRM data in media-buying platforms. @@ -34,7 +34,7 @@ Here are just some of the intended benefits of using UID2 as part of your advert - Target and measure campaigns more holistically. - Offer opt-out, with the goal of improving consumer privacy controls. -## Workflow for Advertisers +## Workflow for advertisers The following steps provide a high-level outline of the workflow intended for organizations that collect user data and push it to DSPs—for example, advertisers, identity graph providers, and third-party data providers. @@ -49,38 +49,38 @@ The following steps are an example of how an advertiser can integrate with UID2: Server-side: The advertiser stores the UID2 and refresh timestamp in a mapping table, DMP, data lake, or other server-side application. -![Data Provider Workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.svg) +![Data provider workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.svg) -## Getting Started +## Getting started To get started, follow these steps: -1. Request access to UID2 by filling out the form on the [Request Access](/request-access) page. +1. Request access to UID2 by filling out the form on the [Request access](/request-access) page. Someone will contact you to discuss your needs and advise on appropriate next steps. 1. Decide on your [participant](participants-overview.md#uid2-external-participants) role or roles. 1. Decide which implementation option you want to use. -1. Receive your credentials (see [UID2 Credentials](../getting-started/gs-credentials.md)) and follow the instructions in the implementation guide for the option you chose. +1. Receive your credentials (see [UID2 credentials](../getting-started/gs-credentials.md)) and follow the instructions in the implementation guide for the option you chose. :::note - Be sure to encrypt request messages to UID2. For details, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). + Be sure to encrypt request messages to UID2. For details, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: 1. Test. 1. Go live. -## Implementation Resources +## Implementation resources The following documentation resources are available for advertisers and data providers to implement UID2. | 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. | -| 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. | +| 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. | +| 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. | -## FAQs for Advertisers +## FAQs for advertisers -For a list of frequently asked questions for advertisers using the UID2 framework, see [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). +For a list of frequently asked questions for advertisers using the UID2 framework, see [FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). diff --git a/docs/overviews/overview-data-providers.md b/docs/overviews/overview-data-providers.md index a3b807c45..5aa6d0434 100644 --- a/docs/overviews/overview-data-providers.md +++ b/docs/overviews/overview-data-providers.md @@ -27,10 +27,10 @@ This solution is for you if you're offering data or related services for online Learn about the benefits, workflow, documentation, and other resources for data providers adopting UID2, as well as instructions for getting started. :::note -If you want access in the left sidebar to the full set of UID2 documentation, see [Unified ID 2.0 Overview](../intro.md). +If you want access in the left sidebar to the full set of UID2 documentation, see [Unified ID 2.0 overview](../intro.md). ::: -## Benefits of UID2 for Data Providers +## Benefits of UID2 for data providers Here are just some of the intended benefits available to you as a data provider using UID2. You can: - Upgrade to a more privacy-conscious identifier that offers opt-out for consumer privacy control. @@ -39,7 +39,7 @@ Here are just some of the intended benefits available to you as a data provider - Connect online and offline data with a common ID to aim for more precision. - More accurately measure campaigns with or without third-party cookies. -## Workflow for Data Providers +## Workflow for data providers The following steps provide a high-level outline of the workflow intended for organizations that collect user data and push it to DSPs—for example, advertisers, identity graph providers, and third-party data providers. @@ -54,38 +54,38 @@ The following steps are an example of how a data provider can integrate with UID Server-side: The data provider stores the UID2 and refresh timestamp in a mapping table, DMP, data lake, or other server-side application. -![Data Provider Workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.svg) +![Data provider workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.svg) -## Getting Started +## Getting started To get started, follow these steps: -1. Request access to UID2 by filling out the form on the [Request Access](/request-access) page. +1. Request access to UID2 by filling out the form on the [Request access](/request-access) page. Someone will contact you to discuss your needs and advise on appropriate next steps. 1. Decide on your [participant](participants-overview.md#uid2-external-participants) role or roles. 1. Decide which implementation option you want to use. -1. Receive your credentials (see [UID2 Credentials](../getting-started/gs-credentials.md)) and follow the instructions in the implementation guide for the option you chose. +1. Receive your credentials (see [UID2 credentials](../getting-started/gs-credentials.md)) and follow the instructions in the implementation guide for the option you chose. :::note - Be sure to encrypt request messages to UID2. For details, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). + Be sure to encrypt request messages to UID2. For details, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: 1. Test. 1. Go live. -## Implementation Resources +## Implementation resources The following documentation resources are available for advertisers and data providers to implement UID2. | 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. | -| 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. | +| 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. | +| 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. | -## FAQs for Data Providers +## FAQs for data providers -For a list of frequently asked questions for data providers using the UID2 framework, see [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). +For a list of frequently asked questions for data providers using the UID2 framework, see [FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers). diff --git a/docs/overviews/overview-dsps.md b/docs/overviews/overview-dsps.md index ffc74f522..f73500aa6 100644 --- a/docs/overviews/overview-dsps.md +++ b/docs/overviews/overview-dsps.md @@ -24,7 +24,7 @@ As a demand-side platform (DSP, media-buying platform), you can facilitate ident Learn about benefits, workflow, documentation, and other resources for DSPs adopting UID2, as well as instructions for getting started. :::note -If you want access in the left sidebar to the full set of UID2 documentation, see [Unified ID 2.0 Overview](../intro.md). +If you want access in the left sidebar to the full set of UID2 documentation, see [Unified ID 2.0 overview](../intro.md). ::: ## Benefits of UID2 for DSPs @@ -58,40 +58,40 @@ The following steps occur for each bid/ad impression: - Matches the raw UID2 to an audience segment. 4. The DSP sends a bid response to the bidstream with the UID2 token. -![Buy-Side Workflow](images/UID2BuySIdeDSPWorkflow.svg) +![Buy-side workflow](images/UID2BuySIdeDSPWorkflow.svg) -## Getting Started +## Getting started To get started, follow these steps: -1. Request access to UID2 by filling out the form on the [Request Access](/request-access) page. +1. Request access to UID2 by filling out the form on the [Request access](/request-access) page. 2. Implement a webhook to receive UID2 opt-out information, and share the webhook with the UID2 administrator. 3. Confirm that you are receiving the opt-out feed via the webhook. - When the webhook is in place, you'll receive your credentials (see [UID2 Credentials](../getting-started/gs-credentials.md)). + When the webhook is in place, you'll receive your credentials (see [UID2 credentials](../getting-started/gs-credentials.md)). 4. Decide which implementation option you want to use. 5. If you're using an SDK, download the SDK. Refer to the applicable SDK guide. 6. Follow the instructions in the implementation guide for the option you chose. :::note - Be sure to encrypt request messages to UID2. For details, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). + Be sure to encrypt request messages to UID2. For details, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: -7. (Conditional) If you want to implement a CRM onboarding solution, request a separate set of credentials for the data provider workflow. See [UID2 Credentials](../getting-started/gs-credentials.md). +7. (Conditional) If you want to implement a CRM onboarding solution, request a separate set of credentials for the data provider workflow. See [UID2 credentials](../getting-started/gs-credentials.md). 8. Test. 9. Go live. -## Implementation Resources +## Implementation resources The following documentation resources are available for DSPs to implement UID2. | 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.| -|SDK for C# / .NET | [SDK for C# / .NET Reference Guide](../sdks/sdk-ref-csharp-dotnet.md) | An SDK for anyone using .NET server-side and who wants to decrypt UID2 advertising tokens to access the raw UID2.| -|SDK for C++ | [SDK for C++ Reference Guide](../sdks/sdk-ref-cplusplus.md) | An SDK for anyone using C++ server-side and who wants to decrypt UID2 advertising tokens to access the raw UID2.| -| Integration Guide | [DSP Integration Guide](../guides/dsp-guide.md) | This integration guide for DSPs covers handling UID2s for bidding and honoring user opt-outs. | -| DSP Direct Integration Instructions | [DSP Direct Integration Tips](../guides/integration-dsp-no-sdk.md) | Instructions for DSPs who prefer to integrate without using one of the UID2 SDKs. | +|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.| +|SDK for C# / .NET | [SDK for C# / .NET reference guide](../sdks/sdk-ref-csharp-dotnet.md) | An SDK for anyone using .NET server-side and who wants to decrypt UID2 advertising tokens to access the raw UID2.| +|SDK for C++ | [SDK for C++ reference guide](../sdks/sdk-ref-cplusplus.md) | An SDK for anyone using C++ server-side and who wants to decrypt UID2 advertising tokens to access the raw UID2.| +| Integration Guide | [DSP integration guide](../guides/dsp-guide.md) | This integration guide for DSPs covers handling UID2s for bidding and honoring user opt-outs. | +| DSP Direct Integration Instructions | [DSP direct integration tips](../guides/integration-dsp-no-sdk.md) | Instructions for DSPs who prefer to integrate without using one of the UID2 SDKs. | +Optionally, if DSPs want to generate UID2s themselves from DII, they can also follow the [Third-party data provider workflow](overview-data-providers.md#workflow-for-data-providers). --> ## FAQs for DSPs diff --git a/docs/overviews/overview-publishers.md b/docs/overviews/overview-publishers.md index 0dee40270..843bc8558 100644 --- a/docs/overviews/overview-publishers.md +++ b/docs/overviews/overview-publishers.md @@ -24,10 +24,10 @@ As a publisher, you can benefit from the cross-device presence of Unified ID 2.0 Learn about benefits, workflow, documentation, and other resources for publishers adopting UID2, as well as instructions for getting started. :::note -If you want access in the left sidebar to the full set of UID2 documentation, see [Unified ID 2.0 Overview](../intro.md). +If you want access in the left sidebar to the full set of UID2 documentation, see [Unified ID 2.0 overview](../intro.md). ::: -## Benefits of UID2 for Publishers +## Benefits of UID2 for publishers Here are just some of the intended benefits for publishers integrating with UID2: - Addressable audience targeting on desktop, mobile, and CTV with a single identifier. @@ -36,7 +36,7 @@ Here are just some of the intended benefits for publishers integrating with UID2 - The ability to provide personalized ad experiences with relevant content. - The ability to offer opt-out, with the goal of improving consumer privacy controls. -## Workflow for Publishers +## Workflow for publishers The following steps provide a high-level outline of the workflow intended for 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 and can handle the UID2 integration on behalf of publishers. @@ -66,32 +66,32 @@ The following steps provide a high-level outline of the workflow intended for or -![Publisher Workflow](images/UID2PublisherAndSSPWorkflow.svg) +![Publisher workflow](images/UID2PublisherAndSSPWorkflow.svg) -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Private Operator Option +## Private Operator option -## Getting Started +## Getting started To get started, follow these steps: -1. Request access to UID2 by filling out the form on the [Request Access](/request-access) page. +1. Request access to UID2 by filling out the form on the [Request access](/request-access) page. 1. Identify the properties that you want to integrate with UID2. 1. Sign the UID2 contract. 1. Determine whether you want a client-side, client-server, or server-side integration, and tell your UID2 contact. - For more information about these options, see [Integration Approaches](../ref-info/ref-integration-approaches.md). + For more information about these options, see [Integration approaches](../ref-info/ref-integration-approaches.md). 1. Receive the [UID2 credentials](../getting-started/gs-credentials.md). 1. Build your integration to UID2 via an SDK or direct integration with the UID2 APIs, using the applicable [implementation resources](#implementation-resources). :::note - Be sure to encrypt request messages to UID2. For details, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). + Be sure to encrypt request messages to UID2. For details, see [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md). ::: 1. Test: @@ -100,10 +100,10 @@ To get started, follow these steps: - Troubleshoot as needed, and work with SSPs to properly pass UID2 tokens in bid requests. 1. Go live. -## Implementation Resources +## Implementation resources -## FAQs for Publishers +## FAQs for publishers -For a list of frequently asked questions for publishers using the UID2 framework, see [FAQs for Publishers](/docs/getting-started/gs-faqs.md#faqs-for-publishers). +For a list of frequently asked questions for publishers using the UID2 framework, see [FAQs for publishers](/docs/getting-started/gs-faqs.md#faqs-for-publishers). diff --git a/docs/overviews/participants-overview.md b/docs/overviews/participants-overview.md index 9c22b8528..6d4b79bce 100644 --- a/docs/overviews/participants-overview.md +++ b/docs/overviews/participants-overview.md @@ -8,28 +8,28 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Overview of UID2 Participants +# Overview of UID2 participants With its transparent and interoperable approach, UID2 provides a collaborative framework for many participants across the advertising ecosystem—advertisers, publishers, DSPs, SSPs, single sign-on (SSO) providers, customer data platforms (CDPs), consent management providers (CMPs), identity providers, third-party data providers, and measurement providers. The following tables list the key participants and their roles in the [UID2 workflows](../ref-info/uid-workflows.md). They are grouped into three categories: -- [UID2 Component Services](#uid2-component-services) -- [UID2 External Participants](#uid2-external-participants) -- [UID2 Consumers](#uid2-consumers) +- [UID2 component services](#uid2-component-services) +- [UID2 external participants](#uid2-external-participants) +- [UID2 consumers](#uid2-consumers) -## UID2 Component Services +## UID2 component services The following table summarizes information about key participant components of the UID2 service. -For a diagram of how the different services work together, see [UID2 Workflows](../ref-info/uid-workflows.md). +For a diagram of how the different services work together, see [UID2 workflows](../ref-info/uid-workflows.md). | 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. | | **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 +## 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. @@ -38,9 +38,9 @@ The following table summarizes the main types of external participant partners f | [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. | | [DSPs](overview-dsps.md) | DSPs integrate with the UID2 system to receive UID2s from advertisers (as first-party data) and third-party data providers (as third-party data) and leverage them to inform bidding on UID2s in the bidstream. | -| [Data Providers](overview-data-providers.md) | Organizations that collect user data and push it to other UID2 participants—for example, advertisers, identity graph providers, and third-party data providers. | +| [Data providers](overview-data-providers.md) | Organizations that collect user data and push it to other UID2 participants—for example, advertisers, identity graph providers, and third-party data providers. | -## UID2 Consumers +## UID2 consumers A UID2 consumer is a user who has had a UID2 token or raw UID2 created from an email address or phone number. diff --git a/docs/portal/api-keys.md b/docs/portal/api-keys.md index 4864f2df6..3e12b8b46 100644 --- a/docs/portal/api-keys.md +++ b/docs/portal/api-keys.md @@ -8,25 +8,25 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# API Keys +# API keys :::note -These instructions are for client-server or server-side implementations. If your UID2 implementation will be client-side, or visible to the public in any way, you'll need to set up different values. For details, see [Client-Side Integration](client-side-integration.md). +These instructions are for client-server or server-side implementations. If your UID2 implementation will be client-side, or visible to the public in any way, you'll need to set up different values. For details, see [Client-side integration](client-side-integration.md). ::: In the UID2 Portal, on the **API Keys** page, you can perform all activities relating to managing the API keys for your UID2 account, including the following: -- [Adding an API Key](#adding-an-api-key) -- [Modifying an API Key](#modifying-an-api-key) -- [Deleting an API Key](#deleting-an-api-key) -- [Rotating an API Key](#rotating-an-api-key) +- [Adding an API key](#adding-an-api-key) +- [Modifying an API key](#modifying-an-api-key) +- [Deleting an API key](#deleting-an-api-key) +- [Rotating an API key](#rotating-an-api-key) ## Overview The API key and client secret allow you to connect to the UID2 Operator Service and call API endpoints, directly or via one of the UID2 SDKs. These values identify you to the service. :::important -When you add an API key in the UID2 Portal, you must store the key and its corresponding secret securely and do everything necessary to make sure that these values are not compromised. For more information, see [API Key and Client Secret](../getting-started/gs-credentials.md#api-key-and-client-secret). +When you add an API key in the UID2 Portal, you must store the key and its corresponding secret securely and do everything necessary to make sure that these values are not compromised. For more information, see [API key and client secret](../getting-started/gs-credentials.md#api-key-and-client-secret). ::: We recommend rotating each API key on a yearly basis. @@ -38,9 +38,9 @@ When you add an API key, you can assign one or more of the following permissions - Sharer - Bidder -For details, see [API Permissions](../getting-started/gs-permissions.md). +For details, see [API permissions](../getting-started/gs-permissions.md). -## Adding an API Key +## Adding an API key To add an API key, complete the following steps: @@ -49,7 +49,7 @@ To add an API key, complete the following steps: 1. In the **Add API Key** page, provide a name for the new key. 1. In the API Permissions section, choose one or more permissions for your key. - Choose only the permissions that you need. For example, if you're a publisher, choose the Generator role. For details, see [API Permissions](../getting-started/gs-permissions.md). + Choose only the permissions that you need. For example, if you're a publisher, choose the Generator role. For details, see [API permissions](../getting-started/gs-permissions.md). :::note If the permission that you want to add isn't available for selection, ask your UID2 contact. @@ -69,7 +69,7 @@ To add an API key, complete the following steps: On the **API Keys** page, the new key is displayed with the name, Key ID, permissions, and the date it was created. -## Modifying an API Key +## Modifying an API key After you've added an API key, you can edit the following: @@ -83,7 +83,7 @@ To modify an API key, complete the following steps: 1. In the Actions column, click ![the Edit icon](images/icon-pencil-solid.png) (the Edit icon). 1. Update the information, and then click **Save Key**. -## Deleting an API Key +## Deleting an API key If a key is compromised, you'll need to remove it. @@ -100,22 +100,22 @@ To delete an API key, follow these steps: The key is removed from the display and is no longer valid. -## Rotating an API Key +## Rotating an API key We recommend rotating each API key on a yearly basis. To rotate an API key, follow these steps: 1. In the UID2 Portal, go to the **API Keys** page. 1. Find the key in the list that needs to be rotated. -1. Add a new key with the same permissions as the key that needs to be rotated. For details, see [Adding an API Key](#adding-an-api-key). +1. Add a new key with the same permissions as the key that needs to be rotated. For details, see [Adding an API key](#adding-an-api-key). 1. Update your UID2 implementation to use the new key instead of the key that needs to be rotated. 1. Ensure the new key is being used without issues. For example, make sure there is no degradation to the service or error logs related to the API key usage. -1. Delete the old key. For details, see [Deleting an API Key](#deleting-an-api-key). +1. Delete the old key. For details, see [Deleting an API key](#deleting-an-api-key). -## Security Recommendations for API Keys +## Security recommendations for API keys It's a security best practice, though not required, to have separate keys for separate roles. -For additional security recommendations, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). +For additional security recommendations, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). -## Endpoint Versions +## Endpoint versions -Version 2 of the `POST /identity/map` endpoint has been superseded by version 3, which includes the additional advantages listed in [Version 3 Improvements](../endpoints/post-identity-map.md#version-3-improvements). +Version 2 of the `POST /identity/map` endpoint has been superseded by version 3, which includes the additional advantages listed in [Version 3 improvements](../endpoints/post-identity-map.md#version-3-improvements). With version 3 of the `POST /identity/map` endpoint, the `POST /identity/buckets` endpoint is no longer used at all. diff --git a/docs/ref-info/glossary-uid.md b/docs/ref-info/glossary-uid.md index f5eeebd59..ea4175a35 100644 --- a/docs/ref-info/glossary-uid.md +++ b/docs/ref-info/glossary-uid.md @@ -9,7 +9,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import MdxJumpAnchor from '@site/src/components/MdxJumpAnchor'; -# Unified ID 2.0 Glossary +# Unified ID 2.0 glossary

This page defines some key terms used in the UID2 documentation.

-## High-Level Steps +## High-level steps To integrate with a single sign-on solution, the general steps are as follows: @@ -35,31 +35,31 @@ To integrate with a single sign-on solution, the general steps are as follows: To find out whether you have to apply [normalization and encoding](../getting-started/gs-normalization-encoding.md) to the email address, or the integration does it for you, check the documentation for your UID2 publisher integration. ::: -## Sign In with Google +## Sign in with Google The following options are available for implementing [Sign in with Google](https://support.google.com/accounts/answer/12849458?hl=en): - [Sign in with Google for Android](#sign-in-with-google-for-android) -- [Sign in with Google for iOS and macOS](#sign-in-with-google-for-ios-and-macos) -- [Sign in with Google for Web](#sign-in-with-google-for-web) +- [Sign in with Google for iOS and macos](#sign-in-with-google-for-ios-and-macos) +- [Sign in with Google for web](#sign-in-with-google-for-web) -### Sign In with Google for Android +### Sign in with Google for Android Follow the instructions in [Create the Sign in with Google flow](https://developer.android.com/identity/sign-in/credential-manager-siwg#create-sign). Once the token has been validated, you can retrieve the email address by using the [getEmail() method](https://cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload#com_google_api_client_googleapis_auth_oauth2_GoogleIdToken_Payload_getEmail__) of the identity token payload. -### Sign In with Google for iOS and macOS +### Sign in with Google for iOS and macos To get an email address from [Sign in with Google](https://developers.google.com/identity/sign-in/ios/start-integrating) on iOS or macOS, retrieve it from the `GIDGoogleUser` object. For details, see [Getting profile information](https://developers.google.com/identity/sign-in/ios/people). -### Sign In with Google for Web +### Sign in with Google for web Follow the instructions to [verify the Google ID token on your server side](https://developers.google.com/identity/gsi/web/guides/verify-google-id-token), and then retrieve the user's email address from the email field of the ID token. -## Facebook Login +## Facebook login There are two ways to integrate Facebook Login with UID2: with an OpenID Connect (OIDC) token or without. -### Facebook Login Using an OIDC Token on iOS +### Facebook login using an oidc token on iOS To get an email address from [Facebook Login](https://developers.facebook.com/docs/facebook-login/) using an [OIDC token](https://developers.facebook.com/docs/facebook-login/guides/access-tokens/get-oidc/) on iOS: @@ -67,7 +67,7 @@ To get an email address from [Facebook Login](https://developers.facebook.com/do 1. Extract the user's email address from the OIDC authentication token: for example, by using the `Profile` helper class. For details, see [OIDC Tokens in Facebook Login for iOS](https://developers.facebook.com/docs/facebook-login/guides/access-tokens/get-oidc). -### Facebook Login Without an OIDC Token +### Facebook login without an oidc token To get an email address from [Facebook Login](https://developers.facebook.com/docs/facebook-login/) without using an OIDC token: @@ -75,7 +75,7 @@ To get an email address from [Facebook Login](https://developers.facebook.com/do 1. If the user has granted the `email` permission, make a Graph API call to the [`/me` endpoint](https://developers.facebook.com/docs/graph-api/overview#me), using the user access token, and specify `email` as one of the fields. -### Sample Applications +### Sample applications The following applications demonstrate how to integrate with Facebook Login: @@ -83,21 +83,21 @@ The following applications demonstrate how to integrate with Facebook Login: - [Facebook Login sample application for iOS](https://github.com/facebook/facebook-ios-sdk/tree/main/samples/FacebookLoginSample) -## Sign In with Apple +## Sign in with apple The instructions for signing in with Apple are different for apps and websites. -### Sign In with Apple in an App +### Sign in with apple in an app Request authorization, making sure to request the `email` scope. For details, see [Request Authorization with Apple ID](https://developer.apple.com/documentation/sign_in_with_apple/implementing_user_authentication_with_sign_in_with_apple#3546458). If authentication succeeds, retrieve the user's email address from the `email` property of the `ASAuthorizationAppleIDCredential` object. -### Sign In with Apple JS on a Webpage +### Sign in with apple js on a webpage Refer to the section [Handle the Authorization Response](https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_js/configuring_your_webpage_for_sign_in_with_apple#3331292) of the page [Configure your webpage for Sign in with Apple](https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_js/configuring_your_webpage_for_sign_in_with_apple). -## Sign In with OpenPass +## Sign in with openpass To get an email address from an [OpenPass](https://openpass.thetradedesk.com/en) integration: diff --git a/docs/ref-info/ref-operators-public-private.md b/docs/ref-info/ref-operators-public-private.md index bd7255ba2..c68de83d6 100644 --- a/docs/ref-info/ref-operators-public-private.md +++ b/docs/ref-info/ref-operators-public-private.md @@ -25,16 +25,16 @@ A UID2 Operator is an organization that runs the Operator Service. Operators per - Encrypt raw UID2s to generate UID2 tokens. - Distribute UID2 token decryption keys to server-side SDKs (see [SDKs: Summary](../sdks/summary-sdks.md)). - Download the latest user opt-out information from the UID2 Opt-Out Service. -- Support a number of UID2 endpoints. For details, see [UID2 Endpoints: Summary](../endpoints/summary-endpoints.md). +- Support a number of UID2 endpoints. For details, see [UID2 endpoints: Summary](../endpoints/summary-endpoints.md). UID2 Operators fall into two categories: -- [Public Operators](#public-operators) +- [Public operators](#public-operators) - [Private Operators](#private-operators) The Operator is the operational code of UID2—the code that turns an email into a raw UID2 or a UID2 token, and that a participant who is sharing uses to refresh decryption keys. -## Public Operators +## Public operators A Public Operator is a UID2 Operator instance that is available to all relevant UID2 participants. Public Operators run publicly available instances of the Operator Service and make them available to participants. @@ -42,13 +42,13 @@ In most cases, UID2 participants use a Public Operator. The Public Operator is owned and managed by the UID2 administration. 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. -## Public Operator: Benefits +## Public operator: Benefits When you use a Public Operator, there is no additional work for you to do to host, configure, maintain, or update the Operator. All you need to do is configure your integration to use an SDK or to call the UID2 endpoints. There is no cost, to the participant, for using a Public Operator. -The participant must sign a contract (see [Account Setup](../getting-started/gs-account-setup.md)) to get the applicable credentials (see [UID2 Credentials](../getting-started/gs-credentials.md)) to use the UID2 APIs hosted on the Public Operator. +The participant must sign a contract (see [Account setup](../getting-started/gs-account-setup.md)) to get the applicable credentials (see [UID2 credentials](../getting-started/gs-credentials.md)) to use the UID2 APIs hosted on the Public Operator. :::note With a Public Operator, data leaves the participant's infrastructure and is sent to the Operator. Rigorous security measures are in place to help protect the data within the Public Operator. @@ -60,7 +60,7 @@ A Private Operator is a private instance of the UID2 Operator. This means that a Any participant can also choose to become a Private Operator to generate and manage their UID2s. However, becoming a Private Operator includes several additional steps, and uses resources that the participant must provide. -For details, see [UID2 Private Operator Integration Overview](../guides/integration-options-private-operator.md). +For details, see [UID2 Private Operator integration overview](../guides/integration-options-private-operator.md). ## Summary 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 1a8289dc8..0eb5a4b01 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 @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Preparing Emails and Phone Numbers for Processing +# Preparing emails and phone numbers for processing The input data that you provide to the UID2 Service must be in the correct format so that the data is correctly converted to valid UID2s that you can use for targeted advertising. @@ -18,16 +18,16 @@ This is true in all cases, whichever of these solutions you're using to convert - By using any of the UID2 SDK integrations, Prebid.js integration, or Android/iOS integration. - By using Snowflake. -## Processing Steps +## Processing steps -The exact steps for preparing your data to be consumed by the UID2 service are laid out in the [Normalization and Encoding](../getting-started/gs-normalization-encoding.md) documentation. The steps, in sequence, are as follows: +The exact steps for preparing your data to be consumed by the UID2 service are laid out in the [Normalization and encoding](../getting-started/gs-normalization-encoding.md) documentation. The steps, in sequence, are as follows: 1. Normalize the raw data. 2. Create a 32-byte SHA-256 hash of the normalized raw data. 3. Apply Base64-encoding to the 32-byte SHA-256 value. If you're making direct calls to the UID2 APIs, or calling the UID2 APIs via your own Private Operator, you must complete each step, exactly as described and in the correct sequence. -## Valid Input +## Valid input If you're using a UID2 SDK, or other integration solution such as the Prebid.js integration, Android/iOS integration, or Snowflake, the options for your input data are shown in the following table. @@ -43,12 +43,12 @@ If you're using a UID2 SDK, or other integration solution such as the Prebid.js Email Must be one of the following:
  • Raw email
  • Normalized email
  • Normalized, then hashed, then base64-encoded
- [Email Address Normalization](../getting-started/gs-normalization-encoding#email-address-normalization)
[Email Address Hash Encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding) + [Email address normalization](../getting-started/gs-normalization-encoding#email-address-normalization)
[Email address hash encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding) Phone Number Must be one of the following:
  • Normalized, including country code
  • Normalized, then hashed, then base64-encoded
- [Phone Number Normalization](../getting-started/gs-normalization-encoding#phone-number-normalization)
[Phone Number Hash Encoding](../getting-started/gs-normalization-encoding#phone-number-hash-encoding) + [Phone number normalization](../getting-started/gs-normalization-encoding#phone-number-normalization)
[Phone number hash encoding](../getting-started/gs-normalization-encoding#phone-number-hash-encoding) diff --git a/docs/ref-info/ref-server-side-token-generation.md b/docs/ref-info/ref-server-side-token-generation.md index 64e30dfa1..edab1942f 100644 --- a/docs/ref-info/ref-server-side-token-generation.md +++ b/docs/ref-info/ref-server-side-token-generation.md @@ -10,7 +10,7 @@ import Link from '@docusaurus/Link'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Server-Side Token Generation +# Server-side token generation If you're a publisher setting up a client-server or server-side UID2 integration, the first step is to generate the UID2 token on your server. Then, you can keep the token refreshed either on the client side or server side, and pass the token to the client side for sending to the RTB bidstream. @@ -20,7 +20,7 @@ There are two approaches for publishers generating UID2 tokens on the server sid - Direct integration to API endpoints :::warning -For security reasons, the API key and secret used in token generation *must* be called on the server side. Do not store these values on the client side, whether on a web page, in a mobile app, or in Prebid. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). +For security reasons, the API key and secret used in token generation *must* be called on the server side. Do not store these values on the client side, whether on a web page, in a mobile app, or in Prebid. For details, see [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret). ::: Options are summarized in the following table. @@ -37,8 +37,8 @@ Whatever integration option you choose to generate the DII you are generating the token for has been opted out of UID2. If this happens, save the information and do not call the token generation endpoint for the same DII again.  diff --git a/docs/ref-info/ref-token-validator.md b/docs/ref-info/ref-token-validator.md index 978649af0..7bc0bfb0a 100644 --- a/docs/ref-info/ref-token-validator.md +++ b/docs/ref-info/ref-token-validator.md @@ -23,16 +23,16 @@ To use the UID2 Token Validator, you need: - A **UID2 API Key** (Client Key) - A **UID2 Client Secret** -If you do not have these, see [API Keys](../portal/api-keys.md) for instructions on creating them in the UID2 Portal. +If you do not have these, see [API keys](../portal/api-keys.md) for instructions on creating them in the UID2 Portal. -## Using the Token Validator +## Using the token validator To use the token validator, follow these steps: 1. In the fields at the top of the Token Validation section, enter your **API Key** (Client Key) and **Client Secret**. 2. Select the **Operator** (environment) you want to validate against. For information about UID2 environments, see [Environments](../getting-started/gs-environments.md). -### Validate a Single Token +### Validate a single token To validate a single token, follow these steps: @@ -46,7 +46,7 @@ To validate a single token, follow these steps: 4. In the **Token** field, paste the UID2 token you want to validate. 5. Click **Validate Tokens**. -### Validate Multiple Tokens (CSV) +### Validate multiple tokens (csv) To validate a batch of token-identifier pairs, follow these steps: @@ -58,7 +58,7 @@ To validate a batch of token-identifier pairs, follow these steps: 3. Upload the CSV file. 4. Click **Validate Tokens**. -## Interpret Validation Results +## Interpret validation results When you click **Validate Tokens**, the **Validation Results** table displays a row for each token-identifier pair, in the format shown in the following table. @@ -80,5 +80,5 @@ The **Validation** column reflects the response from the [POST /token/valid | `Failed: {"status":"unauthorized"}` | The API credentials provided are invalid or unauthorized. | :::tip -If the result is **Failed: Token does not match identifier**, compare the **Normalized Hash** shown in the results with the value your own implementation produced for the same DII. If they differ, the issue is in your normalization or hashing steps. For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md) and [Preparing Emails and Phone Numbers for Processing](ref-preparing-emails-and-phone-numbers-for-processing.md). +If the result is **Failed: Token does not match identifier**, compare the **Normalized Hash** shown in the results with the value your own implementation produced for the same DII. If they differ, the issue is in your normalization or hashing steps. For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md) and [Preparing emails and phone numbers for processing](ref-preparing-emails-and-phone-numbers-for-processing.md). ::: \ No newline at end of file diff --git a/docs/ref-info/ref-tokens.md b/docs/ref-info/ref-tokens.md index 920cec42e..fc0fe7c7f 100644 --- a/docs/ref-info/ref-tokens.md +++ b/docs/ref-info/ref-tokens.md @@ -10,11 +10,11 @@ import Link from '@docusaurus/Link'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# UID2 Tokens and Refresh Tokens +# UID2 tokens and refresh tokens When a publisher sends a user's DII—hashed or unhashed email addresses or phone numbers—to the UID2 Operator, whether via one of the UID2 SDKs or the [POST /token/generate](../endpoints/post-token-generate.md) endpoint, the UID2 Operator converts the DII to a raw UID2, encrypts it into a UID2 token, and returns the UID2 token with associated values, including a refresh token. The publisher can then use the UID2 token in the bidstream. -## UID2 Tokens: Key Information +## UID2 tokens: Key information Here are some key points about UID2 tokens: @@ -23,14 +23,14 @@ Here are some key points about UID2 tokens: - Publishers send UID2 tokens in the bidstream. - The token value is an opaque string: do not make any assumptions about the format or length of the string. - UID2 tokens representing different instances of user activity, on browsers, CTV, and electronic devices such as phones and tablets, can still be matched to the same raw UID2. -- The token generation logic checks for user opt-out. If the user has opted out of UID2, no UID2 token is generated. For details, see [User Opt-Out](../getting-started/gs-opt-out.md). +- The token generation logic checks for user opt-out. If the user has opted out of UID2, no UID2 token is generated. For details, see [User opt-out](../getting-started/gs-opt-out.md). - The token has a limited life, but can be refreshed using the refresh token. - You can refresh many times, to get a new UID2 token and corresponding new refresh token, as long as the current UID2 token is always refreshed before the current refresh token expires. - Refreshing a UID2 token does not invalidate/expire the original or previous UID2 token. You can still use the earlier token until it expires. -For more information, see [How the UID2 Token Is Created](ref-how-uid-is-created.md). +For more information, see [How the UID2 token is created](ref-how-uid-is-created.md). -## Refresh Tokens: Key Information +## Refresh tokens: Key information Here are some key points about refresh tokens: @@ -40,29 +40,29 @@ Here are some key points about refresh tokens: - You can use the refresh token to generate a new UID2 token and new refresh token before the current refresh token expires. - Using refresh tokens is optional: you could choose to generate a new token from DII each time rather than refreshing an existing token. - You can manage token refresh in a variety of ways, such as: - - With a UID2 SDK (see [SDK Functionality](../sdks/summary-sdks.md#sdk-functionality)) + - With a UID2 SDK (see [SDK functionality](../sdks/summary-sdks.md#sdk-functionality)) - By calling the [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint - - By using the UID2 Prebid.js module (see [UID2 Integration Overview for Prebid](../guides/integration-prebid.md)) + - By using the UID2 Prebid.js module (see [UID2 integration overview for Prebid](../guides/integration-prebid.md)) - When a new UID2 token is generated and returned in response to the refresh token, a new refresh token is returned along with it. -- In most cases, you can refresh tokens on the client side, even if the token was generated on the server side. For details about refresh functionality for the various SDKs, see [SDK Functionality](../sdks/summary-sdks.md#sdk-functionality) (*Refresh UID2 Token* column). -- When the UID2 Operator Service receives the refresh token with a request for a new UID2 token, it checks for user opt-out. If the user has opted out of UID2, no new UID2 token is generated. For details, see [User Opt-Out](../getting-started/gs-opt-out.md). +- In most cases, you can refresh tokens on the client side, even if the token was generated on the server side. For details about refresh functionality for the various SDKs, see [SDK functionality](../sdks/summary-sdks.md#sdk-functionality) (*Refresh UID2 Token* column). +- When the UID2 Operator Service receives the refresh token with a request for a new UID2 token, it checks for user opt-out. If the user has opted out of UID2, no new UID2 token is generated. For details, see [User opt-out](../getting-started/gs-opt-out.md). -### Keeping the Token Current +### Keeping the token current It's very important to keep your UID2 tokens current (not expired). You get the advantages of UID2 only if the token is current. There are two options for keeping your UID2 tokens current: -- Refresh frequently, using the [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint or the token refresh feature of many UID2 SDKs. For details, see [Recommended Token Refresh Frequency](#recommended-token-refresh-frequency). +- Refresh frequently, using the [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint or the token refresh feature of many UID2 SDKs. For details, see [Recommended token refresh frequency](#recommended-token-refresh-frequency). - As an alternative to refreshing an existing token, generate a new token each time, using the [POST /token/generate](../endpoints/post-token-generate.md) endpoint or the token generate feature of many UID2 SDKs. -### Recommended Token Refresh Frequency +### Recommended token refresh frequency Currently, the recommended refresh interval is hourly. An hourly interval helps ensure that the token doesn't get close to being expired, and is ready to be sent to the bidstream. In addition, since user opt-out is checked before a new token is generated, this helps ensure that user opt-out preferences are implemented promptly. To determine when to refresh, you can use the timestamp of the `refresh_from` field in the response to a call to one of the following UID2 API endpoints: -- [POST /token/generate](../endpoints/post-token-generate.md) endpoint (see [Successful Response](../endpoints/post-token-generate.md#successful-response)) -- [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint (see [Successful Response With Tokens](../endpoints/post-token-refresh.md#successful-response-with-tokens)) +- [POST /token/generate](../endpoints/post-token-generate.md) endpoint (see [Successful response](../endpoints/post-token-generate.md#successful-response)) +- [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint (see [Successful response with tokens](../endpoints/post-token-refresh.md#successful-response-with-tokens)) The `refresh_from` field is a Unix timestamp, and the value is one hour from the time that the token was generated, expressed in milliseconds. @@ -70,7 +70,7 @@ The `refresh_from` field is a Un The recommended refresh interval could change in the future. Rather than using a fixed value, it's best to calculate based on the `refresh_from` value. ::: -### Managing Token Refresh with an SDK +### Managing token refresh with an SDK An easy way to manage token refresh is to use one of the UID2 SDKs that have a function for the purpose: either the Java or Python SDK. @@ -113,9 +113,9 @@ The following examples show how you could first check if the token can be refres Before using the code example, check the prerequisites and notes for the language you're using. For details, refer to the doc for the applicable SDK: -- [SDK for Java, Usage for Publishers, Basic Usage Server-Side Integration section](../sdks/sdk-ref-java.md#basic-usage-server-side-integration) -- [SDK for Python, Usage for Publishers, Server-Side Integration section](../sdks/sdk-ref-python.md#server-side-integration) +- [SDK for Java, usage for publishers, basic usage server-side integration section](../sdks/sdk-ref-java.md#basic-usage-server-side-integration) +- [SDK for Python, usage for publishers, server-side integration section](../sdks/sdk-ref-python.md#server-side-integration) ## FAQs -There are some frequently asked questions relating to token refresh: see [FAQs for Publishers](../getting-started/gs-faqs.md#faqs-for-publishers). +There are some frequently asked questions relating to token refresh: see [FAQs for publishers](../getting-started/gs-faqs.md#faqs-for-publishers). diff --git a/docs/ref-info/ref-uid-verify.md b/docs/ref-info/ref-uid-verify.md index 86e7ae4a5..362d0ef92 100644 --- a/docs/ref-info/ref-uid-verify.md +++ b/docs/ref-info/ref-uid-verify.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID Verify Chrome Extension +# UID Verify Chrome extension UID Verify is a browser extension for debugging UID2 integrations. It inspects the UID2 implementation on the current page in real time, surfacing UID2 SDK configuration, identity storage, event history, and errors. @@ -36,7 +36,7 @@ If more than one integration type is detected, you can switch between them using Server-side integrations are not currently supported. UID Verify works by reading client-side signals such as browser storage and UID2 SDK globals, which are not present in a server-side integration. ::: -## Installing the Extension +## Installing the extension To install UID Verify from the Chrome Web Store, follow these steps: @@ -57,11 +57,11 @@ Once installed, follow these steps to inspect a UID2 integration: UID Verify supports both UID2 and EUID. A page should use either UID2 (for North America and parts of Asia) or EUID (for Europe and other GDPR-applicable regions), not both. If both are detected on the same page, the extension displays an error. ::: -## Interpreting Results +## Interpreting results The following sections describe the information available in each tab of the UID Verify popup. The content of each tab varies depending on the integration type detected. -### Config Tab +### Config tab The **Config** tab provides a snapshot of the integration's current state, including status banners for successful token generation, errors, opt-out identities, and other configuration states. The information displayed depends on the integration type, as shown in the following sections. @@ -88,7 +88,7 @@ The **Config** tab provides a snapshot of the integration's current state, inclu - Whether `getAdvertisingTokenAsync` is available - Whether a collector function is registered (the function that passes the UID2 token as an encrypted signal to Google Ad Manager) -### Storage Tab +### Storage tab The **Storage** tab shows the raw identity data stored in the browser for the current integration. @@ -106,11 +106,11 @@ SDK and Prebid.js integrations include the fields shown in the following table. 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. -### Callbacks Tab +### Callbacks tab The **Callbacks** tab is available for UID2 SDK integrations only. It displays the source code of all callback functions registered with the UID2 SDK, with syntax highlighting. This is useful for confirming that the correct callbacks are registered and identifying where events are being handled in the page code. -### Event History Tab +### Event history tab The **Event History** tab shows a searchable, real-time log of UID2 SDK events as they occur on the page. It includes the columns shown in the following table. diff --git a/docs/ref-info/uid-components.md b/docs/ref-info/uid-components.md index 5539c73d9..3fc3a1f1c 100644 --- a/docs/ref-info/uid-components.md +++ b/docs/ref-info/uid-components.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Components +# UID2 components The UID2 framework consists of the following components, all of which are currently managed by The Trade Desk. diff --git a/docs/ref-info/uid-identifier-types.md b/docs/ref-info/uid-identifier-types.md index f1a2903c3..640275cb3 100644 --- a/docs/ref-info/uid-identifier-types.md +++ b/docs/ref-info/uid-identifier-types.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Identifier Types +# UID2 identifier types 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. diff --git a/docs/ref-info/uid-workflows.md b/docs/ref-info/uid-workflows.md index 7cf0ccf6a..8801ccfa7 100644 --- a/docs/ref-info/uid-workflows.md +++ b/docs/ref-info/uid-workflows.md @@ -8,17 +8,17 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Workflows +# UID2 workflows 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 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) | -| [Workflow for Publishers](../overviews/overview-publishers.md#workflow-for-publishers) | Organizations that propagate UID2 tokens to the bidstream via SSPs.
NOTE: Publishers can choose to integrate using Prebid, leverage the SDK for JavaScript, or complete their own server-side integration without using an SDK. | See [Publisher Integrations](../guides/summary-guides#publisher-integrations) | -| [Opt-Out Workflow](../getting-started/gs-opt-out.md#opt-out-workflow) | Consumers who engage with publishers or their SSO providers and other identity providers. | N/A | +| [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) | +| [Workflow for publishers](../overviews/overview-publishers.md#workflow-for-publishers) | Organizations that propagate UID2 tokens to the bidstream via SSPs.
NOTE: Publishers can choose to integrate using Prebid, leverage the SDK for JavaScript, or complete their own server-side integration without using an SDK. | See [Publisher integrations](../guides/summary-guides#publisher-integrations) | +| [Opt-out workflow](../getting-started/gs-opt-out.md#opt-out-workflow) | Consumers who engage with publishers or their SSO providers and other identity providers. | N/A | The following diagram summarizes all four workflows. For each workflow, the [external participants](../overviews/participants-overview.md#uid2-external-participants), [components](../ref-info/uid-components.md), [UID2 identifier types](../ref-info/uid-identifier-types.md), and numbered steps are color-coded. -![The UID2 Ecosystem](images/UID2Workflows.svg) +![The UID2 ecosystem](images/UID2Workflows.svg) diff --git a/docs/ref-info/updates-doc.md b/docs/ref-info/updates-doc.md index 928af01a2..f0672ad76 100644 --- a/docs/ref-info/updates-doc.md +++ b/docs/ref-info/updates-doc.md @@ -10,7 +10,7 @@ import Link from '@docusaurus/Link'; import CustomTagsFilters from '@site/src/components/CustomTags/CustomTagsFilters'; import CustomTagsContainer from '@site/src/components/CustomTags/CustomTagsContainer'; -# Documentation Updates +# Documentation updates @@ -40,13 +40,13 @@ For details, see [UID2 Token Validator](ref-token-validator.md). -### Rate Limiting and Parallel Request Updates for POST /identity/map +### Rate limiting and parallel request updates for POST /identity/map April 1, 2026 The [POST /identity/map](../endpoints/post-identity-map.md) endpoint documentation has been updated with the following changes: -- Added a new [Rate Limiting](../endpoints/post-identity-map.md#rate-limiting) section documenting that the endpoint enforces rate limits to safeguard against bursts of incoming traffic. +- Added a new [Rate limiting](../endpoints/post-identity-map.md#rate-limiting) section documenting that the endpoint enforces rate limits to safeguard against bursts of incoming traffic. - Removed the previous recommendation to send batches sequentially over a single HTTP connection. These changes apply to both [v2](../endpoints/post-identity-map-v2.md) and [v3](../endpoints/post-identity-map.md) endpoints. @@ -61,7 +61,7 @@ The following documents were released in the first quarter of 2026. -### Removal of optout_check Parameter +### Removal of optout_check parameter February 10, 2026 @@ -83,13 +83,13 @@ The following documents were released in this quarter. -### Databricks Integration Guide +### Databricks integration guide 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). @@ -101,7 +101,7 @@ The following documents were released in this quarter. -### Identity Map v3 (Python SDK, Snowflake) +### Identity map v3 (Python SDK, Snowflake) July 31, 2025 @@ -109,8 +109,8 @@ We've released updated versions of two additional docs to reflect adoption of th We updated the following additional implementations and corresponding documentation: -- Python SDK: see [SDK for Python Reference Guide](../sdks/sdk-ref-python.md) -- Snowflake: see [Snowflake Integration Guide](../guides/integration-snowflake.md) +- Python SDK: see [SDK for Python reference guide](../sdks/sdk-ref-python.md) +- Snowflake: see [Snowflake integration guide](../guides/integration-snowflake.md) @@ -118,11 +118,11 @@ We updated the following additional implementations and corresponding documentat -### Identity Map v3 (Endpoint Doc) +### Identity map v3 (endpoint doc) July 11, 2025 -We've released a new version of the Identity Map API (v3) that provides significant improvements for advertisers and data providers. This update includes documentation for the [POST /identity/map](../endpoints/post-identity-map.md) endpoint, the [SDK for Java Reference Guide](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers), and the [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md). +We've released a new version of the Identity Map API (v3) that provides significant improvements for advertisers and data providers. This update includes documentation for the [POST /identity/map](../endpoints/post-identity-map.md) endpoint, the [SDK for Java reference guide](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers), and the [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md). @@ -134,13 +134,13 @@ The following documents were released in the first quarter of 2025. -### Private Operator for AKS Integration Guide +### Private Operator for AKS integration guide March 19, 2025 A UID2 participant who wants to be a Private Operator can now set up the UID2 Operator Service as a Private Operator in an Azure Kubernetes Service (AKS) cluster, running on [virtual nodes on Azure Container Instances](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-virtual-nodes) (ACI). -For details, see [UID2 Private Operator for AKS Integration Guide](../guides/operator-guide-aks-enclave.md). +For details, see [UID2 Private Operator for AKS integration guide](../guides/operator-guide-aks-enclave.md). @@ -148,13 +148,13 @@ For details, see [UID2 Private Operator for AKS Integration Guide](../guides/ope -### Server-Side Integration Guide for Mobile +### Server-side integration guide for mobile March 18, 2025 We've added a guide for mobile app publishers who want to manage the UID2 token entirely on the server side. -For details, see [UID2 Server-Side Integration Guide for Mobile](../guides/integration-mobile-server-side.md). +For details, see [UID2 server-side integration guide for mobile](../guides/integration-mobile-server-side.md). @@ -162,13 +162,13 @@ For details, see [UID2 Server-Side Integration Guide for Mobile](../guides/integ -### Portal, Sharing Permissions Page +### Portal, sharing permissions page March 11, 2025 We've significantly expanded and clarified the documentation for configuring sharing permissions in the UID2 Portal. -For details, see [Sharing Permissions](../portal/sharing-permissions.md). +For details, see [Sharing permissions](../portal/sharing-permissions.md). @@ -176,13 +176,13 @@ For details, see [Sharing Permissions](../portal/sharing-permissions.md). -### JavaScript SDK Version 4 +### JavaScript SDK version 4 March 7, 2025 We've added documentation for the recently released update of the UID2 SDK for JavaScript, version 4. -For details, see [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md). +For details, see [SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md). @@ -190,13 +190,13 @@ For details, see [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript -### How the UID2 Token Is Created +### How the UID2 token is created March 7, 2025 We've added a page with high-level information about the steps for creating a UID2 token, including steps, roles, and a diagram. -For details, see [How the UID2 Token Is Created](../ref-info/ref-how-uid-is-created.md). +For details, see [How the UID2 token is created](../ref-info/ref-how-uid-is-created.md). @@ -204,13 +204,13 @@ For details, see [How the UID2 Token Is Created](../ref-info/ref-how-uid-is-crea -### Snowflake Integration Guide +### Snowflake integration guide February 12, 2025 We've significantly updated the UID2 Snowflake integration, and updated the documentation to match. -For details, see [Snowflake Integration Guide](../guides/integration-snowflake.md). +For details, see [Snowflake integration guide](../guides/integration-snowflake.md). @@ -218,13 +218,13 @@ For details, see [Snowflake Integration Guide](../guides/integration-snowflake.m -### Instructions for Using the UID2 Portal +### Instructions for using the UID2 portal February 10, 2025 We've updated the instructions in the UID2 integration guides, SDK docs, and endpoint docs to include information about account setup in the UID2 Portal. -For details, see any implementation guide: for example, [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md#complete-uid2-account-setup-and-configure-account) or [SDK for Android Reference Guide](../sdks/sdk-ref-android.md#api-permissions). +For details, see any implementation guide: for example, [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md#complete-uid2-account-setup-and-configure-account) or [SDK for Android reference guide](../sdks/sdk-ref-android.md#api-permissions). These changes also clarify the different procedures for getting credentials depending on the environment: see expanded information on the [Credentials](../getting-started/gs-credentials.md) and [Environments](../getting-started/gs-environments.md) pages. @@ -234,13 +234,13 @@ These changes also clarify the different procedures for getting credentials depe -### Advertiser/Data Provider Doc +### Advertiser/data provider doc January 10, 2025 We've significantly expanded and restructured the Advertiser/Data Provider documentation. We now have one significantly updated overview doc, and separate docs for the three main integration options that come into play: Snowflake, AWS Entity Resolution, and HTTP endpoints. -For details, including a summary of all integration options for advertisers and data providers, see [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md). +For details, including a summary of all integration options for advertisers and data providers, see [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md). @@ -248,13 +248,13 @@ For details, including a summary of all integration options for advertisers and -### Publisher SSO Integration Page +### Publisher SSO integration page January 8, 2025 We've added a reference page for publishers who integrate with one or more SSO providers to offer SSO login, and want to retrieve the logged-in user's email address from the SSO provider to generate UID2 tokens. -For details, see [Publisher Integration with SSO Providers](ref-integration-sso-providers.md). +For details, see [Publisher integration with SSO providers](ref-integration-sso-providers.md). @@ -274,7 +274,7 @@ The following documents were released in the fourth quarter of 2024. -### Zoom-In Tool for Images +### Zoom-in tool for images December 15, 2024 @@ -288,13 +288,13 @@ Just hover over the image and the tool appears as a magnifying glass, then click -### Portal Audit Trail Page +### Portal audit trail page November 15, 2024 -We've added the following page to the UID2 Portal documentation: [Audit Trail](../portal/audit-trail.md). +We've added the following page to the UID2 Portal documentation: [Audit trail](../portal/audit-trail.md). -The **Audit Trail** page in the UID2 Portal allows users who have the Admin role (see [User Roles](../portal/team-members.md#user-roles)) to view a detailed log of all past actions performed by or on behalf of the current participant. +The **Audit Trail** page in the UID2 Portal allows users who have the Admin role (see [User roles](../portal/team-members.md#user-roles)) to view a detailed log of all past actions performed by or on behalf of the current participant. @@ -302,13 +302,13 @@ The **Audit Trail** page in the UID2 Portal allows users who have the Admin role -### LiveRamp Integration Tips +### LiveRamp integration tips November 14, 2024 We've added a reference page with tips for publishers who are using LiveRamp's Authenticated Traffic Solution (ATS) to generate UID2 tokens to be passed in the bid request. -For details, see [LiveRamp Integration Tips](../guides/integration-liveramp-tips.md). +For details, see [LiveRamp integration tips](../guides/integration-liveramp-tips.md). @@ -320,13 +320,13 @@ The following documents were released in the third quarter of 2024. -### Tokens Page +### Tokens page September 10, 2024 We've added a reference page with information about tokens. -For details, see [UID2 Tokens and Refresh Tokens](../ref-info/ref-tokens.md). +For details, see [UID2 tokens and refresh tokens](../ref-info/ref-tokens.md). @@ -334,13 +334,13 @@ For details, see [UID2 Tokens and Refresh Tokens](../ref-info/ref-tokens.md). -### Private Operator Integration Overview +### Private Operator integration overview August 28, 2024 We've added a page with information about Private Operator integrations. -For details, see [UID2 Private Operator Integration Overview](../guides/integration-options-private-operator). +For details, see [UID2 Private Operator integration overview](../guides/integration-options-private-operator). @@ -348,13 +348,13 @@ For details, see [UID2 Private Operator Integration Overview](../guides/integrat -### DSP Direct Integration Instructions +### DSP direct integration instructions August 22, 2024 We've added a guide for DSPs who are not using UID2 SDKs. -For details, see [DSP Direct Integration Instructions](../guides/integration-dsp-no-sdk.md). +For details, see [DSP direct integration instructions](../guides/integration-dsp-no-sdk.md). @@ -372,13 +372,13 @@ For details, see [UID2 Tokens and Refresh Tokens]. --> -### Integration Approaches Page +### Integration approaches page July 23, 2024 We've added a page with information about the different integration approaches: client-side, client-server, and server-side. -For details, see [Integration Approaches](ref-integration-approaches.md). +For details, see [Integration approaches](ref-integration-approaches.md). @@ -386,13 +386,13 @@ For details, see [Integration Approaches](ref-integration-approaches.md). -### Server-Side Token Generation Page +### Server-side token generation page July 3, 2024 We've added a reference page with information for publishers generating the UID2 token on the server side. -For details, see [Server-Side Token Generation](ref-server-side-token-generation.md). +For details, see [Server-side token generation](ref-server-side-token-generation.md). @@ -406,8 +406,8 @@ July 2, 2024 We've added a section to the two mobile integration guides with instructions for mobile integration using Prebid, currently for Android only: -- [UID2 Client-Side Integration Guide for Mobile: Prebid Integration](../guides/integration-mobile-client-side#optional-uid2-integration-with-prebid-mobile-sdk) -- [UID2 Client-Server Integration Guide for Mobile: Prebid Integration](../guides/integration-mobile-client-server#optional-uid2-integration-with-prebid-mobile-sdk) +- [UID2 client-side integration guide for mobile: Prebid integration](../guides/integration-mobile-client-side#optional-uid2-integration-with-prebid-mobile-sdk) +- [UID2 client-server integration guide for mobile: Prebid integration](../guides/integration-mobile-client-server#optional-uid2-integration-with-prebid-mobile-sdk) @@ -419,13 +419,13 @@ The following documents were released in the second quarter of 2024. -### CTV Integration Guide +### CTV integration guide June 21, 2024 We've just added a guide for CTV publishers who want to integrate with UID2. -For details, see [CTV Integration Guide](../guides/integration-ctv-guide.md). +For details, see [CTV integration guide](../guides/integration-ctv-guide.md). @@ -433,7 +433,7 @@ For details, see [CTV Integration Guide](../guides/integration-ctv-guide.md). -### Opt-Out API +### Opt-out API May 24, 2024 @@ -449,15 +449,15 @@ For details, see [POST /optout/status](../endpoints/post-optout-status.md). -### Client-Side and Server-Side Guides for Mobile +### Client-side and server-side guides for mobile May 17, 2024 We've added the following integration guides to support publishers who want to implement UID2 for their Android or iOS mobile apps: -- [UID2 Mobile Integration Overview for Android and iOS](../guides/integration-mobile-overview) -- [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side) -- [UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server) +- [UID2 mobile integration overview for Android and iOS](../guides/integration-mobile-overview) +- [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side) +- [UID2 client-server integration guide for mobile](../guides/integration-mobile-client-server) @@ -465,11 +465,11 @@ We've added the following integration guides to support publishers who want to i -### Portal Client-Side Integration Page +### Portal client-side integration page May 6, 2024 -We've added the following page to the UID2 Portal documentation: [Client-Side Integration](../portal/client-side-integration.md). +We've added the following page to the UID2 Portal documentation: [Client-side integration](../portal/client-side-integration.md). The **Client-Side Integration** page in the UID2 Portal allows you to set up and manage the values that are needed if you are generating UID2 tokens on the client side, such as specifying your domains. @@ -479,11 +479,11 @@ The **Client-Side Integration** page in the UID2 Portal allows you to set up and -### Portal API Keys Page +### Portal API keys page April 25, 2024 -The UID2 Portal documentation now includes a new page, [API Keys](../portal/api-keys.md). +The UID2 Portal documentation now includes a new page, [API keys](../portal/api-keys.md). The API Keys page in the UID2 Portal allows you to perform all activities relating to managing API keys, and their associated secret values and permission settings, for your UID2 account. @@ -493,7 +493,7 @@ The API Keys page in the UID2 Portal allows you to perform all activities relati -### Documentation for UID2 Sharing +### Documentation for UID2 sharing April 22, 2024 @@ -501,7 +501,7 @@ We've completely reworked and significantly expanded the sharing documentation t The documentation now supports additional sharing scenarios, including the ability to share raw UID2s when senders and receivers follow the applicable legal, security, and technical requirements. -For details, see [UID2 Sharing: Overview](../sharing/sharing-overview.md). +For details, see [UID2 sharing: Overview](../sharing/sharing-overview.md). @@ -513,13 +513,13 @@ The following documents were released in the first quarter of 2024. -### UID2 Hashing Tool +### UID2 hashing tool March 4, 2024 We've added a UID2 hashing tool so that you can check that you're normalizing and encoding correctly. -For details, see [UID2 Hashing Tool](../getting-started/gs-normalization-encoding#uid2-hashing-tool) in the *Normalization and Encoding* documentation. +For details, see [UID2 hashing tool](../getting-started/gs-normalization-encoding#uid2-hashing-tool) in the *Normalization and Encoding* documentation. @@ -527,13 +527,13 @@ For details, see [UID2 Hashing Tool](../getting-started/gs-normalization-encodin -### Java SDK Support, Advertiser/Data Provider +### Java SDK support, advertiser/data provider February 28, 2024 The Java SDK now supports Advertisers and Data Providers wanting to use the [POST /identity/map (v2)](../endpoints/post-identity-map-v2.md) endpoint. -For details, see the updated documentation in the *SDK for Java Reference Guide*: [Usage for Advertisers and Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers). +For details, see the updated documentation in the *SDK for Java Reference Guide*: [Usage for advertisers and data providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers). @@ -541,7 +541,7 @@ For details, see the updated documentation in the *SDK for Java Reference Guide* -### Audience-Specific Sidebars +### Audience-specific sidebars February 9, 2024 @@ -551,7 +551,7 @@ Anyone wanting to see the full set of docs for all audiences can just click thro Note that many docs are applicable to multiple audiences, and there are many interlinks between docs, so the sidebar view might change on your journey through the site. You can always get back to your specific view by clicking the link at the top: these links appear on all pages. -To view the custom sidebars, go to [https://unifiedid.com](https://unifiedid.com/) and click on one of the audience links at the top: [Publishers](../overviews/overview-publishers.md). [Advertisers](../overviews/overview-advertisers.md), [DSPs](../overviews/overview-dsps.md), or [Data Providers](../overviews/overview-data-providers.md). +To view the custom sidebars, go to [https://unifiedid.com](https://unifiedid.com/) and click on one of the audience links at the top: [Publishers](../overviews/overview-publishers.md). [Advertisers](../overviews/overview-advertisers.md), [DSPs](../overviews/overview-dsps.md), or [Data providers](../overviews/overview-data-providers.md). @@ -559,7 +559,7 @@ To view the custom sidebars, go to [https://unifiedid.com](https://unifiedid.com -### Integration Overview for JavaScript +### Integration overview for JavaScript January 26, 2024 @@ -567,9 +567,9 @@ We've added an overview guide summarizing the options for publishers using the S For details, see: -- [UID2 Integration Overview for JavaScript](../guides/integration-javascript) -- [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) -- [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) +- [UID2 integration overview for JavaScript](../guides/integration-javascript) +- [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) +- [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) @@ -577,13 +577,13 @@ For details, see: -### SDK for Java, Publisher Sections +### SDK for Java, publisher sections January 22, 2024 We've added sections in the SDK for Java documentation to help publishers implementing the SDK. -For details, see [Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers) in the SDK for Java Reference Guide. +For details, see [Usage for publishers](../sdks/sdk-ref-java.md#usage-for-publishers) in the SDK for Java Reference Guide. @@ -591,13 +591,13 @@ For details, see [Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publis -### Normalization and Encoding Examples +### Normalization and encoding examples January 19, 2024 We've expanded and clarified the existing Normalization and Encoding doc, and added an examples section to help you make sure that you're following the process correctly. -For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md). +For details, see [Normalization and encoding](../getting-started/gs-normalization-encoding.md). @@ -605,13 +605,13 @@ For details, see [Normalization and Encoding](../getting-started/gs-normalizatio -### Web Integration Overview for Publishers +### Web integration overview for publishers January 16, 2024 We've added a page summarizing the web integration options available to publishers integrating with UID2. -For details, see [Publisher Web Integration Overview](../guides/integration-options-publisher-web.md). +For details, see [Publisher web integration overview](../guides/integration-options-publisher-web.md). @@ -619,7 +619,7 @@ For details, see [Publisher Web Integration Overview](../guides/integration-opti -### UID2 Operator Page +### UID2 Operator page January 3, 2024 @@ -637,7 +637,7 @@ The following documents were released in the fourth quarter of 2023. -### Integration Overview for Prebid +### Integration overview for Prebid December 20, 2023 @@ -647,81 +647,81 @@ In addition, the existing guides have been restructured and simplified. For details, see: -- [UID2 Integration Overview for Prebid](../guides/integration-prebid.md) -- [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) -- [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) +- [UID2 integration overview for Prebid](../guides/integration-prebid.md) +- [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) +- [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) -### Encrypt/Decrypt Examples, Java and C# +### Encrypt/decrypt examples, Java and C# December 14, 2023 We've added instructions and code examples for encrypting UID2 requests and decrypting responses in additional programming languages. To the existing Python example, we've added Java and C#. -For details, see [Encryption and Decryption Code Examples](../getting-started/gs-encryption-decryption.md#encryption-and-decryption-code-examples). +For details, see [Encryption and decryption code examples](../getting-started/gs-encryption-decryption.md#encryption-and-decryption-code-examples). -### Private Operator for Azure Integration Guide +### Private Operator for Azure integration guide November 30, 2023 A UID2 participant who wants to be a [Private Operator](../ref-info/glossary-uid.md#gl-private-operator) can now set up the UID2 Operator Service in an instance of [Confidential Containers](https://learn.microsoft.com/en-us/azure/confidential-computing/confidential-containers), a confidential computing option from Microsoft Azure. -For details, see [UID2 Private Operator for Azure Integration Guide](../guides/operator-guide-azure-enclave.md). +For details, see [UID2 Private Operator for Azure integration guide](../guides/operator-guide-azure-enclave.md). -### API Permissions +### API permissions November 22, 2023 We've added an article in the Getting Started section of the UID2 website that provides information about the key UID2 permissions, the types of participants that commonly use them, and the key associated activities. -For details, see [API Permissions](../getting-started/gs-permissions.md). +For details, see [API permissions](../getting-started/gs-permissions.md). -### UID2 Credentials Page +### UID2 credentials page November 21, 2023 We've replaced the previous **API Keys** page with a page that includes information about the credentials for those following a server-side implementation strategy. -For details, see [UID2 Credentials](../getting-started/gs-credentials.md). +For details, see [UID2 credentials](../getting-started/gs-credentials.md). -### Client-Side Integration Guide for JS +### Client-side integration guide for js November 21, 2023 The Client-Side Integration Guide for JavaScript is a completely new document at the existing URL, covering a way of using the SDK for JavaScript for a client-side publisher implementation. -For details, see [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md). +For details, see [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md). The content that was in the previous *SDK for JavaScript Integration Guide* is now in a supplementary document for publishers who want to implement the JavaScript SDK on the server side. :::note -This document was updated in January 2024 to [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md), and the JavaScript Standard Integration Guide is now the [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md). +This document was updated in January 2024 to [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md), and the JavaScript Standard Integration Guide is now the [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md). ::: -### Client-Side Integration Guide for Prebid.js +### Client-side integration guide for Prebid.js November 2, 2023 @@ -731,28 +731,28 @@ The content that was in the previous version of the Prebid document is now in a :::note These documents were further updated in later revisions. Updated links are as follows: -- [UID2 Integration Overview for Prebid](../guides/integration-prebid.md) -- [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) -- [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) +- [UID2 integration overview for Prebid](../guides/integration-prebid.md) +- [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) +- [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) ::: -### Opt-Out Page +### Opt-out page October 31, 2023 This reference topic provides an overview of user opt-out. -For details, see [User Opt-Out](../getting-started/gs-opt-out.md). +For details, see [User opt-out](../getting-started/gs-opt-out.md). -### AWS Entity Resolution Integration Guide +### AWS Entity Resolution integration guide October 19, 2023 @@ -760,21 +760,21 @@ This guide provides information for using [AWS Entity Resolution](https://aws.am This service allows you to map DII (email addresses or phone numbers) to raw UID2s swiftly and securely. -For details, see [AWS Entity Resolution Integration Guide](../guides/integration-aws-entity-resolution.md). +For details, see [AWS Entity Resolution integration guide](../guides/integration-aws-entity-resolution.md). -### SDK for JavaScript Version 3 +### SDK for JavaScript version 3 October 10, 2023 Significant documentation updates reflect the enhanced functionality of Version 3 of the SDK for JavaScript. The new documentation includes a [migration guide](../sdks/sdk-ref-javascript#migration-guide) for those upgrading from an earlier version of the SDK. For details, see: -- [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) -- [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) +- [SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md) +- [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) @@ -784,13 +784,13 @@ The following documents were released in the third quarter of 2023. -### Private Operator Guide for Google Confidential Space +### Private Operator guide for Google confidential space September 30, 2023 This guide provides information for setting up the UID2 Operator Service in [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space), a confidential computing option from the Google Cloud Platform. -For details, see [UID2 Private Operator for GCP Integration Guide](../guides/operator-private-gcp-confidential-space.md). +For details, see [UID2 Private Operator for GCP integration guide](../guides/operator-private-gcp-confidential-space.md). @@ -798,7 +798,7 @@ For details, see [UID2 Private Operator for GCP Integration Guide](../guides/ope -### Normalization and Encoding Rules +### Normalization and encoding rules September 7, 2023 @@ -806,62 +806,62 @@ We clarified the instructions for normalizing and encoding -### IMA Mobile Plugin for Android +### IMA mobile plugin for Android August 8, 2023 A guide for publishers that provides information about the UID2 Interactive Media Ads (IMA) Plugin for Android. This plugin enables publishers who use the Google IMA SDK for Android to send UID2 tokens as secure signals in ad requests from Android apps. -For details, see [UID2 IMA Plugin for Android Integration Guide](../guides/mobile-plugin-ima-android.md). +For details, see [UID2 IMA plugin for Android integration guide](../guides/mobile-plugin-ima-android.md). -### IMA Mobile Plugin for iOS +### IMA mobile plugin for iOS August 8, 2023 A guide for publishers that provides information about the UID2 Interactive Media Ads (IMA) Plugin for iOS. This plugin enables publishers who use the Google IMA SDK for iOS to send UID2 tokens as secure signals in ad requests from iOS apps. -For details, see [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios.md). +For details, see [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md). -### GMA Mobile Plugin for Android +### GMA mobile plugin for Android August 4, 2023 A guide for publishers that provides information about the UID2 Google Mobile Ads (GMA) Plugin for Android. This plugin enables publishers who use the Google GMA SDK to send UID2 tokens as secure signals in ad requests from Android apps. -For details, see [UID2 GMA Plugin for Android Integration Guide](../guides/mobile-plugin-gma-android.md). +For details, see [UID2 GMA plugin for Android integration guide](../guides/mobile-plugin-gma-android.md). -### GMA Mobile Plugin for iOS +### GMA mobile plugin for iOS August 4, 2023 A guide for publishers that provides information about the UID2 Google Mobile Ads (GMA) Plugin for iOS. This plugin enables publishers who use the Google GMA SDK to send UID2 tokens as secure signals in ad requests from iOS apps. -For details, see [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios.md). +For details, see [UID2 GMA plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md). -### UID2 Website in Japanese +### UID2 website in japanese August 3, 2023 @@ -873,45 +873,45 @@ For details, use the language drop-down at the top of any site page, or go strai -### Portal Documentation +### Portal documentation August 3, 2023 We published several documentation pages to help users navigating the UID2 Portal user interface, where you can manage your UID2 account. -For details, see [UID2 Portal: Overview](../portal/portal-overview.md). +For details, see [UID2 portal: Overview](../portal/portal-overview.md). -### Documentation for UID2 Sharing +### Documentation for UID2 sharing August 3, 2023 We published the following new and updated documents to support use of the UID2 Sharing feature: -- A set of pages providing information relating to UID2 sharing, including an overview, use cases, implementation instructions, best practices, and more. See [UID2 Sharing: Overview](../sharing/sharing-overview.md). +- A set of pages providing information relating to UID2 sharing, including an overview, use cases, implementation instructions, best practices, and more. See [UID2 sharing: Overview](../sharing/sharing-overview.md). - Updates to the four server-side SDKs to support UID2 sharing: - - [SDK for C# / .NET: Usage for UID2 Sharers](../sdks/sdk-ref-csharp-dotnet.md#usage-for-uid2-sharers) - - [SDK for C++: Usage for UID2 Sharers](../sdks/sdk-ref-cplusplus.md#usage-for-uid2-sharers) - - [SDK for Java: Usage for UID2 Sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) - - [SDK for Python: Usage for UID2 Sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) + - [SDK for C# / .NET: Usage for UID2 sharers](../sdks/sdk-ref-csharp-dotnet.md#usage-for-uid2-sharers) + - [SDK for C++: Usage for UID2 sharers](../sdks/sdk-ref-cplusplus.md#usage-for-uid2-sharers) + - [SDK for Java: Usage for UID2 sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) + - [SDK for Python: Usage for UID2 sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) -- Updates to the Snowflake feature to support UID2 sharing. See [Snowflake Integration Guide: Usage for UID2 Sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers). +- Updates to the Snowflake feature to support UID2 sharing. See [Snowflake integration guide: Usage for UID2 sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers). -### Android SDK Guide +### Android SDK guide August 3, 2023 A guide for publishers that provides information about the SDK for Android, an SDK that facilitates the process of establishing client identity using UID2 and retrieving UID2 tokens for publishers who need to support Android apps. -For details, see [SDK for Android Reference Guide](../sdks/sdk-ref-android.md). +For details, see [SDK for Android reference guide](../sdks/sdk-ref-android.md). @@ -923,7 +923,7 @@ August 3, 2023 A guide for publishers that provides information about the SDK for iOS, an SDK that facilitates the process of establishing client identity using UID2 and retrieving UID2 tokens for publishers who need to support iOS apps. -For details, see [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md). +For details, see [SDK for iOS reference guide](../sdks/sdk-ref-ios.md). diff --git a/docs/sdks/sdk-ref-android.md b/docs/sdks/sdk-ref-android.md index 7d991991f..2ed023ac7 100644 --- a/docs/sdks/sdk-ref-android.md +++ b/docs/sdks/sdk-ref-android.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for Android Reference Guide +# SDK for Android reference guide You can use the SDK for Android to facilitate the process of generating or establishing client identity using UID2, retrieving advertising tokens for bidstream use, and automatically refreshing UID2 tokens. @@ -16,12 +16,12 @@ 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 | [UID2 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 | [UID2 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 | [UID2 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 | [UID2 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). +For FAQs relating to mobile publisher integrations, see [FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations). -## Non-Mobile Android Device Support +## Non-mobile Android device support This SDK for Android can be used for non-mobile devices for Android platforms as well. @@ -37,22 +37,22 @@ The SDK for Android is designed to generate and/or manage UID2 identity on behal By default, the SDK automatically refreshes UID2 identity based on expiration dates. However, you can disable this to allow implementing apps to manage the UID2 identity lifecycle manually. -## UID2 Account Setup +## UID2 account setup -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -## API Permissions +## API permissions -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can: +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can: - Generate [credentials](../getting-started/gs-credentials.md) for your account. - Optional: For a client-side implementation, set up configuration values such as domain names or mobile app IDs. - Optionally, configure other values, such as setting up information about team members. -The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. For a summary of mobile integration options, see [Client-Side, Client-Server, or Server-Side Integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration) +The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. For a summary of mobile integration options, see [Client-side, client-server, or server-side integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration) -## SDK Version +## SDK version @@ -60,7 +60,7 @@ This documentation is for the SDK for Android version 2.0.0 and later. For current and past release notes information, see [https://github.com/IABTechLab/uid2-android-sdk/releases](https://github.com/IABTechLab/uid2-android-sdk/releases). -## GitHub Repository/Binary +## Github repository/binary This SDK is in the following open-source GitHub repository: @@ -70,14 +70,14 @@ The binary is published on Sonatype: - [https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk) -## Minimum Requirements +## Minimum requirements To consume the binary package of this SDK in your app: - Minimum target Android version: 4.4+ / API 19+ (SDK) 5.0+ -To run the development app (see [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#client-side-integration-example) or to build binary from source code, the minimum requirements are as follows: +To run the development app (see [Client-side integration guide for mobile](../guides/integration-mobile-client-side#client-side-integration-example) or to build binary from source code, the minimum requirements are as follows: - Android Studio version: Check the Android Gradle Plugin (AGP) version required by the UID2 SDK specified in the [code repository](https://github.com/IABTechLab/uid2-android-sdk/blob/main/gradle/libs.versions.toml) (see the stated `agp` version), and check [the Android Gradle Plugin release notes](https://developer.android.com/build/releases/gradle-plugin) for the corresponding Android Studio version required. - Minimum target Android version: 4.4+ / API 19+ (SDK) 5.0+ / API 21+ (Dev-App) @@ -113,7 +113,7 @@ To install with Maven, add the SDK as a dependency in the `pom.xml` file: ``` -## Usage Guidelines +## Usage guidelines The **UID2Manager** singleton is the primary developer API for the SDK for Android. It is responsible for storing, refreshing, and retrieving the UID2 Identity including the UID2 token. @@ -135,17 +135,17 @@ class MyApplication : Application() { There are two ways to establish an initial UID2 Identity: -1. Generate the UID2 identity using DII—email (hashed or unhashed) or phone number (hashed or unhashed). For integration instructions, see [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md). +1. Generate the UID2 identity using DII—email (hashed or unhashed) or phone number (hashed or unhashed). For integration instructions, see [Client-side integration guide for mobile](../guides/integration-mobile-client-side.md). -2. Create a UID2 identity server-side and then pass it into the UID2 SDK. For integration instructions, see [Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md). +2. Create a UID2 identity server-side and then pass it into the UID2 SDK. For integration instructions, see [Client-server integration guide for mobile](../guides/integration-mobile-client-server.md). The UID2 Mobile SDKs can perform refreshes of UID2 identities, after an Identity is established. This is because the refresh functionality relies on the refresh tokens that are part of the UID2 Identity. -## Code Samples +## Code samples The following code samples provide examples of performing specific activities relating to managing UID2 with the SDK for Android. -Generate an initial UID2 Identity (see [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#configure-the-uid2-mobile-sdk)): +Generate an initial UID2 Identity (see [Client-side integration guide for mobile](../guides/integration-mobile-client-side#configure-the-uid2-mobile-sdk)): ``` javascript UID2Manager.getInstance().generateIdentity( identityRequest: IdentityRequest, @@ -154,7 +154,7 @@ UID2Manager.getInstance().generateIdentity( onResult: (GenerateIdentityResult) -> Unit ) ``` -Set the UID2 Identity (see [Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server#configure-the-uid2-mobile-sdk)): +Set the UID2 Identity (see [Client-server integration guide for mobile](../guides/integration-mobile-client-server#configure-the-uid2-mobile-sdk)): ```js UID2Manager.getInstance().setIdentity(identity: UID2Identity) @@ -166,7 +166,7 @@ Get the UID2 token (advertising token) to pass to the Advertising SDK (for ad re UID2Manager.getInstance().getAdvertisingToken() ``` -## UID2Manager API +## Uid2manager API This section includes the functions and variables that are part of the UID2Manager API. diff --git a/docs/sdks/sdk-ref-cplusplus.md b/docs/sdks/sdk-ref-cplusplus.md index 0931e14d3..ae911b0dc 100644 --- a/docs/sdks/sdk-ref-cplusplus.md +++ b/docs/sdks/sdk-ref-cplusplus.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for C++ Reference Guide +# SDK for C++ reference guide You can use the SDK for C++ on the server side to encrypt raw UID2s to create UID2 tokens for sharing, and to decrypt UID2 tokens to access the raw UID2. @@ -24,17 +24,17 @@ This SDK simplifies integration with UID2 for any DSPs or UID2 sharers who are u | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | — | — | — | — | -## UID2 Account Setup +## UID2 account setup -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -## API Permissions +## API permissions -When initial account setup is complete, if you're a publisher, advertiser, or data provider, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can: +When initial account setup is complete, if you're a publisher, advertiser, or data provider, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can: - Generate [credentials](../getting-started/gs-credentials.md) for your account. - Optionally, configure other values, such as setting up information about team members. -You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. Bear in mind that there might be functions in the SDK that you don't have permission to use. For details, see [API Permissions](../getting-started/gs-permissions.md). +You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. Bear in mind that there might be functions in the SDK that you don't have permission to use. For details, see [API permissions](../getting-started/gs-permissions.md). If you're a DSP, we'll send credentials to you. @@ -42,7 +42,7 @@ If you're a DSP, we'll send credentials to you. The SDK requires C++ version 11. -## GitHub Repository/Binary +## Github repository/binary This SDK is in the following open-source GitHub repository: @@ -59,7 +59,7 @@ The initialization function configures the parameters necessary for the SDK to a | 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 | +| `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 | ## Interface @@ -69,7 +69,7 @@ The interface allows you to decrypt UID2 advertising tokens and return the corre When you use an SDK, you do not need to store or manage decryption keys. ::: -If you're a DSP, for bidding, call the interface to decrypt a UID2 advertising token and return the UID2. For details on the bidding logic for handling user opt-outs, see [DSP Integration Guide](../guides/dsp-guide.md). +If you're a DSP, for bidding, call the interface to decrypt a UID2 advertising token and return the UID2. For details on the bidding logic for handling user opt-outs, see [DSP integration guide](../guides/dsp-guide.md). The following is the decrypt method in C++: @@ -82,17 +82,17 @@ client->Refresh(); //Note that Refresh() should be called once after create(), a const auto result = client->Decrypt(adToken); ``` -### Response Content +### Response content Available information returned through the SDK is outlined in the following table. | Function | Description | | :--- | :--- | -| `GetStatus()` | The decryption result status. For a list of possible values and definitions, see [Response Statuses](#response-statuses). | +| `GetStatus()` | The decryption result status. For a list of possible values and definitions, see [Response statuses](#response-statuses). | | `GetUid()` | The raw UID2 for the corresponding UID2 advertising token. | | `GetEstablished()` | The timestamp indicating when a user first established the UID2 with the publisher. | -### Response Statuses +### Response statuses | Value | Description | | :--- | :--- | @@ -104,14 +104,14 @@ Available information returned through the SDK is outlined in the following tabl | `KeysNotSynced` | The client has failed to synchronize keys from the UID2 service. | | `VersionNotSupported` | The client library does not support the version of the encrypted token. | -## Usage for UID2 Sharers +## Usage for UID2 sharers A UID2 sharing participant is a company that takes part in sharing, either as a sender or a receiver, to share UID2s with another participant. -Advertisers and data providers can use this SDK to share UID2s with other authorized UID2 sharing participants (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +Advertisers and data providers can use this SDK to share UID2s with other authorized UID2 sharing participants (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). :::important -The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: For an example of usage, see [com.uid2.client.test.IntegrationExamples](https://github.com/IABTechLab/uid2-client-java/blob/master/src/test/java/com/uid2/client/test/IntegrationExamples.java) (`runSharingExample` method). diff --git a/docs/sdks/sdk-ref-csharp-dotnet.md b/docs/sdks/sdk-ref-csharp-dotnet.md index effa91d3c..372ed8adb 100644 --- a/docs/sdks/sdk-ref-csharp-dotnet.md +++ b/docs/sdks/sdk-ref-csharp-dotnet.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for C# / .NET Reference Guide +# SDK for C# / .NET reference guide You can use the SDK for C# / .NET on the server side to encrypt raw UID2s to create UID2 tokens for sharing, and to decrypt UID2 tokens to access the raw UID2. @@ -24,17 +24,17 @@ This SDK simplifies integration with UID2 for any DSPs or UID2 sharers who are u | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | — | — | — | — | -## UID2 Account Setup +## UID2 account setup -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -## API Permissions +## API permissions -When initial account setup is complete, if you're a publisher, advertiser, or data provider, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can: +When initial account setup is complete, if you're a publisher, advertiser, or data provider, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can: - Generate [credentials](../getting-started/gs-credentials.md) for your account. - Optionally, configure other values, such as setting up information about team members. -You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. Bear in mind that there might be functions in the SDK that you don't have permission to use. For details, see [API Permissions](../getting-started/gs-permissions.md). +You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. Bear in mind that there might be functions in the SDK that you don't have permission to use. For details, see [API permissions](../getting-started/gs-permissions.md). If you're a DSP, we'll send credentials to you. @@ -42,7 +42,7 @@ If you're a DSP, we'll send credentials to you. The library uses .NET Standard 2.1. unit tests. The sample app uses .NET 5.0. -## GitHub Repository/Binary +## Github repository/binary This SDK is in the following open-source GitHub repository: @@ -61,14 +61,14 @@ You will need to provide the values necessary for the SDK to authenticate with t | Parameter | Description | | :--- | :--- | | `endpoint` | The endpoint for the UID2 service. See [Environments](../getting-started/gs-environments). | -| `authKey` | The API key. See [UID2 Credentials](../getting-started/gs-credentials). | -| `secretKey` | The client secret. See [UID2 Credentials](../getting-started/gs-credentials). | +| `authKey` | The API key. See [UID2 credentials](../getting-started/gs-credentials). | +| `secretKey` | The client secret. See [UID2 credentials](../getting-started/gs-credentials). | ## Interface The `BidstreamClient` class allows you to decrypt UID2 tokens into raw UID2s. -For details on the bidding logic for handling user opt-outs, see [DSP Integration Guide](../guides/dsp-guide.md). +For details on the bidding logic for handling user opt-outs, see [DSP integration guide](../guides/dsp-guide.md). The `SharingClient` class allows you to encrypt raw UID2s into UID2 tokens and decrypt UID2 tokens into raw UID2s. @@ -76,16 +76,16 @@ The `SharingClient` class allows you to encrypt raw UID2s into UID2 tokens and d When you use an SDK, you do not need to store or manage decryption keys. ::: -### Encryption Response Content +### Encryption response content When encrypting with the `SharingClient`, the SDK returns the following information: | Property | Description | | :--- | :--- | -| `Status` | The encryption result status. For a list of possible values and definitions, see [Encryption Response Statuses](#encryption-response-statuses). | +| `Status` | The encryption result status. For a list of possible values and definitions, see [Encryption response statuses](#encryption-response-statuses). | | `EncryptedData` | The encrypted UID2 token. | -### Encryption Response Statuses +### Encryption response statuses | Value | Description | | :--- | :--- | @@ -98,17 +98,17 @@ When encrypting with the `SharingClient`, the SDK returns the following informat | `EncryptionFailure` | A generic encryption failure occurred. | -### Decryption Response Content +### Decryption response content Whether decrypting with the `BidstreamClient` or the `SharingClient`, the SDK returns the following information: | Property | Description | | :--- | :--- | -| `Status` | The decryption result status. For a list of possible values and definitions, see [Decryption Response Statuses](#decryption-response-statuses). | +| `Status` | The decryption result status. For a list of possible values and definitions, see [Decryption response statuses](#decryption-response-statuses). | | `Uid` | The raw UID2 for the corresponding UID2 token. | | `Established` | The timestamp indicating when a user first established the UID2 with the publisher. | -### Decryption Response Statuses +### Decryption response statuses | Value | Description | | :--- | :--- | @@ -157,14 +157,14 @@ else For a full example, see the `ExampleBidStreamClient` method in [SampleApp/Program.cs](https://github.com/IABTechLab/uid2-client-net/blob/main/src/SampleApp/Program.cs). -## Usage for UID2 Sharers +## Usage for UID2 sharers A UID2 sharing participant is a company that takes part in sharing, either as a sender or a receiver, to share UID2s with another participant. -Advertisers and data providers can use this SDK to share UID2s with other authorized UID2 sharing participants (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +Advertisers and data providers can use this SDK to share UID2s with other authorized UID2 sharing participants (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). :::important -The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: The following instructions provide an example of how you can implement sharing using the SDK for C# / .NET, either as a sender or a receiver. diff --git a/docs/sdks/sdk-ref-ios.md b/docs/sdks/sdk-ref-ios.md index a75c3bc66..7c02592ab 100644 --- a/docs/sdks/sdk-ref-ios.md +++ b/docs/sdks/sdk-ref-ios.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for iOS Reference Guide +# SDK for iOS reference guide You can use the SDK for iOS to facilitate the process of generating or establishing client identity using UID2, retrieving advertising tokens for bidstream use, and automatically refreshing UID2 tokens. @@ -16,11 +16,11 @@ 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 | [UID2 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 | [UID2 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 | [UID2 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 | [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | ## tvOS Support -Although this page refers to SDK for iOS, this SDK also supports tvOS. For the required tvOS version, see [Minimum Requirements](#minimum-requirements). +Although this page refers to SDK for iOS, this SDK also supports tvOS. For the required tvOS version, see [Minimum requirements](#minimum-requirements). ## Functionality @@ -34,22 +34,22 @@ The SDK for iOS is designed to generate and/or manage UID2 identity on behalf of By default, the SDK automatically refreshes UID2 identity based on expiration dates. However, you can disable this to allow implementing apps to manage the UID2 identity lifecycle manually. -## UID2 Account Setup +## UID2 account setup -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -## API Permissions +## API permissions -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can: +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can: - Generate [credentials](../getting-started/gs-credentials.md) for your account. - Optional: For a client-side implementation, set up configuration values such as domain names or mobile app IDs. - Optionally, configure other values, such as setting up information about team members. -The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. For a summary of mobile integration options, see [Client-Side, Client-Server, or Server-Side Integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration) +The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. For a summary of mobile integration options, see [Client-side, client-server, or server-side integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration) -## SDK Version +## SDK version @@ -57,13 +57,13 @@ This documentation is for the SDK for iOS version 2.0.0 or later. For current and past release notes information, see [https://github.com/IABTechLab/uid2-ios-sdk/releases](https://github.com/IABTechLab/uid2-ios-sdk/releases). -## GitHub Open-Source Repository +## Github open-source repository This SDK is in the following open-source GitHub repository: - [https://github.com/IABTechLab/uid2-ios-sdk](https://github.com/IABTechLab/uid2-ios-sdk) -## Minimum Requirements +## Minimum requirements Minimum requirements for this SDK are as follows: @@ -80,11 +80,11 @@ Minimum requirements for this SDK are as follows: Install the iOS SDK via Swift Package Manager (SPM) or CocoaPods. There are three installation options: -- [Package.swift](#installing-with-packageswift) +- [Package.Swift](#installing-with-packageswift) - [Xcode](#installing-with-xcode) -- [CocoaPods](#installing-with-cocoapods) +- [Cocoapods](#installing-with-cocoapods) -### Installing with Package.swift +### Installing with package.Swift Add the following dependency to Package.swift: @@ -94,7 +94,7 @@ dependencies: [ ] ``` -### Installing with Xcode +### Installing with xcode In the XCode user interface, under Package Dependencies, add the following entry for your apps: @@ -102,7 +102,7 @@ In the XCode user interface, under Package Dependencies, add the following entry | :--- | :--- | :--- | | 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 +### Installing with cocoapods Add the following entry in your `Podfile`: @@ -110,7 +110,7 @@ Add the following entry in your `Podfile`: pod 'UID2', '~> 2.0' ``` -## Usage Guidelines +## Usage guidelines The **UID2Manager** singleton is the primary developer API for the SDK for iOS. It is responsible for storing, refreshing, and retrieving the UID2 Identity including the UID2 token. @@ -118,18 +118,18 @@ For iOS, the `UID2Manager` is initialized automatically the first time it is acc There are two ways to establish an initial UID2 Identity: -1. Generate the UID2 identity using DII—email (hashed or unhashed) or phone number (hashed or unhashed). For integration instructions, see [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md). +1. Generate the UID2 identity using DII—email (hashed or unhashed) or phone number (hashed or unhashed). For integration instructions, see [Client-side integration guide for mobile](../guides/integration-mobile-client-side.md). -2. Create a UID2 identity from your server's back end and then pass it to the UID2 SDK. For integration instructions, see [Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server). +2. Create a UID2 identity from your server's back end and then pass it to the UID2 SDK. For integration instructions, see [Client-server integration guide for mobile](../guides/integration-mobile-client-server). The UID2 Mobile SDKs can perform refreshes of UID2 identities, after an Identity is established. This is because the refresh functionality relies on the refresh tokens that are part of the UID2 Identity. -## Code Samples +## Code samples The following code samples provide examples of performing specific activities relating to managing UID2 with the SDK for iOS. -Generate an initial UID2 Identity (for instructions, see [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md#configure-the-uid2-mobile-sdk)): +Generate an initial UID2 Identity (for instructions, see [Client-side integration guide for mobile](../guides/integration-mobile-client-side.md#configure-the-uid2-mobile-sdk)): ```js UID2Manager.shared.generateIdentity( @@ -139,7 +139,7 @@ UID2Manager.shared.generateIdentity( appName: String? = nil ) ``` -Set the Initial UID2 Identity (for instructions, see [Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server#configure-the-uid2-mobile-sdk)): +Set the Initial UID2 Identity (for instructions, see [Client-server integration guide for mobile](../guides/integration-mobile-client-server#configure-the-uid2-mobile-sdk)): ``` javascript UID2Manager.shared.setIdentity(_ identity: UID2Identity) @@ -151,7 +151,7 @@ Get the UID2 token (advertising token) to pass to the Advertising SDK (for ad re UID2Manager.shared.getAdvertisingToken() ``` -## UID2Manager API +## Uid2manager API This section includes the functions and variables that are part of the UID2Manager API. diff --git a/docs/sdks/sdk-ref-java.md b/docs/sdks/sdk-ref-java.md index 349ef83c6..bc80f5aa6 100644 --- a/docs/sdks/sdk-ref-java.md +++ b/docs/sdks/sdk-ref-java.md @@ -9,7 +9,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import SnptPOSTIdentityMapImprovements from '../snippets/_snpt-post-identity-map-improvements-v3.mdx'; -# SDK for Java Reference Guide +# SDK for Java reference guide You can use the SDK for Java on the server side to facilitate the process of generating or establishing client identity using UID2, retrieving advertising tokens for bidstream use, and automatically refreshing UID2 tokens. If you have the applicable permissions, you can also encrypt and decrypt for sharing and map DII to raw UID2s. @@ -21,17 +21,17 @@ This SDK simplifies integration with UID2 for any publishers, DSPs, advertisers, | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | ✅ | ✅ | ✅ | — | -## UID2 Account Setup +## UID2 account setup -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -## API Permissions +## API permissions -When initial account setup is complete, if you're a publisher, advertiser, or data provider, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can: +When initial account setup is complete, if you're a publisher, advertiser, or data provider, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can: - Generate [credentials](../getting-started/gs-credentials.md) for your account. - Optionally, configure other values, such as setting up information about team members. -You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. Bear in mind that there might be functions in the SDK that you don't have permission to use. For example, publishers get a specific API permission to generate and refresh tokens, but the SDK might support other activities that require a different API permission. For details, see [API Permissions](../getting-started/gs-permissions.md). +You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. Bear in mind that there might be functions in the SDK that you don't have permission to use. For example, publishers get a specific API permission to generate and refresh tokens, but the SDK might support other activities that require a different API permission. For details, see [API permissions](../getting-started/gs-permissions.md). If you're a DSP, we'll send credentials to you. @@ -39,7 +39,7 @@ If you're a DSP, we'll send credentials to you. The SDK requires Java version 1.8 or later. -## GitHub Repository/Binary +## Github repository/binary This SDK is in the following open-source GitHub repository: @@ -55,24 +55,24 @@ The initialization step depends on the role, as shown in the following table. | 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) | +| Publisher | `PublisherUid2Client` | [Usage for publishers](#usage-for-publishers) | +| 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) | +| Sharer | `SharingClient` | [Usage for UID2 sharers](#usage-for-uid2-sharers) | You will need to provide the values necessary for the SDK to authenticate with the UID2 service. | Parameter | Description | | :--- |:-------------------------------------------------------------------------------------------| | `baseUrl/uid2BaseUrl` | The endpoint for the UID2 service. See [Environments](../getting-started/gs-environments). | -| `clientApiKey` | The API key. See [UID2 Credentials](../getting-started/gs-credentials). | -| `base64SecretKey` | The client secret. See [UID2 Credentials](../getting-started/gs-credentials). | +| `clientApiKey` | The API key. See [UID2 credentials](../getting-started/gs-credentials). | +| `base64SecretKey` | The client secret. See [UID2 credentials](../getting-started/gs-credentials). | ### Interface The `BidstreamClient` class allows you to decrypt UID2 tokens into raw UID2s. -For details on the bidding logic for handling user opt-outs, see [DSP Integration Guide](../guides/dsp-guide.md). +For details on the bidding logic for handling user opt-outs, see [DSP integration guide](../guides/dsp-guide.md). The `SharingClient` class allows you to encrypt raw UID2s into UID2 tokens and decrypt UID2 tokens into raw UID2s. @@ -80,16 +80,16 @@ The `SharingClient` class allows you to encrypt raw UID2s into UID2 tokens and d When you use an SDK, you do not need to store or manage decryption keys. ::: -### Encryption Response Content +### Encryption response content When encrypting with the `SharingClient` class, the SDK returns the information shown in the following table. | Method | Description | |:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------| -| `getStatus()` | The encryption result status. For a list of possible values and definitions, see [Encryption Response Statuses](#encryption-response-statuses). | +| `getStatus()` | The encryption result status. For a list of possible values and definitions, see [Encryption response statuses](#encryption-response-statuses). | | `getEncryptedData()` | The encrypted UID2 token. | -### Encryption Response Statuses +### Encryption response statuses Encryption response codes, and their meanings, are shown in the following table. @@ -102,17 +102,17 @@ Encryption response codes, and their meanings, are shown in the following table. | `KEYS_NOT_SYNCED` | The client has failed to synchronize keys from the UID2 service. | | `ENCRYPTION_FAILURE` | A generic encryption failure occurred. | -### Decryption Response Content +### Decryption response content Whether decrypting with the `BidstreamClient` class or the `SharingClient` class, the SDK returns the information shown in the following table. | Methods | Description | |:-------------------|:------------------------------------------------------------------------------------------------------------------------------------------------| -| `getStatus()` | The decryption result status. For a list of possible values and definitions, see [Decryption Response Statuses](#decryption-response-statuses). | +| `getStatus()` | The decryption result status. For a list of possible values and definitions, see [Decryption response statuses](#decryption-response-statuses). | | `getUid()` | The raw UID2 for the corresponding UID2 token. | | `getEstablished()` | The timestamp indicating when a user first established the UID2 with the publisher. | -### Decryption Response Statuses +### Decryption response statuses Decryption response codes, and their meanings, are shown in the following table. @@ -127,15 +127,15 @@ Decryption response codes, and their meanings, are shown in the following table. | `VERSION_NOT_SUPPORTED` | The client library does not support the version of the encrypted token. | | `INVALID_TOKEN_LIFETIME` | The token has an invalid timestamp. | -## Usage for Publishers +## Usage for publishers As a publisher, there are two ways to use the SDK for Java: -1. [**Basic Usage**](#basic-usage) is for publishers who want to use this SDK's HTTP implementation (synchronous [OkHttp](https://square.github.io/okhttp/)). -2. [**Advanced Usage**](#advanced-usage) is for publishers who prefer to use their own HTTP library. +1. [**basic usage**](#basic-usage) is for publishers who want to use this SDK's HTTP implementation (synchronous [OkHttp](https://square.github.io/okhttp/)). +2. [**advanced usage**](#advanced-usage) is for publishers who prefer to use their own HTTP library. For an example application that demonstrates both Basic and Advanced usage, see [Java UID2 Integration Example](https://github.com/UnifiedID2/uid2-examples/tree/main/publisher/uid2-java-test-site#readme). -### Basic Usage +### Basic usage If you're using the SDK's HTTP implementation, follow these steps. @@ -152,9 +152,9 @@ If you're using the SDK's HTTP implementation, follow these steps. -#### Basic Usage, Client-Server Integration +#### Basic usage, client-server integration -If you're using client-server integration (see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: +If you're using client-server integration (see [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: * Send this identity as a JSON string back to the client (to use in the [identity field](../sdks/sdk-ref-javascript.md#initopts-object-void)), using the following: @@ -166,9 +166,9 @@ If you're using client-server integration (see [Client-Server Integration Guide If the user has opted out, this method returns `null`, so be sure to handle that case. ::: -#### Basic Usage, Server-Side Integration +#### Basic usage, server-side integration -If you're using server-side integration (see [Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md)), follow these steps: +If you're using server-side integration (see [Publisher integration guide, server-side](../guides/integration-publisher-server-side.md)), follow these steps: 1. Store this identity as a JSON string in the user's session, using the `tokenGenerateResponse.getIdentityJsonString()` function. @@ -208,7 +208,7 @@ If you're using server-side integration (see [Publisher Integration Guide, Serve If the user has opted out, this method returns `null`, indicating that the user's identity should be removed from the session. To confirm optout, you can use the `tokenRefreshResponse.isOptout()` function. -### Advanced Usage +### Advanced usage 1. Create an instance of `PublisherUid2Helper` as an instance variable: @@ -229,15 +229,15 @@ If you're using server-side integration (see [Publisher Integration Guide, Serve -4. If the HTTP response status code is _not_ 200, see [Response Status Codes](../endpoints/post-token-generate.md#response-status-codes) to determine next steps. Otherwise, convert the UID2 identity response content into a `TokenGenerateResponse` object: +4. If the HTTP response status code is _not_ 200, see [Response status codes](../endpoints/post-token-generate.md#response-status-codes) to determine next steps. Otherwise, convert the UID2 identity response content into a `TokenGenerateResponse` object: ```java TokenGenerateResponse tokenGenerateResponse = publisherUid2Helper.createTokenGenerateResponse({response body}, envelope); ``` -#### Advanced Usage, Client-Server Integration +#### Advanced usage, client-server integration -If you're using client-server integration (see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: +If you're using client-server integration (see [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: * Send this identity as a JSON string back to the client (to use in the [identity field](../sdks/sdk-ref-javascript.md#initopts-object-void)) using the following: @@ -249,9 +249,9 @@ If you're using client-server integration (see [Client-Server Integration Guide This method returns null if the user has opted out, so be sure to handle that case. ::: -#### Advanced Usage, Server-Side Integration +#### Advanced usage, server-side integration -If you're using server-side integration (see [Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md)): +If you're using server-side integration (see [Publisher integration guide, server-side](../guides/integration-publisher-server-side.md)): 1. Store this identity as a JSON string in the user's session, using: `tokenGenerateResponse.getIdentityJsonString()`. @@ -296,11 +296,11 @@ If you're using server-side integration (see [Publisher Integration Guide, Serve If the user has opted out, this method returns null, indicating that the user's identity should be removed from the session. To confirm optout, you can use the `tokenRefreshResponse.isOptout()` function. -## Usage for Advertisers/Data Providers +## Usage for advertisers/data providers The following instructions provide an example of how to map DII to raw UID2s using the latest version of the `POST /identity/map` endpoint. -For the earlier version, see [Previous SDK Version (using POST /identity/map v2)](#previous-sdk-version-using-post-identitymap-v2). For migration steps to the latest version, see [Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map). +For the earlier version, see [Previous SDK version (using POST /identity/map v2)](#previous-sdk-version-using-post-identitymap-v2). For migration steps to the latest version, see [Migration from version using v2 identity map](#migration-from-version-using-v2-identity-map). 1. Create an IdentityMapV3Client as an instance variable: ```java @@ -353,7 +353,7 @@ For the earlier version, see [Previous SDK Version (using POST /identity/map v2) The raw UID2 does not change before the refresh timestamp. After the refresh timestamp, remapping the DII returns a new refresh timestamp, but the raw UID2 might or might not change. It is possible for the raw UID2 to remain unchanged for multiple refresh intervals. ::: -### Usage Example +### Usage example ```java IdentityMapV3Client client = new IdentityMapV3Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY); @@ -386,19 +386,19 @@ IdentityMapV3Input mixedInput = new IdentityMapV3Input() IdentityMapV3Response mixedResponse = client.generateIdentityMap(mixedInput); ``` -## Migration From Version Using v2 Identity Map +## Migration from version using v2 identity map The following sections provide general information and guidance for migrating to the latest version of this SDK, which references `POST /identity/map` version 3, including: -- [Version 3 Improvements](#version-3-improvements) -- [Required Changes](#required-changes) -- [Recommended Changes](#recommended-changes) +- [Version 3 improvements](#version-3-improvements) +- [Required changes](#required-changes) +- [Recommended changes](#recommended-changes) -### Version 3 Improvements +### Version 3 improvements -### Required Changes +### Required changes To upgrade, follow these steps: @@ -406,7 +406,7 @@ To upgrade, follow these steps: 2. [Change client class](#2-change-client-class) 3. [Update import statements](#3-update-import-statements) -#### 1. Update dependency version +#### 1. update dependency version Update the dependency version referenced in your code, as shown in the following example. @@ -418,7 +418,7 @@ Update the dependency version referenced in your code, as shown in the following ``` -#### 2. Change client class +#### 2. change client class Update the client class referenced in your code, as shown in the following example. @@ -430,7 +430,7 @@ IdentityMapClient identityMapClient = new IdentityMapClient(UID2_BASE_URL, UID2_ IdentityMapV3Client identityMapClient = new IdentityMapV3Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY); ``` -#### 3. Update import statements +#### 3. update import statements Update import statements, as shown in the following example. @@ -441,7 +441,7 @@ import com.uid2.client.IdentityMapV3Response; import com.uid2.client.UnmappedIdentityReason; ``` -### Recommended Changes +### Recommended changes The following changes are **optional** but allow you to take advantage of new v3 features. The [required changes](#required-changes) are sufficient for basic functionality, but these recommended changes enable improved capabilities. @@ -487,11 +487,11 @@ The following changes are **optional** but allow you to take advantage of new v3 String rawReason = unmapped.getRawReason(); ``` -## Previous SDK Version (using POST /identity/map v2) +## Previous SDK version (using POST /identity/map v2) :::note An earlier version of the SDK for Java, which references the `POST /identity/map` v2 endpoint is also available, for backwards compatibility. Migrate to the current SDK for improved performance, multi-identity type support, and better UID rotation management. New integrations should not use this version. -For details, see [Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map). +For details, see [Migration from version using v2 identity map](#migration-from-version-using-v2-identity-map). ::: To use the earlier version, follow these instructions. @@ -561,14 +561,14 @@ else For a full example, see the `ExampleBidStreamClient` method in [test/IntegrationExamples.java](https://github.com/IABTechLab/uid2-client-java/blob/main/src/test/java/com/uid2/client/test/IntegrationExamples.java). -## Usage for UID2 Sharers +## Usage for UID2 sharers A UID2 sharing participant is a company that takes part in sharing, either as a sender or a receiver, to share UID2s with another participant. -Advertisers and data providers can use this SDK to share UID2s with other authorized UID2 sharing participants (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +Advertisers and data providers can use this SDK to share UID2s with other authorized UID2 sharing participants (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). :::important -The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: The following instructions provide an example of how you can implement sharing using the SDK for Java, either as a sender or a receiver. @@ -578,7 +578,7 @@ The following instructions provide an example of how you can implement sharing u SharingClient client = new SharingClient(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY); ``` -2. Refresh once at startup, and then periodically. Recommended refresh interval is hourly: for details, see [Decryption Key Refresh Cadence for Sharing](../sharing/sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing). +2. Refresh once at startup, and then periodically. Recommended refresh interval is hourly: for details, see [Decryption key refresh cadence for sharing](../sharing/sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing). ```java client.refresh(); ``` diff --git a/docs/sdks/sdk-ref-javascript-v2.md b/docs/sdks/sdk-ref-javascript-v2.md index 8a65b64b7..0ccf63583 100644 --- a/docs/sdks/sdk-ref-javascript-v2.md +++ b/docs/sdks/sdk-ref-javascript-v2.md @@ -10,15 +10,15 @@ import Link from '@docusaurus/Link'; import SnptExampleUid2Cookie from '../snippets/_snpt-example-uid2-cookie.mdx'; import SnptExampleJavaScriptV2Init from '../snippets/_snpt-example-javascript-v2-init.mdx'; -# SDK for JavaScript Reference Guide (v2.x and earlier) +# SDK for JavaScript reference guide (v2.x and earlier) :::important -This documentation is for earlier versions of the SDK for JavaScript. If you're using an earlier version, we recommend upgrading. See [SDK for JavaScript Reference Guide](sdk-ref-javascript.md), which includes a migration guide to upgrade to the current version, v4. +This documentation is for earlier versions of the SDK for JavaScript. If you're using an earlier version, we recommend upgrading. See [SDK for JavaScript reference guide](sdk-ref-javascript.md), which includes a migration guide to upgrade to the current version, v4. ::: Use this SDK to facilitate the process of establishing client identity using UID2 and retrieving advertising tokens. The following sections describe the high-level [workflow](#workflow-overview) for establishing UID2 identity, provide the SDK [API reference](#api-reference), and explain the [UID2 cookie format](#uid2-cookie-format). -For integration steps for content publishers, see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md). +For integration steps for content publishers, see [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md). ## Functionality @@ -28,19 +28,19 @@ This SDK simplifies integration with UID2 for any publishers who want to support | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | — | ✅ | — | — | -## API Permissions +## API permissions -To use this SDK, you'll need to complete the UID2 account setup by following the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To use this SDK, you'll need to complete the UID2 account setup by following the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. -For details, see [API Permissions](../getting-started/gs-permissions.md). +For details, see [API permissions](../getting-started/gs-permissions.md). -## SDK Version +## SDK version This documentation is for version 2 of the SDK for JavaScript. -## GitHub Repository +## Github repository This SDK is in the following open-source GitHub repository: @@ -52,7 +52,7 @@ In this document, the following terms apply: - **Identity** refers to a package of values, returned by the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint, that includes the UID2 token, the refresh token, and associated values such as timestamps. - **Advertising token** refers to the UID2 token. -## Include the SDK Script +## Include the SDK script On every page where you want to use UID2 for targeted advertising, include the following SDK script: @@ -60,7 +60,7 @@ On every page where you want to use UID2 for targeted advertising, include the f ``` -## Workflow Overview +## Workflow overview The high-level client-side workflow for establishing UID2 identity using the SDK consists of the following steps: @@ -70,14 +70,14 @@ The high-level client-side workflow for establishing UID2 identity using the SDK - If the identity is unavailable, the reason for its unavailability is specified in the object passed to the callback function. 3. SDK: Based on the identity [state](#workflow-states-and-transitions), the SDK does the following: - If a valid identity is available, the SDK ensures that the identity is available in a [first-party cookie](#uid2-cookie-format). - - If the identity is unavailable, the SDK takes the appropriate action based on whether the identity is refreshable or not. For details, see [Workflow States and Transitions](#workflow-states-and-transitions). + - If the identity is unavailable, the SDK takes the appropriate action based on whether the identity is refreshable or not. For details, see [Workflow states and transitions](#workflow-states-and-transitions). 4. Publisher: Handle the identity based on its state: - If the advertising token is available, use it to initiate requests for targeted advertising. - If the advertising token is not available, either use untargeted advertising or redirect the user to the data capture with the consent form. -For web integration steps, see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md). +For web integration steps, see [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md). -### Workflow States and Transitions +### Workflow states and transitions 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. @@ -90,9 +90,9 @@ The following table outlines the four main states that the SDK can be in, based 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. -![Client-Side JavaScript SDK Workflow](images/uid2-js-sdk-workflow.png) +![Client-side JavaScript SDK workflow](images/uid2-js-sdk-workflow.png) -### Background Token Auto-Refresh +### Background token auto-refresh As part of the SDK [initialization](#initopts-object-void), a token auto-refresh for the identity is set up, which is triggered in the background by the timestamps on the identity or by failed refresh attempts due to intermittent errors. @@ -106,7 +106,7 @@ Here's what you need to know about the token auto-refresh: - When identity has become invalid—for example, because the user has opted out.
NOTE: The callback is *not* invoked when identify is temporarily unavailable and the auto-refresh keeps failing. In this case, the SDK continues using the existing advertising token. - A [disconnect()](#disconnect-void) call cancels the active timer. -## API Reference +## API reference All interactions with the Client-Side JavaScript SDK are done through the global `__uid2` object, which is a member of the `UID2` class. All of the following JavaScript functions are members of the `UID2` class: @@ -169,7 +169,7 @@ The `opts` object supports the following properties. | 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 | +| `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 | | `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`. | | `refreshRetryPeriod` | number | Optional | The number of seconds after which to retry refreshing tokens if intermittent errors occur. | 5 | @@ -186,21 +186,21 @@ The `init()` function can throw the following errors. | `TypeError` | One of the following issues has occurred:
- The function has already been called.
- The `opts` value is not an object.
- There is no callback function specified.
- The `callback` value is not a function. | | `RangeError` | The refresh retry period is less than 1. | -#### Callback Function +#### Callback function The `function(object): void` callback function indicates that the initialization is complete. From that point onwards, the SDK invokes the callback when it successfully refreshes the established identity. -For details on when the callback function is called, see [Background Token Auto-Refresh](#background-token-auto-refresh). +For details on when the callback function is called, see [Background token auto-refresh](#background-token-auto-refresh). The `object` parameter includes the following properties. | 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). | +| `status` | `UID2.IdentityStatus` enum | The numeric value that indicates the status of the identity. For details, see [Identity status values](#identity-status-values). | | `statusText` | string | Additional information about the identity status. | -#### Identity Status Values +#### Identity status values The [callback function](#callback-function) returns the `status` field values as numbers from the `UID2.IdentityStatus` enum, which can be turned into the corresponding strings by calling `UID2.IdentityStatus[state.status]`. The following table lists the string values for the `status` enum. @@ -269,7 +269,7 @@ You can use this function to be notified of the completion of the Client-Side Ja Specifies whether a UID2 [POST /token/generate](../endpoints/post-token-generate.md) call is required. -This function can also provide additional context for handling missing identities, as shown in [Workflow States and Transitions](#workflow-states-and-transitions). +This function can also provide additional context for handling missing identities, as shown in [Workflow states and transitions](#workflow-states-and-transitions). ```html ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -306,7 +306,7 @@ Terminates any background timers or requests. The UID2 object remains in an unsp This function is intended for use in advanced scenarios where you might want to replace the existing UID2 object with a new instance. For example, a single-page application could use this to clear the current UID2 object and construct or initialize a new one after receiving a new identity from the server in the [POST /token/generate](../endpoints/post-token-generate.md) response. -## UID2 Cookie Format +## UID2 cookie format The SDK uses a first-party cookie to store the user's identity. @@ -321,7 +321,7 @@ The following table lists the cookie properties. | `Path` | `/` | If you want to use a different value, you can set it during SDK initialization using the `cookiePath` [init() parameter](#parameters). | | `Domain` | `undefined` | If you want to use a different value, you can set it during SDK initialization using the `cookieDomain` [init() parameter](#parameters). | -### Contents Structure +### Contents structure The UID2 cookie contents are a URI-encoded string representation of a JSON object with the structure identical to that of the `body` property in a [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) response, with the exception of the `private` object. diff --git a/docs/sdks/sdk-ref-javascript-v3.md b/docs/sdks/sdk-ref-javascript-v3.md index fca8d2730..0709f36c9 100644 --- a/docs/sdks/sdk-ref-javascript-v3.md +++ b/docs/sdks/sdk-ref-javascript-v3.md @@ -24,10 +24,10 @@ export const Deprecated3100 = () => ( Deprecated in version 3.10.0 ); -# SDK for JavaScript Reference Guide (v3) +# SDK for JavaScript reference guide (v3) :::important -This documentation is for version 3 of the SDK for JavaScript, which is not the latest version. If you're using this version, we recommend upgrading. See [SDK for JavaScript Reference Guide](sdk-ref-javascript.md), which includes a migration guide. +This documentation is for version 3 of the SDK for JavaScript, which is not the latest version. If you're using this version, we recommend upgrading. See [SDK for JavaScript reference guide](sdk-ref-javascript.md), which includes a migration guide. ::: Use this SDK to facilitate the process of generating or establishing client identity using UID2, retrieving advertising tokens for bidstream use, and automatically refreshing UID2 tokens. @@ -35,14 +35,14 @@ Use this SDK to facilitate the process of generating or establishing client iden The following sections describe the high-level [workflow](#workflow-overview) for establishing UID2 identity, provide the SDK [API reference](#api-reference), and explain the UID2 [storage format](#uid2-storage-format). :::tip -If you're using Prebid.js with the UID2 Identity Module, or with another product that has UID2 support, you probably don't need to use the SDK at all. The Prebid.js module manages everything. For details, see [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md). +If you're using Prebid.js with the UID2 Identity Module, or with another product that has UID2 support, you probably don't need to use the SDK at all. The Prebid.js module manages everything. For details, see [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md). ::: This page describes version 3 of the SDK. If you are using an earlier version, we recommend that you upgrade your integration, using the [migration guide](#migration-guide). If needed, documentation for [earlier versions of the SDK](./sdk-ref-javascript-v2.md) is also available. For integration steps for content publishers, refer to either of the following: - - [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) - - [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) + - [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) + - [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) ## Functionality @@ -52,30 +52,30 @@ This SDK simplifies development for publishers who want to build their own custo | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | ✅ | ✅ | — | — | -## UID2 Account Setup +## UID2 account setup -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -## API Permissions +## API permissions -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can: +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can: - Generate [credentials](../getting-started/gs-credentials.md) for your account. - Optional: For a client-side implementation, set up configuration values such as domain names. - Optionally, configure other values, such as setting up information about team members. You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. -## SDK Version +## SDK version This documentation is for version 3 of the SDK for JavaScript. -## GitHub Repository +## Github repository The source for this SDK is in the following open-source GitHub repository: - [https://github.com/iabtechlab/uid2-web-integrations](https://github.com/iabtechlab/uid2-web-integrations) -## SDK Distribution +## SDK distribution The SDK is published in these locations: @@ -98,10 +98,10 @@ The SDK is published in these locations: In this document, the following terms apply: - **Identity** refers to a package of values, returned by the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint, that includes the UID2 token, the refresh token, and associated values such as timestamps. - **Advertising token** refers to the UID2 token. -- **Callback function** refers to a callback function built for the current version of this SDK and registered using the [Array Push Pattern](#array-push-pattern). +- **Callback function** refers to a callback function built for the current version of this SDK and registered using the [Array push pattern](#array-push-pattern). - **Legacy callback function** refers to a callback function built for version 1.x or 2.x of this SDK and registered in the call to `init`. -## Include the SDK Script +## Include the SDK script On every page where you want to use UID2 for targeted advertising, include the following SDK script: @@ -109,7 +109,7 @@ On every page where you want to use UID2 for targeted advertising, include the f ``` -### Async or Defer Loading the SDK Script +### Async or defer loading the SDK script Version 3 and above of the SDK can be used with `async` or `defer` script loading. @@ -126,11 +126,11 @@ If you are using `async` or `defer` script loading on your site, do the followin ``` -## Workflow Overview +## Workflow overview The high-level client-side workflow for establishing UID2 identity using the SDK consists of the following steps: -1. Register a callback function using the [Array Push Pattern](#array-push-pattern). +1. Register a callback function using the [Array push pattern](#array-push-pattern). 2. When your callback receives the `SdkLoaded` event, initialize the SDK using the [init](#initopts-object-void) function. 3. Wait for your event listener to receive the `InitCompleted` event. The event data indicates the identity availability: - If the identity is available, it is returned in the event payload. The SDK sets up a [background token auto-refresh](#background-token-auto-refresh). @@ -142,9 +142,9 @@ The high-level client-side workflow for establishing UID2 identity using the SDK - If the advertising token is available, use it to initiate requests for targeted advertising. - If the advertising token is not available, either use untargeted advertising or redirect the user to the data capture with the consent form. -For more detailed web integration steps, see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md). +For more detailed web integration steps, see [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md). -### Background Token Auto-Refresh +### Background token auto-refresh As part of the SDK [initialization](#initopts-object-void), a token auto-refresh for the identity is set up, which is triggered in the background by the timestamps on the identity or by failed refresh attempts due to intermittent errors. @@ -152,14 +152,14 @@ Here's what you need to know about the token auto-refresh: - Only one token refresh call can be active at a time. - If the [POST /token/refresh](../endpoints/post-token-refresh.md) response is unsuccessful because the user has opted out, or because the refresh token has expired, this suspends the background auto-refresh process. To use UID2-based targeted advertising again if the refresh token has expired, you must obtain the email or phone number from the consumer. If the user has opted out, take no further steps. In all other cases, auto-refresh attempts continue in the background. -- All [callback functions](#callback-function) provided using the [Array Push Pattern](#array-push-pattern) are invoked in the following cases: +- All [callback functions](#callback-function) provided using the [Array push pattern](#array-push-pattern) are invoked in the following cases: - After each successful refresh attempt. - When identity has become invalid—for example, because the user has opted out.
NOTE: The callback is *not* invoked when identity is temporarily unavailable and the auto-refresh keeps failing. In this case, the SDK continues using the existing advertising token as long as it hasn't expired. - A [disconnect()](#disconnect-void) call cancels the active timer. -### Callback Function +### Callback function -You can register functions to receive events from the UID2 SDK using the [Array Push Pattern](#array-push-pattern). There are a number of events currently available: +You can register functions to receive events from the UID2 SDK using the [Array push pattern](#array-push-pattern). There are a number of events currently available: - `SdkLoaded` is raised after the SDK has been parsed and the global `__uid2` object has been constructed. This is useful for calling `init()`, especially if your script loading order is not guaranteed (for example, if you are using `async` or `defer` script loading). - `InitCompleted` is raised when `init()` has finished and the SDK is ready for use. If an identity was provided in the `init` call, or the SDK was able to load a previously-provided identity, the identity is included in the payload. - `IdentityUpdated` is raised whenever there is a new identity available, or the existing identity is no longer available. @@ -168,7 +168,7 @@ You can register functions to receive events from the UID2 SDK using the [Array You can provide as many callback functions as you want, and register them from anywhere. This allows you to split your code up in a way that makes sense for your site. ::: -#### Callback Function Signature +#### Callback function signature Your callback function should accept two parameters: an event type and a payload. The type of the payload depends on the event type. @@ -213,7 +213,7 @@ The following example callback handles the `SdkLoaded` event to call init and th -#### Event Types and Payload Details +#### Event types and payload details
@@ -227,7 +227,7 @@ The following example callback handles the `SdkLoaded` event to call init and th The `Identity` type is the same type as the identity you can provide when calling `init()`. -#### Array Push Pattern +#### Array push pattern In order to best support script tags that are not guaranteed to load in order (for example, if you're using `async` or `defer` script tags), use the following pattern to register callbacks: @@ -242,27 +242,27 @@ This ensures the following: - If the SDK runs before your code does, you do not overwrite the `__uid2` object or the `callbacks` array. - If multiple callbacks are registered using this pattern, they do not overwrite each other. -### Provide an Identity to the SDK +### Provide an identity to the SDK Unless the SDK is able to load a previously-stored identity from local storage or the cookie, you must provide an identity to it. There are several ways to do this: -- [Provide an Identity by Setting a First-Party Cookie](#provide-an-identity-by-setting-a-first-party-cookie) -- [Provide an Identity in the Call to `init`](#provide-an-identity-in-the-call-to-init) -- [Provide an Identity by Calling `setIdentity`](#provide-an-identity-by-calling-setidentity) +- [Provide an identity by setting a first-party cookie](#provide-an-identity-by-setting-a-first-party-cookie) +- [Provide an identity in the call to `init`](#provide-an-identity-in-the-call-to-init) +- [Provide an identity by calling `setidentity`](#provide-an-identity-by-calling-setidentity) -#### Provide an Identity by Setting a First-Party Cookie +#### Provide an identity by setting a first-party cookie If you store a first-party cookie, as described in the [storage format section](#uid2-storage-format), and the value is newer than the value available in local storage, the SDK loads the value from the cookie. If you have set the `useCookie` init option to `true`, it always loads this value, and does not check local storage. You can control several other things about the cookie using [init parameters](#init-parameters). -#### Provide an Identity in the Call to `init` +#### Provide an identity in the call to `init` You can provide a new identity when you call [`init`](#initopts-object-void). -#### Provide an Identity by Calling `setIdentity` +#### Provide an identity by calling `setidentity` -At any time after `init` has completed, you can call [`setIdentity`](#setidentityidentity-identity-void) to provide the SDK with a new identity to use. +At any time after `init` has completed, you can call [`setidentity`](#setidentityidentity-identity-void) to provide the SDK with a new identity to use. -## API Reference +## API reference All interactions with the SDK for JavaScript are done through the global `__uid2` object, which is an instance of the `UID2` class. All of the following JavaScript functions are members of the `UID2` class: @@ -293,11 +293,11 @@ Initializes the SDK and establishes user identity for targeted advertising. Here's what you need to know about this function: -- You can call `init()` any time after the SDK has been loaded. The recommended way to do this is by registering a callback function that handles the `SdkLoaded` event using the [Array Push Pattern](#array-push-pattern). By using this pattern you can make sure that your code works regardless of script load order, and that using `async` or `defer` on your script tags does not cause UID2 SDK errors. +- You can call `init()` any time after the SDK has been loaded. The recommended way to do this is by registering a callback function that handles the `SdkLoaded` event using the [Array push pattern](#array-push-pattern). By using this pattern you can make sure that your code works regardless of script load order, and that using `async` or `defer` on your script tags does not cause UID2 SDK errors. - The `identity` property in the `init()` call refers to the `body` property of the response JSON object returned from a successful [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) call with the server-side generated identity. This is a good way to provide the identity if your server-side integration ensures you always have a current token available and it is more convenient to provide it using JavaScript. - If the `identity` property in the `init()` call is falsy, the SDK attempts to load the identity from local storage or the cookie. - Once `init()` is complete, all callbacks receive the `InitCompleted` event. If the `identity` property on the payload of this event is null, no identity could be loaded, and you should therefore [provide an identity to the SDK](#provide-an-identity-to-the-sdk). This is the recommended way to provide an identity if your server-side integration does not ensure a current identity is always available, and you need to request it from the server only when necessary. - - If you are using a first-party cookie (see [UID2 Storage Format](#uid2-storage-format)) to store the passed UID2 information for the session, a call to `init()` made by a page on a different domain might not be able to access the cookie. You can adjust the settings used for the cookie with the `cookieDomain` and `cookiePath` options. + - If you are using a first-party cookie (see [UID2 storage format](#uid2-storage-format)) to store the passed UID2 information for the session, a call to `init()` made by a page on a different domain might not be able to access the cookie. You can adjust the settings used for the cookie with the `cookieDomain` and `cookiePath` options. - To tune specific behaviors, initialization calls might include optional configuration [init parameters](#init-parameters). The following is an example of an `init()` call made using a callback with the server-side generated identity included. @@ -318,38 +318,38 @@ The following is an example of an `init()` call that loads a previously-provided ``` -#### Init Parameters +#### Init parameters The `opts` object supports the following properties. | 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 | +| `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`. | | `refreshRetryPeriod` | number | Optional | The number of milliseconds after which to retry refreshing a token if an intermittent error occurs.
This value must be >= 1000. | 5000 | -| `cookieDomain` | string | Optional | The domain name string to apply to the UID2 cookie (see [UID2 Storage Format](#uid2-storage-format)).
For example, if the `baseUrl` is `https://my.operator.com`, the `cookieDomain` value might be `operator.com`. | `undefined` | -| `cookiePath` | string | Optional | The path string to apply to the UID2 cookie (see [UID2 Storage Format](#uid2-storage-format)). | `/` | +| `cookieDomain` | string | Optional | The domain name string to apply to the UID2 cookie (see [UID2 storage format](#uid2-storage-format)).
For example, if the `baseUrl` is `https://my.operator.com`, the `cookieDomain` value might be `operator.com`. | `undefined` | +| `cookiePath` | string | Optional | The path string to apply to the UID2 cookie (see [UID2 storage format](#uid2-storage-format)). | `/` | | `useCookie` | `boolean` | Optional | Set this to `true` to tell the SDK to store the identity in cookie storage instead of local storage. You can still provide an identity using a first-party cookie if this value is false or not provided. | | `callback` | `function(object): void` | Deprecated | The function that the SDK should invoke after validating the passed identity. Do not use this for new integrations. | N/A | -#### Multiple Init Calls +#### Multiple init calls You can call the `init()` function any number of times. In most cases, the code will accept the latest value of a certain [init parameter](#init-parameters). For example, if init is called twice, and a different `baseUrl` is passed in each call, the `baseUrl` variable is updated to the value from the second call. There are two exceptions to this functionality: 1. If a new identity is passed in a subsequent call, and the new identity expires before the current identity, the new identity does not replace the current identity. -2. For every subsequent callback function passed, the function is added to the existing array of callbacks using the [Array Push Pattern](#array-push-pattern). +2. For every subsequent callback function passed, the function is added to the existing array of callbacks using the [Array push pattern](#array-push-pattern). :::note If `useCookie` is updated, the location of the identity changes. For example, if the value is updated from `true` to `false`, the first-party cookie is removed and the identity is added to local storage. ::: -### Init Config +### Init config Calling `init()` stores an init config in a first-party cookie or local storage which can include the following parameters if given: `baseUrl`, `useCookie`, `refreshRetryPeriod`, `cookiePath`, and `cookieDomain`. This config is used to [bootstrap init](#self-bootstrap) and save load time in future page loads. Subsequent calls to `init()` update the config with the most recent parameters. -### Self Bootstrap +### Self bootstrap When the constructor has completed and the SDK has been put on the window object, the code will check local storage and cookie storage for a stored [init config](#init-config). If the config exists, `init()` is automatically called with the parameters from the config, and as a result, any functions that require `init()` can be used. @@ -362,11 +362,11 @@ The `init()` function can throw the following errors. | `TypeError` | One of the following issues has occurred:
  • The `opts` value is not an object.
  • A legacy callback is provided, but it is not a function.
  • `refreshRetryPeriod` is provided, but it is not a number.
| | `RangeError` | The refresh retry period is less than 1000. | -#### Legacy Callback Function +#### Legacy callback function -This is provided for backward compatibility only: new integrations should use the new-style [callback function](#callback-function). Note that the callback parameters are not compatible in either direction: legacy callbacks cannot be registered using the [Array Push Pattern](#array-push-pattern), and new-style callbacks cannot be provided to `init`. +This is provided for backward compatibility only: new integrations should use the new-style [callback function](#callback-function). Note that the callback parameters are not compatible in either direction: legacy callbacks cannot be registered using the [Array push pattern](#array-push-pattern), and new-style callbacks cannot be provided to `init`. -For details, see [Legacy Callback Function](./sdk-ref-javascript-v2#callback-function) in the documentation for earlier versions of this SDK. +For details, see [Legacy callback function](./sdk-ref-javascript-v2#callback-function) in the documentation for earlier versions of this SDK. If you have already built an integration using a legacy callback function, you can use it with the current version of the SDK with no changes. However, this functionality will be removed in a future version of the SDK. We strongly recommend that you update your integration to use the new-style [callback function](#callback-function). @@ -427,7 +427,7 @@ Specifies whether a UID2 [POST /token/generate](../endpoints/post-token-gen ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -447,7 +447,7 @@ If false, a UID2 [POST /token/generate](../endpoints/post-token-generate.md __uid2.isIdentityAvailable(); ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -456,7 +456,7 @@ If false, a UID2 [POST /token/generate](../endpoints/post-token-generate.md ### disconnect(): void -Clears the UID2 identity from the first-party cookie and local storage (see [UID2 Storage Format](#uid2-storage-format)). This closes the client's identity session and disconnects the client lifecycle. +Clears the UID2 identity from the first-party cookie and local storage (see [UID2 storage format](#uid2-storage-format)). This closes the client's identity session and disconnects the client lifecycle. When a user logs out of the publisher's site, make the following call: @@ -484,7 +484,7 @@ This function is intended for use in advanced scenarios where you might want to ### callbacks -This is an array that stores all of the registered callbacks. You should only interact with it using the [Array Push Pattern](#array-push-pattern). +This is an array that stores all of the registered callbacks. You should only interact with it using the [Array push pattern](#array-push-pattern). ### setIdentity(identity: Identity): void @@ -510,13 +510,13 @@ Returns true if the `init()` function has been called at least once. Returns false if `init()` has never been called. -## UID2 Storage Format +## UID2 storage format The SDK uses either local storage or a first-party cookie to store the user's identity. The default option is to use local storage, but this can be changed using an [init parameter](#init-parameters). Even when using local storage, the SDK checks to see if there is a newer identity available in a first-party cookie. This allows the SDK to make use of local storage while still allowing you to provide an identity by setting the first-party cookie. -### UID2 Cookie Properties +### UID2 cookie properties If cookie storage is being used, the cookie uses the properties in the following table. @@ -527,7 +527,7 @@ If cookie storage is being used, the cookie uses the properties in the following | `Path` | `/` | If you want to use a different value, you can set it during SDK initialization using the `cookiePath` [init() parameter](#init-parameters). | | `Domain` | `undefined` | If you want to use a different value, you can set it during SDK initialization using the `cookieDomain` [init() parameter](#init-parameters). | -### Contents Structure +### Contents structure The content of the UID2 local storage or cookie is a URI-encoded string representation of a JSON object with the structure identical to that of the `body` property in a [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) response, with the exception of the `private` object. @@ -539,16 +539,16 @@ The following is an example of the UID2 cookie structure: The contents of the `private` object are explicitly unspecified and are left for the SDK to interpret. Do not make any assumptions about the structure, semantics, or compatibility of this object. Any updates to the cookie must retain its structure. ::: -## Migration Guide +## Migration guide This section includes all the information you need to upgrade from an earlier version of the SDK for JavaScript to version 3. It includes: -- [Benefits of Migrating](#benefits-of-migrating) -- [Required Changes](#required-changes) -- [Recommended Changes](#recommended-changes) -- [Optional Changes](#optional-changes) +- [Benefits of migrating](#benefits-of-migrating) +- [Required changes](#required-changes) +- [Recommended changes](#recommended-changes) +- [Optional changes](#optional-changes) -### Benefits of Migrating +### Benefits of migrating If your existing integration uses version 1.x or 2.x of the SDK, version 3 is fully backwards-compatible. You can update to version 3 of the SDK just by changing your script tag to refer to the new URL. Doing this gives you the following benefits: @@ -572,33 +572,33 @@ By updating your integration, you can take advantage of the additional features This makes the SDK much easier to use in single-page app scenarios. -### Required Changes +### Required changes #### Update your script URL Update your script tag to load the SDK from [the version 3 CDN URL](#include-the-sdk-script). -### Recommended Changes +### Recommended changes We strongly recommend that you implement the following changes to get the benefits of version 3 of the SDK: -- [Migrate to the Version 3 Callback System](#migrate-to-the-version-3-callback-system) -- [Take advantage of `setIdentity` and other new features](#take-advantage-of-setidentity-and-other-new-features) +- [Migrate to the version 3 callback system](#migrate-to-the-version-3-callback-system) +- [Take advantage of `setidentity` and other new features](#take-advantage-of-setidentity-and-other-new-features) - [Change how you call init](#change-how-you-call-init) -#### Migrate to the Version 3 Callback System +#### Migrate to the version 3 callback system -In earlier versions, the callback accepts a single object as a parameter, with properties `advertisingToken`, `status`, and `statusText`. For version 3, change this function to use the new [Callback Function Signature](#callback-function-signature). +In earlier versions, the callback accepts a single object as a parameter, with properties `advertisingToken`, `status`, and `statusText`. For version 3, change this function to use the new [Callback function signature](#callback-function-signature). Your original callback probably has some logic to deal with different values of `status`. The previous system had a variety of different status values to handle, such as `EXPIRED`, `REFRESHED`, and `NO_IDENTITY`. The new system instead has only three event types: `SdkLoaded`, `InitCompleted`, and `IdentityUpdated`. -This guide cannot cover every possible scenario, and you should review the [Callback Function](#callback-function) section and consider the best way to implement your requirements using the new system. However, there are some general guidelines that should help: +This guide cannot cover every possible scenario, and you should review the [Callback function](#callback-function) section and consider the best way to implement your requirements using the new system. However, there are some general guidelines that should help: - Check the `event` parameter. If the value is `SdkLoaded`, return immediately. - Otherwise, check to see if the `payload` parameter has an `identity` property. - If there is no object on the `identity` property, there is no UID2 identity available. You should invoke whatever the previous callback did in the equivalent situation. - Otherwise, the `identity` property is an object with a `string` property named `advertising_token`. You should use this in the same way that the old callback did. -Remove the old callback from your `init` call, and provide your updated callback function to the SDK using the [Array Push Pattern](#array-push-pattern): +Remove the old callback from your `init` call, and provide your updated callback function to the SDK using the [Array push pattern](#array-push-pattern): ``` window.__uid2 = window.__uid2 || {}; @@ -606,13 +606,13 @@ window.__uid2.callbacks = window.__uid2.callbacks || []; window.__uid2.callbacks.push(callbackFunction); ``` -#### Take advantage of `setIdentity` and other new features +#### Take advantage of `setidentity` and other new features Previous versions of the SDK had only one way to provide a new identity: in the call to `init`. This meant that some publishers had to make use of various workarounds to provide a new identity later in the page lifecycle. You might be able to simplify your integration by removing these workarounds and just calling `setIdentity` if you want to pass a new identity to the SDK after `init` has been called. #### Change how you call init -The recommended way to call `init` is by using the [Array Push Pattern](#array-push-pattern). Your existing call to `init` should be moved inside a callback handler that only handles the `SdkLoaded` event, as shown in the following example: +The recommended way to call `init` is by using the [Array push pattern](#array-push-pattern). Your existing call to `init` should be moved inside a callback handler that only handles the `SdkLoaded` event, as shown in the following example: ``` window.__uid2 = window.__uid2 || {}; @@ -627,7 +627,7 @@ window.__uid2.callbacks.push((eventType) => { }); ``` -### Optional Changes +### Optional changes #### Add `async` or `defer` to your script tag diff --git a/docs/sdks/sdk-ref-javascript.md b/docs/sdks/sdk-ref-javascript.md index 4f6e6ec78..e61132dec 100644 --- a/docs/sdks/sdk-ref-javascript.md +++ b/docs/sdks/sdk-ref-javascript.md @@ -12,28 +12,28 @@ import TabItem from '@theme/TabItem'; import SnptExampleUid2Cookie from '../snippets/_snpt-example-uid2-cookie.mdx'; import SnptExampleJavaScriptInit from '../snippets/_snpt-example-javascript-init.mdx'; -# SDK for JavaScript Reference Guide +# SDK for JavaScript reference guide Use this SDK to facilitate the process of generating or establishing client identity using UID2, retrieving advertising tokens for bidstream use, and automatically refreshing UID2 tokens. The following sections describe the high-level [workflow](#workflow-overview) for establishing UID2 identity, provide the SDK [API reference](#api-reference), and explain the UID2 [storage format](#uid2-storage-format). :::tip -If you're using Prebid.js with the UID2 Identity Module, or with another product that has UID2 support, you probably don't need to use the SDK at all. The Prebid.js module manages everything. For details, see [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md). +If you're using Prebid.js with the UID2 Identity Module, or with another product that has UID2 support, you probably don't need to use the SDK at all. The Prebid.js module manages everything. For details, see [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md). ::: For integration steps for publishers, refer to one of the following: - - [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) - - [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) + - [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) + - [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) -## SDK Version +## SDK version This page describes version 4 of the UID2 SDK for JavaScript, which is the latest version. If you're using an earlier version, we recommend that you upgrade your integration, using the [migration guide](#migration-guide). If needed, documentation is also available for the following earlier versions: - [Version 3](./sdk-ref-javascript-v3.md) - [Version 2.x and earlier](./sdk-ref-javascript-v2.md) -## Changes in Version 4 +## Changes in version 4 Version 4 includes the following key changes from version 3: @@ -51,7 +51,7 @@ This SDK simplifies development for publishers who want to build their own custo | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | ✅ | ✅ | — | — | -## Sample Implementations +## Sample implementations For sample implementations with associated documentation, see: - Client-Side Integration Using UID2 SDK for JavaScript: @@ -61,30 +61,30 @@ For sample implementations with associated documentation, see: - [Code](https://github.com/IABTechLab/uid2-examples/tree/main/web-integrations/javascript-sdk/client-server) - Running site: [Client-Server UID2 Integration Example](https://js-client-server.samples.uidapi.com/) -## UID2 Account Setup +## UID2 account setup -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -## API Permissions +## API permissions -When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can: +When initial account setup is complete, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can: - Generate [credentials](../getting-started/gs-credentials.md) for your account. - Optional: For a client-side implementation, set up configuration values such as domain names. - Optional: Configure other values, such as setting up information about team members. You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. -## SDK Version +## SDK version This documentation is for version 4 of the SDK for JavaScript. -## GitHub Repository +## Github repository The source for this SDK is in the following open-source GitHub repository: - [https://github.com/iabtechlab/uid2-web-integrations](https://github.com/iabtechlab/uid2-web-integrations) -## SDK Distribution +## SDK distribution The SDK is published in these locations: @@ -107,10 +107,10 @@ The SDK is published in these locations: In this document, the following terms apply: - **Identity** refers to a package of values, returned by the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint, that includes the UID2 token, the refresh token, and associated values such as timestamps. - **Advertising token** refers to the UID2 token. -- **Callback function** refers to a callback function built for the current version of this SDK and registered using the [Array Push Pattern](#array-push-pattern). +- **Callback function** refers to a callback function built for the current version of this SDK and registered using the [Array push pattern](#array-push-pattern). - **Legacy callback function** refers to a callback function built for version 1.x or 2.x of this SDK and registered in the call to `init`. -## Include the SDK Script +## Include the SDK script On every page where you want to use UID2 for targeted advertising, include the following SDK script: @@ -118,7 +118,7 @@ On every page where you want to use UID2 for targeted advertising, include the f ``` -### Async or Defer Loading the SDK Script +### Async or defer loading the SDK script Version 3 and above of the SDK can be used with `async` or `defer` script loading. @@ -135,11 +135,11 @@ If you are using `async` or `defer` script loading on your site, do the followin ``` -## Workflow Overview +## Workflow overview The high-level client-side workflow for establishing UID2 identity using the SDK consists of the following steps: -1. Register a callback function using the [Array Push Pattern](#array-push-pattern). +1. Register a callback function using the [Array push pattern](#array-push-pattern). 2. When your callback receives the `SdkLoaded` event, initialize the SDK using the [init](#initopts-object-void) function. 3. Wait for your event listener to receive the `InitCompleted` event. The event data indicates the identity availability: - If the identity is available, it is returned in the event payload. The SDK sets up a [background token auto-refresh](#background-token-auto-refresh). @@ -151,9 +151,9 @@ The high-level client-side workflow for establishing UID2 identity using the SDK - If the advertising token is available, use it to initiate requests for targeted advertising. - If the advertising token is not available, either use untargeted advertising or redirect the user to the data capture with the consent form. -For more detailed web integration steps, see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md). +For more detailed web integration steps, see [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md). -### Background Token Auto-Refresh +### Background token auto-refresh As part of the SDK [initialization](#initopts-object-void), a token auto-refresh for the identity is set up, which is triggered in the background by the timestamps on the identity or by failed refresh attempts due to intermittent errors. @@ -161,14 +161,14 @@ Here's what you need to know about the token auto-refresh: - Only one token refresh call can be active at a time. - If the [POST /token/refresh](../endpoints/post-token-refresh.md) response is unsuccessful because the user has opted out, or because the refresh token has expired, this suspends the background auto-refresh process. To use UID2-based targeted advertising again if the refresh token has expired, you must obtain the email or phone number from the consumer. If the user has opted out, take no further steps. In all other cases, auto-refresh attempts continue in the background. -- All [callback functions](#callback-function) provided using the [Array Push Pattern](#array-push-pattern) are invoked in the following cases: +- All [callback functions](#callback-function) provided using the [Array push pattern](#array-push-pattern) are invoked in the following cases: - After each successful refresh attempt. - When identity has become invalid—for example, because the user has opted out.
NOTE: The callback is *not* invoked when identity is temporarily unavailable and the auto-refresh keeps failing. In this case, the SDK continues using the existing advertising token as long as it hasn't expired. - A [disconnect()](#disconnect-void) call cancels the active timer. -### Callback Function +### Callback function -You can register functions to receive events from the UID2 SDK using the [Array Push Pattern](#array-push-pattern). The following events are currently available: +You can register functions to receive events from the UID2 SDK using the [Array push pattern](#array-push-pattern). The following events are currently available: - `SdkLoaded` is raised after the SDK has been parsed and the global `__uid2` object has been constructed. This is useful for calling `init()`, especially if your script loading order is not guaranteed (for example, if you are using `async` or `defer` script loading). - `InitCompleted` is raised when `init()` has finished and the SDK is ready for use. If an identity was provided in the `init` call, or the SDK was able to load a previously-provided identity, the identity is included in the payload. - `IdentityUpdated` is raised whenever there is a new identity available, or the existing identity is no longer available. @@ -177,7 +177,7 @@ You can register functions to receive events from the UID2 SDK using the [Array You can provide as many callback functions as you want, and register them from anywhere. This allows you to split your code up in a way that makes sense for your site. ::: -#### Callback Function Signature +#### Callback function signature Your callback function should accept two parameters: an event type and a payload. The type of the payload depends on the event type. @@ -222,7 +222,7 @@ window.__uid2.callbacks.push((eventType: EventType, payload: CallbackPayload) => -#### Array Push Pattern +#### Array push pattern In order to best support script tags that are not guaranteed to load in order (for example, if you're using `async` or `defer` script tags), use the following pattern to register callbacks: @@ -237,27 +237,27 @@ This ensures the following: - If the SDK runs before your code does, you do not overwrite the `__uid2` object or the `callbacks` array. - If multiple callbacks are registered using this pattern, they do not overwrite each other. -### Provide an Identity to the SDK +### Provide an identity to the SDK Unless the SDK is able to load a previously-stored identity from local storage or the cookie, you must provide an identity to it. There are several ways to do this: -- [Provide an Identity by Setting a First-Party Cookie](#provide-an-identity-by-setting-a-first-party-cookie) -- [Provide an Identity in the Call to `init`](#provide-an-identity-in-the-call-to-init) -- [Provide an Identity by Calling `setIdentity`](#provide-an-identity-by-calling-setidentity) +- [Provide an identity by setting a first-party cookie](#provide-an-identity-by-setting-a-first-party-cookie) +- [Provide an identity in the call to `init`](#provide-an-identity-in-the-call-to-init) +- [Provide an identity by calling `setidentity`](#provide-an-identity-by-calling-setidentity) -#### Provide an Identity by Setting a First-Party Cookie +#### Provide an identity by setting a first-party cookie If you store a first-party cookie, as described in the [storage format section](#uid2-storage-format), and the value is newer than the value available in local storage, the SDK loads the value from the cookie. If you have set the `useCookie` init option to `true`, it always loads this value, and does not check local storage. You can control several other things about the cookie using [init parameters](#init-parameters). -#### Provide an Identity in the Call to `init` +#### Provide an identity in the call to `init` You can provide a new identity when you call [`init`](#initopts-object-void). -#### Provide an Identity by Calling `setIdentity` +#### Provide an identity by calling `setidentity` -At any time after `init` has completed, you can call [`setIdentity`](#setidentityidentity-identity-void) to provide the SDK with a new identity to use. +At any time after `init` has completed, you can call [`setidentity`](#setidentityidentity-identity-void) to provide the SDK with a new identity to use. -## API Reference +## API reference All interactions with the SDK for JavaScript are done through the global `__uid2` object, which is an instance of the `UID2` class. All of the following JavaScript functions are members of the `UID2` class: @@ -287,11 +287,11 @@ Initializes the SDK and establishes user identity for targeted advertising. Here's what you need to know about this function: -- You can call `init()` any time after the SDK has been loaded. The recommended way to do this is by registering a callback function that handles the `SdkLoaded` event using the [Array Push Pattern](#array-push-pattern). By using this pattern you can make sure that your code works regardless of script load order, and that using `async` or `defer` on your script tags does not cause UID2 SDK errors. +- You can call `init()` any time after the SDK has been loaded. The recommended way to do this is by registering a callback function that handles the `SdkLoaded` event using the [Array push pattern](#array-push-pattern). By using this pattern you can make sure that your code works regardless of script load order, and that using `async` or `defer` on your script tags does not cause UID2 SDK errors. - The `identity` property in the `init()` call refers to the `body` property of the response JSON object returned from a successful [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) call with the server-side generated identity. This is a good way to provide the identity if your server-side integration ensures you always have a current token available and it is more convenient to provide it using JavaScript. - If the `identity` property in the `init()` call is falsy, the SDK attempts to load the identity from local storage or the cookie. - Once `init()` is complete, all callbacks receive the `InitCompleted` event. If the `identity` property on the payload of this event is null, no identity could be loaded, and you should therefore [provide an identity to the SDK](#provide-an-identity-to-the-sdk). This is the recommended way to provide an identity if your server-side integration does not ensure a current identity is always available, and you need to request it from the server only when necessary. - - If you are using a first-party cookie (see [UID2 Storage Format](#uid2-storage-format)) to store the passed UID2 information for the session, a call to `init()` made by a page on a different domain might not be able to access the cookie. You can adjust the settings used for the cookie with the `cookieDomain` and `cookiePath` options. + - If you are using a first-party cookie (see [UID2 storage format](#uid2-storage-format)) to store the passed UID2 information for the session, a call to `init()` made by a page on a different domain might not be able to access the cookie. You can adjust the settings used for the cookie with the `cookieDomain` and `cookiePath` options. - To tune specific behaviors, initialization calls might include optional configuration [init parameters](#init-parameters). The following is an example of an `init()` call made using a callback with the server-side generated identity included. @@ -312,37 +312,37 @@ The following is an example of an `init()` call that loads a previously-provided ``` -#### Init Parameters +#### Init parameters The `opts` object supports the following properties. | 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 | +| `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`. | | `refreshRetryPeriod` | number | Optional | The number of milliseconds after which to retry refreshing a token if an intermittent error occurs.
This value must be >= 1000. | 5000 | -| `cookieDomain` | string | Optional | The domain name string to apply to the UID2 cookie (see [UID2 Storage Format](#uid2-storage-format)).
For example, if the `baseUrl` is `https://my.operator.com`, the `cookieDomain` value might be `operator.com`. | `undefined` | -| `cookiePath` | string | Optional | The path string to apply to the UID2 cookie (see [UID2 Storage Format](#uid2-storage-format)). | `/` | +| `cookieDomain` | string | Optional | The domain name string to apply to the UID2 cookie (see [UID2 storage format](#uid2-storage-format)).
For example, if the `baseUrl` is `https://my.operator.com`, the `cookieDomain` value might be `operator.com`. | `undefined` | +| `cookiePath` | string | Optional | The path string to apply to the UID2 cookie (see [UID2 storage format](#uid2-storage-format)). | `/` | | `useCookie` | `boolean` | Optional | Set this to `true` to tell the SDK to store the identity in cookie storage instead of local storage. You can still provide an identity using a first-party cookie if this value is false or not provided. | -#### Multiple Init Calls +#### Multiple init calls You can call the `init()` function any number of times. In most cases, the code will accept the latest value of a certain [init parameter](#init-parameters). For example, if init is called twice, and a different `baseUrl` is passed in each call, the `baseUrl` variable is updated to the value from the second call. There are two exceptions to this functionality: 1. If a new identity is passed in a subsequent call, and the new identity expires before the current identity, the new identity does not replace the current identity. -2. For every subsequent callback function passed, the function is added to the existing array of callbacks using the [Array Push Pattern](#array-push-pattern). +2. For every subsequent callback function passed, the function is added to the existing array of callbacks using the [Array push pattern](#array-push-pattern). :::note If `useCookie` is updated, the location of the identity changes. For example, if the value is updated from `true` to `false`, the first-party cookie is removed and the identity is added to local storage. ::: -### Init Config +### Init config Calling `init()` stores an init config in a first-party cookie or local storage which can include the following parameters if given: `baseUrl`, `useCookie`, `refreshRetryPeriod`, `cookiePath`, and `cookieDomain`. This config is used to [bootstrap init](#self-bootstrap) and save load time in future page loads. Subsequent calls to `init()` update the config with the most recent parameters. -### Self Bootstrap +### Self bootstrap When the constructor has completed and the SDK has been put on the window object, the code will check local storage and cookie storage for a stored [init config](#init-config). If the config exists, `init()` is automatically called with the parameters from the config, and as a result, any functions that require `init()` can be used. @@ -355,11 +355,11 @@ The `init()` function can throw the following errors. | `TypeError` | One of the following issues has occurred:
  • The `opts` value is not an object.
  • A legacy callback is provided, but it is not a function.
  • `refreshRetryPeriod` is provided, but it is not a number.
| | `RangeError` | The refresh retry period is less than 1000. | -#### Legacy Callback Function +#### Legacy callback function -This is provided only for backward compatibility between version 3 or 4 and earlier versions: new integrations should use the newer [callback function](#callback-function). Note that the callback parameters are not compatible in either direction: legacy callbacks cannot be registered using the [Array Push Pattern](#array-push-pattern), and newer callbacks cannot be provided to `init`. +This is provided only for backward compatibility between version 3 or 4 and earlier versions: new integrations should use the newer [callback function](#callback-function). Note that the callback parameters are not compatible in either direction: legacy callbacks cannot be registered using the [Array push pattern](#array-push-pattern), and newer callbacks cannot be provided to `init`. -For details, see [Legacy Callback Function](./sdk-ref-javascript-v2#callback-function) in the documentation for earlier versions of this SDK. +For details, see [Legacy callback function](./sdk-ref-javascript-v2#callback-function) in the documentation for earlier versions of this SDK. If you have already built an integration using a legacy callback function, you can use it with the current version of the SDK with no changes. However, this functionality will be removed in a future version of the SDK. We strongly recommend that you update your integration to use the newer [callback function](#callback-function) used in versions 3 and 4. @@ -420,7 +420,7 @@ Specifies whether a UID2 [POST /token/generate](../endpoints/post-token-gen ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -438,7 +438,7 @@ If false, a UID2 [POST /token/generate](../endpoints/post-token-generate.md __uid2.isIdentityAvailable(); ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -447,7 +447,7 @@ If false, a UID2 [POST /token/generate](../endpoints/post-token-generate.md ### disconnect(): void -Clears the UID2 identity from the first-party cookie and local storage (see [UID2 Storage Format](#uid2-storage-format)). This closes the client's identity session and disconnects the client lifecycle. +Clears the UID2 identity from the first-party cookie and local storage (see [UID2 storage format](#uid2-storage-format)). This closes the client's identity session and disconnects the client lifecycle. When a user logs out of the publisher's site, make the following call: @@ -465,7 +465,7 @@ If you need to provide a `cookieDomain` or `cookiePath` for the SDK to access th ### callbacks -This is an array that stores all of the registered callbacks. You should only interact with it using the [Array Push Pattern](#array-push-pattern). +This is an array that stores all of the registered callbacks. You should only interact with it using the [Array push pattern](#array-push-pattern). ### setIdentity(identity: Identity): void @@ -491,13 +491,13 @@ Returns true if the `init()` function has been called at least once. Returns false if `init()` has never been called. -## UID2 Storage Format +## UID2 storage format The SDK uses either local storage or a first-party cookie to store the user's identity. The default option is to use local storage, but this can be changed using an [init parameter](#init-parameters). Even when using local storage, the SDK checks to see if there is a newer identity available in a first-party cookie. This allows the SDK to make use of local storage while still allowing you to provide an identity by setting the first-party cookie. -### UID2 Cookie Properties +### UID2 cookie properties If cookie storage is being used, the cookie uses the properties in the following table. @@ -508,7 +508,7 @@ If cookie storage is being used, the cookie uses the properties in the following | `Path` | `/` | If you want to use a different value, you can set it during SDK initialization using the `cookiePath` [init() parameter](#init-parameters). | | `Domain` | `undefined` | If you want to use a different value, you can set it during SDK initialization using the `cookieDomain` [init() parameter](#init-parameters). | -### Contents Structure +### Contents structure The content of the UID2 local storage or cookie is a URI-encoded string representation of a JSON object with the structure identical to that of the `body` property in a [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) response, with the exception of the `private` object. @@ -520,27 +520,27 @@ The following is an example of the UID2 cookie structure: The contents of the `private` object are explicitly unspecified and are left for the SDK to interpret. Do not make any assumptions about the structure, semantics, or compatibility of this object. Any updates to the cookie must retain its structure. ::: -## Migration Guide +## Migration guide This section includes all the information you need to upgrade from an earlier version of the SDK for JavaScript to the current version, v4. It includes: -- [Benefits of Migrating](#benefits-of-migrating) -- [Required Changes](#required-changes) -- [Recommended Changes](#recommended-changes) -- [Optional Changes](#optional-changes) +- [Benefits of migrating](#benefits-of-migrating) +- [Required changes](#required-changes) +- [Recommended changes](#recommended-changes) +- [Optional changes](#optional-changes) -### Benefits of Migrating +### Benefits of migrating Migrating to version 4 gives you the following benefits introduced in versions 3 and 4: -- [Benefits in Version 3](#benefits-in-version-3) -- [Benefits in Version 4](#benefits-in-version-4) +- [Benefits in version 3](#benefits-in-version-3) +- [Benefits in version 4](#benefits-in-version-4) :::important -Version 3 of the SDK is fully backwards-compatible with earlier versions, but includes deprecated elements which were removed in version 4. To migrate to version 4, you must change your script tag to refer to the new URL. In addition, if your integration references any of the items listed in [Changes in Version 4](#changes-in-version-4), and is not updated, you must make those updates as part of upgrading to version 4. For example, make sure your code no longer uses the `abort()` function, which has been removed in version 4. +Version 3 of the SDK is fully backwards-compatible with earlier versions, but includes deprecated elements which were removed in version 4. To migrate to version 4, you must change your script tag to refer to the new URL. In addition, if your integration references any of the items listed in [Changes in version 4](#changes-in-version-4), and is not updated, you must make those updates as part of upgrading to version 4. For example, make sure your code no longer uses the `abort()` function, which has been removed in version 4. ::: -#### Benefits in Version 3 +#### Benefits in version 3 In version 3: @@ -552,7 +552,7 @@ In version 3: - If you rely on setting a first-party cookie to provide a new identity, you do not gain any benefit from this change. - If you only provide the identity by passing it to `init`, the SDK no longer writes to the cookie. -Some of the functionality from version 2 and earlier was deprecated in version 3, and we recommended that anyone upgrading to version 3 should future proof their integration by making some code updates. This functionality was removed in version 4. If your integration references any of the items listed in [Changes in Version 4](#changes-in-version-4), and is not updated, you **must** make those updates as part of upgrading to version 4. +Some of the functionality from version 2 and earlier was deprecated in version 3, and we recommended that anyone upgrading to version 3 should future proof their integration by making some code updates. This functionality was removed in version 4. If your integration references any of the items listed in [Changes in version 4](#changes-in-version-4), and is not updated, you **must** make those updates as part of upgrading to version 4. The legacy callback system was deprecated in version 3, and will be removed in a future version. @@ -565,48 +565,48 @@ By updating your integration, you can take advantage of these features added in This makes the SDK much easier to use in single-page app scenarios. -#### Benefits in Version 4 +#### Benefits in version 4 -Version 4 is more robust than earlier versions. For a summary of the benefits, see [Changes in Version 4](#changes-in-version-4). +Version 4 is more robust than earlier versions. For a summary of the benefits, see [Changes in version 4](#changes-in-version-4). -### Required Changes +### Required changes To migrate to version 4, the steps are a little different depending on how your current implementation is configured: -- **Migration from version 3, with no elements from earlier versions**: The only step needed is to update your script tag to load the SDK from the version 4.0.1 CDN URL. See [Include the SDK Script](#include-the-sdk-script). +- **Migration from version 3, with no elements from earlier versions**: The only step needed is to update your script tag to load the SDK from the version 4.0.1 CDN URL. See [Include the SDK script](#include-the-sdk-script). -- **Migration from version 3, and you previously migrated from version 2 without completing the steps to update your implementation**: Update your script tag, and also update your code so that it doesn't reference elements removed in version 4. For details, see [Changes in Version 4](#changes-in-version-4). +- **Migration from version 3, and you previously migrated from version 2 without completing the steps to update your implementation**: Update your script tag, and also update your code so that it doesn't reference elements removed in version 4. For details, see [Changes in version 4](#changes-in-version-4). -- **Migration from version 2 or earlier**: Update your script tag, and also update your code so that it doesn't reference elements removed in version 4. For details, see [Changes in Version 4](#changes-in-version-4). +- **Migration from version 2 or earlier**: Update your script tag, and also update your code so that it doesn't reference elements removed in version 4. For details, see [Changes in version 4](#changes-in-version-4). -### Additional Changes: Migration from v2 or Earlier +### Additional changes: Migration from v2 or earlier If you're migrating from a version earlier than v3, or if you previously migrated from an earlier version to version 3 without updating your code, consider the following recommended and optional changes to improve your implementation of the UID2 JavaScript SDK: -- [Recommended Changes](#recommended-changes) -- [Optional Changes](#optional-changes) +- [Recommended changes](#recommended-changes) +- [Optional changes](#optional-changes) -#### Recommended Changes +#### Recommended changes If you're migrating from a version earlier than v3, or if you previously migrated from an earlier version to version 3 without updating your code, we strongly recommend that you implement the following changes in your code: -- [Migrate to the Newer Callback System Introduced in Version 3](#migrate-to-the-newer-callback-system-introduced-in-version-3) -- [Take advantage of `setIdentity` and other features introduced in version 3](#take-advantage-of-setidentity-and-other-features-introduced-in-version-3) +- [Migrate to the newer callback system introduced in version 3](#migrate-to-the-newer-callback-system-introduced-in-version-3) +- [Take advantage of `setidentity` and other features introduced in version 3](#take-advantage-of-setidentity-and-other-features-introduced-in-version-3) - [Change how you call init](#change-how-you-call-init) ##### Migrate to the Newer Callback System Introduced in Version 3 -In versions before version 3, the callback accepted a single object as a parameter, with properties `advertisingToken`, `status`, and `statusText`. When upgrading to version 3 or 4, change this function to use the [Callback Function Signature](#callback-function-signature) introduced in version 3. +In versions before version 3, the callback accepted a single object as a parameter, with properties `advertisingToken`, `status`, and `statusText`. When upgrading to version 3 or 4, change this function to use the [Callback function signature](#callback-function-signature) introduced in version 3. Your original callback probably has some logic to deal with different values of `status`. The previous system had a variety of different status values to handle, such as `EXPIRED`, `REFRESHED`, and `NO_IDENTITY`. The new system instead has only three event types: `SdkLoaded`, `InitCompleted`, and `IdentityUpdated`. -This guide cannot cover every possible scenario, and you should review the [Callback Function](#callback-function) section and consider the best way to implement your requirements using the new system. However, there are some general guidelines that should help: +This guide cannot cover every possible scenario, and you should review the [Callback function](#callback-function) section and consider the best way to implement your requirements using the new system. However, there are some general guidelines that should help: - Check the `event` parameter. If the value is `SdkLoaded`, return immediately. - Otherwise, check to see if the `payload` parameter has an `identity` property. - If there is no object on the `identity` property, there is no UID2 identity available. You should invoke whatever the previous callback did in the equivalent situation. - Otherwise, the `identity` property is an object with a `string` property named `advertising_token`. You should use this in the same way that the old callback did. -Remove the old callback from your `init` call, and provide your updated callback function to the SDK using the [Array Push Pattern](#array-push-pattern): +Remove the old callback from your `init` call, and provide your updated callback function to the SDK using the [Array push pattern](#array-push-pattern): ``` window.__uid2 = window.__uid2 || {}; @@ -620,7 +620,7 @@ Versions of the SDK prior to version 3 had only one way to provide a new identit ##### Change how you call init -The recommended way to call `init` is by using the [Array Push Pattern](#array-push-pattern). Your existing call to `init` should be moved inside a callback handler that only handles the `SdkLoaded` event, as shown in the following example: +The recommended way to call `init` is by using the [Array push pattern](#array-push-pattern). Your existing call to `init` should be moved inside a callback handler that only handles the `SdkLoaded` event, as shown in the following example: ``` window.__uid2 = window.__uid2 || {}; @@ -635,7 +635,7 @@ window.__uid2.callbacks.push((eventType) => { }); ``` -#### Optional Changes +#### Optional changes If you're upgrading from a version earlier than v3, consider this optional change. diff --git a/docs/sdks/sdk-ref-python.md b/docs/sdks/sdk-ref-python.md index a11a1cdbf..31792a706 100644 --- a/docs/sdks/sdk-ref-python.md +++ b/docs/sdks/sdk-ref-python.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for Python Reference Guide +# SDK for Python reference guide You can use the SDK for Python on the server side to facilitate the process of generating or establishing client identity using UID2, retrieving advertising tokens for bidstream use, and automatically refreshing UID2 tokens. If you have the applicable permissions, you can also encrypt and decrypt for sharing and map DII to raw UID2s. @@ -22,17 +22,17 @@ This SDK simplifies integration with UID2 for any DSPs or UID2 sharers who are u *Only applicable to SDK versions referencing versions of the `POST /identity/map` endpoint prior to version 3. -## UID2 Account Setup +## UID2 account setup -To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page. +To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account setup](../getting-started/gs-account-setup.md) page. -## API Permissions +## API permissions -When initial account setup is complete, if you're a publisher, advertiser, or data provider, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can: +When initial account setup is complete, if you're a publisher, advertiser, or data provider, you'll receive instructions and a link to access the [UID2 portal](../portal/portal-overview.md), where you can: - Generate [credentials](../getting-started/gs-credentials.md) for your account. - Optionally, configure other values, such as setting up information about team members. -You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. Bear in mind that there might be functions in the SDK that you don't have permission to use. For example, publishers get a specific API permission to generate and refresh tokens, but the SDK might support other activities that require a different API permission. For details, see [API Permissions](../getting-started/gs-permissions.md). +You'll be granted permission to use specific functions offered by the SDK, and given credentials for that access. Bear in mind that there might be functions in the SDK that you don't have permission to use. For example, publishers get a specific API permission to generate and refresh tokens, but the SDK might support other activities that require a different API permission. For details, see [API permissions](../getting-started/gs-permissions.md). If you're a DSP, we'll send credentials to you. @@ -45,7 +45,7 @@ version: - **v2.6.0**: Python 3.8 or higher - **v2.5.0 and below**: Python 3.6 or higher -## GitHub Repository/Package +## Github repository/package This SDK is in the following open-source GitHub repository: @@ -55,7 +55,7 @@ The package is published in this location: - [https://pypi.org/project/uid2-client/](https://pypi.org/project/uid2-client/) -## Release Notes +## Release notes For detailed information about changes, bug fixes, and new features in each release, see the [release notes on GitHub](https://github.com/IABTechLab/uid2-client-python/releases). @@ -73,10 +73,10 @@ The initialization step depends on the role, as shown in the following table. | 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) | +| Publisher | `Uid2PublisherClient` | [Usage for publishers](#usage-for-publishers) | +| 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) | +| Sharer | `SharingClient` | [Usage for sharers](#usage-for-uid2-sharers) | @@ -85,14 +85,14 @@ You will need to provide the values necessary for the SDK to authenticate with t | Parameter | Description | |:-------------|:-------------------------------------------------------------------------------------------| | `base_url` | The endpoint for the UID2 service. See [Environments](../getting-started/gs-environments). | -| `auth_key` | The API key. See [UID2 Credentials](../getting-started/gs-credentials). | -| `secret_key` | The client secret. See [UID2 Credentials](../getting-started/gs-credentials). | +| `auth_key` | The API key. See [UID2 credentials](../getting-started/gs-credentials). | +| `secret_key` | The client secret. See [UID2 credentials](../getting-started/gs-credentials). | ## Interface The `BidstreamClient` class allows you to decrypt UID2 tokens into raw UID2s. -For details on the bidding logic for handling user opt-outs, see [DSP Integration Guide](../guides/dsp-guide.md). +For details on the bidding logic for handling user opt-outs, see [DSP integration guide](../guides/dsp-guide.md). The `SharingClient` class allows you to encrypt raw UID2s into UID2 tokens and decrypt UID2 tokens into raw UID2s. @@ -101,16 +101,16 @@ The `SharingClient` class allows you to encrypt raw UID2s into UID2 tokens and d When you use an SDK, you do not need to store or manage decryption keys. ::: -### Encryption Response Content +### Encryption response content When encrypting with the `SharingClient`, the SDK returns the information shown in the following table. | Property | Description | |:-----------------|:------------------------------------------------------------------------------------------------------------------------------------------------| -| `status` | The encryption result status. For a list of possible values and definitions, see [Encryption Response Statuses](#encryption-response-statuses). | +| `status` | The encryption result status. For a list of possible values and definitions, see [Encryption response statuses](#encryption-response-statuses). | | `encrypted_data` | The encrypted UID2 token. | -### Encryption Response Statuses +### Encryption response statuses Encryption response codes, and their meanings, are shown in the following table. @@ -123,17 +123,17 @@ Encryption response codes, and their meanings, are shown in the following table. | `KEYS_NOT_SYNCED` | The client has failed to synchronize keys from the UID2 service. | | `ENCRYPTION_FAILURE` | A generic encryption failure occurred. | -### Decryption Response Content +### Decryption response content Whether decrypting with the `BidstreamClient` or the `SharingClient`, the SDK returns the information shown in the following table. | Property | Description | |:--------------|:------------------------------------------------------------------------------------------------------------------------------------------------| -| `status` | The decryption result status. For a list of possible values and definitions, see [Decryption Response Statuses](#decryption-response-statuses). | +| `status` | The decryption result status. For a list of possible values and definitions, see [Decryption response statuses](#decryption-response-statuses). | | `uid` | The raw UID2 for the corresponding UID2 token. | | `established` | The timestamp indicating when a user first established the UID2 with the publisher. | -### Decryption Response Statuses +### Decryption response statuses Decryption response codes, and their meanings, are shown in the following table. @@ -149,7 +149,7 @@ Decryption response codes, and their meanings, are shown in the following table. | `DOMAIN_NAME_CHECK_FAILED` | The domain name doesn't match the domain of the encrypted token. | | `INVALID_TOKEN_LIFETIME` | The token has an invalid timestamp. | -## Usage for Publishers +## Usage for publishers 1. Create an instance of `Uid2PublisherClient`: ```py @@ -163,9 +163,9 @@ Decryption response codes, and their meanings, are shown in the following table. -### Client-Server Integration +### Client-server integration -If you're using client-server integration (see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: +If you're using client-server integration (see [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: * Send this identity as a JSON string back to the client (to use in the [identity field](../sdks/sdk-ref-javascript.md#initopts-object-void)) using the following: @@ -177,9 +177,9 @@ If you're using client-server integration (see [Client-Server Integration Guide If the user has opted out, this method returns None, so be sure to handle that case. ::: -### Server-Side Integration +### Server-side integration -If you're using server-side integration (see [Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md)): +If you're using server-side integration (see [Publisher integration guide, server-side](../guides/integration-publisher-server-side.md)): 1. Store this identity as a JSON string in the user's session, using the `token_generate_response.get_identity_json_string()` function. @@ -221,13 +221,13 @@ If you're using server-side integration (see [Publisher Integration Guide, Serve If the user has opted out, this method returns `None`, indicating that the user's identity should be removed from the session. To confirm optout, you can use the `token_refresh_response.is_optout()` function. -## Usage for Advertisers/Data Providers +## Usage for advertisers/data providers The following instructions provide an example of how to map DII to raw UID2s using the latest version of the `POST /identity/map` endpoint. -For the earlier version, see [Previous Version (v2 Identity Map)](#previous-version-v2-identity-map). For migration steps to the latest version, see [Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map). +For the earlier version, see [Previous version (v2 identity map)](#previous-version-v2-identity-map). For migration steps to the latest version, see [Migration from version using v2 identity map](#migration-from-version-using-v2-identity-map). -### Map DII to Raw UID2s +### Map DII to raw UID2s To map DII to raw UID2s, follow these steps: @@ -280,7 +280,7 @@ To map DII to raw UID2s, follow these steps: The raw UID2 does not change before the refresh timestamp. After the refresh timestamp, remapping the DII returns a new refresh timestamp, but the raw UID2 might or might not change. It is possible for the raw UID2 to remain unchanged for multiple refresh intervals. ::: -#### Usage Example +#### Usage example ```py client = IdentityMapV3Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY) @@ -309,15 +309,15 @@ mixed_input = IdentityMapV3Input() mixed_response = client.generate_identity_map(mixed_input) ``` -## Migration From Version Using v2 Identity Map +## Migration from version using v2 identity map The following sections provide general information and guidance for migrating to the latest version of this SDK, which references `POST /identity/map` version 3, including: -- [Version 3 Improvements](#version-3-improvements) -- [Upgrading Client Version](#upgrading-client-version) -- [Updating DII Mapping](#updating-dii-mapping) +- [Version 3 improvements](#version-3-improvements) +- [Upgrading client version](#upgrading-client-version) +- [Updating DII mapping](#updating-dii-mapping) -### Version 3 Improvements +### Version 3 improvements The `POST /v3/identity/map` provides the following improvements over v2: @@ -327,7 +327,7 @@ The `POST /v3/identity/map` provides the following improvements over v2: - **Multiple Identity Types in One Request**: You can process both emails and phone numbers in a single request. - **Improved Performance**: The updated version uses significantly less bandwidth to process the same amount of DII. -### Upgrading Client Version +### Upgrading client version To upgrade your client to the latest version (version 3), follow these steps: @@ -350,7 +350,7 @@ To upgrade your client to the latest version (version 3), follow these steps: from uid2_client import IdentityMapV3Client, IdentityMapV3Input, IdentityMapV3Response, UnmappedIdentityReason ``` -### Updating DII Mapping +### Updating DII mapping To update DII mapping from version 2 to version 3 of the `POST /identity/map` endpoint, follow these steps: @@ -397,14 +397,14 @@ To update DII mapping from version 2 to version 3 of the `POST /identity/map` en raw_reason = unmapped.raw_reason ``` -### Previous Version (v2 Identity Map) +### Previous version (v2 identity map) :::note The v2 Identity Map SDK is an earlier version maintained for backwards compatibility. Migrate to the current SDK for improved performance, multi-identity type support, and better UID2 rotation management. New integrations should not use this version. -For instructions, see [Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map). +For instructions, see [Migration from version using v2 identity map](#migration-from-version-using-v2-identity-map). ::: To map email addresses, phone numbers, or their respective hashes to their raw UID2s and salt bucket IDs, if you're using an earlier SDK version that uses `POST /identity/map` version 2, follow these steps. @@ -440,11 +440,11 @@ To map email addresses, phone numbers, or their respective hashes to their raw U reason = unmapped_identity.get_reason() ``` -#### Monitor Rotated Salt Buckets +#### Monitor rotated salt buckets To monitor salt buckets, follow these steps. -1. Create an instance of `IdentityMapClient` as an instance variable or reuse the one from [Map DII to Raw UID2s:](#map-dii-to-raw-uid2s) +1. Create an instance of `IdentityMapClient` as an instance variable or reuse the one from [Map DII to raw UID2s:](#map-dii-to-raw-uid2s) ```py client = IdentityMapClient(base_url, api_key, client_secret) @@ -504,14 +504,14 @@ else: For a full example, see the `sample_bidstream_client.py` in [examples/sample_bidstream_client.py](https://github.com/IABTechLab/uid2-client-python/blob/main/examples/sample_bidstream_client.py). -## Usage for UID2 Sharers +## Usage for UID2 sharers A UID2 sharing participant is a company that takes part in sharing, either as a sender or a receiver, to share UID2s with another participant. -Advertisers and data providers can use this SDK to share UID2s with other authorized UID2 sharing participants (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security Requirements for UID2 Sharing](../sharing/sharing-security.md). +Advertisers and data providers can use this SDK to share UID2s with other authorized UID2 sharing participants (tokenized sharing). They can encrypt [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) into UID2 tokens and then send them to another participant for sharing in pixels (see [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md)). If you are not sending data in pixels, you can take part in UID2 sharing as long as you follow the requirements laid out in [Security requirements for UID2 sharing](../sharing/sharing-security.md). :::important -The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). +The UID2 token generated during this process is for sharing only—you cannot use it in the bidstream. There is a different workflow for generating tokens for the bidstream: see [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md). ::: The following instructions provide an example of how you can implement sharing using the SDK for Python, either as a sender or a receiver. @@ -555,10 +555,10 @@ For a full example, see the `sample_sharing_client.py` in [examples/sample_shari The following steps might be useful in development: -- [Example Usage](#example-usage) +- [Example usage](#example-usage) - [Running tests](#running-tests) -### Example Usage +### Example usage You can run specific examples from the [examples](https://github.com/IABTechLab/uid2-client-python/blob/main/examples) directory. ```py diff --git a/docs/sdks/summary-sdks.md b/docs/sdks/summary-sdks.md index c5989854b..d5b94690c 100644 --- a/docs/sdks/summary-sdks.md +++ b/docs/sdks/summary-sdks.md @@ -14,7 +14,7 @@ import Link from '@docusaurus/Link'; Review the SDK functionality to determine which SDK or SDKs you want to use, then click through in the SDKs table to review the reference documentation. -## SDK Functionality +## SDK functionality The following table summarizes the functionality available with each SDK. @@ -121,21 +121,21 @@ The following table summarizes the functionality available with each SDK. -* Advertisers and Data Providers who need to generate raw UID2s from DII can also do this via Snowflake (see [Snowflake Integration Guide](../guides/integration-snowflake.md)) or by using the [POST /identity/map](../endpoints/post-identity-map.md) endpoint. +* Advertisers and Data Providers who need to generate raw UID2s from DII can also do this via Snowflake (see [Snowflake integration guide](../guides/integration-snowflake.md)) or by using the [POST /identity/map](../endpoints/post-identity-map.md) endpoint. ** Monitoring rotated salt buckets is not necessary for implementations using the latest version of the [POST /identity/map](../endpoints/post-identity-map.md) endpoint. -## SDK Documentation +## SDK documentation The following SDK documentation is available for UID2 integration. Documentation links are in the first column. | 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:
  • Helps publishers to generate or refresh UID2 tokens from DII ([POST /token/generate](../endpoints/post-token-generate)).
  • Helps UID2 sharers to encrypt or decrypt UID2 tokens ([Usage for UID2 Sharers](sdk-ref-java.md#usage-for-uid2-sharers)).
  • Helps DSPs to decrypt UID2 tokens from bid requests ([Decrypt UID2 Tokens for RTB Use](guides/dsp-guide.md#decrypt-uid2-tokens-for-rtb-use)).
| Publishers
DSPs
Advertisers
Data Providers
Sharers | -| [SDK for Python](sdk-ref-python.md) | An SDK for audiences using Python server-side:
  • Helps publishers to generate or refresh UID2 tokens from DII ([POST /token/generate](../endpoints/post-token-generate)).
  • Helps UID2 sharers to encrypt or decrypt UID2 tokens ([Usage for UID2 Sharers](sdk-ref-python.md#usage-for-uid2-sharers)).
  • Helps DSPs to decrypt UID2 tokens from bid requests ([Decrypt UID2 Tokens for RTB Use](guides/dsp-guide.md#decrypt-uid2-tokens-for-rtb-use)).
| Publishers
DSPs
Data Providers
Sharers | +| [SDK for Java](sdk-ref-java.md) | An SDK for audiences using Java server-side:
  • Helps publishers to generate or refresh UID2 tokens from DII ([POST /token/generate](../endpoints/post-token-generate)).
  • Helps UID2 sharers to encrypt or decrypt UID2 tokens ([Usage for UID2 sharers](sdk-ref-java.md#usage-for-uid2-sharers)).
  • Helps DSPs to decrypt UID2 tokens from bid requests ([Decrypt UID2 tokens for RTB use](guides/dsp-guide.md#decrypt-uid2-tokens-for-rtb-use)).
| Publishers
DSPs
Advertisers
Data Providers
Sharers | +| [SDK for Python](sdk-ref-python.md) | An SDK for audiences using Python server-side:
  • Helps publishers to generate or refresh UID2 tokens from DII ([POST /token/generate](../endpoints/post-token-generate)).
  • Helps UID2 sharers to encrypt or decrypt UID2 tokens ([Usage for UID2 sharers](sdk-ref-python.md#usage-for-uid2-sharers)).
  • Helps DSPs to decrypt UID2 tokens from bid requests ([Decrypt UID2 tokens for RTB use](guides/dsp-guide.md#decrypt-uid2-tokens-for-rtb-use)).
| Publishers
DSPs
Data Providers
Sharers | | [SDK for C# / .NET](sdk-ref-csharp-dotnet.md) | An SDK for audiences using .NET server-side:
  • Helps DSPs to decrypt UID2 tokens from bid requests.
  • Helps UID2 sharers to encrypt or decrypt UID2 tokens.
| DSPs
Data Providers
Sharers | | [SDK for C++](sdk-ref-cplusplus.md) | An SDK for audiences using C++ server-side:
  • Helps DSPs to decrypt UID2 tokens from bid requests.
  • Helps UID2 sharers to encrypt or decrypt UID2 tokens.
| DSPs
Data Providers
Sharers | | [SDK for Android](sdk-ref-android.md) |An SDK that facilitates the process of generating or establishing client identity using UID2 and retrieving UID2 tokens for publishers that need to support Android apps. | Publishers | diff --git a/docs/sharing/sharing-best-practices.md b/docs/sharing/sharing-best-practices.md index 192a3c69f..6560684a4 100644 --- a/docs/sharing/sharing-best-practices.md +++ b/docs/sharing/sharing-best-practices.md @@ -8,20 +8,20 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Sharing: Best Practices +# UID2 sharing: Best practices The ability to securely share raw UID2s or UID2 tokens with other authorized UID2 users opens the door to using UID2 in many additional ways in your business. However, every UID2 participant has a responsibility to maintain the security of the UID2 ecosystem. Here are some best practices to help ensure that UID2 sharing runs smoothly and securely. -## Best Practices for Managing Raw UID2s and UID2 Tokens +## Best practices for managing raw UID2s and UID2 tokens Follow these guidelines: - For any UID2s that are in your platform, use and store them as raw UID2s, not as UID2 tokens. When you receive UID2 tokens, decrypt them as soon as possible. This is important because a UID2 token is short-lived. When the key that was used to create a UID2 token expires, you can no longer decrypt the token. -- A raw UID2 **must not** be passed through non-participants. For more information, see [UID2 Token Pass-Through](sharing-tokenized-overview.md#uid2-token-pass-through). +- A raw UID2 **must not** be passed through non-participants. For more information, see [UID2 token pass-through](sharing-tokenized-overview.md#uid2-token-pass-through). - In your code, for future extensibility, allow for the following: @@ -31,7 +31,7 @@ Follow these guidelines: - Before sharing raw UID2s with another authorized sharing participant, check the opt-out status of the raw UID2s, using the [POST /optout/status](../endpoints/post-optout-status.md) endpoint. Do not share raw UID2s that have been opted out. -## Decryption Key Refresh Cadence for Sharing +## Decryption key refresh cadence for sharing If you're using an SDK, defining the schedule for refreshing the sharing keys is part of setup. diff --git a/docs/sharing/sharing-overview.md b/docs/sharing/sharing-overview.md index a71a4a586..9f3cd4b72 100644 --- a/docs/sharing/sharing-overview.md +++ b/docs/sharing/sharing-overview.md @@ -8,54 +8,54 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Sharing: Overview  +# UID2 sharing: Overview  In UID2, sharing is a process for distributing either [raw UID2s](../ref-info/glossary-uid.md#gl-raw-uid2) or [UID2 tokens](../ref-info/glossary-uid.md#gl-uid2-token) between UID2 participants. -All instances where a raw UID2 or UID2 token is shared with another participant fall under the definition of sharing. All sharing participants who send raw UID2s must follow the security requirements specified in the standard security practices. For details, see [Security Requirements for UID2 Sharing](sharing-security.md). We encourage all participants who are sharing UID2 tokens to follow these steps. +All instances where a raw UID2 or UID2 token is shared with another participant fall under the definition of sharing. All sharing participants who send raw UID2s must follow the security requirements specified in the standard security practices. For details, see [Security requirements for UID2 sharing](sharing-security.md). We encourage all participants who are sharing UID2 tokens to follow these steps. -## Sharing Participants +## Sharing participants In UID2, a sharing participant is a company that takes part in distributing raw UID2s or UID2 tokens from one UID2 participant to another, either as a sender or a receiver. A sharing participant can be a publisher, advertiser, DSP, or data provider, or might have more than one of these roles. -## Approved Sharing Scenarios +## Approved sharing scenarios There are several main sharing scenarios, summarized in the following table. -For examples, see [Sharing UID2s: Use Cases](sharing-use-cases.md). +For examples, see [Sharing UID2s: Use cases](sharing-use-cases.md). | 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) | -| Sharing with another UID2 sharing participant, outside of the bidstream or pixels | Any authorized [participant](../ref-info/glossary-uid.md#gl-sharing-participant) | Any authorized [participant](../ref-info/glossary-uid.md#gl-sharing-participant) | Sharing raw UID2s
or
Sharing UID2 tokens (tokenized sharing) | Sharing by any secure channel, such as via API or Amazon S3 drop. | [Raw UID2 Sharing](sharing-raw.md)
or
[Tokenized Sharing from Raw UID2s](sharing-tokenized-from-raw.md) | +| 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) | +| Sharing with another UID2 sharing participant, outside of the bidstream or pixels | Any authorized [participant](../ref-info/glossary-uid.md#gl-sharing-participant) | Any authorized [participant](../ref-info/glossary-uid.md#gl-sharing-participant) | Sharing raw UID2s
or
Sharing UID2 tokens (tokenized sharing) | Sharing by any secure channel, such as via API or Amazon S3 drop. | [Raw UID2 sharing](sharing-raw.md)
or
[Tokenized sharing from raw UID2s](sharing-tokenized-from-raw.md) | -## UID2 Sharing Approaches +## UID2 sharing approaches If a sharing participant wants to share UID2s with another authorized sharing participant, there are two possible paths: -- [Sharing UID2 Tokens](#sharing-uid2-tokens) -- [Sharing Raw UID2s](#sharing-raw-uid2s) +- [Sharing UID2 tokens](#sharing-uid2-tokens) +- [Sharing raw UID2s](#sharing-raw-uid2s) -### Sharing UID2 Tokens +### Sharing UID2 tokens The following are the high-level steps for sharing UID2 tokens ([tokenized sharing](../ref-info/glossary-uid.md#gl-tokenized-sharing)): 1. The sender sets up sharing permissions in the UID2 Portal. :::note - Use of sharing requires an API key (see [API Keys](../portal/api-keys.md)) or client-side key pair (see [Client-Side Integration](../portal/client-side-integration.md)). In the UID2 Portal, configure these values before setting up sharing permissions. + Use of sharing requires an API key (see [API keys](../portal/api-keys.md)) or client-side key pair (see [Client-side integration](../portal/client-side-integration.md)). In the UID2 Portal, configure these values before setting up sharing permissions. ::: 2. The sender does either of the following: - Generates UID2 tokens from DII. - Encrypts raw UID2s into UID2 tokens. - 3. The receiver decrypts the UID2 tokens into raw UID2s, following the instructions that apply to the sharing scenario (see [Approved Sharing Scenarios](#approved-sharing-scenarios)). + 3. The receiver decrypts the UID2 tokens into raw UID2s, following the instructions that apply to the sharing scenario (see [Approved sharing scenarios](#approved-sharing-scenarios)). -For more information about the options for sharing UID2 tokens, and links to instructions, see [Tokenized Sharing Overview](sharing-tokenized-overview.md). +For more information about the options for sharing UID2 tokens, and links to instructions, see [Tokenized sharing overview](sharing-tokenized-overview.md). -### Sharing Raw UID2s +### Sharing raw UID2s -To share raw UID2s, we expect that both the sender and receiver are [sharing participants](ref-info/glossary-uid.md#gl-sharing-participant) who have the resources, processes, and facilities in place to ensure that the raw UID2s are not compromised, and who will follow standard security practices as defined in [Security Requirements for UID2 Sharing](sharing-security.md). +To share raw UID2s, we expect that both the sender and receiver are [sharing participants](ref-info/glossary-uid.md#gl-sharing-participant) who have the resources, processes, and facilities in place to ensure that the raw UID2s are not compromised, and who will follow standard security practices as defined in [Security requirements for UID2 sharing](sharing-security.md). diff --git a/docs/sharing/sharing-raw.md b/docs/sharing/sharing-raw.md index 03a700e52..a7f90426c 100644 --- a/docs/sharing/sharing-raw.md +++ b/docs/sharing/sharing-raw.md @@ -8,9 +8,9 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Raw UID2 Sharing +# Raw UID2 sharing -[Sharing participants](ref-info/glossary-uid.md#gl-sharing-participant) who want to share [raw UID2s](../ref-info/glossary-uid.md#gl-raw-uid2) with another authorized sharing participant must adhere to the responsibilities of authentication, authorization, accounting, and secure transport, as specified in [Security Requirements for UID2 Sharing](sharing-security.md). Make sure that all points are rigorously followed. +[Sharing participants](ref-info/glossary-uid.md#gl-sharing-participant) who want to share [raw UID2s](../ref-info/glossary-uid.md#gl-raw-uid2) with another authorized sharing participant must adhere to the responsibilities of authentication, authorization, accounting, and secure transport, as specified in [Security requirements for UID2 sharing](sharing-security.md). Make sure that all points are rigorously followed. :::note It's important to honor user opt-out status. Before sharing raw UID2s with another authorized sharing participant, check the opt-out status of the raw UID2s, using the [POST /optout/status](../endpoints/post-optout-status.md) endpoint. Do not share raw UID2s that have been opted out. diff --git a/docs/sharing/sharing-security.md b/docs/sharing/sharing-security.md index dcbe53732..ce6529da4 100644 --- a/docs/sharing/sharing-security.md +++ b/docs/sharing/sharing-security.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Security Requirements for UID2 Sharing +# Security requirements for UID2 sharing All UID2 participants have a core responsibility to ensure that the UID2 ecosystem is safe. The following are standard security practices for all UID2 participants. If you are sharing raw UID2s between authorized [sharing participants](../ref-info/glossary-uid.md#gl-sharing-participant) they are required and must all be met consistently; if you are sharing UID2 tokens they are recommended. @@ -17,8 +17,8 @@ The security requirements are as follows: - [Authentication](#authentication) - [Authorization](#authorization) - [Accounting](#accounting) -- [Secure Transport](#secure-transport) -- [Example Workflow](#example-workflow) +- [Secure transport](#secure-transport) +- [Example workflow](#example-workflow) ## Authentication @@ -59,14 +59,14 @@ The following table shows the key fields you should consider including in the tr Additional logs, such as network logs, application logs, and cloud audit logs, can also help by providing additional information such as source and destination IP addresses or cloud platform account IDs. -## Secure Transport +## Secure transport Secure transport helps protect raw UID2s from being accessible or modifiable by an onlooker during the transition of data from sender to receiver, end to end. Examples of secure transport include: - HTTPS or TLS - Message-based encryption -## Example Workflow +## Example workflow The following is an example workflow for an online AAA (Authentication, Authorization, and Accounting) flow, with an additional human verification step for contract validation. 1. Pre-Authentication: diff --git a/docs/sharing/sharing-tokenized-from-data-bid-stream.md b/docs/sharing/sharing-tokenized-from-data-bid-stream.md index 111e90b25..91589a8f4 100644 --- a/docs/sharing/sharing-tokenized-from-data-bid-stream.md +++ b/docs/sharing/sharing-tokenized-from-data-bid-stream.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Tokenized Sharing in the Bidstream +# Tokenized sharing in the bidstream UID2 data shared to the bidstream must be in the form of UID2 tokens generated by encrypting [directly identifying information (DII)](../ref-info/glossary-uid.md#gl-dii) (an email address or phone number) directly into a UID2 token. @@ -21,49 +21,49 @@ Data in the bidstream can be accessed by unauthorized parties, so it is never ac ::: Additional information for publishers is on the following pages: -- [UID2 Overview for Publishers](../overviews/overview-publishers.md) -- [UID2 Portal: Overview](../portal/portal-overview.md) +- [UID2 overview for publishers](../overviews/overview-publishers.md) +- [UID2 portal: Overview](../portal/portal-overview.md) ### Audience Tokenized sharing in the bidstream is applicable to the following audiences: - **Sender**: Publisher. Account Setup in the UID2 Portal is optional. -- **Receiver**: DSP. See [Information for Sharing Receivers](#information-for-sharing-receivers). +- **Receiver**: DSP. See [Information for sharing receivers](#information-for-sharing-receivers). -### Implementation Options for Senders +### Implementation options for senders 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 | | :--- | :--- | :--- | -| Prebid.js | Client-Side | [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) | -| Prebid.js | Server-Side | [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) | -| JavaScript SDK | Client-Side | [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) | -| JavaScript SDK | Server-Side | [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) | -| Java SDK | Server-Side | [SDK for Java Reference Guide](../sdks/sdk-ref-java.md) | -| Python SDK | Server-Side | [SDK for Python Reference Guide](../sdks/sdk-ref-python.md) | -| UID2 API (token generate and refresh) | Server-Side | [UID2 Endpoints Summary: UID2 Tokens](../endpoints/summary-endpoints.md#uid2-tokens) | +| Prebid.js | Client-Side | [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) | +| Prebid.js | Server-Side | [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) | +| JavaScript SDK | Client-Side | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | +| JavaScript SDK | Server-Side | [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) | +| Java SDK | Server-Side | [SDK for Java reference guide](../sdks/sdk-ref-java.md) | +| Python SDK | Server-Side | [SDK for Python reference guide](../sdks/sdk-ref-python.md) | +| UID2 API (token generate and refresh) | Server-Side | [UID2 endpoints summary: UID2 tokens](../endpoints/summary-endpoints.md#uid2-tokens) | These options support generating UID2 tokens from email addresses or phone numbers and also refreshing the tokens regularly. Other SDKs do not support token generate and token refresh at this time. :::tip -For a complete SDK summary, see [SDK Functionality](../sdks/summary-sdks.md#sdk-functionality). For a complete summary of integration approaches for publishers, see [Publisher Integrations](../guides/summary-guides.md#publisher-integrations). +For a complete SDK summary, see [SDK functionality](../sdks/summary-sdks.md#sdk-functionality). For a complete summary of integration approaches for publishers, see [Publisher integrations](../guides/summary-guides.md#publisher-integrations). ::: -### Decryption Options for Receivers +### Decryption options for receivers The following approaches are available for decrypting UID2 tokens. | 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) | - | Tokenized sharing in the bidstream from DII | [DSP Integration Guide](../guides/dsp-guide.md) | - | Tokenized sharing in tracking pixels from DII | [Workflow: Tokenized Sharing in Tracking Pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-tracking-pixels) | - | Tokenized sharing in creative pixels from raw UID2s | [Workflow: Tokenized Sharing in Creative Pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-creative-pixels) | + | 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) | + | Tokenized sharing in the bidstream from DII | [DSP integration guide](../guides/dsp-guide.md) | + | Tokenized sharing in tracking pixels from DII | [Workflow: Tokenized sharing in tracking pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-tracking-pixels) | + | Tokenized sharing in creative pixels from raw UID2s | [Workflow: Tokenized sharing in creative pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-creative-pixels) | -### Account Setup in the UID2 Portal +### Account setup in the UID2 portal For sharing in the bidstream, the sender does not need a UID2 Portal account. We automatically set up any publisher to share with all DSPs. However, if you are a publisher and want to limit your sharing scope, you can request a UID2 Portal account and set up sharing permissions. For example, you might want to share with a limited audience of one or more sharing partners for security or other reasons. @@ -71,18 +71,18 @@ All sharing receivers must set up an account in the UID2 Portal. The sender only needs to set up sharing permission once for each receiver or participant type. However, if you want to add new sharing permissions or change existing ones, you'll need to go back to adjust your settings. -For details, see [UID2 Portal: Overview](../portal/portal-overview.md) and follow the links for each task. +For details, see [UID2 portal: Overview](../portal/portal-overview.md) and follow the links for each task. -### Workflow: Tokenized Sharing in the Bidstream +### Workflow: Tokenized sharing in the bidstream The workflow for generating UID2 tokens from DII, via the API or the specified server-side SDKs, consists of the following steps: 1. Set up integration with UID2: - - Publisher: Use one of the integration options listed in [Implementation Options for Senders](#implementation-options-for-senders). + - Publisher: Use one of the integration options listed in [Implementation options for senders](#implementation-options-for-senders). - Optional to restrict which DSPs can decrypt your UID2 tokens: Set up sharing permissions in the UID2 Portal. See [Account Setup in the UID2 Portal](#account-setup-in-the-uid2-portal). - - DSP: Use one of the integration options listed in [Decryption Options for Receivers](#decryption-options-for-receivers). + Optional to restrict which DSPs can decrypt your UID2 tokens: Set up sharing permissions in the UID2 Portal. See [Account setup in the UID2 portal](#account-setup-in-the-uid2-portal). + - DSP: Use one of the integration options listed in [Decryption options for receivers](#decryption-options-for-receivers). 1. The publisher completes the following steps to create and send the UID2 tokens: @@ -93,13 +93,13 @@ The workflow for generating UID2 tokens from DII, via the API or the specified s 1. Receives the UID2 tokens. 1. Decrypts the UID2 tokens into raw UID2s. - 1. Checks that the UID2s are not opted out. For details, see [Honor User Opt-Outs](../guides/dsp-guide.md#honor-user-opt-outs). If they are not opted out, uses the raw UID2s for bidding. + 1. Checks that the UID2s are not opted out. For details, see [Honor user opt-outs](../guides/dsp-guide.md#honor-user-opt-outs). If they are not opted out, uses the raw UID2s for bidding. The following diagram illustrates the UID2 sharing workflow for publishers. -![UID2 Sharing Permission Integration Workflow for publishers](images/UID2_Sharing_Diagram_Integrate_SDK_Bid_Stream.png) +![UID2 sharing permission integration workflow for publishers](images/UID2_Sharing_Diagram_Integrate_SDK_Bid_Stream.png) -### Token Example for Publishers in the Bidstream +### Token example for publishers in the bidstream Publishers convert the input email address or phone number directly to a UID2 token for use in the bidstream, as shown in the following example. @@ -134,17 +134,17 @@ Publishers convert the input email address or phone number directly to a UID2 to -## Information for Sharing Receivers +## Information for sharing receivers To be able to decrypt a UID2 token into a raw UID2, you must be an authorized sharer and have the sender's cryptographic keys. By default, for publishers sending UID2 tokens to the bidstream, the publisher's cryptographic keys are shared with all authorized DSPs. However, if a publisher has set up specific sharing relationships, you'll only receive that publisher's cryptographic keys if the publisher has created a sharing relationship with you. -For details, see [Receiving UID2 Tokens from Another Sharing Participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant). +For details, see [Receiving UID2 tokens from another sharing participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant). It's important to set up a regular cadence for refreshing cryptographic keys, and to decrypt UID2 tokens promptly. For details, see the following sections in *UID2 Sharing: Best Practices*: -- [Decryption Key Refresh Cadence for Sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) -- [Best Practices for Managing Raw UID2s and UID2 Tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) +- [Decryption key refresh cadence for sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) +- [Best practices for managing raw UID2s and UID2 tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) diff --git a/docs/sharing/sharing-tokenized-from-data-pixel.md b/docs/sharing/sharing-tokenized-from-data-pixel.md index abc843c43..3dfc1687d 100644 --- a/docs/sharing/sharing-tokenized-from-data-pixel.md +++ b/docs/sharing/sharing-tokenized-from-data-pixel.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Tokenized Sharing in Pixels +# Tokenized sharing in pixels UID2 data shared in pixels must be in the form of UID2 tokens generated in one of these two ways: @@ -26,9 +26,9 @@ Data in pixels can be accessed by unauthorized parties, so it is never acceptabl Tokenized sharing in pixels is applicable to the following audiences: - **Sender**: Most commonly an advertiser or data provider, but can be any authorized sharing participant. -- **Receiver**: Any authorized sharing participant. See [Information for Sharing Receivers](#information-for-sharing-receivers). +- **Receiver**: Any authorized sharing participant. See [Information for sharing receivers](#information-for-sharing-receivers). -## Sharing UID2 Tokens in Pixels +## Sharing UID2 tokens in pixels Different participants might use pixels in different ways. The following table shows two common use cases for pixels in the advertising technology ecosystem. @@ -41,26 +41,26 @@ Different participants might use pixels in different ways. The following table s There are two scenarios: -- [Tokenized Sharing in Tracking Pixels](#workflow-tokenized-sharing-in-tracking-pixels) -- [Tokenized Sharing in Creative Pixels](#workflow-tokenized-sharing-in-creative-pixels) +- [Tokenized sharing in tracking pixels](#workflow-tokenized-sharing-in-tracking-pixels) +- [Tokenized sharing in creative pixels](#workflow-tokenized-sharing-in-creative-pixels) -## Account Setup in the UID2 Portal +## Account setup in the UID2 portal In the UID2 Portal, the sender and the receiver must set up an account and the sender must configure sharing permissions. The sender only needs to set up sharing permission once for each receiver or participant type. However, if you want to add new sharing permissions or change existing ones, you'll need to go back to adjust your settings. -For details, see [UID2 Portal: Overview](../portal/portal-overview.md) and follow the links for each task. +For details, see [UID2 portal: Overview](../portal/portal-overview.md) and follow the links for each task. -## Workflow: Tokenized Sharing in Tracking Pixels +## Workflow: Tokenized sharing in tracking pixels :::tip -If you're generating a token for a tracking pixel, we recommend generating the UID2 token directly from DII, not from a raw UID2. You can do this in several ways; our recommendation is to generate the UID2 token client-side. For instructions, see [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md). +If you're generating a token for a tracking pixel, we recommend generating the UID2 token directly from DII, not from a raw UID2. You can do this in several ways; our recommendation is to generate the UID2 token client-side. For instructions, see [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md). ::: If you're using tracking pixels that fire when someone completes an action such as purchasing a product on a website, it's most likely that you'll start with DII and then convert it to a UID2 token, for tokenized sharing. -The UID2 sender specifies which receivers can decrypt their UID2 tokens, by configuring permissions in the UID2 Portal (see [Sharing Permissions](../portal/sharing-permissions.md)). When a sender grants permission to a receiver for UID2 sharing, the sender's cryptographic keys are shared with the receiver via a UID2 SDK or Snowflake. As part of sharing, the UID2 SDKs and APIs take care of the encryption and decryption. +The UID2 sender specifies which receivers can decrypt their UID2 tokens, by configuring permissions in the UID2 Portal (see [Sharing permissions](../portal/sharing-permissions.md)). When a sender grants permission to a receiver for UID2 sharing, the sender's cryptographic keys are shared with the receiver via a UID2 SDK or Snowflake. As part of sharing, the UID2 SDKs and APIs take care of the encryption and decryption. For example, let's say that an advertiser (sender) wants to share UID2 tokens with a trusted sharing participant who is a UID2 DSP, for conversion tracking via a tracking pixel. Using sharing, here's the sequence: @@ -70,31 +70,31 @@ For example, let's say that an advertiser (sender) wants to share UID2 tokens wi 2. Directly generates UID2 tokens from the [DII](../ref-info/glossary-uid.md#gl-dii) provided by the user using the [POST /token/generate](../endpoints/post-token-generate.md) endpoint or one of the SDKs that support generating a UID2 token from DII. - For a summary of options, see [SDK Functionality](../sdks/summary-sdks.md#sdk-functionality). We recommend using the [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md). + For a summary of options, see [SDK functionality](../sdks/summary-sdks.md#sdk-functionality). We recommend using the [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md). 3. Sends the UID2 tokens securely to the DSP. 2. The DSP, who is also taking part in sharing, is the receiver. The DSP has access to the advertiser's cryptographic keys, through the UID2 Portal sharing permissions setup, and can therefore decrypt the UID2 tokens into raw UID2s for segment creation. -Both the UID2 sender and receiver must create a UID2 Portal account (see [Account Setup in the UID2 Portal](#account-setup-in-the-uid2-portal)) in order to take part in sharing. Without an account, a UID2 participant is not displayed in the list of sharing participants in the UID2 Portal, and cannot receive the sender's cryptographic keys for decryption. +Both the UID2 sender and receiver must create a UID2 Portal account (see [Account setup in the UID2 portal](#account-setup-in-the-uid2-portal)) in order to take part in sharing. Without an account, a UID2 participant is not displayed in the list of sharing participants in the UID2 Portal, and cannot receive the sender's cryptographic keys for decryption. -## Workflow: Tokenized Sharing in Creative Pixels +## Workflow: Tokenized sharing in creative pixels If you're using creative pixels, the DSP takes the raw UID2 and encrypts it into a UID2 token. The token is added into the creative pixel that is fired on impression. All the implementation steps are the same as for [tokenized sharing from raw UID2](sharing-tokenized-from-raw.md). -For examples of how you could implement tokenized sharing in pixels using Snowflake, see [Snowflake Integration Guide: Usage for UID2 Sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers). +For examples of how you could implement tokenized sharing in pixels using Snowflake, see [Snowflake integration guide: Usage for UID2 sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers). -## Information for Sharing Receivers +## Information for sharing receivers To be able to decrypt a UID2 token into a raw UID2, you must have a UID2 Portal account and the sender must create a sharing relationship with you. -For details, see [Receiving UID2 Tokens from Another Sharing Participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant). +For details, see [Receiving UID2 tokens from another sharing participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant). It's important to set up a regular cadence for refreshing cryptographic keys, and to decrypt UID2 tokens promptly. For details, see the following sections in *UID2 Sharing: Best Practices*: -- [Decryption Key Refresh Cadence for Sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) -- [Best Practices for Managing Raw UID2s and UID2 Tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) +- [Decryption key refresh cadence for sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) +- [Best practices for managing raw UID2s and UID2 tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) diff --git a/docs/sharing/sharing-tokenized-from-raw.md b/docs/sharing/sharing-tokenized-from-raw.md index af312ec58..eccbdec15 100644 --- a/docs/sharing/sharing-tokenized-from-raw.md +++ b/docs/sharing/sharing-tokenized-from-raw.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Tokenized Sharing from Raw UID2s +# Tokenized sharing from raw UID2s In some cases, sharing participants might have raw UID2s and want to encrypt them before sending to another sharing participant. One example is for advertisers sharing UID2s in creative pixels. @@ -22,31 +22,31 @@ To share raw UID2s with another participant by encrypting into UID2 tokens befor The sharing receiver must create a UID2 Portal account and implement sharing, and must have a sharing relationship with the sender, so that the receiver has the cryptographic keys necessary to decrypt the UID2 tokens into raw UID2s. -## Account Setup in the UID2 Portal +## Account setup in the UID2 portal In the UID2 Portal, the sender and the receiver must set up an account and the sender must configure sharing permissions. The sender only needs to set up sharing permission once for each receiver or participant type. However, if you want to add new sharing permissions or change existing ones, you'll need to go back to adjust your settings. -For details, see [UID2 Portal: Overview](../portal/portal-overview.md) and follow the links for each task. +For details, see [UID2 portal: Overview](../portal/portal-overview.md) and follow the links for each task. -## Tokenized Sharing Steps: Summary +## Tokenized sharing steps: Summary At a very high level, the following are the steps to set up and configure tokenized sharing from raw UID2s: -1. All users must set up an account and configure sharing options. See [Account Setup in the UID2 Portal](#account-setup-in-the-uid2-portal). +1. All users must set up an account and configure sharing options. See [Account setup in the UID2 portal](#account-setup-in-the-uid2-portal). 2. To implement sharing in your code, choose from the following, depending on the integration option you're using: - - [Implementing Sharing Encryption/Decryption with an SDK](#implementing-sharing-encryptiondecryption-with-an-sdk) - - [Implementing Sharing Encryption/Decryption Using Snowflake](#implementing-sharing-encryptiondecryption-using-snowflake) + - [Implementing sharing encryption/decryption with an SDK](#implementing-sharing-encryptiondecryption-with-an-sdk) + - [Implementing sharing encryption/decryption using Snowflake](#implementing-sharing-encryptiondecryption-using-snowflake) -## Workflow: Tokenized Sharing from Raw UID2 +## Workflow: Tokenized sharing from raw UID2 The workflow for tokenized sharing by generating UID2 tokens from raw UID2s consists of the following steps. :::note -Both sender and receiver must have a UID2 Portal account. See [Request an Account](../portal/portal-getting-started.md#request-an-account). +Both sender and receiver must have a UID2 Portal account. See [Request an account](../portal/portal-getting-started.md#request-an-account). ::: 1. Sender and receiver: Integrate with UID2 sharing, using a [UID2 SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) or [Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake). @@ -54,7 +54,7 @@ Both sender and receiver must have a UID2 Portal account. See [Request an Accoun 1. Sender: Approve sharing permissions in the UID2 Portal: 1. Define which sharing participants you want to allow to decrypt your UID2 tokens. - 1. Log in to the UID2 Portal, go to the [Sharing Permissions](../portal/sharing-permissions.md) page, and specify the participants that you want to share with. If needed, use the search feature to find specific sharing participants. + 1. Log in to the UID2 Portal, go to the [Sharing permissions](../portal/sharing-permissions.md) page, and specify the participants that you want to share with. If needed, use the search feature to find specific sharing participants. 1. Save the sharing selection. 1. Sender: Encrypt raw UID2s to convert them into UID2 tokens, using a [UID2 SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) or [Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake). @@ -64,13 +64,13 @@ Both sender and receiver must have a UID2 Portal account. See [Request an Accoun 1. Receiver: Complete the following steps to decrypt the UID2 tokens: 1. Securely receive the UID2 tokens. - 1. Decrypt the UID2 tokens into raw UID2s that you can use: see [Implementing Sharing Encryption/Decryption with an SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) or [Implementing Sharing Encryption/Decryption Using Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake). + 1. Decrypt the UID2 tokens into raw UID2s that you can use: see [Implementing sharing encryption/decryption with an SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) or [Implementing sharing encryption/decryption using Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake). The following diagram illustrates the UID2 sharing permission SDK integration workflow: -![UID2 Sharing Permission SDK Integration Workflow](images/UID2_Sharing_Diagram_Integrate_SDK_Sharing_Token.png) +![UID2 sharing permission SDK integration workflow](images/UID2_Sharing_Diagram_Integrate_SDK_Sharing_Token.png) -## Implementing Sharing Encryption/Decryption with an SDK +## Implementing sharing encryption/decryption with an SDK The following steps are for all sharing participants who are using an SDK to encrypt raw UID2s into UID2 tokens or decrypt back to raw UID2s—senders and receivers. @@ -78,35 +78,35 @@ The following steps are for all sharing participants who are using an SDK to enc | 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) | - | Java | [SDK for Java: Usage for UID2 Sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) | - | Python | [SDK for Python: Usage for UID2 Sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) | + | 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) | + | Java | [SDK for Java: Usage for UID2 sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) | + | Python | [SDK for Python: Usage for UID2 sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) | 2. Integrate the SDK into your code to implement each step, depending on whether your role is sender or receiver. To see code examples for the language you're using, follow the link in the table provided in Step 1. 1. Both senders and receivers: define the UID2 client. 2. Both senders and receivers: define the schedule for refreshing cryptographic keys. - Recommended refresh interval is hourly. For an example, see [Decryption Key Refresh Cadence for Sharing (SDK Only)](#decryption-key-refresh-cadence-for-sharing-sdk-only). + Recommended refresh interval is hourly. For an example, see [Decryption key refresh cadence for sharing (SDK only)](#decryption-key-refresh-cadence-for-sharing-sdk-only). 3. Senders, set up encryption. 4. Receivers, set up decryption. -### Decryption Key Refresh Cadence for Sharing (SDK Only) +### Decryption key refresh cadence for sharing (SDK only) If you're using an SDK, defining the schedule for refreshing the sharing keys is part of step 2. For long/continuously running processes, we recommend calling the `uid2client.refresh()` function once per hour. -For details, see [Decryption Key Refresh Cadence for Sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) in *UID2 Sharing: Best Practices*. +For details, see [Decryption key refresh cadence for sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) in *UID2 Sharing: Best Practices*. :::note If you're using Snowflake, you don't need to do this step. The Snowflake UID2 integration takes care of refreshing the keys. ::: -### Decryption Key Refresh Example +### Decryption key refresh example This example illustrates how the `uid2client.refresh()` function enables a new sharing permission. In this example, Advertiser ABC wants to send data to Data Provider XYZ. @@ -116,26 +116,26 @@ This example illustrates how the `uid2client.refresh()` function enables a new s | 12:30 pm | Advertiser ABC logs in to the UID2 Portal and creates a sharing permission with Data Provider XYZ. | | 1:00 pm | Data Provider XYZ, on an hourly cadence, again calls `uid2client.refresh()`. Because there is a new sharing permission, the key for Advertiser ABC is returned in the response.
Data Provider XYZ can now decrypt any UID2 token received from Advertiser ABC into a raw UID2. | -## Implementing Sharing Encryption/Decryption Using Snowflake +## Implementing sharing encryption/decryption using Snowflake The following steps are for Snowflake users who want to take part in UID2 sharing, either as senders or receivers. -1. Review the examples in [Snowflake Integration Guide: Usage for UID2 Sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) to see what the sharing code might look like. +1. Review the examples in [Snowflake integration guide: Usage for UID2 sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) to see what the sharing code might look like. -2. Integrate Snowflake into your code, according to whether your role is sender or receiver. Use the code examples in the documentation referenced in the Snowflake Integration Guide, [UID2 Sharing Example](../guides/integration-snowflake.md#uid2-sharing-example): +2. Integrate Snowflake into your code, according to whether your role is sender or receiver. Use the code examples in the documentation referenced in the Snowflake Integration Guide, [UID2 sharing example](../guides/integration-snowflake.md#uid2-sharing-example): - Senders, set up encryption. - Receivers, set up decryption. -## Information for Sharing Receivers +## Information for sharing receivers To be able to decrypt a UID2 token into a raw UID2, you must have a UID2 Portal account and the sender must create a sharing relationship with you. -For details, see [Receiving UID2 Tokens from Another Sharing Participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant). +For details, see [Receiving UID2 tokens from another sharing participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant). It's important to set up a regular cadence for refreshing decryption keys, and to decrypt UID2 tokens promptly. For details, see the following sections in *UID2 Sharing: Best Practices*: -- [Decryption Key Refresh Cadence for Sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) -- [Best Practices for Managing Raw UID2s and UID2 Tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) +- [Decryption key refresh cadence for sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) +- [Best practices for managing raw UID2s and UID2 tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) diff --git a/docs/sharing/sharing-tokenized-overview.md b/docs/sharing/sharing-tokenized-overview.md index b6581991c..89171d4e8 100644 --- a/docs/sharing/sharing-tokenized-overview.md +++ b/docs/sharing/sharing-tokenized-overview.md @@ -8,27 +8,27 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Tokenized Sharing Overview +# Tokenized sharing overview In UID2, tokenized sharing means encrypting DII or raw UID2s into UID2 tokens and sharing the tokens with recipients who are authorized [sharing participants](ref-info/glossary-uid.md#gl-sharing-participant). Using UID2 tokens helps protect raw UID2s end-to-end between the sender and receiver of the data, including when the data passes through unauthorized parties. Tokenized sharing is required for sharing in the bidstream or via pixels, but you can use it in any sharing use case. Tokens are generated in one of the following ways: -- By encrypting raw UID2s into UID2 tokens: see [Tokenized Sharing: Starting with a Raw UID2](#tokenized-sharing-starting-with-a-raw-uid2). -- By generating UID2 tokens directly from DII: see [Tokenized Sharing: Starting with DII](#tokenized-sharing-starting-with-dii). +- By encrypting raw UID2s into UID2 tokens: see [Tokenized sharing: Starting with a raw UID2](#tokenized-sharing-starting-with-a-raw-uid2). +- By generating UID2 tokens directly from DII: see [Tokenized sharing: Starting with DII](#tokenized-sharing-starting-with-dii). -## Tokenized Sharing Scenarios +## Tokenized sharing scenarios 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 | | :--- | :--- | :--- | :--- | -| 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) | -| Sending UID2 tokens to another sharing participant | Any sharing participant, if all security requirements listed in [Security Requirements for UID2 Sharing](sharing-security.md) cannot be followed, or for any other reason. | Any sharing participant | See [Tokenized Sharing from Raw UID2s](sharing-tokenized-from-raw.md) | +| 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) | +| Sending UID2 tokens to another sharing participant | Any sharing participant, if all security requirements listed in [Security requirements for UID2 sharing](sharing-security.md) cannot be followed, or for any other reason. | Any sharing participant | See [Tokenized sharing from raw UID2s](sharing-tokenized-from-raw.md) | -For additional examples, see [Sharing UID2s: Use Cases](sharing-use-cases.md). +For additional examples, see [Sharing UID2s: Use cases](sharing-use-cases.md). -## Sending UID2 Tokens to Another Sharing Participant +## Sending UID2 tokens to another sharing participant Sharing UID2s with another sharing participant via UID2 tokens is an option in any sharing scenario, but is required within the bidstream or in pixels. The process is a little different depending on the starting point, as shown in the following table. @@ -36,41 +36,41 @@ Choose the integration option that's right for your implementation, and then cli | Starting Point | Encryption Option/Scenario | Link to Details | | :--- | :--- | :--- | -| DII | Sharing UID2 tokens from DII in the bidstream | [Tokenized Sharing in the Bidstream](sharing-tokenized-from-data-bid-stream.md) | -| DII | Sharing UID2 tokens from DII in tracking pixels | [Workflow: Tokenized Sharing in Tracking Pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-tracking-pixels) | -| Raw UID2 | Sharing UID2 tokens from raw UID2s in creative pixels | [Workflow: Tokenized Sharing in Creative Pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-creative-pixels) | -| Raw UID2 | Sharing UID2 tokens from raw UID2s using an SDK | [Implementing Sharing Encryption/Decryption with an SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) | -| Raw UID2 | Sharing UID2 tokens from raw UID2s using Snowflake | [Implementing Sharing Encryption/Decryption Using Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake) | +| DII | Sharing UID2 tokens from DII in the bidstream | [Tokenized sharing in the bidstream](sharing-tokenized-from-data-bid-stream.md) | +| DII | Sharing UID2 tokens from DII in tracking pixels | [Workflow: Tokenized sharing in tracking pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-tracking-pixels) | +| Raw UID2 | Sharing UID2 tokens from raw UID2s in creative pixels | [Workflow: Tokenized sharing in creative pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-creative-pixels) | +| Raw UID2 | Sharing UID2 tokens from raw UID2s using an SDK | [Implementing sharing encryption/decryption with an SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) | +| Raw UID2 | Sharing UID2 tokens from raw UID2s using Snowflake | [Implementing sharing encryption/decryption using Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake) | -## Receiving UID2 Tokens from Another Sharing Participant +## Receiving UID2 tokens from another sharing participant The steps that the receiver takes are similar for all approved sharing scenarios. The receiver must decrypt the UID2 token to arrive at the raw UID2. To do this, the receiver must have a UID2 Portal account and the sender must create a sharing relationship with the receiver in the UID2 Portal, so that the receiver can access the sender's decryption keys. :::tip -We recommend decrypting the tokens as soon as possible after receiving them, to avoid token expiration. See [Best Practices for Managing Raw UID2s and UID2 Tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens). +We recommend decrypting the tokens as soon as possible after receiving them, to avoid token expiration. See [Best practices for managing raw UID2s and UID2 tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens). ::: The following implementation options are available for decrypting UID2 tokens. | Starting Point | Decryption Option/Scenario | Link to Details | | :--- | :--- | :--- | -| Token | C# / .NET SDK | [SDK for C# / .NET: Usage for UID2 Sharers](../sdks/sdk-ref-csharp-dotnet.md#usage-for-uid2-sharers) | -| Token | C++ SDK | [SDK for C++: Usage for UID2 Sharers](../sdks/sdk-ref-cplusplus.md#usage-for-uid2-sharers) | -| Token | Java SDK | [SDK for Java: Usage for UID2 Sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) | -| Token | Python SDK | [SDK for Python: Usage for UID2 Sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) | -| Token | Snowflake | [Snowflake Integration Guide: Usage for UID2 Sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) -| Token | Decryption of UID2 tokens sent in the bidstream (DSPs only) | [DSP Integration Guide: Decrypt UID2 Tokens for RTB Use](../guides/dsp-guide#decrypt-uid2-tokens-for-rtb-use) +| Token | C# / .NET SDK | [SDK for C# / .NET: Usage for UID2 sharers](../sdks/sdk-ref-csharp-dotnet.md#usage-for-uid2-sharers) | +| Token | C++ SDK | [SDK for C++: Usage for UID2 sharers](../sdks/sdk-ref-cplusplus.md#usage-for-uid2-sharers) | +| Token | Java SDK | [SDK for Java: Usage for UID2 sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) | +| Token | Python SDK | [SDK for Python: Usage for UID2 sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) | +| Token | Snowflake | [Snowflake integration guide: Usage for UID2 sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) +| Token | Decryption of UID2 tokens sent in the bidstream (DSPs only) | [DSP integration guide: Decrypt UID2 tokens for RTB use](../guides/dsp-guide#decrypt-uid2-tokens-for-rtb-use) -## Tokenized Sharing Examples +## Tokenized sharing examples The steps for tokenized sharing depend on whether you're starting with DII or with a raw UID2. This section includes the following: -- [Tokenized Sharing: Starting with DII](#tokenized-sharing-starting-with-dii) -- [Example: DII to UID2 Token](#example-dii-to-uid2-token) -- [Tokenized Sharing: Starting with a Raw UID2](#tokenized-sharing-starting-with-a-raw-uid2) -- [Example: Raw UID2 to UID2 Token](#example-raw-uid2-to-uid2-token) +- [Tokenized sharing: Starting with DII](#tokenized-sharing-starting-with-dii) +- [Example: DII to UID2 token](#example-dii-to-uid2-token) +- [Tokenized sharing: Starting with a raw UID2](#tokenized-sharing-starting-with-a-raw-uid2) +- [Example: Raw UID2 to UID2 token](#example-raw-uid2-to-uid2-token) -### Tokenized Sharing: Starting with DII +### Tokenized sharing: Starting with DII Starting with DII is most common for publishers [sharing in the bidstream](sharing-tokenized-from-data-bid-stream.md) and for [sharing in tracking pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-tracking-pixels). @@ -82,11 +82,11 @@ If you're starting with DII, generate the UID2 token by following either of thes 1. Convert the input email address or phone number to a raw UID2, which you can store securely. - 2. Encrypt the raw UID2 to create a UID2 token that you can share with another trusted UID2 sharing participant. For an example, see [Example: Raw UID2 to UID2 Token](#example-raw-uid2-to-uid2-token). + 2. Encrypt the raw UID2 to create a UID2 token that you can share with another trusted UID2 sharing participant. For an example, see [Example: Raw UID2 to UID2 token](#example-raw-uid2-to-uid2-token). Then, share the resulting UID2 token with another trusted UID2 sharing participant. -### Example: DII to UID2 Token +### Example: DII to UID2 token The following example shows sample values when converting input DII directly to a UID2 token. @@ -120,22 +120,22 @@ The following example shows sample values when converting input DII directly to -### Tokenized Sharing: Starting with a Raw UID2 +### Tokenized sharing: Starting with a raw UID2 Setting up tokenized sharing to encrypt raw UID2s requires some steps by each participant: - The **sender**, who encrypts the raw UID2 to create UID2 tokens and sends the tokens to an authorized sharing participant. - The **receiver**, an authorized sharing participant who receives the UID2 tokens and decrypts them. -Tokenized sharing starting with a raw UID2 is common for [sharing in creative pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-creative-pixels). It can also be used in other scenarios. For details, see [Tokenized Sharing from Raw UID2s](sharing-tokenized-from-raw.md). +Tokenized sharing starting with a raw UID2 is common for [sharing in creative pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-creative-pixels). It can also be used in other scenarios. For details, see [Tokenized sharing from raw UID2s](sharing-tokenized-from-raw.md). If you're starting with a raw UID2, follow these steps: -1. Encrypt the raw UID2, using one of the UID2 server-side SDKs or the UID2 Snowflake integration, to create a UID2 token that you can share with another trusted UID2 sharing participant. For an example, see [Example: Raw UID2 to UID2 Token](#example-raw-uid2-to-uid2-token). +1. Encrypt the raw UID2, using one of the UID2 server-side SDKs or the UID2 Snowflake integration, to create a UID2 token that you can share with another trusted UID2 sharing participant. For an example, see [Example: Raw UID2 to UID2 token](#example-raw-uid2-to-uid2-token). 2. Share the resulting UID2 token with another trusted UID2 sharing participant. -### Example: Raw UID2 to UID2 Token +### Example: Raw UID2 to UID2 token The following example shows sample values when converting input DII to a raw UID2 and then encrypting the raw UID2 to create a UID2 token. @@ -180,7 +180,7 @@ The following example shows sample values when converting input DII to a raw UID -## UID2 Token Pass-Through +## UID2 token pass-through The UID2 token is designed so that even if the underlying raw UID2 remains the same, each time a UID2 token is generated from it, the token value is different. This means that the UID2 token can be seen by all but can only be used by UID2 participants that have access to the decryption key. diff --git a/docs/sharing/sharing-use-cases.md b/docs/sharing/sharing-use-cases.md index 305ef397b..6eba5fd65 100644 --- a/docs/sharing/sharing-use-cases.md +++ b/docs/sharing/sharing-use-cases.md @@ -8,19 +8,19 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Sharing UID2s: Use Cases +# Sharing UID2s: Use cases The secure sharing workflow allows you to share UID2s with trusted participants in many different ways. Depending on the route, you might send either raw UID2s or UID2 tokens. For example, here are some scenarios where a sender wants to share raw UID2s or UID2 tokens with a receiver: - Tokenized sharing (sharing a UID2 token) examples: - - A publisher (sender) sends a UID2 token via the bidstream to a DSP (receiver) (see [Tokenized Sharing in the Bidstream](sharing-tokenized-from-data-bid-stream.md)). - - An advertiser (sender) sends a UID2 token to a data provider (receiver) via a tracking pixel (see [Tokenized Sharing in Pixels](sharing-tokenized-from-data-pixel.md)). + - A publisher (sender) sends a UID2 token via the bidstream to a DSP (receiver) (see [Tokenized sharing in the bidstream](sharing-tokenized-from-data-bid-stream.md)). + - An advertiser (sender) sends a UID2 token to a data provider (receiver) via a tracking pixel (see [Tokenized sharing in pixels](sharing-tokenized-from-data-pixel.md)). - Raw UID2 sharing (sharing a raw UID2) examples: - - A measurement partner (sender) sends a raw UID2 to an advertiser (receiver) via Amazon Simple Storage Service (S3) (see [Raw UID2 Sharing](sharing-raw.md)). - - A DSP (sender) sends a raw UID2 to an advertiser (receiver) via reporting (see [Raw UID2 Sharing](sharing-raw.md)). + - A measurement partner (sender) sends a raw UID2 to an advertiser (receiver) via Amazon Simple Storage Service (S3) (see [Raw UID2 sharing](sharing-raw.md)). + - A DSP (sender) sends a raw UID2 to an advertiser (receiver) via reporting (see [Raw UID2 sharing](sharing-raw.md)). These scenarios, and others, are represented in the following diagram. -![Illustration of Sharing Use Cases](images/SharingSlide-Examples.png) +![Illustration of sharing use cases](images/SharingSlide-Examples.png) diff --git a/docs/snippets/_snpt-integrating-with-sso.mdx b/docs/snippets/_snpt-integrating-with-sso.mdx index 795b4d52f..53b91b45d 100644 --- a/docs/snippets/_snpt-integrating-with-sso.mdx +++ b/docs/snippets/_snpt-integrating-with-sso.mdx @@ -1,3 +1,3 @@ If you integrate with one or more SSO providers to offer SSO login, you might be able to retrieve the logged-in user's email address from the SSO provider to generate UID2 tokens. -For details, see [Publisher Integration with SSO Providers](/docs/ref-info/ref-integration-sso-providers). \ No newline at end of file +For details, see [Publisher integration with SSO providers](/docs/ref-info/ref-integration-sso-providers). \ No newline at end of file diff --git a/docs/snippets/_snpt-mobile-docs-error-response-states.mdx b/docs/snippets/_snpt-mobile-docs-error-response-states.mdx index c75e36907..8517a7b6e 100644 --- a/docs/snippets/_snpt-mobile-docs-error-response-states.mdx +++ b/docs/snippets/_snpt-mobile-docs-error-response-states.mdx @@ -3,15 +3,15 @@ In certain conditions, the mobile SDK might return one of the following error response states: - [Expired](#response-state-of-expired) -- [RefreshExpired](#response-state-of-refreshexpired) +- [Refreshexpired](#response-state-of-refreshexpired) - [Invalid](#response-state-of-expired) -- [NoIdentity](#response-state-of-expired) +- [Noidentity](#response-state-of-expired) :::note The response states are the same for both Android and iOS. ::: -### Response State of Expired +### Response state of expired A response state of `Expired` means that the UID2 token has expired but the refresh token has not expired, therefore the UID2 token can be refreshed. @@ -23,7 +23,7 @@ For example, if the app is launched and the SDK is immediately queried, you migh **Manual refresh**: If you've disabled automatic refreshing of the token, and get a response state of `Expired`, you can manually request the refresh by calling the `refreshIdentity()` method. -### Response State of RefreshExpired +### Response state of refreshexpired A response state of `RefreshExpired` means that the UID2 token and the refresh token have both expired, therefore the UID2 token cannot be refreshed. @@ -31,7 +31,7 @@ An example of how this could occur is if a user does not run your app for a long In this scenario, you'd need to regenerate the identity. -### Response State of Invalid +### Response state of invalid A response state of `Invalid` means that the identity, whether loaded off disk or requested via the API, did not include all the necessary tokens. This should never happen, but might occur in unexpected circumstances. @@ -39,7 +39,7 @@ If the SDK detects this error, it clears any previous identity since it's consid In this scenario, you'd need to regenerate the identity. Ideally, also report the issue to your UID2 contact. -### Response State of NoIdentity +### Response state of noidentity A response state of `NoIdentity` means that the SDK has been initialized, but doesn't yet have a current identity. diff --git a/docs/snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx b/docs/snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx index 27f0e530d..a73a6b6c9 100644 --- a/docs/snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx +++ b/docs/snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx @@ -3,10 +3,10 @@ import TabItem from '@theme/TabItem'; If you intend to generate UID2 tokens to send to the [Google GMA SDK](https://developers.google.com/ad-manager/mobile-ads-sdk) or the [Google IMA SDK](https://developers.google.com/interactive-media-ads/), assuming you have followed the instructions in this guide, you must also add the UID2 GMA/IMA plugins into your mobile app. For instructions, refer to the applicable plug-in guide: -- [UID2 GMA Plugin for Android Integration Guide](../guides/mobile-plugin-gma-android) -- [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios) -- [UID2 IMA Plugin for Android Integration Guide](../guides/mobile-plugin-ima-android) -- [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios) +- [UID2 GMA plugin for Android integration guide](../guides/mobile-plugin-gma-android) +- [UID2 GMA plugin for iOS integration guide](../guides/mobile-plugin-gma-ios) +- [UID2 IMA plugin for Android integration guide](../guides/mobile-plugin-ima-android) +- [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios) You do not need to explicitly make the `getAdvertisingToken()` method call to retrieve the advertising tokens and pass them into Google GMA/IMA SDK manually. The UID2 GMA/IMA plugins manage this for you. diff --git a/docs/snippets/_snpt-mobile_docs_prebid-mobile.mdx b/docs/snippets/_snpt-mobile_docs_prebid-mobile.mdx index 79aa4af9b..7ca1d1b2a 100644 --- a/docs/snippets/_snpt-mobile_docs_prebid-mobile.mdx +++ b/docs/snippets/_snpt-mobile_docs_prebid-mobile.mdx @@ -15,7 +15,7 @@ To configure your UID2 Prebid for Mobile integration, follow these steps: 1. Set up Prebid's Mobile SDK, following the steps in [Prebid SDK Integration for Android](https://docs.prebid.org/prebid-mobile/pbm-api/android/code-integration-android.html) or [Prebid SDK Integration for iOS](https://docs.prebid.org/prebid-mobile/pbm-api/ios/code-integration-ios.html). -2. Add the UID2 Mobile SDK to your app, following the steps in [Add the UID2 Mobile SDK to Your Mobile App](#add-the-uid2-mobile-sdk-to-your-mobile-app). +2. Add the UID2 Mobile SDK to your app, following the steps in [Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). 3. The UID2 Prebid integration is distributed as a separate module, so you must add it as a dependency in your project. Follow the installation instructions that apply to your integration, out of the following options: diff --git a/docs/snippets/_snpt-preparing-emails-and-phone-numbers.mdx b/docs/snippets/_snpt-preparing-emails-and-phone-numbers.mdx index 3321d5066..34b5aaf7e 100644 --- a/docs/snippets/_snpt-preparing-emails-and-phone-numbers.mdx +++ b/docs/snippets/_snpt-preparing-emails-and-phone-numbers.mdx @@ -1,7 +1,7 @@ import Link from '@docusaurus/Link'; -It's critical that the input data, which you are converting to UID2, is in an acceptable format. If it isn't, you won't get the expected results. For example, you must normalize phone numbers to include the country code, as explained in [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization). +It's critical that the input data, which you are converting to UID2, is in an acceptable format. If it isn't, you won't get the expected results. For example, you must normalize phone numbers to include the country code, as explained in [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization). -For details, see [Preparing Emails and Phone Numbers for Processing](../ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md). +For details, see [Preparing emails and phone numbers for processing](../ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md). To validate the full token generation pipeline end to end, confirming that tokens generated from your normalized, hashed, and encoded values are correct, use the [UID2 Token Validator](../ref-info/ref-token-validator.md). \ No newline at end of file diff --git a/docs/snippets/_snpt-private-operator-option.mdx b/docs/snippets/_snpt-private-operator-option.mdx index eaefeb90c..df0d8f284 100644 --- a/docs/snippets/_snpt-private-operator-option.mdx +++ b/docs/snippets/_snpt-private-operator-option.mdx @@ -5,7 +5,7 @@ If you're a publisher and want to keep your first-party data within your corpora For additional information, review these resources: - [The UID2 Operator](../ref-info/ref-operators-public-private.md) -- [UID2 Private Operator Integration Overview](../guides/integration-options-private-operator.md) +- [UID2 Private Operator integration overview](../guides/integration-options-private-operator.md) :::note The UID2 Private Operator solutions do not support client-side generation of the UID2 token. If you want a client-side implementation, you must use a Public Operator solution. diff --git a/docs/snippets/_snpt-publisher-implementation-resources.mdx b/docs/snippets/_snpt-publisher-implementation-resources.mdx index b8b73bef9..5b3c93c3d 100644 --- a/docs/snippets/_snpt-publisher-implementation-resources.mdx +++ b/docs/snippets/_snpt-publisher-implementation-resources.mdx @@ -2,71 +2,71 @@ import Link from '@docusaurus/Link'; The following resources are available for publishers to implement UID2: -- [Web Integrations](#web-integrations) -- [Mobile Integrations](#mobile-integrations) -- [CTV Integrations](#ctv-integrations) -- [Prebid Integrations](#prebid-integrations) -- [Google Ad Manager Integrations](#google-ad-manager-integrations) +- [Web integrations](#web-integrations) +- [Mobile integrations](#mobile-integrations) +- [CTV integrations](#ctv-integrations) +- [Prebid integrations](#prebid-integrations) +- [Google Ad Manager integrations](#google-ad-manager-integrations) -### Web Integrations +### Web integrations The following resources are available for publisher web integrations. :::tip -For a detailed summary of web integration options, see [Publisher Web Integration Overview](../guides/integration-options-publisher-web.md). +For a detailed summary of web integration options, see [Publisher web integration overview](../guides/integration-options-publisher-web.md). ::: | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| Prebid (Overview) | [UID2 Integration Overview for Prebid](../guides/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 or the Prebid Mobile SDK in the RTB bidstream. | -| Prebid.js Client-Side Integration | [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) | A guide for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach, and choose to have Prebid.js manage the following:
  • Token generation and token refresh.
  • Passing the tokens into the RTB bidstream.
| -| Prebid.js Client-Server Integration | [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) | A guide for publishers who want to integrate with UID2 and generate UID2 tokens to be passed by Prebid.js in the RTB bidstream, but want to generate tokens server-side: for example, publishers who are using a Private Operator. | -| JavaScript (Overview) | [UID2 Integration Overview for JavaScript](../guides/integration-javascript.md) | An overview of options for publishers who want to integrate with UID2 using the JavaScript SDK. | -| JavaScript Client-Side Integration | [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) | A guide for publishers who want to integrate with UID2 using only client-side JavaScript changes, which is the easiest implementation approach.
The SDK for JavaScript manages token generation and token refresh automatically. | -| JavaScript Client-Server Integration | [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) | A publisher guide covering standard web integration scenarios that use the SDK for JavaScript and require tokens to be generated on the server side and passed to the publisher web pages. | -| Server-Side Integration | [Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md) | A guide for publishers who do not use the [SDK for JavaScript](../sdks/sdk-ref-javascript.md). | -| Publisher/SSP Integration with GAM | [Google Ad Manager Secure Signals Integration Guide](../guides/integration-google-ss.md) | A guide covering the additional steps needed for publishers using UID2 with the Google Ad Manager Secure Signals feature (previously known as Encrypted Signals for Publishers, ESP). | +| Prebid (Overview) | [UID2 integration overview for Prebid](../guides/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 or the Prebid Mobile SDK in the RTB bidstream. | +| Prebid.js Client-Side Integration | [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) | A guide for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach, and choose to have Prebid.js manage the following:
  • Token generation and token refresh.
  • Passing the tokens into the RTB bidstream.
| +| Prebid.js Client-Server Integration | [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) | A guide for publishers who want to integrate with UID2 and generate UID2 tokens to be passed by Prebid.js in the RTB bidstream, but want to generate tokens server-side: for example, publishers who are using a Private Operator. | +| JavaScript (Overview) | [UID2 integration overview for JavaScript](../guides/integration-javascript.md) | An overview of options for publishers who want to integrate with UID2 using the JavaScript SDK. | +| JavaScript Client-Side Integration | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | A guide for publishers who want to integrate with UID2 using only client-side JavaScript changes, which is the easiest implementation approach.
The SDK for JavaScript manages token generation and token refresh automatically. | +| JavaScript Client-Server Integration | [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) | A publisher guide covering standard web integration scenarios that use the SDK for JavaScript and require tokens to be generated on the server side and passed to the publisher web pages. | +| Server-Side Integration | [Publisher integration guide, server-side](../guides/integration-publisher-server-side.md) | A guide for publishers who do not use the [SDK for JavaScript](../sdks/sdk-ref-javascript.md). | +| Publisher/SSP Integration with GAM | [Google Ad Manager Secure Signals integration guide](../guides/integration-google-ss.md) | A guide covering the additional steps needed for publishers using UID2 with the Google Ad Manager Secure Signals feature (previously known as Encrypted Signals for Publishers, ESP). | -### Mobile Integrations +### Mobile integrations The following resources are available for publisher integrations supporting Android or iOS devices. | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| Android/iOS (Overview) | [Mobile Integration Overview for Android and iOS](../guides/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. | -| Android/iOS, Client-Side Integration | [Client-Side Integration Guide for Mobile](../guides/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). | -| Android/iOS, Client-Server Integration | [Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md) | An integration guide for mobile app publishers who want to integrate with UID2 by doing the following:
  1. Generating UID2 tokens server-side via either a Public or Private Operator.
  2. Passing the resulting identities to a mobile app for passing into the bidstream.
| -| Android/iOS, Server-Side Integration | [Server-Side Integration Guide for Mobile](../guides/integration-mobile-server-side.md) | An integration guide for mobile app publishers who want to manage the UID2 token entirely on the server side. | -| Android | [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) |An SDK that facilitates the process of generating or establishing client identity using UID2 and retrieving UID2 tokens for publishers that need to support Android apps. | -| iOS | [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) | An SDK that facilitates the process of generating or establishing client identity using UID2 and retrieving UID2 tokens for publishers that need to support iOS apps. | +| Android/iOS (Overview) | [Mobile integration overview for Android and iOS](../guides/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. | +| Android/iOS, Client-Side Integration | [Client-side integration guide for mobile](../guides/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). | +| Android/iOS, Client-Server Integration | [Client-server integration guide for mobile](../guides/integration-mobile-client-server.md) | An integration guide for mobile app publishers who want to integrate with UID2 by doing the following:
  1. Generating UID2 tokens server-side via either a Public or Private Operator.
  2. Passing the resulting identities to a mobile app for passing into the bidstream.
| +| Android/iOS, Server-Side Integration | [Server-side integration guide for mobile](../guides/integration-mobile-server-side.md) | An integration guide for mobile app publishers who want to manage the UID2 token entirely on the server side. | +| Android | [SDK for Android reference guide](../sdks/sdk-ref-android.md) |An SDK that facilitates the process of generating or establishing client identity using UID2 and retrieving UID2 tokens for publishers that need to support Android apps. | +| iOS | [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) | An SDK that facilitates the process of generating or establishing client identity using UID2 and retrieving UID2 tokens for publishers that need to support iOS apps. | -### CTV Integrations +### CTV integrations The following resources are available for publisher integrations supporting CTV. | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| CTV | [CTV Integration Guide](../guides/integration-ctv-guide.md) | A summary of CTV integration options, with links to additional information and instructions. | +| CTV | [CTV integration guide](../guides/integration-ctv-guide.md) | A summary of CTV integration options, with links to additional information and instructions. | -### Prebid Integrations +### Prebid integrations The following resources are available for publishers integrating with Prebid. | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| Prebid (Overview) | [UID2 Integration Overview for Prebid](../guides/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 or the Prebid Mobile SDK in the RTB bidstream. | -| Prebid.js Client-Side Integration | [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) | A guide for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach, and choose to have Prebid.js manage the following:
  • Token generation and token refresh.
  • Passing the tokens into the RTB bidstream.
| -| Prebid.js Client-Server Integration | [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) | A guide for publishers who want to integrate with UID2 and generate UID2 tokens to be passed by Prebid.js in the RTB bidstream, but want to generate tokens server-side: for example, publishers who are using a Private Operator. | -| Prebid.js on Mobile | [UID2 Mobile Integration for Prebid.js](../guides/integration-prebid-mobile-summary.md) | A summary of information resources for UID2 integration with Prebid.js on mobile devices. | +| Prebid (Overview) | [UID2 integration overview for Prebid](../guides/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 or the Prebid Mobile SDK in the RTB bidstream. | +| Prebid.js Client-Side Integration | [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) | A guide for publishers who want to request UID2 tokens client-side, which is the easiest implementation approach, and choose to have Prebid.js manage the following:
  • Token generation and token refresh.
  • Passing the tokens into the RTB bidstream.
| +| Prebid.js Client-Server Integration | [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) | A guide for publishers who want to integrate with UID2 and generate UID2 tokens to be passed by Prebid.js in the RTB bidstream, but want to generate tokens server-side: for example, publishers who are using a Private Operator. | +| Prebid.js on Mobile | [UID2 mobile integration for Prebid.js](../guides/integration-prebid-mobile-summary.md) | A summary of information resources for UID2 integration with Prebid.js on mobile devices. | -### Google Ad Manager Integrations +### Google Ad Manager integrations The following resources are available for publishers integrating with Google Ad Manager. | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| Publisher/SSP Integration with GAM | [Google Ad Manager Secure Signals Integration Guide](../guides/integration-google-ss.md) | A guide covering 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 for Android | [UID2 GMA Plugin for Android Integration Guide](../guides/mobile-plugin-gma-android.md) | A guide that enables publishers using the Google Mobile Ads (GMA) SDK to include UID2 tokens in ad requests from their Android apps. | -| GMA for iOS | [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios.md) | A guide that enables publishers using the Google Mobile Ads (GMA) SDK to include UID2 tokens in ad requests from their iOS apps. | -| IMA for Android | [UID2 IMA Plugin for Android Integration Guide](../guides/mobile-plugin-ima-android.md) | A guide that enables publishers using the Google Interactive Media Ads (IMA) SDK to include UID2 tokens in ad requests from their Android apps. | -| IMA for iOS | [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios.md) | A guide that enables publishers using the Google Interactive Media Ads (IMA) SDK to include UID2 tokens in ad requests from their iOS apps. | \ No newline at end of file +| Publisher/SSP Integration with GAM | [Google Ad Manager Secure Signals integration guide](../guides/integration-google-ss.md) | A guide covering 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 for Android | [UID2 GMA plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | A guide that enables publishers using the Google Mobile Ads (GMA) SDK to include UID2 tokens in ad requests from their Android apps. | +| GMA for iOS | [UID2 GMA plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | A guide that enables publishers using the Google Mobile Ads (GMA) SDK to include UID2 tokens in ad requests from their iOS apps. | +| IMA for Android | [UID2 IMA plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | A guide that enables publishers using the Google Interactive Media Ads (IMA) SDK to include UID2 tokens in ad requests from their Android apps. | +| IMA for iOS | [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | A guide that enables publishers using the Google Interactive Media Ads (IMA) SDK to include UID2 tokens in ad requests from their iOS apps. | \ No newline at end of file diff --git a/docs/summary-doc-v2.md b/docs/summary-doc-v2.md index 3124b91ff..cbe994955 100644 --- a/docs/summary-doc-v2.md +++ b/docs/summary-doc-v2.md @@ -8,15 +8,15 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 API v2 Documentation +# UID2 API v2 documentation -For UID2 definitions, ID types, guiding principles, components, and other conceptual details, see [Unified ID 2.0 Overview](intro.md). For contact and license information, as well as normalization and hash encoding rules, see [Getting Started](/docs/category/getting-started). +For UID2 definitions, ID types, guiding principles, components, and other conceptual details, see [Unified ID 2.0 overview](intro.md). For contact and license information, as well as normalization and hash encoding rules, see [Getting started](/docs/category/getting-started). For details on using the API, see the following pages. | Documentation | Content Description | | :--- | :--- | -| [Encrypting Requests and Decrypting Responses](getting-started/gs-encryption-decryption.md) | The high-level request-response workflow for the UID2 APIs, requirements for encrypting requests and decrypting responses, and respective script examples in different programming languages. | +| [Encrypting requests and decrypting responses](getting-started/gs-encryption-decryption.md) | The high-level request-response workflow for the UID2 APIs, requirements for encrypting requests and decrypting responses, and respective script examples in different programming languages. | | [Endpoints](endpoints/summary-endpoints.md) | The API reference for managing identity tokens and mapping email addresses, phone numbers, or hashes to their UID2s and salt bucket IDs used to generate the UID2s.
NOTE: The integration environment and the production environment require different [API keys](ref-info/glossary-uid.md#gl-api-key). | -| [Integration Guides](guides/summary-guides.md) | The UID2 integration workflows for UID2 participants, such as publishers, DSPs, advertisers, and data providers, as well as Operator Enterprise Partners, such as Microsoft Azure, AWS, Snowflake, and Databricks. | +| [Integration guides](guides/summary-guides.md) | The UID2 integration workflows for UID2 participants, such as publishers, DSPs, advertisers, and data providers, as well as Operator Enterprise Partners, such as Microsoft Azure, AWS, Snowflake, and Databricks. | | [SDKs](sdks/summary-sdks.md) | Links to documentation for using UID2 SDKs. | diff --git a/i18n/ja/TRANSLATION_GLOSSARY.md b/i18n/ja/TRANSLATION_GLOSSARY.md index 337d55dca..7326d89a8 100644 --- a/i18n/ja/TRANSLATION_GLOSSARY.md +++ b/i18n/ja/TRANSLATION_GLOSSARY.md @@ -1,4 +1,4 @@ -# 翻訳用語集 (Translation Glossary) +# 翻訳用語集 (translation glossary) This glossary defines standard Japanese translations for technical terms used in UID2 documentation. この用語集は、UID2 ドキュメントで使用される専門用語の標準的な日本語訳を定義するものです。 diff --git a/i18n/ja/TRANSLATION_GUIDELINES.md b/i18n/ja/TRANSLATION_GUIDELINES.md index 1af638942..d392cb1a5 100644 --- a/i18n/ja/TRANSLATION_GUIDELINES.md +++ b/i18n/ja/TRANSLATION_GUIDELINES.md @@ -1,4 +1,4 @@ -# 翻訳ガイドライン (Translation Guidelines) +# 翻訳ガイドライン (translation guidelines) This document outlines the rules for style, tone, and terminology unification for translating UID2 documentation into Japanese. このドキュメントは、UID2 ドキュメントの日本語翻訳における、スタイル、トーン、用語の統一ルールをまとめたものです。 @@ -103,6 +103,6 @@ This document outlines the rules for style, tone, and terminology unification fo * **相対パスの使用**: サイト内の別ドキュメントへのリンクは、可能な限り相対パスを使用してください。 * 絶対パス (例: `/docs/intro`) を使用すると、言語を切り替えた際（日本語版閲覧時など）に、常にデフォルト言語（英語）のページに遷移してしまう問題が発生するためです。 - * 例: `[Getting Started](getting-started/gs-account-setup.md)` + * 例: `[Getting started](getting-started/gs-account-setup.md)` 詳細は、別途 `TRANSLATION_GLOSSARY.md` を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-buckets.md b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-buckets.md index 043ac65ff..824c52fb4 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-buckets.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-buckets.md @@ -12,35 +12,35 @@ import Link from '@docusaurus/Link'; ソルトバケット のローテーションをモニターします。 -Used by: このエンドポイントは、主に広告主とデータプロバイダーによって使用されます。詳細は [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 +Used by: このエンドポイントは、主に広告主とデータプロバイダーによって使用されます。詳細は [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 :::important 最新バージョン (v3) の `POST /v3/identity/map` を使用している場合は、`POST /identity/buckets` を使用する必要はありません。以前のバージョン (v2) の `POST /v2/identity/map` を使用している場合にのみ必要です。 -v2 バージョンを使用している場合は、改善点を活用するためにできるだけ早くアップグレードすることをお勧めします。移行ガイダンスは、[Migration from v2 Identity Map](post-identity-map.md#migration-from-v2-identity-map) を参照してください。 +v2 バージョンを使用している場合は、改善点を活用するためにできるだけ早くアップグレードすることをお勧めします。移行ガイダンスは、[Migration from v2 identity map](post-identity-map.md#migration-from-v2-identity-map) を参照してください。 ::: -## Request Format +## Request format `POST '{environment}/v2/identity/buckets'` -認証の詳細は、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。 +認証の詳細は、 [Authentication and authorization](../getting-started/gs-auth.md) を参照してください。 :::important -すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: -### Path Parameters +### Path parameters | Path Parameter | Data Type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`
本番環境: `https://prod.uidapi.com`
リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 | :::note -インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法は、[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 +インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法は、[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters :::important 暗号化する際には、リクエストの JSON ボディに以下のパラメータを key-value ペアとして含める必要があります。 @@ -50,7 +50,7 @@ v2 バージョンを使用している場合は、改善点を活用するた | :--- | :--- | :--- | :--- | :--- | | `since_timestamp` | date-time or integer | 必須 | バケットの最終更新 UTC タイムスタンプを比較する日時を指定します。 | ISO 8601 形式:
`YYYY-MM-DDThh:mm:ss` | -### Request Examples +### Request examples 以下は、暗号化されていない JSON リクエストボディの例で、ID バケットのローテーションリクエストに含める必要があります: @@ -65,9 +65,9 @@ v2 バージョンを使用している場合は、改善点を活用するた echo '{"since_timestamp": "2023-04-19T13:00:00"}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/buckets [Your-Client-API-Key] [Your-Client-Secret] ``` -詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 -## Decrypted JSON Response Format +## Decrypted JSON response format :::note レスポンスは、HTTP ステータスコードが 200 の場合のみ暗号化されます。それ以外の場合、レスポンスは暗号化されません。 @@ -94,7 +94,7 @@ echo '{"since_timestamp": "2023-04-19T13:00:00"}' | python3 uid2_request.py http "status": "success" } ``` -### Response Body Properties +### Response body properties レスポンスボディには、次の表に示すプロパティが含まれます。 @@ -103,7 +103,7 @@ echo '{"since_timestamp": "2023-04-19T13:00:00"}' | python3 uid2_request.py http | `bucket_id` | string | ソルトバケット ID です。 | | `last_updated` | date-time | ソルトバケットが最後にローテーションされた UTC タイムスタンプです。 | -### Response Status Codes +### Response status codes 次の表は、`status` プロパティの値と、それに対応する HTTP ステータスコードの一覧です。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map-v2.md b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map-v2.md index c938f0d71..47db5912d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map-v2.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map-v2.md @@ -11,48 +11,48 @@ import Link from '@docusaurus/Link'; 複数のメールアドレス、電話番号、またはそれぞれのハッシュを、raw UID2 と ソルトバケット ID にマッピングします。このエンドポイントを使用して、オプトアウト情報の更新をチェックすることもできます。 -Used by: このエンドポイントは、主に広告主やデータプロバイダーが使用します。詳細は [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 +Used by: このエンドポイントは、主に広告主やデータプロバイダーが使用します。詳細は [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 -UID2 のオプトアウトワークフローとユーザーがオプトアウトする方法の詳細は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +UID2 のオプトアウトワークフローとユーザーがオプトアウトする方法の詳細は、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 ## Version このドキュメントは、このエンドポイントのバージョン 2 のものであり、最新バージョンではありません。最新バージョン v3 の詳細は、[POST /identity/map](post-identity-map.md) を参照してください。 :::note -以前のバージョンを使用している場合は、改善点を活用するためにできるだけ早くアップグレードすることを推奨します。移行ガイダンスは、[Migration from v2 Identity Map](post-identity-map.md#migration-from-v2-identity-map) を参照してください。廃止に関する情報は、[Deprecation Schedule: Endpoint Versions](../ref-info/deprecation-schedule.md#endpoint-versions) を参照してください。 +以前のバージョンを使用している場合は、改善点を活用するためにできるだけ早くアップグレードすることを推奨します。移行ガイダンスは、[Migration from v2 identity map](post-identity-map.md#migration-from-v2-identity-map) を参照してください。廃止に関する情報は、[Deprecation schedule: Endpoint versions](../ref-info/deprecation-schedule.md#endpoint-versions) を参照してください。 ::: -## Batch Size and Request Parallelization Requirements +## Batch size and request parallelization requirements 知っておくべきことは以下のとおりです: - リクエストの最大サイズは 1MB です。 - 大量のメールアドレス、電話番号、またはそれぞれのハッシュをマップするには、1 バッチあたり最大 5,000 アイテムのバッチサイズで、それらを *連続した* バッチで送信してください。 -- Private Operator を使用している場合を除き、バッチを並行して送信しないでください。つまり、単一の HTTP 接続を使用して、[Directly Identifying Information (DII)](../ref-info/glossary-uid.md#gl-dii) を連続してマッピングしてください。 -- メールアドレス、電話番号、またはそれぞれのハッシュのマッピングを必ず保存してください。
マッピングを保存しないと、数百万のメールアドレスや電話番号をマッピングする必要がある場合に、処理時間が大幅に増加する可能性があります。しかし、実際に更新が必要なマッピングのみを再計算することで、毎日更新が必要な raw UID2 の数は約 1/365 となり、総処理時間を短縮できます。[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) と [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) も参照してください。 +- Private Operator を使用している場合を除き、バッチを並行して送信しないでください。つまり、単一の HTTP 接続を使用して、[Directly identifying information (DII)](../ref-info/glossary-uid.md#gl-dii) を連続してマッピングしてください。 +- メールアドレス、電話番号、またはそれぞれのハッシュのマッピングを必ず保存してください。
マッピングを保存しないと、数百万のメールアドレスや電話番号をマッピングする必要がある場合に、処理時間が大幅に増加する可能性があります。しかし、実際に更新が必要なマッピングのみを再計算することで、毎日更新が必要な raw UID2 の数は約 1/365 となり、総処理時間を短縮できます。[Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) と [FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) も参照してください。 -## Request Format +## Request format `POST '{environment}/v2/identity/map'` -認証の詳細は、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。 +認証の詳細は、 [Authentication and authorization](../getting-started/gs-auth.md) を参照してください。 :::important -すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: -### Path Parameters +### Path parameters | Path Parameter | Data Type | Attribute | Description | |:---|:---|:---|:---| | `{environment}` | string | 必須| テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`
本番環境: `https://prod.uidapi.com`
リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 | :::note -インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法は、[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 +インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法は、[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters :::important リクエストを暗号化するときは、以下の 4 つの条件パラメータのうち、**1 つ** だけをリクエストの JSON ボディにキーと値のペアとして含める必要があります。 @@ -65,7 +65,7 @@ UID2 のオプトアウトワークフローとユーザーがオプトアウト | `phone` | string array | 条件付きで必須 | マッピングする [正規化](../getting-started/gs-normalization-encoding.md#phone-number-normalization) 済み電話番号のリストです。 | | `phone_hash` | string array | 条件付きで必須 | マッピングする [SHA-256 ハッシュし、Base64 エンコード](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) した [正規化](../getting-started/gs-normalization-encoding.md#phone-number-normalization) 済み電話番号のリストです。 | -### Request Examples +### Request examples 以下は、各パラメータの暗号化されていない JSON リクエストボディの例です。このうちの 1 つを、`POST /identity/map` エンドポイントへのリクエストに含める必要があります: @@ -108,9 +108,9 @@ UID2 のオプトアウトワークフローとユーザーがオプトアウト echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map [Your-Client-API-Key] [Your-Client-Secret] ``` -詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 -## Decrypted JSON Response Format +## Decrypted JSON response format :::note レスポンスは、HTTP ステータスコードが 200 の場合のみ暗号化されます。それ以外の場合、レスポンスは暗号化されません。 @@ -184,7 +184,7 @@ echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py ht } ``` -### Response Body Properties +### Response body properties レスポンスボディには、次の表に示すプロパティが含まれます。 @@ -194,7 +194,7 @@ echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py ht | `advertising_id` | string | 対応する Advertising ID (raw UID2) です。 | | `bucket_id` | string | raw UID2 の生成に使用したソルトバケットの ID です。 | -### Response Status Codes +### Response status codes 次の表は、`status` プロパティの値と、それに対応する HTTP ステータスコードの一覧です。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map.md b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map.md index ef4c99caf..1185f683b 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map.md @@ -13,9 +13,9 @@ import SnptPOSTIdentityMapImprovements from '../snippets/_snpt-post-identity-map 複数のメールアドレス、電話番号、またはそれぞれのハッシュを、raw UID2 にマッピングします。このエンドポイントを使用して、オプトアウト情報の更新をチェックしたり、raw UID2 の更新が可能な時期を確認したり、現在の raw UID2 が発行されてから 90 日未満の場合に前の UID2 を表示することもできます。 -Used by: このエンドポイントは、主に広告主とデータプロバイダーによって使用されます。詳細は、[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 +Used by: このエンドポイントは、主に広告主とデータプロバイダーによって使用されます。詳細は、[Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 -UID2 のオプトアウト手順とユーザーがオプトアウトする方法は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +UID2 のオプトアウト手順とユーザーがオプトアウトする方法は、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 ## Version @@ -23,36 +23,36 @@ UID2 のオプトアウト手順とユーザーがオプトアウトする方法 必要に応じて、以前のバージョンのドキュメントも利用可能です: [POST /identity/map (v2)](post-identity-map-v2.md) を参照してください。 -## Batch Size and Request Parallelization Requirements +## Batch size and request parallelization requirements 以下が必要な情報です: - 最大リクエストサイズは 1MB です。 - 大量のメールアドレス、電話番号、またはそれぞれのハッシュをマッピングする場合は、1 バッチあたり最大 5,000 アイテムの *順次* バッチで送信します。 - Private Operator を使用していない限り、バッチを並行して送信しないでください。つまり、単一の HTTP 接続を使用し、ハッシュ化またはハッシュされていない Directly Identifying Information (DII) 値のバッチを連続して送信し、複数の並行接続を作成しないでください。 -- メールアドレス、電話番号、またはそれぞれのハッシュのマッピングを必ず保存してください。
マッピングを保存しないと、数百万のメールアドレスや電話番号をマッピングする際に処理時間が大幅に増加する可能性があります。ただし、実際に更新が必要なマッピングのみを再計算すると、UID2 の約 1/365 が毎日更新されるため、総処理時間が短縮されます。詳細は、[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) と [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) を参照してください。 +- メールアドレス、電話番号、またはそれぞれのハッシュのマッピングを必ず保存してください。
マッピングを保存しないと、数百万のメールアドレスや電話番号をマッピングする際に処理時間が大幅に増加する可能性があります。ただし、実際に更新が必要なマッピングのみを再計算すると、UID2 の約 1/365 が毎日更新されるため、総処理時間が短縮されます。詳細は、[Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) と [FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) を参照してください。 -## Request Format +## Request format `POST '{environment}/v3/identity/map'` -認証の詳細は、[Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。 +認証の詳細は、[Authentication and authorization](../getting-started/gs-auth.md) を参照してください。 :::important -すべてのリクエストをシークレットを使用して暗号化する必要があります。詳細は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +すべてのリクエストをシークレットを使用して暗号化する必要があります。詳細は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: -### Path Parameters +### Path parameters | Path Parameter | Data Type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | 必須 | テスト（インテグレーション）環境: `https://operator-integ.uidapi.com`
本番環境: 最適な選択は、ユーザーの所在地によって異なります。ユースケースに適した URL の選択方法や、有効なベース URL の一覧は、[Environments](../getting-started/gs-environments.md) を参照してください。 | :::note -インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報の取得方法は、[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 +インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報の取得方法は、[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters :::important 暗号化を行う際には、リクエストの JSON 本文に次の 4 つのパラメータのうち、**いずれか 1 つ** をキーと値のペアとして含めてください。 @@ -66,7 +66,7 @@ UID2 のオプトアウト手順とユーザーがオプトアウトする方法 | `phone_hash` | string array | 条件付きで必須 | マッピングする [正規化済み](../getting-started/gs-normalization-encoding.md#phone-number-normalization) 電話番号の [Base64 エンコードされた SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) ハッシュのリスト。 | -### Request Examples +### Request examples 以下の例は、`POST /identity/map` エンドポイントへの暗号化されていない JSON リクエスト本文の例です: @@ -102,9 +102,9 @@ UID2 のオプトアウト手順とユーザーがオプトアウトする方法 echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v3/identity/map [YOUR_CLIENT_API_KEY] [YOUR_CLIENT_SECRET] ``` -詳細および異なるプログラミング言語でのコード例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +詳細および異なるプログラミング言語でのコード例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 -## Decrypted JSON Response Format +## Decrypted JSON response format :::note HTTP ステータスコードが 200 の場合、レスポンスは暗号化されます。それ以外の場合、レスポンスは暗号化されません。 @@ -158,7 +158,7 @@ Response: } ``` -### Response Body Properties +### Response body properties レスポンス本文には、以下の表に示すプロパティのいずれかが含まれます。 @@ -188,7 +188,7 @@ raw UID2 はリフレッシュタイムスタンプの前では変化しませ | :------- | :-------- | :--------------------------------------------------------------------------------------------------- | | `e` | string | マッピングできなかった理由。次のいずれかの値:
  • `optout`
  • `invalid identifier`
| -### Response Status Codes +### Response status codes 以下の表は、`status` プロパティの値とその HTTP ステータスコードの対応を示しています。 @@ -200,20 +200,20 @@ raw UID2 はリフレッシュタイムスタンプの前では変化しませ `status` プロパティの値が `success` 以外の場合、`message` フィールドには問題に関する追加情報が提供されます。 -## Migration from v2 Identity Map +## Migration from v2 identity map 以下のセクションでは、以前のバージョンからバージョン 3 への移行に関する一般的な情報とガイダンスを提供します: -- [Version 3 Improvements](#version-3-improvements) -- [Key Differences Between v2 and v3](#key-differences-between-v2-and-v3) -- [Required Changes](#required-changes) -- [Additional Resources](#additional-resources) +- [Version 3 improvements](#version-3-improvements) +- [Key differences between v2 and v3](#key-differences-between-v2-and-v3) +- [Required changes](#required-changes) +- [Additional resources](#additional-resources) -### Version 3 Improvements +### Version 3 improvements -### Key Differences Between v2 and v3 +### Key differences between v2 and v3 以下の表は、バージョン間の主な違いを示しています。 @@ -224,15 +224,15 @@ raw UID2 はリフレッシュタイムスタンプの前では変化しませ | リフレッシュ管理 | `/identity/buckets` エンドポイントを介してソルトバケットのローテーションをモニター | `refresh_from` タイムスタンプを過ぎたときに再マッピング | | 前の UID2 アクセス | 利用不可 | 90 日間利用可能 | -### Required Changes +### Required changes 以前のバージョンからバージョン 3 へのアップグレードは、以下の手順に従ってください。 -1. [Update Endpoint URL](#1-update-endpoint-url) -2. [Update v3 Response Parsing Logic](#2-update-v3-response-parsing-logic) -3. [Replace Salt Bucket Monitoring with Refresh Timestamp Logic](#3-replace-salt-bucket-monitoring-with-refresh-timestamp-logic) +1. [Update endpoint URL](#1-update-endpoint-url) +2. [Update v3 response parsing logic](#2-update-v3-response-parsing-logic) +3. [Replace salt bucket monitoring with refresh timestamp logic](#3-replace-salt-bucket-monitoring-with-refresh-timestamp-logic) -#### 1. Update Endpoint URL +#### 1. update endpoint URL エンドポイント URL を更新して、/v3/ 実装を参照するようにしてください。以下の例を参照してください。 @@ -244,7 +244,7 @@ url = '/v2/identity/map' url = '/v3/identity/map' ``` -#### 2. Update v3 Response Parsing Logic +#### 2. update v3 response parsing logic 以下の例に従って、レスポンスの解析ロジックを更新してください。 @@ -275,7 +275,7 @@ for index, item in enumerate(response['body']['email']): handle_unmapped(original_email, item['e']) ``` -#### 3. Replace Salt Bucket Monitoring with Refresh Timestamp Logic +#### 3. replace salt bucket monitoring with refresh timestamp logic ソルトバケットのモニタリングを更新して、`refresh_from` タイムスタンプをチェックし、raw UID2 の更新が必要なものを判断するコードに置き換えます。 @@ -293,12 +293,12 @@ to_remap = [mapping for mapping in mappings if is_refresh_needed(mapping)] remap_identities(to_remap) ``` -### Additional Resources +### Additional resources -アイデンティティマッピングの一般的な情報については、[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 +アイデンティティマッピングの一般的な情報については、[Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 特定の SDK の移行ガイダンスについては、以下を参照してください: -- SDK for Python Reference Guide, [Usage for Advertisers/Data Providers](../sdks/sdk-ref-python.md#usage-for-advertisersdata-providers) セクション -- SDK for Java Reference Guide, [Usage for Advertisers/Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers) セクション +- SDK for Python Reference Guide, [Usage for advertisers/data providers](../sdks/sdk-ref-python.md#usage-for-advertisersdata-providers) セクション +- SDK for Java Reference Guide, [Usage for advertisers/data providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers) セクション -Snowflake に関する情報は、[Snowflake Integration Guide](../guides/integration-snowflake.md) を参照してください。 +Snowflake に関する情報は、[Snowflake integration guide](../guides/integration-snowflake.md) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-optout-status.md b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-optout-status.md index b3fde4c28..e2cd9cc15 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-optout-status.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-optout-status.md @@ -10,44 +10,44 @@ import Link from '@docusaurus/Link'; # POST /optout/status -raw UID2 のオプトアウトステータスを確認します。指定された raw UID2 のリストを使用して、このエンドポイントはオプトアウトした raw UID2 とそのオプトアウトが行われた時刻を返します。詳細は [User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +raw UID2 のオプトアウトステータスを確認します。指定された raw UID2 のリストを使用して、このエンドポイントはオプトアウトした raw UID2 とそのオプトアウトが行われた時刻を返します。詳細は [User opt-out](../getting-started/gs-opt-out.md) を参照してください。 Used by: このエンドポイントは、主に広告主、データプロバイダー、DSP、Sharer（共有参加者）によって使用されます。一般的には、元のメールアドレスや電話番号にアクセスできないが、オプトアウトステータスを知りたい参加者向けです。 詳細は、役割に応じて以下のドキュメントを参照してください: -- [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) -- [DSP Integration Guide](../guides/dsp-guide.md) -- [UID2 Sharing: Overview](../sharing/sharing-overview) +- [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) +- [DSP integration guide](../guides/dsp-guide.md) +- [UID2 sharing: Overview](../sharing/sharing-overview) -## Batch Size and Request Parallelization Requirements +## Batch size and request parallelization requirements このエンドポイントへのリクエストのバッチを管理するための主要なガイドラインは次のとおりです: - 多数の UID2 のオプトアウトステータスを確認するには、1 バッチあたりのバッチサイズが最大 5,000 件となるように、順次バッチを送信してください。 - Private Operator を使用している場合を除き、バッチを並行して送信しないでください。つまり、複数の並列接続を作成せず、単一の HTTP 接続を使用して、連続して raw UID2 のバッチを送信してください。 -## Request Format +## Request format `POST '{environment}/v2/optout/status'` -認証の詳細は、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。 +認証の詳細は、 [Authentication and authorization](../getting-started/gs-auth.md) を参照してください。 :::important -すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: -### Path Parameters +### Path parameters | Path Parameter | Data Type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`
本番環境: `https://prod.uidapi.com`
リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 | :::note -インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法は、[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 +インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法は、[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters ボディパラメータは 1 つだけです。 @@ -55,7 +55,7 @@ Used by: このエンドポイントは、主に広告主、データプロバ | :--- | :--- | :--- | :--- | | `advertising_ids` | string array | 必須 | オプトアウトのステータスをチェックしたい raw UID2 のリスト。
1 回の API 呼び出しで最大 5,000 件のエントリー。 | -### Request Example +### Request example 以下は、暗号化されていない JSON リクエストボディの例です: @@ -75,9 +75,9 @@ Used by: このエンドポイントは、主に広告主、データプロバ echo '{"advertising_ids": ["ufv1uGRovNiJNbJqiE/xzM+aKE7jP69MgspOZoEQ3xc="]}' | python3 uid2_request.py https://prod.uidapi.com/v2/optout/status [Your-Client-API-Key] [Your-Client-Secret] ``` -詳細と、さまざまなプログラミング言語でのコード例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +詳細と、さまざまなプログラミング言語でのコード例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 -## Decrypted JSON Response Format +## Decrypted JSON response format :::note レスポンスは、HTTP ステータスコードが 200 の場合のみ暗号化されます。それ以外の場合、レスポンスは暗号化されません。 @@ -103,7 +103,7 @@ echo '{"advertising_ids": ["ufv1uGRovNiJNbJqiE/xzM+aKE7jP69MgspOZoEQ3xc="]}' | p } ``` -### Response Body Properties +### Response body properties レスポンスボディには、次のプロパティが含まれます。 @@ -112,7 +112,7 @@ echo '{"advertising_ids": ["ufv1uGRovNiJNbJqiE/xzM+aKE7jP69MgspOZoEQ3xc="]}' | p | `advertising_id` | string | Advertising ID (raw UID2). | | `opted_out_since` | number | raw UID2 がいつオプトアウトされたかを示す Unix タイムスタンプ (ミリ秒単位)。 | -### Response Status Codes +### Response status codes ステータスプロパティの値と、HTTP ステータスコードに対応する値は次の表の通りです。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-generate.md b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-generate.md index 449ef7947..18243a373 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-generate.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-generate.md @@ -20,26 +20,26 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 このエンドポイントを直接呼び出すのではなく、UID2 SDK を使って管理することもできます。オプションの概要は、[SDKs: Summary](../sdks/summary-sdks.md) を参照してください。 :::important -どのオプションを使用する場合でも、UID2 を生成するために送信するデータは、送信前に正規化、ハッシュ化、およびエンコードする必要があります。詳細については、[Normalization and Encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 +どのオプションを使用する場合でも、UID2 を生成するために送信するデータは、送信前に正規化、ハッシュ化、およびエンコードする必要があります。詳細については、[Normalization and encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 ::: -## Request Format +## Request format `POST '{environment}/v2/token/generate'` -認証の詳細は、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。 +認証の詳細は、 [Authentication and authorization](../getting-started/gs-auth.md) を参照してください。 このエンドポイントリクエストについて知っておくべきことは、以下のとおりです: - サービスにアクセスする際に使用する API key を秘密にするため、UID2 Token は認証後に Server-Side でのみ生成する必要があります。 -- すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +- すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 -### Path Parameters +### Path parameters | Path Parameter | Data Type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`
本番環境: ユーザーの所在地に応じて最適な URL が異なります。ユースケースに最適な URL の選択方法および有効なベース URL の全リストは、[Environments](../getting-started/gs-environments.md) を参照してください。
Notes:
  • `integ` 環境と `prod` 環境では、異なる API Key が必要です。
  • トークンの有効期限は変更される可能性がありますが、`integ` 環境では常に `prod` 環境よりも大幅に短くなります。
| -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters :::important リクエストを暗号化するときには、以下の 4 つの条件付きパラメータのうち **1 つ** のみを JSON ボディのキーと値のペアとして含める必要があります。 @@ -52,10 +52,10 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 | `phone` | string | 条件付きで必須 | トークンを生成する [正規化](../getting-started/gs-normalization-encoding.md#phone-number-normalization) 済み電話番号です。 | | `phone_hash` | string | 条件付きで必須 | [SHA-256 ハッシュし、Base64 エンコード](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) した、[正規化](../getting-started/gs-normalization-encoding.md#phone-number-normalization) 済み電話番号です。 | -### Request Examples +### Request examples :::important -サービスへのアクセスに使用する API キーを秘密にしておくため、[POST /token/generate](post-token-generate.md) エンドポイントは、[POST /token/refresh](post-token-refresh.md) とは異なり、Server-Side から呼び出す必要があります。Client-Side でトークンを生成する場合は、[Client-Side Integration Options](../guides/integration-options-publisher-web.md#client-side-integration-options) (Web ベースの実装) または [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md) を参照してください。 +サービスへのアクセスに使用する API キーを秘密にしておくため、[POST /token/generate](post-token-generate.md) エンドポイントは、[POST /token/refresh](post-token-refresh.md) とは異なり、Server-Side から呼び出す必要があります。Client-Side でトークンを生成する場合は、[Client-side integration options](../guides/integration-options-publisher-web.md#client-side-integration-options) (Web ベースの実装) または [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side.md) を参照してください。 ::: 以下は、各パラメータの暗号化されていない JSON リクエストボディの例で、このうちの 1 つはトークン生成リクエストに含める必要があります: @@ -86,9 +86,9 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 ```sh echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/generate [Your-Client-API-Key] [Your-Client-Secret] ``` -詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 -## Decrypted JSON Response Format +## Decrypted JSON response format :::note レスポンスは、HTTP ステータスコードが 200 の場合のみ暗号化されます。それ以外の場合、レスポンスは暗号化されません。 @@ -96,10 +96,10 @@ echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="}' | python3 このセクションには、次のサンプルレスポンスが含まれています: -- [Successful Response](#successful-response) +- [Successful response](#successful-response) - [Optout](#optout) -#### Successful Response +#### Successful response 復号化に成功すると、指定されたメールアドレス、電話番号、またはそれぞれのハッシュに対するユーザーの Advertising Token および Refresh Token が返されます。 @@ -115,7 +115,7 @@ echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="}' | python3 } ``` -### Response Body Properties +### Response body properties レスポンスボディには、次の表に示すプロパティが含まれます。 @@ -128,7 +128,7 @@ echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="}' | python3 | `refresh_expires` | number | Refresh Token の有効期限を示す Unix タイムスタンプ (ミリ秒単位) です。 | | `refresh_response_key` | string | [POST /token/refresh](post-token-refresh.md) リクエストでレスポンス復号化のために使用される鍵です。 | -### Response Status Codes +### Response status codes 次の表は、`status` プロパティの値と、それに対応する HTTP ステータスコードの一覧です。 @@ -141,7 +141,7 @@ echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="}' | python3 `status` の値が `success` 以外であれば、`message` フィールドにその問題に関する追加情報が表示されます。 -## Test Identities +## Test identities | Type | Identity | Purpose | Next Endpoint | | :---- | :--------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- | diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-refresh.md b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-refresh.md index 2b8b74bef..fad739b40 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-refresh.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-refresh.md @@ -21,7 +21,7 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 このエンドポイントを直接呼び出す代わりに、UID2 SDK のいずれかを使用して管理することができます。オプションの概要は、[SDKs: Summary](../sdks/summary-sdks.md) を参照してください。 ::: -## Request Format +## Request format `POST '{environment}/v2/token/refresh'` @@ -34,24 +34,24 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 - 成功したレスポンスは、そのレスポンスに新しいトークンまたはオプトアウト情報が含まれているかどうかにかかわらず暗号化されます。エラーレスポンスは暗号化されません。 - レスポンスを復号化するには、このトークンに対する最新の `refresh_response_key` 値を使用します。`refresh_response_key` の値は、[POST /token/generate](post-token-generate.md) と `POST /token/refresh` のレスポンスで返されます。トークンがリフレッシュされるたびに、新しい `refresh_response_key` が返されます。現在のレスポンスを復号化するには、必ず最新のものを使用してください。 -### Path Parameters +### Path parameters | Path Parameter | Data Type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`
本番環境: `https://prod.uidapi.com`
リージョンごとのオペレーターを含む全リストは、[Environments](../getting-started/gs-environments.md) を参照してください。
Notes:
  • `integ` 環境と `prod` 環境は異なる API Key を必要とします。
  • トークンの有効期限は変更される可能性がありますが、`integ` 環境では常に `prod` 環境よりも大幅に短くなります。
| -#### Testing Notes +#### Testing notes [POST /token/generate](post-token-generate.md) リクエストで以下のパラメータのいずれかを使用すると、常に `refresh_token` による ID レスポンスが生成され、`POST /token/refresh` エンドポイントと共に使用するとログアウトレスポンスとなります。 - メールアドレス `refresh-optout@example.com` - 電話番号 `+00000000002` -### Request Example +### Request example -詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 -## Decrypted JSON Response Format +## Decrypted JSON response format 復号化された成功したレスポンスには、ユーザーの新しい UID2 Token (`advertising_token`) と関連する値が含まれるか、ユーザーがオプトアウトしたことを示します。 @@ -61,17 +61,17 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 このセクションには、次のサンプルレスポンスが含まれています: -- [Successful Response With Tokens](#successful-response-with-tokens) -- [Successful Response With Opt-Out](#successful-response-with-opt-out) -- [Error Response](#error-response) +- [Successful response with tokens](#successful-response-with-tokens) +- [Successful response with opt-out](#successful-response-with-opt-out) +- [Error response](#error-response) -#### Successful Response With Tokens +#### Successful response with tokens すべての値が有効で、ユーザーがオプトアウトしていない場合、レスポンスは成功し、新しい UID2 Token が関連する値とともに返されます。以下の例は、トークンを含む成功したレスポンスを復号したものです: -#### Successful Response With Opt-Out +#### Successful response with opt-out ユーザーがオプトアウトした場合、レスポンスは成功しますが、新しい UID2 Token は返されません。以下の例は、復号化されたオプトアウトレスポンスを示しています: @@ -81,7 +81,7 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 } ``` -#### Error Response +#### Error response エラーレスポンスは以下のようなものになる可能性があります: @@ -92,7 +92,7 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 } ``` -### Response Body Properties +### Response body properties レスポンスボディには、次の表に示すプロパティが含まれます。 @@ -101,11 +101,11 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 | `advertising_token` | string | ユーザーの UID2 Token (Advertising Token とも呼ばれます) です。 | | `refresh_token` | string | UID2 Service と最新の ID トークンのセットを交換できる暗号化されたトークンです。 | | `identity_expires` | number | UID2 Token の有効期限を示す Unix タイムスタンプ (ミリ秒単位) です。 | -| `refresh_from` | number | SDK for JavaScript ([SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照) が UID2 Token のリフレッシュを開始するタイミングを示す Unix タイムスタンプ (ミリ秒単位)。
TIP: SDK を使用していない場合は、このタイムスタンプから Advertising Token もリフレッシュすることを検討してください。 | +| `refresh_from` | number | SDK for JavaScript ([SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md) を参照) が UID2 Token のリフレッシュを開始するタイミングを示す Unix タイムスタンプ (ミリ秒単位)。
TIP: SDK を使用していない場合は、このタイムスタンプから Advertising Token もリフレッシュすることを検討してください。 | | `refresh_expires` | number | Refresh Token の有効期限を示す Unix タイムスタンプ (ミリ秒単位)。 | | `refresh_response_key` | string | [POST /token/refresh](post-token-refresh.md) リクエストでレスポンス復号化のために使用される鍵です。| -### Response Status Codes +### Response status codes 次の表は、`status` プロパティの値と、それに対応する HTTP ステータスコードの一覧です。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-validate.md b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-validate.md index ca3783e1c..c3658d68f 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-validate.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-token-validate.md @@ -18,27 +18,27 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 このエンドポイントは、主に新しいインテグレーションのテストとトラブルシューティングのために用意されています。 ::: -## Request Format +## Request format `POST '{environment}/v2/token/validate'` -認証の詳細は、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。 +認証の詳細は、 [Authentication and authorization](../getting-started/gs-auth.md) を参照してください。 :::important -すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: -### Path Parameters +### Path parameters | Path Parameter | Data Type | Attribute | Description | | :--- | :--- | :--- | :--- | | `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`
本番環境: `https://prod.uidapi.com`
リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 | :::note -インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法は、[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 +インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法は、[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 ::: -### Unencrypted JSON Body Parameters +### Unencrypted JSON body parameters このエンドポイントの使用に関する主なポイントは以下の通りです。 @@ -53,7 +53,7 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 | `phone` | string | 条件付きで必須 | トークン検証用の電話番号です。有効な電話番号値を使用できますが、[正規化](../getting-started/gs-normalization-encoding.md#phone-number-normalization)されている必要があります。 | | `phone_hash` | string | 条件付きで必須 | 有効な [正規化された](../getting-started/gs-normalization-encoding.md#phone-number-normalization) 電話番号の [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) ハッシュです。 | -### Request Examples +### Request examples 以下は、各パラメータの暗号化されていない JSON リクエストボディの例で、トークン検証のリクエストに含める必要があります: @@ -92,9 +92,9 @@ Used by: このエンドポイントは、主にパブリッシャーが使用 echo '{"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXlfWETZ3b%2FbesPFFvJxNLLySg4QEYHUAiyUrNncgnm7ppu0mi6wU2CW6hssiuEkKfstbo9XWgRUbWNTM%2BewMzXXM8G9j8Q%3D", "email_hash": "LdhtUlMQ58ZZy5YUqGPRQw5xUMS5dXG5ocJHYJHbAKI="}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/validate [Your-Client-API-Key] [Your-Client-Secret] ``` -詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 -## Decrypted JSON Response Format +## Decrypted JSON response format :::note レスポンスは、HTTP ステータスコードが 200 の場合のみ暗号化されます。それ以外の場合、レスポンスは暗号化されません。 @@ -109,7 +109,7 @@ echo '{"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXl } ``` -## Body Response Properties +## Body response properties 以下の表は、レスポンスボディに関する情報を提供します。 @@ -117,7 +117,7 @@ echo '{"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXl | :--- | :--- | :--- | | `body` | boolean | `true` の値は、リクエストで指定されたメールアドレス、電話番号、またはそれぞれのハッシュが、Advertising Token を生成するために使用されたものと同じであることを示します。
`false` の値は、リクエストで指定されたメールアドレス、電話番号、またはそれぞれのハッシュが、Advertising Token を生成するために使用されたものと同じではないことを示します。 | -### Response Status Codes +### Response status codes 次の表は、`status` プロパティの値と、それに対応する HTTP ステータスコードの一覧です。 @@ -129,7 +129,7 @@ echo '{"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXl `status` の値が `success` 以外であれば、`message` フィールドにその問題に関する追加情報が表示されます。 -## Using POST /token/validate to Test +## Using POST /token/validate to test このエンドポイントを使用して、[POST /token/generate](../endpoints/post-token-generate.md) で送信する DII が有効かどうかをテストできます。以下の手順に従ってください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/summary-endpoints.md b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/summary-endpoints.md index 95f1bae60..5c3cda303 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/summary-endpoints.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/endpoints/summary-endpoints.md @@ -8,23 +8,23 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Endpoints: Summary +# UID2 endpoints: Summary -すべての UID2 エンドポイントでは、API リクエストの暗号化([POST /token/refresh](post-token-refresh.md) を除く) とレスポンスの復号化に Client Secret が必要です。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 +すべての UID2 エンドポイントでは、API リクエストの暗号化([POST /token/refresh](post-token-refresh.md) を除く) とレスポンスの復号化に Client Secret が必要です。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 -## UID2 Endpoints by Audience +## UID2 endpoints by audience 以下の表は、UID2 エンドポイントと各エンドポイントの対象ユーザーを示しています。詳細については、該当するセクションをクリックしてください。 | Endpoint | Audience | Details | | :--- | :--- | :--- | -| [POST /token/generate](post-token-generate.md) | パブリッシャー | [UID2 Tokens](#uid2-tokens) | -| [POST /token/validate](post-token-validate.md) | パブリッシャー | [UID2 Tokens](#uid2-tokens) | -| [POST /token/refresh](post-token-refresh.md) | パブリッシャー | [UID2 Tokens](#uid2-tokens) | -| [POST /identity/map](post-identity-map.md) | 広告主、データプロバイダー | [Identity Map](#identity-map) | -| [POST /optout/status](post-optout-status.md) | 広告主、データプロバイダー、DSP、共有参加者 | [Opt-Out Status](#opt-out-status) | +| [POST /token/generate](post-token-generate.md) | パブリッシャー | [UID2 tokens](#uid2-tokens) | +| [POST /token/validate](post-token-validate.md) | パブリッシャー | [UID2 tokens](#uid2-tokens) | +| [POST /token/refresh](post-token-refresh.md) | パブリッシャー | [UID2 tokens](#uid2-tokens) | +| [POST /identity/map](post-identity-map.md) | 広告主、データプロバイダー | [Identity map](#identity-map) | +| [POST /optout/status](post-optout-status.md) | 広告主、データプロバイダー、DSP、共有参加者 | [Opt-out status](#opt-out-status) | -## UID2 Tokens +## UID2 tokens 以下のエンドポイントは、UID2 Token (identity tokens, advertising tokens) を取得および管理するためのもので、主にパブリッシャーが使用します。 @@ -34,11 +34,11 @@ import Link from '@docusaurus/Link'; | [POST /token/validate](post-token-validate.md) | Advertising Token (UID2) が指定されたメールアドレス、電話番号、またはそれぞれのハッシュと一致するかどうかを検証するためのテストに使用します。 | 必須 | 必須 | | [POST /token/refresh](post-token-refresh.md) | [POST /token/generate](./post-token-generate.md) レスポンスから、ユーザーの Refresh Token 用に新しいトークンを生成します。 | N/A | 必須 | -## Identity Map +## Identity map 以下のエンドポイントは、広告主とサードパーティのデータプロバイダーが使用します。パブリッシャーはこれらのエンドポイントを使用する必要はありません。 -### Latest Identity Map Endpoint (v3) +### Latest identity map endpoint (v3) 最新の Identity Map インテグレーションでは、1 つのエンドポイント `POST /identity/map` を呼び出すだけで済みます。`POST /identity/buckets` エンドポイントはワークフローの一部ではありません。 @@ -52,7 +52,7 @@ import Link from '@docusaurus/Link'; | :--- | :--- | :--- | :--- | | [POST /identity/map](post-identity-map.md) | 1 つ以上のメールアドレス、電話番号、またはそのハッシュに対して、raw UID2、以前の raw UID2、および更新タイムスタンプをマップします。 | 必須 | 必須 | -### Earlier Identity Map Endpoints (v2) +### Earlier identity map endpoints (v2) 以下のエンドポイントは、以前の Identity Map インテグレーション (バージョン 2) の一部です。 @@ -61,11 +61,11 @@ import Link from '@docusaurus/Link'; | [POST /identity/buckets](post-identity-buckets.md) | ローテーションしたソルトバケットの最終更新タイムスタンプをモニターします。 | 必須 | 必須 | | [POST /identity/map (v2)](post-identity-map-v2.md) | 1 つ以上のメールアドレス、電話番号、またはそれぞれのハッシュに対して、raw UID2 と ソルトバケット ID をマッピングします。 | 必須 | 必須 | -## Opt-Out Status +## Opt-out status 以下のエンドポイントは、広告主、サードパーティのデータプロバイダー、DSP、共有参加者が使用できます。パブリッシャーは、このエンドポイントを使用する必要はありません。 -UID2 の Opt-Out ワークフローとユーザーが Opt-Out する方法の詳細は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +UID2 の Opt-Out ワークフローとユーザーが Opt-Out する方法の詳細は、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 | Endpoint | Description | Request Encryption | Response Decryption | | :--- | :--- | :--- | :--- | diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-account-setup.md b/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-account-setup.md index 48d6c1bc4..b232d4dfb 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-account-setup.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-account-setup.md @@ -8,11 +8,11 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Account Setup +# Account setup このページでは、UID2 でアカウントを設定するために必要な一般的な情報を提供します。 -## Contact Info +## Contact info UID2 フレームワークにアクセスするには、以下の The Trade Desk の担当チームに連絡してください。 @@ -24,10 +24,10 @@ The Trade Desk (現在の UID2 Administrator) とすでに取引関係がある | Your Role | Contact Email | | :--- | :--- | -| パブリッシャー、アプリ開発者 | [UID2publishers@thetradedesk.com](mailto:UID2publishers@thetradedesk.com) | -| 代理店、ブランド、DSP、SSP、Customer Data Platform (CDP)、データプロバイダー | [UID2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) | +| パブリッシャー、アプリ開発者 | [Uid2publishers@thetradedesk.com](mailto:UID2publishers@thetradedesk.com) | +| 代理店、ブランド、DSP、SSP、Customer Data Platform (CDP)、データプロバイダー | [Uid2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) | -## Account Setup Details +## Account setup details UID2 に関心を示すと、詳細を調整するために担当者から連絡があります。 @@ -40,7 +40,7 @@ UID2 に関心を示すと、詳細を調整するために担当者から連絡 * メールアドレス * 役職 -### Client-Side Web Integrations +### Client-side web integrations UID2 Token を [モバイル](../overviews/overview-publishers.md#mobile-integrations) アプリではなく [ウェブ](../overviews/overview-publishers.md#web-integrations) の Client-Side でリクエストする場合、サイトのドメイン名のリストも提供する必要があります。これは、Client-Side 実装のみのセキュリティ対策です。 @@ -48,7 +48,7 @@ UID2 Token を [モバイル](../overviews/overview-publishers.md#mobile-integra アカウント設定に必要なのは、ルートレベルのドメインだけです。たとえば、example.com、shop.example.com、example.org の Client-Side でトークンを生成するために UID2 を実装する場合、ドメイン名 example.com と example.org だけを提供します。 ::: -### Client-Side Mobile Integrations +### Client-side mobile integrations [モバイルアプリ](../guides/integration-mobile-client-side.md) で Client-Side から UID2 Token をリクエストする場合、すべてのモバイルアプリ ID の完全なリストを提供する必要があります: @@ -59,6 +59,6 @@ UID2 Token を [モバイル](../overviews/overview-publishers.md#mobile-integra UID2 に参加するための契約に署名した後、[UID2 credentials](gs-credentials.md) と UID2 の運用開始に必要な追加情報を提供します。 -## API Version +## API version UID2 API の現在のバージョンは v2 です。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-auth.md b/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-auth.md index d3622d03d..b27733bf4 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-auth.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-auth.md @@ -8,14 +8,14 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Authentication and Authorization +# Authentication and authorization Server-Side 実装で UID2 エンドポイントへの認証を行うには、以下のものが必要です： -- クライアントの [API Key](gs-credentials.md#api-key-and-client-secret)。API Key はベアラートークンとしてリクエストの Authorization ヘッダーに含めます。たとえば:
+- クライアントの [API key](gs-credentials.md#api-key-and-client-secret)。API Key はベアラートークンとしてリクエストの Authorization ヘッダーに含めます。たとえば:
`Authorization: Bearer YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk=` -- API リクエストを暗号化し、API レスポンスを復号化するための Client Secret 。これは、[POST /token/refresh](../endpoints/post-token-refresh.md) を除くすべてのエンドポイントで必要です。
詳細と、いくつかのプログラミング言語での暗号化/復号化の例は、[Encrypting Requests and Decrypting Responses](gs-encryption-decryption.md) を参照してください。 +- API リクエストを暗号化し、API レスポンスを復号化するための Client Secret 。これは、[POST /token/refresh](../endpoints/post-token-refresh.md) を除くすべてのエンドポイントで必要です。
詳細と、いくつかのプログラミング言語での暗号化/復号化の例は、[Encrypting requests and decrypting responses](gs-encryption-decryption.md) を参照してください。 :::note -パブリッシャーの場合、Client-Side に UID2 を実装しているなら、認証と認可は Prebid.js ([UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) を参照) や JavaScript SDK ([Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) を参照) などの実装によって自動的に管理されます。 +パブリッシャーの場合、Client-Side に UID2 を実装しているなら、認証と認可は Prebid.js ([UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) を参照) や JavaScript SDK ([Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) を参照) などの実装によって自動的に管理されます。 ::: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-credentials.md b/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-credentials.md index 07bf59c9f..de1a079ae 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-credentials.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-credentials.md @@ -8,25 +8,25 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Credentials +# UID2 credentials UID2 の 参加者は、参加形態に応じて、少なくとも 1 つの固有の認証情報セットを必要とします。必要な認証情報のセットは、次の表に示すように、UID2 にどのように参加しているかによって異なります。 | Audience | Credentials | Integration | | :--- | :--- | :--- | -| Client-Side 実装を使用する参加者 | 次の両方:
  • Subscription ID
  • Public key
これら 2 つをあわせて client keypair と呼ぶこともあります。 | 次のいずれかを使用したインテグレーション:
  • [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md)
  • [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)
  • [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md)
| -| Client-Server 実装を使用する参加者 | 次の両方:
  • API Key、Client Key とも呼ばれます。
  • Client Secretは、参加者と UID2 Service のみが知る値です。
| 次のいずれかを使用したインテグレーション:
  • [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)
  • [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md)
  • [UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md)
| -| Server-Side 実装を使用する参加者 | 次の両方:
  • API Key、Client Key とも呼ばれます。
  • Client Secretは、参加者と UID2 Service のみが知る値です。
| 次のいずれかを使用したインテグレーション:
  • [Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md)
  • [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md)
| +| Client-Side 実装を使用する参加者 | 次の両方:
  • Subscription ID
  • Public key
これら 2 つをあわせて client keypair と呼ぶこともあります。 | 次のいずれかを使用したインテグレーション:
  • [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md)
  • [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md)
  • [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side.md)
| +| Client-Server 実装を使用する参加者 | 次の両方:
  • API Key、Client Key とも呼ばれます。
  • Client Secretは、参加者と UID2 Service のみが知る値です。
| 次のいずれかを使用したインテグレーション:
  • [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md)
  • [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md)
  • [UID2 client-server integration guide for mobile](../guides/integration-mobile-client-server.md)
| +| Server-Side 実装を使用する参加者 | 次の両方:
  • API Key、Client Key とも呼ばれます。
  • Client Secretは、参加者と UID2 Service のみが知る値です。
| 次のいずれかを使用したインテグレーション:
  • [Publisher integration guide, server-side](../guides/integration-publisher-server-side.md)
  • [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md)
| -## Separate Credentials Per Environment/Role +## Separate credentials per environment/role -インテグレーション環境 と本番環境の両方を使用している場合、それぞれの環境用に別々の認証情報が提供されます。詳細は [Getting Your Credentials](#getting-your-credentials) を参照してください。 +インテグレーション環境 と本番環境の両方を使用している場合、それぞれの環境用に別々の認証情報が提供されます。詳細は [Getting your credentials](#getting-your-credentials) を参照してください。 さらに、いくつかのケースでは、異なるシナリオに対して異なるセットの認証情報を持つことを推奨しますが、必須ではありません。たとえば: - UID2 Token を生成するパブリッシャーである場合([POST /token/generate](../endpoints/post-token-generate.md) または他の方法で)、自分のために raw UID2 を生成/マッピングする場合([POST /identity/map](../endpoints/post-identity-map.md) を参照)、それぞれの活動に対して異なる認証情報を持つことがあります。 - 広告主の場合、広告主キーを使用して複数のサービスプロバイダーが運用するシナリオで、各サービスプロバイダーに対して異なる認証情報を割り当てることができます。 -## Getting Your Credentials +## Getting your credentials 以下の表は、各 [インテグレーションアプローチ](../ref-info/ref-integration-approaches.md) と各 [environment](../getting-started/gs-environments.md) に対して、認証情報を取得する方法を示しています。 @@ -42,17 +42,17 @@ UID2 の

Prod Client-Side - UID2 Portal > [Client-Side Integration](../portal/client-side-integration.md) + UID2 Portal > [Client-side integration](../portal/client-side-integration.md) Client-Server - UID2 Portal > [API Keys](../portal/api-keys.md) + UID2 Portal > [API keys](../portal/api-keys.md) Server-Side - UID2 Portal > [API Keys](../portal/api-keys.md) + UID2 Portal > [API keys](../portal/api-keys.md)

Integ @@ -77,9 +77,9 @@ For no-portal: To get your credentials, ask your UID2 contact. --> -## Subscription ID and Public Key +## Subscription ID and public key -Client-Side の実装([UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) または [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) を参照) を使用している場合は、以下の認証情報を受け取ります: +Client-Side の実装([UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) または [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) を参照) を使用している場合は、以下の認証情報を受け取ります: - **Subscription ID**: UID2 Service に対してサイトを識別する値です。 - **Public key**: この値は暗号化に使用されます。 @@ -93,24 +93,24 @@ Notes: - 値は特定の [environment](gs-environments.md) で有効です。インテグレーション環境と本番環境の両方を使っている場合、環境ごとに認証情報のセットを取得します。 -- Subscription ID と Public Key の認証情報は、Client-Side トークンの生成にのみ使用できます。追加のロールが必要な場合は ([API Permissions](gs-permissions.md) を参照)、そのロールの API キーと Client Secret をリクエストしてください。 +- Subscription ID と Public Key の認証情報は、Client-Side トークンの生成にのみ使用できます。追加のロールが必要な場合は ([API permissions](gs-permissions.md) を参照)、そのロールの API キーと Client Secret をリクエストしてください。 -## API Key and Client Secret +## API key and client secret -Client-Server または Server-Side の実装を使用している場合([UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) または [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照)、API Key と Client Secret を使用して、Operator Service に接続し、API エンドポイントを呼び出すことができます。これらの値は、サービスの参加者を識別します。 +Client-Server または Server-Side の実装を使用している場合([UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) または [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) を参照)、API Key と Client Secret を使用して、Operator Service に接続し、API エンドポイントを呼び出すことができます。これらの値は、サービスの参加者を識別します。 以下は API Key と Client Secret に関する情報です: -- これらの値は安全に保管する必要があります。詳細は、[Security of API Key and Client Secret](#security-of-api-key-and-client-secret) を参照してください。 +- これらの値は安全に保管する必要があります。詳細は、[Security of API key and client secret](#security-of-api-key-and-client-secret) を参照してください。 - UID2 参加者は、複数のキーを持つことができます。 - 各キーには、それを使用できるエンドポイントを決定する [権限](gs-permissions.md) のセットがあります。 - 各キーには対応する Client Secret があります。 -- ほとんどの API エンドポイントは、認証のために API Key と Client Secret の両方を必要とします。詳細は [Authentication and Authorization](gs-auth.md) を参照してください。 +- ほとんどの API エンドポイントは、認証のために API Key と Client Secret の両方を必要とします。詳細は [Authentication and authorization](gs-auth.md) を参照してください。 - インテグレーション環境と本番環境の両方を使用する場合、環境ごとに個別の API Key を受け取ります。 - Client Secret は特定の [environment](gs-environments.md) で有効です。インテグレーション環境と本番環境の両方を使っている場合、環境ごとに Client Secret を取得します。 -UID2 アカウントのセットアップの一環として、1つ以上の API Key が発行され、それぞれに対応する Client Secret が割り当てられます。連絡先の詳細は [Contact Info](gs-account-setup.md#contact-info) を参照してください。 +UID2 アカウントのセットアップの一環として、1つ以上の API Key が発行され、それぞれに対応する Client Secret が割り当てられます。連絡先の詳細は [Contact info](gs-account-setup.md#contact-info) を参照してください。 -### Security of API Key and Client Secret +### Security of API key and client secret キーと Client Secret のセキュリティは非常に重要です。以下のガイドラインに従ってください: @@ -120,11 +120,11 @@ UID2 アカウントのセットアップの一環として、1つ以上の API API Key と Client Secret は、認証情報が漏洩するリスクを減らすために、定期的に(たとえば1年ごとに)更新することを推奨します。 -## Refreshing Credentials +## Refreshing credentials 新しい認証情報をリクエストするには、次のいずれかを行います: -- UID2 Portal にアクセスできる場合、新しい本番環境の認証情報が必要な場合: [Getting Your Credentials](#getting-your-credentials) に記載されているページに移動します。 +- UID2 Portal にアクセスできる場合、新しい本番環境の認証情報が必要な場合: [Getting your credentials](#getting-your-credentials) に記載されているページに移動します。 - UID2 Portal へのアクセス権がない場合、またはインテグレーション環境用の新しい認証情報が必要な場合は、UID2 の担当者に問い合わせてください。 -### Honor User Opt-Outs +### Honor user opt-outs このセクションには、UID2 のユーザーオプトアウトを受け入れる必要がある DSP 向けの以下の情報が含まれています: -- [Opt-Out Webhook](#opt-out-webhook) -- [POST /optout/status Endpoint](#post-optoutstatus-endpoint) -- [Bidding Opt-Out Logic](#bidding-opt-out-logic) +- [Opt-out webhook](#opt-out-webhook) +- [POST /optout/status endpoint](#post-optoutstatus-endpoint) +- [Bidding opt-out logic](#bidding-opt-out-logic) -UID2 のオプトアウトワークフローとユーザーがどのようにオプトアウトできるかの詳細は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +UID2 のオプトアウトワークフローとユーザーがどのようにオプトアウトできるかの詳細は、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 -#### Opt-Out Webhook +#### Opt-out webhook UID2 Service からユーザーオプトアウトを受け取り、それを受け入れるために DSP が事前に設定されたインターフェース (オプトアウト Webhook/API エンドポイント) を確立し、オンボーディング中に UID2 Service に提供します。ユーザーがオプトアウトすると、UID2 Service はユーザーの raw UID2 と対応するオプトアウトタイムスタンプを事前に設定されたインターフェースに送信します。 -UID2 Service は、ユーザーのオプトアウトから数秒以内に次のデータを送信し、DSP は [Decrypt UID2 Tokens for RTB Use](#decrypt-uid2-tokens-for-rtb-use) で定義された入札ロジックを使用します。 +UID2 Service は、ユーザーのオプトアウトから数秒以内に次のデータを送信し、DSP は [Decrypt UID2 tokens for RTB use](#decrypt-uid2-tokens-for-rtb-use) で定義された入札ロジックを使用します。 | Parameter | Description | | :--- | :--- | @@ -60,11 +60,11 @@ DSP は、オプトアウトデータに 200 レスポンスコードでレス https://dsp.example.com/optout?user=%%identity%%&optouttime=%%timestamp%% ``` -#### POST /optout/status Endpoint +#### POST /optout/status endpoint DSP は、[POST /optout/status](../endpoints/post-optout-status.md) エンドポイントを使用して raw UID2 のオプトアウトステータスを確認できます。 -#### Bidding Opt-Out Logic +#### Bidding opt-out logic 入札時 (2-b)に以下のロジックを使用し、ユーザーのオプトアウトを受け入れます。 @@ -76,16 +76,16 @@ Server-Side SDK のいずれか ([SDKs: Summary](../sdks/summary-sdks.md) を参 ユーザーがオプトアウトした場合、UID2 は RTB に使用されるべきではありません。このような場合、DSP は入札のために代替 ID を送信するか、入札しないことを選択できます。 -### Decrypt UID2 Tokens for RTB Use +### Decrypt UID2 tokens for RTB use -次の表は、[Integration Steps](#integration-steps) で示したワークフロー図の Step 2 の詳細です。 +次の表は、[Integration steps](#integration-steps) で示したワークフロー図の Step 2 の詳細です。 | Step | SDK | Description | | :--- | :--- | :--- | | 2-a | Server-Side SDK ([SDKs: Summary](../sdks/summary-sdks.md) を参照) | 提供されている SDK を活用して、入力された UID2 Token を復号化します。レスポンスには `UID2` と UID2 の作成時刻が含まれます。 | -| 2-b | | DSP は UID2 のオプトアウトプロトコルを受け入れることが要求されます。ユーザーオプトアウトの設定と入札時の受け入れは、[Honor User Opt-Outs](#honor-user-opt-outs) を参照してください。 | +| 2-b | | DSP は UID2 のオプトアウトプロトコルを受け入れることが要求されます。ユーザーオプトアウトの設定と入札時の受け入れは、[Honor user opt-outs](#honor-user-opt-outs) を参照してください。 | -## Recommendations for Managing Latency +## Recommendations for managing latency :::note このセクションは、*SDK for C# / .NET Reference Guide* の [Usage for DSPs](../sdks/sdk-ref-csharp-dotnet.md#usage-for-dsps) にあるサンプルコードを参照してください。メソッド名は [Java](../sdks/sdk-ref-java.md#usage-for-dsps)、[Python](../sdks/sdk-ref-python#usage-for-dsps)、および [C++](../sdks/sdk-ref-cplusplus.md#interface) SDK でも同様です。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-advertiser-dataprovider-endpoints.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-advertiser-dataprovider-endpoints.md index 3485d0f32..f325aaafd 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-advertiser-dataprovider-endpoints.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-advertiser-dataprovider-endpoints.md @@ -10,82 +10,82 @@ displayed_sidebar: sidebarAdvertisers import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Advertiser/Data Provider Integration to HTTP Endpoints +# Advertiser/data provider integration to HTTP endpoints このガイドでは、広告主やデータプロバイダーが UID2 HTTP エンドポイントを呼び出すコードを記述して、SDK、Snowflake、Databricks、または AWS Entity Resolution などの他の実装オプションを使用するのではなく、UID2 とインテグレーションする手順について説明します。 :::tip -広告主及びデータプロバイダー向けのインテグレーションオプションと手順の概要は、[Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md) を参照してください。 +広告主及びデータプロバイダー向けのインテグレーションオプションと手順の概要は、[Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md) を参照してください。 ::: -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。まだアカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページに記載されている手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。まだアカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページに記載されている手順に従ってください。 -初期アカウント設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための指示とリンクが送信されます。ここで、[credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を構成できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +初期アカウント設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための指示とリンクが送信されます。ここで、[credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を構成できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -UID2 Portal の [API Keys](../portal/api-keys.md) ページで、次の値を設定する必要があります: +UID2 Portal の [API keys](../portal/api-keys.md) ページで、次の値を設定する必要があります: - API Key (Client Key とも呼ばれます) - Client Secret (参加者と UID2 Service のみが知る値です) :::important -これらの値を安全に保管することが非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 +これらの値を安全に保管することが非常に重要です。詳細は、[Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 ::: -## Preparing DII for Processing +## Preparing DII for processing -## High-Level Steps +## High-level steps UID2 とインテグレーションするための広告主やデータプロバイダー向けの手順は、以下のとおりです: -1. [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) +1. [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) -2. [Store Raw UID2s and Refresh Timestamps](#2-store-raw-uid2s-and-refresh-timestamps) +2. [Store raw UID2s and refresh timestamps](#2-store-raw-uid2s-and-refresh-timestamps) -3. [Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s) +3. [Manipulate or combine raw UID2s](#3-manipulate-or-combine-raw-uid2s) -4. [Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) +4. [Send stored raw UID2s to DSPs to create audiences or conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) -5. [Monitor for Raw UID2 Refresh](#5-monitor-for-raw-uid2-refresh) +5. [Monitor for raw UID2 refresh](#5-monitor-for-raw-uid2-refresh) -6. [Monitor for Opt-Out Status](#6-monitor-for-opt-out-status) +6. [Monitor for opt-out status](#6-monitor-for-opt-out-status) -## Integration Diagram +## Integration diagram 次の図は、オーディエンスの構築とターゲティングのために、DII を raw UID2 にマッピングするためにデータ収集者が行わなければならない手順です。 DII は、ユーザーの正規化されたメールアドレスまたは電話番号、または正規化および SHA-256 ハッシュ化されたメールアドレスまたは電話番号を指します。 -![Advertiser Flow](images/advertiser-flow-endpoints-mermaid-v3.png) +![Advertiser flow](images/advertiser-flow-endpoints-mermaid-v3.png) -### 1: Generate Raw UID2s from DII +### 1: Generate raw UID2s from DII | Step | Endpoint | Description | | --- | --- | --- | | 1-a | [POST /identity/map](../endpoints/post-identity-map.md) request | DII を含むリクエストを Identity Map エンドポイントに送信します。 | -| 1-b | [POST /identity/map](../endpoints/post-identity-map.md) response | レスポンスで返される raw UID2 (`u` フィールド) は、関連する DSP でオーディエンスをターゲティングするために使用できます。
レスポンスは、ユーザーの raw UID2 (`u`)、リフレッシュタイムスタンプ (`r`)、およびオプションで、現在の UID2 が過去 90 日以内にローテーションされた場合の以前の raw UID2 (`p`) を返します。リフレッシュタイムスタンプを使用して、UID2 を更新するタイミングを判断します。詳細は、[5: Monitor for Raw UID2 Refresh](#5-monitor-for-raw-uid2-refresh) を参照してください。 | +| 1-b | [POST /identity/map](../endpoints/post-identity-map.md) response | レスポンスで返される raw UID2 (`u` フィールド) は、関連する DSP でオーディエンスをターゲティングするために使用できます。
レスポンスは、ユーザーの raw UID2 (`u`)、リフレッシュタイムスタンプ (`r`)、およびオプションで、現在の UID2 が過去 90 日以内にローテーションされた場合の以前の raw UID2 (`p`) を返します。リフレッシュタイムスタンプを使用して、UID2 を更新するタイミングを判断します。詳細は、[5: Monitor for raw UID2 refresh](#5-monitor-for-raw-uid2-refresh) を参照してください。 | -### 2: Store Raw UID2s and Refresh Timestamps +### 2: Store raw UID2s and refresh timestamps -Step 1、[Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) のレスポンスには、マッピング情報が含まれています。以下の情報を保存することを推奨します: +Step 1、[Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) のレスポンスには、マッピング情報が含まれています。以下の情報を保存することを推奨します: - DII と raw UID2 (`u` フィールド) のマッピングをキャッシュします。 - raw UID2 がいつリフレッシュされるかを知るために、リフレッシュタイムスタンプ (`r` フィールド) を保存します。 - 過去 90 日以内にローテーションされた場合の以前の raw UID2 (`p` フィールド) をオプションで保存します。 -### 3: Manipulate or Combine Raw UID2s +### 3: Manipulate or combine raw UID2s Step 1 で受け取った UID2 を使用します。例えば、以下のような操作を行うことができます: - いくつかの操作を行います:たとえば、DII から生成した raw UID2 と、広告主やデータプロバイダーなどの別の参加者から受け取った raw UID2 を結合します。 - 新しい raw UID2 を既存のオーディエンスに追加します。 -### 4: Send Stored Raw UID2s to DSPs to Create Audiences or Conversions +### 4: Send stored raw UID2s to DSPs to create audiences or conversions raw UID2 は、以下のような目的で使用できます: @@ -96,7 +96,7 @@ raw UID2 は、以下のような目的で使用できます: API またはピクセルを介してコンバージョン情報を送信し、測定（アトリビューション）やリターゲティングに使用することもできます。 -### 5: Monitor for Raw UID2 Refresh +### 5: Monitor for raw UID2 refresh raw UID2 は、特定の時点でのユーザーの識別子です。特定のユーザーの raw UID2 は、UID2 リフレッシュプロセスの一環として、およそ 1 年に 1 回変更されます。 @@ -122,7 +122,7 @@ raw UID2 をリフレッシュする必要があるかを判断するには、 このアプローチにより、raw UID2 が最新の状態で、オーディエンスターゲティングや測定に有効であることが保証されます。 -### 6: Monitor for Opt-Out Status +### 6: Monitor for opt-out status ユーザーのオプトアウトステータスを受け入れることは重要です。定期的にオプトアウトステータスを監視し、最近オプトアウトしたユーザーの raw UID2 を引き続き使用しないようにすることが重要です。 @@ -132,12 +132,12 @@ UID2 Operator Service< - [POST /optout/status](../endpoints/post-optout-status.md) エンドポイントを使用して raw UID2 のオプトアウトステータスを確認します。 -UID2 のオプトアウト手順の詳細と、ユーザーがどのようにオプトアウトできるかは、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +UID2 のオプトアウト手順の詳細と、ユーザーがどのようにオプトアウトできるかは、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 -## Using POST /identity/map Version 2 +## Using POST /identity/map version 2 :::note -以下の情報は、`POST /identity/map` エンドポイントのバージョン 2 またはそれ以前を使用している場合にのみ関連し、参照用に提供されています。新しい実装では最新バージョンを使用する必要があります。手順は、[High-Level Steps](#high-level-steps) を参照してください。 +以下の情報は、`POST /identity/map` エンドポイントのバージョン 2 またはそれ以前を使用している場合にのみ関連し、参照用に提供されています。新しい実装では最新バージョンを使用する必要があります。手順は、[High-level steps](#high-level-steps) を参照してください。 ::: v2 Identity Map API の使用時との主な違いは以下の通りです: @@ -145,17 +145,17 @@ v2 Identity Map API の使用時との主な違いは以下の通りです: - **Step 2**: リフレッシュタイムスタンプの代わりにソルトバケット ID を保存します。 - **Step 5**: リフレッシュタイムスタンプの代わりにソルトバケットのローテーションを監視します。 -その他の Step (1, 3, 4, 6) は、v3 実装で説明されている内容と同じです: [High-Level Steps](#high-level-steps) を参照してください。 +その他の Step (1, 3, 4, 6) は、v3 実装で説明されている内容と同じです: [High-level steps](#high-level-steps) を参照してください。 -### Integration Diagram (v2) +### Integration diagram (v2) 次の図は、v2 インテグレーションフローを示しています。違いは Step 2（ソルトバケット ID の保存）と Step 5（ソルトバケットのローテーションの監視）です。 -![Advertiser Flow](images/advertiser-flow-endpoints-mermaid.png) +![Advertiser flow](images/advertiser-flow-endpoints-mermaid.png) -### Store Raw UID2s and Salt Bucket IDs (v2) +### Store raw UID2s and salt bucket ids (v2) :::note このステップは、v3 実装の Step 2 を置き換えます。 @@ -166,7 +166,7 @@ Step 1 のレスポンスには、マッピング情報が含まれています - DII (`identifier`)、raw UID2 (`advertising_id`)、およびソルトバケット (`bucket_id`) のマッピングをキャッシュします。 - レスポンスデータを受信した時刻のタイムスタンプを保存します。後で、このタイムスタンプを Step 5 で返される `last_updated` タイムスタンプと比較できます。 -### Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2) +### Monitor for salt bucket rotations for your stored raw UID2s (v2) :::note このステップは、v3 実装の Step 5 を置き換えます。 @@ -197,4 +197,4 @@ raw UID2 は、特定の時点におけるユーザーを識別する ID です - 同じ `bucket_id` の raw UID2 生成時のタイムスタンプ。これはステップ 1 で返され、ステップ 2 で保存されました。 -1. `last_updated` タイムスタンプが以前のタイムスタンプよりも新しい場合、ソルトバケットがローテーションされています。そのため、この `bucket_id` に関連付けられた raw UID2 を再生成する必要があります。Step 1 の [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) に従ってください。 +1. `last_updated` タイムスタンプが以前のタイムスタンプよりも新しい場合、ソルトバケットがローテーションされています。そのため、この `bucket_id` に関連付けられた raw UID2 を再生成する必要があります。Step 1 の [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) に従ってください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-advertiser-dataprovider-overview.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-advertiser-dataprovider-overview.md index aebf83cc5..3e54f571b 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-advertiser-dataprovider-overview.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-advertiser-dataprovider-overview.md @@ -10,11 +10,11 @@ displayed_sidebar: sidebarAdvertisers import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Advertiser/Data Provider Integration Overview +# Advertiser/data provider integration overview このガイドは、ユーザーデータを収集し、他の UID2 参加者に送信する組織向けのインテグレーションオプションの概要を提供します。データ収集者には、広告主、データオンボーダー、計測プロバイダー、ID グラフプロバイダー、サードパーティデータプロバイダー、およびその他のデータを他の参加者に送信する組織が含まれます。 -## Advertiser/Data Provider Routes to Use UID2 +## Advertiser/data provider routes to use UID2 アドテクノロジー業界では、広告主はアイデンティティを使用してオーディエンスを構築し、コンバージョンを追跡し、グラフを作成します。広告主として、または広告主に代わって行動するデータプロバイダーとして、以下の表は UID2 を使用してこれらの目標の一部を達成する方法の例を示しています。 @@ -28,44 +28,44 @@ UID2 は、これらのユースケース以外でも使用できます。これ | コンバージョンを送信 | コンバージョン情報として raw UID2 を送信 | コンバージョン情報を計測（アトリビューション）または API やピクセルを介してリターゲティングに使用します。 | | グラフデータを受信 | API またはピクセルを介してグラフ/データプロバイダーから raw UID2 を受信 | グラフデータを作成します。 | -## Preparing DII for Processing +## Preparing DII for processing -## High-Level Steps +## High-level steps UID2 とインテグレーションする広告主とデータプロバイダーのインテグレーション手順は、次のとおりです。 -1. [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) +1. [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) -2. [Store Raw UID2s and Refresh Timestamps](#2-store-raw-uid2s-and-refresh-timestamps) +2. [Store raw UID2s and refresh timestamps](#2-store-raw-uid2s-and-refresh-timestamps) -3. [Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s) +3. [Manipulate or combine raw UID2s](#3-manipulate-or-combine-raw-uid2s) -4. [Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) +4. [Send stored raw UID2s to DSPs to create audiences or conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) -5. [Monitor for Raw UID2 Refresh](#5-monitor-for-raw-uid2-refresh) +5. [Monitor for raw UID2 refresh](#5-monitor-for-raw-uid2-refresh) -6. [Monitor for Opt-Out Status](#6-monitor-for-opt-out-status) +6. [Monitor for opt-out status](#6-monitor-for-opt-out-status) :::note -[POST /identity/map](../endpoints/post-identity-map.md) エンドポイントのバージョン 3 より前のバージョンを使用している場合は、[Using POST /identity/map Version 2](#using-post-identitymap-version-2) を参照してください。このバージョンを使用している場合は、強化された機能を利用するためにできるだけ早くアップグレードすることを推奨します。 +[POST /identity/map](../endpoints/post-identity-map.md) エンドポイントのバージョン 3 より前のバージョンを使用している場合は、[Using POST /identity/map version 2](#using-post-identitymap-version-2) を参照してください。このバージョンを使用している場合は、強化された機能を利用するためにできるだけ早くアップグレードすることを推奨します。 ::: -## Summary of Implementation Options +## Summary of implementation options 以下の表は、広告主とデータプロバイダー向けの実装オプションを、各レベルのステップごとに示しています。一部のステップは、独自のカスタム実装の一部としてのみ管理されます。一部のステップは、利用可能な UID2 実装オプションの 1 つ以上によって管理できます。詳細は、各ステップのリンクをクリックしてください。 | High-Level Step | Implementation Options | | --- | --- | -| [1: Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) | DII を raw UID2 にマップするには、次のいずれかのオプションを利用します:
  • UID2 SDK のいずれか:
    • Python SDK: [Map DII to Raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s)
    • Java SDK: [Usage for Advertisers/Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers)
  • Snowflake: [Map DII](integration-snowflake.md#map-dii)
  • Databricks: [Map DII](integration-databricks.md#map-dii)
  • AWS Entity Resolution: [AWS Entity Resolution Integration Guide](integration-aws-entity-resolution.md)
  • HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md)
| -| [2: Store Raw UID2s and Refresh Timestamps](#2-store-raw-uid2s-and-refresh-timestamps) | カスタム（必要に応じて） | -| [3: Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s) | カスタム（必要に応じて） | -| [4: Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) | カスタム（必要に応じて） | -| [5: Monitor for Raw UID2 Refresh](#5-monitor-for-raw-uid2-refresh) | [POST /identity/map](../endpoints/post-identity-map.md) エンドポイントから返されるリフレッシュタイムスタンプ（`r` フィールド）を使用して、raw UID2 を更新するタイミングを判断します。 | -| [6: Monitor for Opt-Out Status](#6-monitor-for-opt-out-status) | [POST /optout/status](../endpoints/post-optout-status.md) エンドポイントへの API コール。 | +| [1: Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) | DII を raw UID2 にマップするには、次のいずれかのオプションを利用します:
  • UID2 SDK のいずれか:
    • Python SDK: [Map DII to raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s)
    • Java SDK: [Usage for advertisers/data providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers)
  • Snowflake: [Map DII](integration-snowflake.md#map-dii)
  • Databricks: [Map DII](integration-databricks.md#map-dii)
  • AWS Entity Resolution: [AWS Entity Resolution integration guide](integration-aws-entity-resolution.md)
  • HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md)
| +| [2: Store raw UID2s and refresh timestamps](#2-store-raw-uid2s-and-refresh-timestamps) | カスタム（必要に応じて） | +| [3: Manipulate or combine raw UID2s](#3-manipulate-or-combine-raw-uid2s) | カスタム（必要に応じて） | +| [4: Send stored raw UID2s to DSPs to create audiences or conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions) | カスタム（必要に応じて） | +| [5: Monitor for raw UID2 refresh](#5-monitor-for-raw-uid2-refresh) | [POST /identity/map](../endpoints/post-identity-map.md) エンドポイントから返されるリフレッシュタイムスタンプ（`r` フィールド）を使用して、raw UID2 を更新するタイミングを判断します。 | +| [6: Monitor for opt-out status](#6-monitor-for-opt-out-status) | [POST /optout/status](../endpoints/post-optout-status.md) エンドポイントへの API コール。 | -## Integration Diagram +## Integration diagram 以下の図は、データ収集者がオーディエンスの構築とターゲティングのために DII を raw UID2 にマッピングするために完了する必要があるステップを概説しています。 @@ -73,13 +73,13 @@ DII とは、ユーザーの正規化されたメールアドレスまたは電 UID2 ベースのオーディエンス情報を正確かつ最新の状態に保つには、これらのインテグレーションステップを毎日実行してください。 -![Advertiser Flow](images/advertiser-flow-overview-mermaid-v3.png) +![Advertiser flow](images/advertiser-flow-overview-mermaid-v3.png) 図の各部分の詳細は、以下のセクションを参照してください。 -### 1: Generate Raw UID2s from DII +### 1: Generate raw UID2s from DII Directly Identifying Information (DII) から raw UID2 を生成するか、データプロバイダーなどの他の UID2 参加者から UID2 を受信できます。 @@ -87,33 +87,33 @@ raw UID2 を生成するには、次のいずれかのオプションを使用 - UID2 SDK のいずれか: - - Python SDK: See [Map DII to Raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s). - - Java SDK: See [Usage for Advertisers/Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers). + - Python SDK: See [Map DII to raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s). + - Java SDK: See [Usage for advertisers/data providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers). - Snowflake: [Map DII](integration-snowflake.md#map-dii) を参照してください。 - Databricks: [Map DII](integration-databricks.md#map-dii) を参照してください。 -- AWS Entity Resolution: [AWS Entity Resolution Integration Guide](integration-aws-entity-resolution.md) を参照してください。 +- AWS Entity Resolution: [AWS Entity Resolution integration guide](integration-aws-entity-resolution.md) を参照してください。 -- HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md) を参照してください。詳細は、[Advertiser/Data Provider Integration to HTTP Endpoints](integration-advertiser-dataprovider-endpoints.md#1-generate-raw-uid2s-from-dii) を参照してください。 +- HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md) を参照してください。詳細は、[Advertiser/data provider integration to HTTP endpoints](integration-advertiser-dataprovider-endpoints.md#1-generate-raw-uid2s-from-dii) を参照してください。 -### 2: Store Raw UID2s and Refresh Timestamps +### 2: Store raw UID2s and refresh timestamps -Step 1 [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) のレスポンスには、マッピング情報が含まれています。Step 1 で返される以下の情報を保存することを推奨します: +Step 1 [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) のレスポンスには、マッピング情報が含まれています。Step 1 で返される以下の情報を保存することを推奨します: - DII と raw UID2 (`u` フィールド) のマッピングをキャッシュします。 - リフレッシュタイムスタンプ (`r` フィールド) を保存して、raw UID2 がいつリフレッシュされるかを把握します。 - オプションで、過去 90 日以内に UID2 がリフレッシュされたユーザーのために提供された場合は、前の raw UID2 (`p` フィールド) を保存します。 -### 3: Manipulate or Combine Raw UID2s +### 3: Manipulate or combine raw UID2s Step 1 で受け取った raw UID2 を使用します。たとえば、以下を行うことができます: - 何らかの操作を行う: たとえば、DII から生成した raw UID2 と、広告主やデータプロバイダーなどの他の参加者から受け取った raw UID2 を組み合わせます。 - 新しい raw UID2 を既存のオーディエンスに追加します。 -### 4: Send Stored Raw UID2s to DSPs to Create Audiences or Conversions +### 4: Send stored raw UID2s to DSPs to create audiences or conversions raw UID2 を次の目的で使用します: @@ -124,7 +124,7 @@ raw UID2 を次の目的で使用します: コンバージョン情報を API またはピクセルを介して送信して、測定 (アトリビューション) またはリターゲティングを行うこともできます。 -### 5: Monitor for Raw UID2 Refresh +### 5: Monitor for raw UID2 refresh raw UID2 は、特定の時点でのユーザーの識別子です。特定のユーザーの raw UID2 は、UID2 リフレッシュプロセスの一環として、約 1 年に 1 回変更されます。 @@ -140,7 +140,7 @@ raw UID2 は、更新タイムスタンプ以降の時間には変更されま このアプローチにより、raw UID2 が最新かつ有効であり、オーディエンスのターゲティングや測定に使用できることが保証されます。 -### 6: Monitor for Opt-Out Status +### 6: Monitor for opt-out status ユーザーのオプトアウトステータスを受け入れることは重要です。定期的にオプトアウトステータスを監視し、最近オプトアウトしたユーザーの raw UID2 を使用し続けないようにします。 @@ -150,12 +150,12 @@ UID2 Operator Service< - [POST /optout/status](../endpoints/post-optout-status.md) エンドポイントを使用して raw UID2 のオプトアウトステータスを確認します。 -UID2 オプトアウトワークフローの詳細や、ユーザーがオプトアウトする方法は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +UID2 オプトアウトワークフローの詳細や、ユーザーがオプトアウトする方法は、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 -## Using POST /identity/map Version 2 +## Using POST /identity/map version 2 :::note -以下の情報は、`POST /identity/map` エンドポイントの以前のバージョン 2 を使用するインテグレーションアプローチにのみ関連し、参照用に提供されています。新しい実装では最新バージョンを使用する必要があります: [High-Level Steps](#high-level-steps) を参照してください。 +以下の情報は、`POST /identity/map` エンドポイントの以前のバージョン 2 を使用するインテグレーションアプローチにのみ関連し、参照用に提供されています。新しい実装では最新バージョンを使用する必要があります: [High-level steps](#high-level-steps) を参照してください。 ::: Identity Map API のバージョン 2 を使用する場合の主な違いは次のとおりです: @@ -163,17 +163,17 @@ Identity Map API のバージョン 2 を使用する場合の主な違いは次 - **Step 2**: ソルトバケット ID を保存する代わりにリフレッシュタイムスタンプを保存します - **Step 5**: ソルトバケットのローテーションを監視する代わりにリフレッシュタイムスタンプを使用します -他のすべてのステップ (1, 3, 4, および 6) は、v3 実装で説明されているとおりです: [High-Level Steps](#high-level-steps) を参照してください。 +他のすべてのステップ (1, 3, 4, および 6) は、v3 実装で説明されているとおりです: [High-level steps](#high-level-steps) を参照してください。 -### Integration Diagram (v2) +### Integration diagram (v2) 以下の図は、v2 インテグレーションフローを概説しています。主な違いは、Step 2（ソルトバケット ID の保存）と Step 5（ソルトバケットのローテーションの監視）にあります。 -![Advertiser Flow](images/advertiser-flow-overview-mermaid.png) +![Advertiser flow](images/advertiser-flow-overview-mermaid.png) -### Store Raw UID2s and Salt Bucket IDs (v2) +### Store raw UID2s and salt bucket ids (v2) :::note このステップは、v3 実装の Step 2 を置き換えます。 @@ -184,7 +184,7 @@ Step 1 のレスポンスには、マッピング情報が含まれています - DII (`identifier`) と raw UID2 (`advertising_id`) とソルトバケット (`bucket_id`) のマッピングを保存します。 - レスポンスデータを受信したタイムスタンプを保存します。後で、このタイムスタンプを Step 5 で返される `last_updated` タイムスタンプと比較できます。 -### Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2) +### Monitor for salt bucket rotations for your stored raw UID2s (v2) :::note このステップは、v3 実装の Step 5 を置き換えます。 @@ -198,11 +198,11 @@ raw UID2 は特定の時点でのユーザーの識別子です。特定のユ ソルトバケットのローテーションを監視する手順は、以下のいずれかを参照してください: -- Python SDK: [Monitor Rotated Salt Buckets](../sdks/sdk-ref-python.md#monitor-rotated-salt-buckets) +- Python SDK: [Monitor rotated salt buckets](../sdks/sdk-ref-python.md#monitor-rotated-salt-buckets) -- Snowflake: [Monitor for Salt Bucket Rotation and Regenerate Raw UID2s](integration-snowflake-previous#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s) +- Snowflake: [Monitor for salt bucket rotation and regenerate raw UID2s](integration-snowflake-previous#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s) -- HTTP endpoints: [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s (v2)](integration-advertiser-dataprovider-endpoints.md#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2) +- HTTP endpoints: [Monitor for salt bucket rotations for your stored raw UID2s (v2)](integration-advertiser-dataprovider-endpoints.md#monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s-v2) @@ -220,8 +220,8 @@ AWS Entity Resolution では、ソルトバケットの監視を行う方法は - 同じ `bucket_id` の raw UID2 生成のタイムスタンプ。これは Step 1 で返され、Step 2 で保存したものです。 -1. `last_updated` タイムスタンプが、先ほど記録したタイムスタンプよりも新しい場合、ソルトバケットがローテーションされています。その結果、この `bucket_id` に関連付けられているすべての raw UID2 を、Step1 [Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii) に従って再生成する必要があります。 +1. `last_updated` タイムスタンプが、先ほど記録したタイムスタンプよりも新しい場合、ソルトバケットがローテーションされています。その結果、この `bucket_id` に関連付けられているすべての raw UID2 を、Step1 [Generate raw UID2s from DII](#1-generate-raw-uid2s-from-dii) に従って再生成する必要があります。 ## FAQs -UID2 フレームワークを使用する広告主とデータプロバイダー向けのよくある質問のリストは、[FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) を参照してください。 +UID2 フレームワークを使用する広告主とデータプロバイダー向けのよくある質問のリストは、[FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-aws-entity-resolution.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-aws-entity-resolution.md index e49eff681..6db1922ea 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-aws-entity-resolution.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-aws-entity-resolution.md @@ -11,7 +11,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# AWS Entity Resolution Integration Guide +# AWS Entity Resolution integration guide [AWS Entity Resolution](https://aws.amazon.com/entity-resolution/) は、Amazon Web Services が提供する ID ソリューションプロダクトで、AWS の顧客が UID2 フレームワークとインテグレーションすることを可能にします。このインテグレーションにより、UID2 Operator を直接呼び出したり、機密性の高いクライアント ID や秘密鍵の値を扱ったりすることなく、安全かつシームレスに UID2 を生成することができます。 @@ -24,7 +24,7 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai AWS Entity Resolution を使用して UID2 とインテグレーションに関するビデオプレゼンテーションとデモは、YouTube の [Getting Started with AWS Entity Resolution Integration with Unified ID 2.0](https://www.youtube.com/watch?v=ORbSsKMgVj8) を参照してください。 :::tip -広告主とデータプロバイダー向けのすべてのインテグレーションオプションと手順の概要は、[Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md) を参照してください。 +広告主とデータプロバイダー向けのすべてのインテグレーションオプションと手順の概要は、[Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md) を参照してください。 ::: ## Functionality @@ -35,22 +35,22 @@ AWS Entity Resolution を使用して UID2 とインテグレーションに関 | :--- | :--- | :--- | :--- | :--- | | No | No | No | No | Yes | -## Integration Summary +## Integration summary 次の表は、AWS Entity Resolution を使用して UID2 とインテグレーションする手順をまとめたものです。 | Step/Link | Details | | --- | --- | -| [Initial Setup Steps](#initial-setup-steps) | UID2 アカウント、AWS アカウントを作成し、リンクします:
  • [Create UID2 Account](#create-uid2-account)
  • [Create AWS Account](#create-aws-account)
  • [Subscribe to UID2 on AWS Data Exchange](#subscribe-to-uid2-on-aws-data-exchange)
| -| [Configure AWS Account](#configure-aws-account) | IAM ユーザー、データテーブル、データのスキーママッピングを設定します。 | -| [Create a Matching Workflow](#create-a-matching-workflow) | 入力場所、適用するマッチング手法、出力場所など、データをマッチングするためのワークフローを作成します。 | -| [Run the Matching Workflow](#run-the-matching-workflow) | 入力データを処理して raw UID2 を生成します。 | +| [Initial setup steps](#initial-setup-steps) | UID2 アカウント、AWS アカウントを作成し、リンクします:
  • [Create UID2 account](#create-uid2-account)
  • [Create AWS account](#create-aws-account)
  • [Subscribe to UID2 on AWS data exchange](#subscribe-to-uid2-on-aws-data-exchange)
| +| [Configure AWS account](#configure-aws-account) | IAM ユーザー、データテーブル、データのスキーママッピングを設定します。 | +| [Create a matching workflow](#create-a-matching-workflow) | 入力場所、適用するマッチング手法、出力場所など、データをマッチングするためのワークフローを作成します。 | +| [Run the matching workflow](#run-the-matching-workflow) | 入力データを処理して raw UID2 を生成します。 | -## Workflow Diagram +## Workflow diagram 以下の図は、サービスへの登録から設定ステップを経て raw UID2 を受け取るまでの、エンドツーエンドの UID2 プロセスを示しています。 -![AWS Entity Resolution Workflow](images/integration-aws-entity-resolution.png) +![AWS Entity Resolution workflow](images/integration-aws-entity-resolution.png) 次の表は、図に示されたステップを示しています。 @@ -74,44 +74,44 @@ AWS Entity Resolution を使用して UID2 とインテグレーションに関 | 16 | Amazon Data Exchange | raw UID2 を AWS Entity Resolution に返します。 | | 17 | AWS Entity Resolution | raw UID2 を含む出力レコードを S3 バケットに書き込みます。 | -## Preparing DII for Processing +## Preparing DII for processing -## Initial Setup Steps +## Initial setup steps 以下は、AWS Entity Resolution で UID2 インテグレーションを設定するための初期手順です: -- [Create AWS Account](#create-aws-account) -- [Create UID2 Account](#create-uid2-account) -- [Subscribe to UID2 on AWS Data Exchange](#subscribe-to-uid2-on-aws-data-exchange) +- [Create AWS account](#create-aws-account) +- [Create UID2 account](#create-uid2-account) +- [Subscribe to UID2 on AWS data exchange](#subscribe-to-uid2-on-aws-data-exchange) -### Create AWS Account +### Create AWS account AWS アカウントにサインアップするか、既存のアカウントを使用します。 詳細は AWS ドキュメントの [Getting started: Are you a first time AWS user?](https://docs.aws.amazon.com/accounts/latest/reference/welcome-first-time-user.html) を参照してください。 -### Create UID2 Account +### Create UID2 account -UID2 の連絡先に、あなたを UID2 参加者として登録するよう依頼します。依頼先がわからない場合は、[Contact Info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 +UID2 の連絡先に、あなたを UID2 参加者として登録するよう依頼します。依頼先がわからない場合は、[Contact info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 UID2 の連絡先に、Entity Resolution での UID2 インテグレーションに使用する AWS アカウント ID を送信してください。 -### Subscribe to UID2 on AWS Data Exchange +### Subscribe to UID2 on AWS data exchange AWS Data Exchange の [Unified ID 2.0 Identity Resolution](https://aws.amazon.com/marketplace/pp/prodview-66zqls7iqsm6o?sr=0-4&ref_=beagle&applicationId=AWSMPContessa#offers) ページにアクセスし、**Continue to Subscribe.** をクリックします。 -![AWS Data Exchange market place screenshot](images/integration-aws-entity-resolution-public-listing.png) +![AWS data exchange market place screenshot](images/integration-aws-entity-resolution-public-listing.png) 加入リクエストを受け取ると、UID2 チームは以下を行います: - サブスクリプションのリクエストを確認します。 -- リクエストを [Create UID2 Account](#create-uid2-account) で送信した AWS アカウント ID と照合します。 +- リクエストを [Create UID2 account](#create-uid2-account) で送信した AWS アカウント ID と照合します。 - リクエストを承認します。 -## Configure AWS Account +## Configure AWS account -UID2 の参加者は AWS の S3 バケットにデータを保存し、AWS Entity Resolution とインテグレーションします。AWS アカウントを作成したら([Create AWS Account](#create-aws-account) を参照してください。)、基本的な手順は以下の通りです。 +UID2 の参加者は AWS の S3 バケットにデータを保存し、AWS Entity Resolution とインテグレーションします。AWS アカウントを作成したら([Create AWS account](#create-aws-account) を参照してください。)、基本的な手順は以下の通りです。 :::note 詳細な手順は、AWSドキュメントの [Setting up AWS Entity Resolution](https://docs.aws.amazon.com/entityresolution/latest/userguide/setting-up.html) を参照してください。 @@ -133,7 +133,7 @@ UID2 の参加者は AWS の S3 バケットにデータを保存し、AWS Entit 5. データのスキーママッピングを作成します: AWS ドキュメントの [Creating a schema mapping](https://docs.aws.amazon.com/entityresolution/latest/userguide/create-schema-mapping.html) を参照してください。 -## Create a Matching Workflow +## Create a matching workflow 最初のアカウント作成とセットアップが完了したら、次のステップはデータのマッチングワークフローを作成することです。 @@ -184,7 +184,7 @@ UID2 は、UID2 生成のためにメールアドレスまたは電話番号の - 次に、**Partner services** で、**Unified ID2.0** を選択します。 - **Next** をクリックします。 - 先のステップ、[Subscribe to UID2 on AWS Data Exchange](#subscribe-to-uid2-on-aws-data-exchange) を完了していれば、**Approved** のメッセージが表示されます。 + 先のステップ、[Subscribe to UID2 on AWS data exchange](#subscribe-to-uid2-on-aws-data-exchange) を完了していれば、**Approved** のメッセージが表示されます。 3. データの出力先を定義します: - **Data Output Destination** には、出力データに使用する S3 バケットの URI を指定します。データフォーマットを選択します: Normalized または Original を選択します。 @@ -204,7 +204,7 @@ UID2 は、UID2 生成のためにメールアドレスまたは電話番号の 一致するワークフローが作成され、確認メッセージが表示されます。 -## Run the Matching Workflow +## Run the matching workflow 以下の手順に従って、マッチングワークフローを実行し、結果を表示します。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-ctv-guide.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-ctv-guide.md index ca516b70d..bf53d22c1 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-ctv-guide.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-ctv-guide.md @@ -13,64 +13,64 @@ import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; import SnptPrivateOperatorOption from '../snippets/_snpt-private-operator-option.mdx'; -# CTV Integration Guide +# CTV integration guide Connected TV (CTV) パブリッシャーであれば、UID2 とインテグレーションして、CTV アプリのコンテキストで RTB ビッドストリームに渡す ID トークンを生成およびリフレッシュする方法がいくつかあります。 -## Key Integration Steps +## Key integration steps UID2 とインテグレーションするには、次の 3 つの主要なステップを実装します: 1. UID2 Token を生成します。 1. UID2 Token を頻繁に更新または再生成し、トークンが最新の状態を維持するようにしてください。 - 詳細については、[Keeping the Token Current](../ref-info/ref-tokens.md#keeping-the-token-current) と [Recommended Token Refresh Frequency](../ref-info/ref-tokens.md#recommended-token-refresh-frequency) を参照してください。 + 詳細については、[Keeping the token current](../ref-info/ref-tokens.md#keeping-the-token-current) と [Recommended token refresh frequency](../ref-info/ref-tokens.md#recommended-token-refresh-frequency) を参照してください。 1. UID2 Token をビッドストリームに渡します。 -これらのステップをどのように実装するかを決定するには、[CTV Integration Options](#ctv-integration-options) から選択してください。 +これらのステップをどのように実装するかを決定するには、[CTV integration options](#ctv-integration-options) から選択してください。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Private Operator Option +## Private Operator option -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 のアカウントが必要です。まだアカウントを作成していない場合は、最初に [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 のアカウントが必要です。まだアカウントを作成していない場合は、最初に [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できる [UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。詳細は、[UID2 Portal での開始](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できる [UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。詳細は、[UID2 portal での開始](../portal/portal-getting-started.md) を参照してください。 設定する具体的な値は、[CTV integration options](#ctv-integration-options) で選択したオプションによって異なります: -- Client-Server または Server-Side の実装の場合、UID2 Portal の [API Keys](../portal/api-keys.md) ページで次の値を設定する必要があります: +- Client-Server または Server-Side の実装の場合、UID2 Portal の [API keys](../portal/api-keys.md) ページで次の値を設定する必要があります: - API Key、Client Key とも呼ばれます。 - Client Secret、参加者と UID2 Service のみが知る値です。 :::important - これらの値を安全に保管することは非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 + これらの値を安全に保管することは非常に重要です。詳細は、[Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 ::: -- Client-Side の実装には、UID2 Portal の [Client-Side Integration](../portal/client-side-integration.md) ページで次の値を設定する必要があります: - - Subscription ID と Public Key: [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 - - この SDK を使用するすべてのサイトの **domain names** のリスト: [Adding and Managing Root-Level Domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) を参照してください。 +- Client-Side の実装には、UID2 Portal の [Client-side integration](../portal/client-side-integration.md) ページで次の値を設定する必要があります: + - Subscription ID と Public Key: [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 + - この SDK を使用するすべてのサイトの **domain names** のリスト: [Adding and managing root-level domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) を参照してください。 - モバイルアプリ ID (適用される場合): [モバイルアプリ ID の追加と管理](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) を参照してください。 -## CTV Integration Options +## CTV integration options UID2 Token の生成とリフレッシュをどこで行うかに基づいて、最適なインテグレーションオプションを選択できます。以下の表に示すように、3 つのオプションがあります: | Option | Details | | :--- | :--- | -| [Client-Side Integration](#client-side-integration-for-ctv-apps) | トークンは Client-Side で生成され、リフレッシュされます。 | -| [Server-Side Integration](#server-side-integration-for-ctv-apps) | トークンは Server-Side で生成され、リフレッシュされます。 | -| [Client-Server Integration](#client-server-integration-for-ctv-apps) | トークンは Server-Side で生成され、Client-Side でリフレッシュされます。 | +| [Client-side integration](#client-side-integration-for-ctv-apps) | トークンは Client-Side で生成され、リフレッシュされます。 | +| [Server-side integration](#server-side-integration-for-ctv-apps) | トークンは Server-Side で生成され、リフレッシュされます。 | +| [Client-server integration](#client-server-integration-for-ctv-apps) | トークンは Server-Side で生成され、Client-Side でリフレッシュされます。 | -### Client-Side Integration for CTV Apps +### Client-side integration for CTV apps Client-Side オプションは、UID2 Token を完全に Client-Side で管理したいパブリッシャー向けです: @@ -79,16 +79,16 @@ Client-Side オプションは、UID2 Token を完全に Client-Side で管理 このセットアップでは、すべてのコード変更が CTV アプリ内で行う必要があります。 -この方法で実装するには、[UID2 Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) の手順に従ってください。 +この方法で実装するには、[UID2 client-side integration guide for mobile](integration-mobile-client-side.md) の手順に従ってください。 次の表は、対応するオペレーティングシステムと、関連するドキュメントリソースへのリンクを示しています。 | Operating System | Integration Guide | Link to SDK Guide | | :--- | :--- | :--- | -| [Apple tvOS](https://developer.apple.com/tvos/) | [UID2 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/) | [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md) | [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) | +| [Apple tvOS](https://developer.apple.com/tvos/) | [UID2 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/) | [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side.md) | [SDK for Android reference guide](../sdks/sdk-ref-android.md) | -### Server-Side Integration for CTV Apps +### Server-side integration for CTV apps Server-Side オプションは、UID2 Token を完全に Server-Side で管理したいパブリッシャー向けです: @@ -99,30 +99,30 @@ Server-Side オプションは、UID2 Token を完全に Server-Side で管理 この方法の利点の 1 つは、複数のプラットフォーム (Web / CTV / モバイル) に対処する場合、すべてを Server-Side で行うことで、プラットフォーム固有の作業を減らすことができることです。 -この方法で実装するには、[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) の手順に従ってください。 +この方法で実装するには、[Publisher integration guide, server-side](integration-publisher-server-side.md) の手順に従ってください。 Server-Side コードが Java または Python である場合、UID2 SDK のいずれかを使用して、UID2 への HTTP リクエストを行うことができます。自分でソースコードを書く代わりに、次のいずれかの SDK ガイドを参照してください: -- [SDK for Java Reference Guide: Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers) -- [SDK for Python Reference Guide: Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers) +- [SDK for Java reference guide: Usage for publishers](../sdks/sdk-ref-java.md#usage-for-publishers) +- [SDK for Python reference guide: Usage for publishers](../sdks/sdk-ref-python.md#usage-for-publishers) -### Client-Server Integration for CTV Apps +### Client-server integration for CTV apps このオプションは UID2 Token を Client-Server で管理したいパブリッシャー向けです: - トークンは Server-Side で生成されます。 - トークンは CTV アプリ内から必要に応じて Client-Side でリフレッシュされます。 -この方法で実装するには、[UID2 Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) の手順に従ってください。 +この方法で実装するには、[UID2 client-server integration guide for mobile](integration-mobile-client-server.md) の手順に従ってください。 次の表は、対応するオペレーティングシステムと、関連するドキュメントリソースへのリンクを示しています。 | Operating System | Integration Guide | Link to SDK Guide | | :--- | :--- | :--- | -| [Apple tvOS](https://developer.apple.com/tvos/) | [UID2 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/) | [UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md) | [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) | +| [Apple tvOS](https://developer.apple.com/tvos/) | [UID2 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/) | [UID2 client-server integration guide for mobile](../guides/integration-mobile-client-server.md) | [SDK for Android reference guide](../sdks/sdk-ref-android.md) | -## Best Practices +## Best practices CTV インテグレーションのベストプラクティスは次のとおりです: 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 ac956df90..5eba32ce3 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 @@ -11,18 +11,18 @@ 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 に変換したい広告主およびデータプロバイダーを対象としています。 -## Integration Overview +## Integration overview このソリューションでは、[Databricks Clean Rooms](https://docs.databricks.com/aws/en/clean-rooms/) 機能のインスタンスでデータを処理することにより、DII (Directly Identifying Information) を公開することなく、コンシューマー識別データを安全に共有できます。この機能は、機密データを扱うための、安全でプライバシーが保護された環境を提供します。 Databricks Clean Rooms 環境をセットアップしたら、UID2 サービスとの信頼関係を確立し、クリーンルームで共有したデータを raw UID2 に変換することを許可します。 @@ -35,7 +35,7 @@ Databricks Clean Rooms 環境をセットアップしたら、UID2 サービス | :--- | :--- | :--- | :--- | :--- | | — | — | — | — | ✅ | -## Key Benefits +## Key benefits UID2 処理に Databricks を統合する主なメリットは以下の通りです。 @@ -45,11 +45,11 @@ UID2 処理に Databricks を統合する主なメリットは以下の通りで - UID2 識別子と The Trade Desk アクティベーションエコシステム間の合理化されたインテグレーション。 - Databricks を通じたマーケターや広告主向けのセルフサービスサポート。 -## Preparing DII for Processing +## Preparing DII for processing -## Integration Steps +## Integration steps 概要レベルでは、Databricks インテグレーションをセットアップし、データを処理する手順は以下の通りです。 @@ -58,17 +58,17 @@ UID2 処理に Databricks を統合する主なメリットは以下の通りで 1. [クリーンルームにデータを追加する](#add-data-to-the-clean-room)。 1. クリーンルームのノートブックを実行して [DII をマッピングする](#map-dii)。 -### Create Clean Room for UID2 Collaboration +### Create clean room for UID2 collaboration 出発点として、Databricks Clean Rooms 環境（UID2 とコラボレーションしてデータを処理するための安全な環境）を作成します。 -Databricks ドキュメントの [Create clean rooms](https://docs.databricks.com/aws/en/clean-rooms/create-clean-room) の手順に従ってください。接続する [UID2 環境](../getting-started/gs-environments) に基づいて、正しい共有識別子を使用してください。[UID2 Sharing Identifiers](#uid2-sharing-identifiers) を参照してください。 +Databricks ドキュメントの [Create clean rooms](https://docs.databricks.com/aws/en/clean-rooms/create-clean-room) の手順に従ってください。接続する [UID2 環境](../getting-started/gs-environments) に基づいて、正しい共有識別子を使用してください。[UID2 sharing identifiers](#uid2-sharing-identifiers) を参照してください。 :::important クリーンルームを作成した後は、コラボレーターを変更することはできません。Databricks Python SDK を使用してクリーンルームを作成する場合など、クリーンルームのコラボレーターのエイリアスを設定するオプションがある場合、自身のコラボレーターエイリアスは `creator`、UID2 コラボレーターエイリアスは `collaborator` である必要があります。Databricks Web UI を使用してクリーンルームを作成する場合は、正しいコラボレーターエイリアスが自動的に設定されます。 ::: -### Send Sharing Identifier to UID2 Contact +### Send sharing identifier to UID2 contact クリーンルームのノートブックを使用する前に、Databricks 共有識別子を UID2 担当者に送信する必要があります。 @@ -78,30 +78,30 @@ Databricks ドキュメントの [Create clean rooms](https://docs.databricks.co 1. クリーンルームで作業する Databricks ワークスペースにアタッチされている Unity Catalog メタストアの共有識別子を見つけます。 - この値を見つける方法については、[Finding a Sharing Identifier](#finding-a-sharing-identifier) を参照してください。 + この値を見つける方法については、[Finding a sharing identifier](#finding-a-sharing-identifier) を参照してください。 1. 共有識別子を UID2 担当者に送信します。 -### Add Data to the Clean Room +### Add data to the clean room -1 つ以上のテーブルまたはビューをクリーンルームに追加します。スキーマ、テーブル、ビューの名前は任意です。テーブルとビューは、[Input Table](#input-table) で詳述されているスキーマに従う必要があります。 +1 つ以上のテーブルまたはビューをクリーンルームに追加します。スキーマ、テーブル、ビューの名前は任意です。テーブルとビューは、[Input table](#input-table) で詳述されているスキーマに従う必要があります。 ### Map DII Databricks Clean Rooms の `identity_map_v3` [ノートブック](https://docs.databricks.com/aws/en/notebooks/) を実行して、メールアドレス、電話番号、またはそれぞれのハッシュを raw UID2 にマッピングします。 -ノートブックの実行が成功すると、出力テーブルに raw UID2 が生成されます。詳細については、[Output Table](#output-table) を参照してください。 +ノートブックの実行が成功すると、出力テーブルに raw UID2 が生成されます。詳細については、[Output table](#output-table) を参照してください。 -## Running the Clean Rooms Notebook +## Running the clean rooms notebook このセクションでは、Databricks Clean Rooms 環境を使用して DII を raw UID2 に処理するための詳細を提供します。これには以下が含まれます。 -- [Notebook Parameters](#notebook-parameters) -- [Input Table](#input-table) -- [DII Format and Normalization](#dii-format-and-normalization) -- [Output Table](#output-table) -- [Output Table Schema](#output-table-schema) +- [Notebook parameters](#notebook-parameters) +- [Input table](#input-table) +- [DII format and normalization](#dii-format-and-normalization) +- [Output table](#output-table) +- [Output table schema](#output-table-schema) -### Notebook Parameters +### Notebook parameters `identity_map_v3` ノートブックを使用して、クリーンルームの `creator` カタログに追加した任意のテーブルまたはビュー内の DII をマッピングできます。 @@ -114,7 +114,7 @@ Databricks Clean Rooms の `identity_map_v3` [ノートブック](https://docs.d | `input_schema` | テーブルまたはビューを含むスキーマ。 | | `input_table` | マッピング対象の DII を含むテーブルまたはビューに指定した名前。 | -### Input Table +### Input table 入力テーブルまたはビューには、以下の表に示す 2 つのカラムが必要です。テーブルまたはビューに追加のカラムがあってもかまいませんが、ノートブックはこれら 2 つのカラムのみを使用し、他のカラムは使用しません。 @@ -123,20 +123,20 @@ Databricks Clean Rooms の `identity_map_v3` [ノートブック](https://docs.d | `INPUT` | string | マッピングする DII。 | | `INPUT_TYPE` | string | マッピングする DII のタイプ。許容値: `email`, `email_hash`, `phone`, `phone_hash`。 | -### DII Format and Normalization +### DII format and normalization 正規化の要件は、処理する DII のタイプによって異なり、以下の通りです。 -- **Email address**: ノートブックは、UID2 [Email Address Normalization](../getting-started/gs-normalization-encoding#email-address-normalization) ルールを使用してデータを自動的に正規化します。 -- **Phone number**: UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding#phone-number-normalization) ルールを使用して、ノートブックでマッピングする前に電話番号を正規化する必要があります。 +- **Email address**: ノートブックは、UID2 [Email address normalization](../getting-started/gs-normalization-encoding#email-address-normalization) ルールを使用してデータを自動的に正規化します。 +- **Phone number**: UID2 [Phone number normalization](../getting-started/gs-normalization-encoding#phone-number-normalization) ルールを使用して、ノートブックでマッピングする前に電話番号を正規化する必要があります。 -### Output Table +### Output table クリーンルームに出力カタログがある場合、マッピングされた DII は出力カタログ内のテーブルに書き込まれます。出力テーブルは 30 日間保存されます。 詳細については、Databricks ドキュメントの [Overview of output tables](https://docs.databricks.com/aws/en/clean-rooms/output-tables#overview-of-output-tables) を参照してください。 -### Output Table Schema +### Output table schema 以下の表は、フィールド名や値など、出力データの構造に関する情報を示しています。 @@ -145,13 +145,13 @@ Databricks Clean Rooms の `identity_map_v3` [ノートブック](https://docs.d | `UID` | string | 値は以下のいずれかです。
  • **DII が正常にマッピングされた場合**: DII に関連付けられた UID2。
  • **それ以外の場合**: `NULL`。
| | `PREV_UID` | string | 値は以下のいずれかです。
  • **DII が正常にマッピングされ、現在の raw UID2 が過去 90 日以内にローテーションされた場合**: 以前の raw UID2。
  • **それ以外の場合**: `NULL`。
| | `REFRESH_FROM` | timestamp | 値は以下のいずれかです。
  • **DII が正常にマッピングされた場合**: この UID2 をリフレッシュすべき日時を示すタイムスタンプ。
  • **それ以外の場合**: `NULL`。
| -| `UNMAPPED` | string | 値は以下のいずれかです。
  • **DII が正常にマッピングされた場合**: `NULL`。
  • **それ以外の場合**: 識別子がマッピングされなかった理由。(`OPTOUT`, `INVALID IDENTIFIER`, または `INVALID INPUT TYPE`)。
    詳細については、[Values for the UNMAPPED Column](#values-for-the-unmapped-column) を参照してください。
| +| `UNMAPPED` | string | 値は以下のいずれかです。
  • **DII が正常にマッピングされた場合**: `NULL`。
  • **それ以外の場合**: 識別子がマッピングされなかった理由。(`OPTOUT`, `INVALID IDENTIFIER`, または `INVALID INPUT TYPE`)。
    詳細については、[Values for the unmapped column](#values-for-the-unmapped-column) を参照してください。
| :::note raw UID2 は、リフレッシュのタイムスタンプより前には変更されません。リフレッシュのタイムスタンプ以降に DII を再マッピングすると、新しいリフレッシュのタイムスタンプが返されますが、raw UID2 は変更される場合と変更されない場合があります。raw UID2 は、複数のリフレッシュ間隔にわたって変更されない可能性があります。 ::: -#### Values for the UNMAPPED Column +#### Values for the unmapped column 以下の表は、出力テーブルスキーマの `UNMAPPED` カラムに設定可能な値を示しています。 @@ -162,7 +162,7 @@ raw UID2 は、リフレッシュのタイムスタンプより前には変更 | `INVALID IDENTIFIER` | メールアドレスまたは電話番号が無効です。 | | `INVALID INPUT TYPE` | `INPUT_TYPE` の値が無効です。`INPUT_TYPE` の有効な値は、`email`, `email_hash`, `phone`, `phone_hash` です。 | -## Testing in the Integ Environment +## Testing in the integ environment UID2 POC に署名する前に Databricks Clean Rooms の実装をテストしたい場合は、UID2 担当者にインテグレーション (integ) 環境へのアクセスを依頼できます。この環境はテスト専用であり、本番データは含まれません。 @@ -172,7 +172,7 @@ UID2 POC に署名する前に Databricks Clean Rooms の実装をテストし - インテグレーション環境用の UID2 共有識別子を使用して、クリーンルームを作成する。 - アセットをクリーンルームに配置する。 -詳細については、[Integration Steps](#integration-steps) を参照してください。 +詳細については、[Integration steps](#integration-steps) を参照してください。 アクセスの準備ができると、UID2 担当者から通知があります。 @@ -180,10 +180,10 @@ UID2 POC に署名する前に Databricks Clean Rooms の実装をテストし このセクションには、以下の参照情報が含まれています。 -- [UID2 Sharing Identifiers](#uid2-sharing-identifiers) -- [Finding a Sharing Identifier](#finding-a-sharing-identifier) +- [UID2 sharing identifiers](#uid2-sharing-identifiers) +- [Finding a sharing identifier](#finding-a-sharing-identifier) -### UID2 Sharing Identifiers +### UID2 sharing identifiers UID2 共有識別子は変更される可能性があります。新しいクリーンルームを作成する前に、このセクションを確認して最新の共有識別子を入手してください。 @@ -192,7 +192,7 @@ UID2 共有識別子は変更される可能性があります。新しいクリ | 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` | -### Finding a Sharing Identifier +### Finding a sharing identifier UID2 担当者向けの共有識別子を見つけるには、以下の手順に従ってください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-dsp-no-sdk.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-dsp-no-sdk.md index f0b7faa3c..fdefcca76 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-dsp-no-sdk.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-dsp-no-sdk.md @@ -9,7 +9,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# DSP Direct Integration Instructions +# DSP direct integration instructions このドキュメントは、既存の UID2 SDK でサポートされていないプログラミング言語を使用していて、UID2 とインテグレーションを行いたい DSP 向けの手順を提供します。 @@ -27,7 +27,7 @@ DSP が、ターゲティング広告や入札の目的で復号化されたト このドキュメントでは、例として C# / .NET SDK の追加のコードセクションを参照します。 -## Retrieve/Refresh Encryption Keys +## Retrieve/refresh encryption keys UID2 Token を raw UID2 に復号化できるように、暗号化キーを取得またはリフレッシュするには、以下を行うコードを記述する必要があります: @@ -46,15 +46,15 @@ UID2 Token を raw UID2 に復号化できるように、暗号化キーを取 UID2 SDK for C# / .NET は `Refresh` 関数を使用します。詳細は、[BidstreamClient.cs, line 26](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/BidstreamClient.cs#L26) を参照してください。 -リクエストの暗号化とレスポンスの復号化を示す実装例については、[Encryption and Decryption Code Examples](../getting-started/gs-encryption-decryption.md#encryption-and-decryption-code-examples) を参照してください。 +リクエストの暗号化とレスポンスの復号化を示す実装例については、[Encryption and decryption code examples](../getting-started/gs-encryption-decryption.md#encryption-and-decryption-code-examples) を参照してください。 復号化された API レスポンスは JSON 形式で、`site_data` (サイトに許可されたドメインまたはアプリ名のリスト) が含まれています。 すべてのフィールドがどのようにパースされるかを確認するには、UID2 SDK for C# / .NET の parse 関数を参照してください: [KeyParser.cs, lines 41-74](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/KeyParser.cs#L41-L74)。 -トークンを raw UID2 に復号化した後、トークンが Client-Side で生成された場合は、特定のドメインまたはアプリ名が許可された名前のリストにあることを確認するために、`site_data` の情報を使用する必要があります。詳細は、[Verify the Domain or App Name](#for-tokens-generated-on-the-client-side-verify-the-domain-or-app-name) を参照してください。 +トークンを raw UID2 に復号化した後、トークンが Client-Side で生成された場合は、特定のドメインまたはアプリ名が許可された名前のリストにあることを確認するために、`site_data` の情報を使用する必要があります。詳細は、[Verify the domain or app name](#for-tokens-generated-on-the-client-side-verify-the-domain-or-app-name) を参照してください。 -## Decrypt UID2 Tokens into Raw UID2s +## Decrypt UID2 tokens into raw UID2s 現在のキーがあれば、UID2 Token を raw UID2 に復号化できます。また、トークンがビッドストリームで使用可能であることを確認するために、いくつかの条件をチェックする必要があります。 @@ -69,29 +69,29 @@ UID2 SDK for C# / .NET は `Refresh` 関数を使用します。詳細は、[Bid UID2 SDK for C# / .NET は、これらのステップを実行するために `DecryptTokenIntoRawUid` 関数を使用します: [BidstreamClient.cs, line 15](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/BidstreamClient.cs#L15) を参照してください。 -### Decrypt the Token +### Decrypt the token マスターキーとサイトキーを使用してトークンを復号化します。コード例については、`Decrypt` 関数を参照してください: [UID2Encryption.cs, line 29](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/UID2Encryption.cs#L29)。この関数は UID2 SDK for C# / .NET の一部として、UID2 Token を raw UID2 に復号化します。 -### Make Sure Token Lifetime and Expiration Are Valid +### Make sure token lifetime and expiration are valid ビッドストリームで使用するためには、トークンが有効で最新である必要があります。次の 2 つのことを行う必要があります: @@ -107,7 +107,7 @@ For more information about client-side UID2 integration, refer to one of these i これがどのように行われるかの例については、`DoesTokenHaveValidLifetimeImpl` 関数のコードを確認してください: [UID2Encryption.cs, line 237](https://github.com/IABTechLab/uid2-client-net/blob/6ac53b106301e431a4aada3cbfbb93f8164ff7be/src/UID2.Client/UID2Encryption.cs#L237) を参照してください。 -#### Calculating Token Lifetime +#### Calculating token lifetime ビッドストリームの使用に対してトークンの寿命が有効であることを確認するための計算式は次のとおりです: @@ -119,7 +119,7 @@ time until token generation = token generated - current time トークンには **Token Generated** フィールドが含まれており、トークンがリフレッシュされると更新されるため、これを使用してトークンの寿命を計算します。 -### For Tokens Generated on the Client Side: Verify the Domain or App Name +### For tokens generated on the client side: Verify the domain or app name Client-Side で生成されたトークンの場合、トークンを復号化した後、ドメイン名またはアプリ名が有効であることを確認する必要があります。これを行うには、`/v2/key/bidstream` API エンドポイントからのレスポンスの `site_data` セクション内のサイト ID の `domain_names` リストに `domainOrAppName` の値が含まれていることを確認します。 @@ -127,12 +127,12 @@ Client-Side で生成されたトークンの場合、トークンを復号化 Client-Side UID2 インテグレーションの詳細は、以下のインテグレーションガイドのいずれかを参照してください: -- [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) -- [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) -- [UID2 Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) +- [Client-side integration guide for JavaScript](integration-javascript-client-side.md) +- [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) +- [UID2 client-side integration guide for mobile](integration-mobile-client-side.md) -## Honor User Opt-Out After Token Decryption +## Honor user opt-out after token decryption トークンを復号化した後、結果の raw UID2 をオプトアウトレコードと照合する必要があります。オプトアウトレコードにある場合は、入札に UID2 を使用しないなど、ユーザーのオプトアウト設定を尊重する必要があります。 -詳細については、*DSP Integration Guide* の [Honor User Opt-Outs](dsp-guide.md#honor-user-opt-outs) を参照してください。 +詳細については、*DSP Integration Guide* の [Honor user opt-outs](dsp-guide.md#honor-user-opt-outs) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-google-ss.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-google-ss.md index 05c3fba4d..08812070a 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-google-ss.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-google-ss.md @@ -12,12 +12,12 @@ import Link from '@docusaurus/Link'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Google Ad Manager Secure Signals Integration Guide +# Google Ad Manager Secure Signals integration guide このガイドでは、UID2 を Google Ad Manager のセキュアシグナル機能 (旧称: Encrypted Signals for Publishers、ESP) で使用するパブリッシャー向けのインテグレーション手順について説明します。 :::note -UID2 Google Ad Manager セキュアシグナルインテグレーションを使用するには、SDK を使用している場合、UID2 インテグレーションがすでに設定されている必要があります。サーバーのみのインテグレーションを使用している場合は、この限りではありません。使用可能なすべてのインテグレーションオプションの概要は、[UID2 Integration Guides: Summary](summary-guides.md) を参照してください。 +UID2 Google Ad Manager セキュアシグナルインテグレーションを使用するには、SDK を使用している場合、UID2 インテグレーションがすでに設定されている必要があります。サーバーのみのインテグレーションを使用している場合は、この限りではありません。使用可能なすべてのインテグレーションオプションの概要は、[UID2 integration guides: Summary](summary-guides.md) を参照してください。 ::: ## Overview @@ -30,27 +30,27 @@ Google secure signals は、パブリッシャーが [Google Ad Manager](https:/ 2. セキュアシグナル機能は、Client-Side でそれらをキャッシュし、Google Ad Manager に透過的に渡します。 3. Google Ad Manager は UID2 Token を使ってビッドリクエストを行い、パブリッシャーの設定に基づき Google AdX 内の承認済み入札者にトークンを転送します。 -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、提供する必要がある追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、提供する必要がある追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -設定する値は、選択した [Publisher Integration Options](#publisher-integration-options) によって異なります: +設定する値は、選択した [Publisher integration options](#publisher-integration-options) によって異なります: -- Client-Server または Server-Side の実装の場合、UID2 Portal の [API Keys](../portal/api-keys.md) ページで次の値を設定する必要があります: +- Client-Server または Server-Side の実装の場合、UID2 Portal の [API keys](../portal/api-keys.md) ページで次の値を設定する必要があります: - API Key、Client Key とも呼ばれます。 - Client Secret、参加者と UID2 Service のみが知っている値。 :::important - これらの値を安全に保管することが非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 + これらの値を安全に保管することが非常に重要です。詳細は、[Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 ::: -- Client-Side の実装の場合、UID2 Portal の [Client-Side Integration](../portal/client-side-integration.md) ページで次の値を設定する必要があります: - - Subscription ID と Public Key: [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 - - この SDK を使用するサイトの **domain names** のリスト: [Adding and Managing Root-Level Domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) を参照してください。 - - モバイルアプリ ID (適用される場合): [Adding and Managing Mobile App IDs](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) を参照してください。 +- Client-Side の実装の場合、UID2 Portal の [Client-side integration](../portal/client-side-integration.md) ページで次の値を設定する必要があります: + - Subscription ID と Public Key: [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 + - この SDK を使用するサイトの **domain names** のリスト: [Adding and managing root-level domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) を参照してください。 + - モバイルアプリ ID (適用される場合): [Adding and managing mobile app ids](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) を参照してください。 -## Allow Secure Signals Sharing +## Allow Secure Signals sharing Google Ad Manager アカウントで暗号化 UID2 Token を受け取るには、暗号化されたシグナルが Google Ad Manager アカウントで第三者の入札者と適切に共有されていることを確認する必要があります。 @@ -83,17 +83,17 @@ Prebid.js で Secure Signals を使用する場合は、UID2 が正しく処理 詳細は、Prebid ドキュメントの [ESP Configurations](https://docs.prebid.org/dev-docs/modules/userId.html#esp-configurations) を参照してください。 -Prebid.js とセキュアシグナルを用いたサンプル実装も利用可能です。詳細は[Sample Implementations](#sample-implementations)を 参照してください。 +Prebid.js とセキュアシグナルを用いたサンプル実装も利用可能です。詳細は[Sample implementations](#sample-implementations)を 参照してください。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Publisher Integration +## Publisher integration 暗号化されたシグナルがキャッシュされると、セキュアシグナル機能は、新しいシグナルを生成するためのハンドラを実行しません。このため、データキャプチャの前後にキャッシュをクリアする必要があります。 @@ -110,18 +110,18 @@ window.googletag.cmd.push(function () { }); ``` -## Publisher Integration Options +## Publisher integration options Google Secure Signals パブリッシャーインテグレーションには、UID2 との 3 つのインテグレーションオプションがあります: -- [Server-Side Integration](#server-side-integration) -- [SDK for JavaScript Client-Server Integration](#sdk-for-javascript-client-server-integration) -- [SDK for JavaScript Client-Side Integration](#sdk-for-javascript-client-side-integration) +- [Server-side integration](#server-side-integration) +- [SDK for JavaScript client-server integration](#sdk-for-javascript-client-server-integration) +- [SDK for JavaScript client-side integration](#sdk-for-javascript-client-side-integration) -### Server-Side Integration +### Server-side integration 暗号化されたシグナルを共有できるように、ホストされ、自動ロードされたセキュアシグナルスクリプトは `window.getUid2AdvertisingToken` 関数を非同期に呼び出し、そのレスポンスとして `advertising_token` を文字列として受け取れるようにしなければなりません。 -ID トークンがフレッシュであることを確認することが重要です。Server-Sideのインテグレーションでは、[POST /token/refresh](../endpoints/post-token-refresh.md) というエンドポイントを呼び出し、JSON レスポンスから新しい [Advertising Token](../endpoints/post-token-refresh.md#decrypted-json-response-format) を取得することが推奨されます。 +ID トークンがフレッシュであることを確認することが重要です。Server-Sideのインテグレーションでは、[POST /token/refresh](../endpoints/post-token-refresh.md) というエンドポイントを呼び出し、JSON レスポンスから新しい [Advertising token](../endpoints/post-token-refresh.md#decrypted-json-response-format) を取得することが推奨されます。 次のコードは、その例です。 @@ -133,31 +133,31 @@ window.getUid2AdvertisingToken = async () => { } ``` -詳細は、[Server-Only UID2 Integration Guide](integration-publisher-server-side.md) を参照してください。 +詳細は、[Server-only UID2 integration guide](integration-publisher-server-side.md) を参照してください。 -Server Only インテグレーションのためのサンプルアプリケーションも用意されています。[Sample Implementations](#sample-implementations) を参照してください。 +Server Only インテグレーションのためのサンプルアプリケーションも用意されています。[Sample implementations](#sample-implementations) を参照してください。 -### SDK for JavaScript Client-Server Integration +### SDK for JavaScript client-server integration Javascript SDK Version 3.0.0 以降を使用している場合、UID2 セキュアシグナルスクリプトは、SDK で提供されている `getAdvertisingTokenAsync` 関数を使用して新しい Advertising Token を取得し、そのトークンを Google Ad Manager にプッシュします。 このスクリプトは CDN でホストされており、GPT はセキュアシグナル機能で自動的にロードします。 -詳細は、[Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) を参照してください。 +詳細は、[Client-server integration guide for JavaScript](integration-javascript-client-server.md) を参照してください。 -JavaScript SDK を使用したインテグレーションのためのサンプルアプリケーションも用意されています。[Sample Implementations](#sample-implementations) を参照してください。 +JavaScript SDK を使用したインテグレーションのためのサンプルアプリケーションも用意されています。[Sample implementations](#sample-implementations) を参照してください。 -### SDK for JavaScript Client-Side Integration +### SDK for JavaScript client-side integration SDK for JavaScript バージョン 3.0.0 以降を使用している場合、UID2 セキュアシグナルスクリプトは、SDKで提供されている `getAdvertisingTokenAsync` 関数を使用して新しい Advertising Token を取得し、そのトークンを Google Ad Manager にプッシュします。 このスクリプトは CDN でホストされており、GPT はセキュアシグナル機能で自動的にロードします。 -詳しくは [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) を参照してください。 +詳しくは [Client-side integration guide for JavaScript](integration-javascript-client-side.md) を参照してください。 - + -## Sample Implementations +## Sample implementations Google Ad Manager のセキュアシグナル機能との連携方法は、以下のサンプルアプリケーションを参照してください: @@ -191,4 +191,4 @@ Google Ad Manager で Secure Signals を有効にした後、Google を介して UID2 が Google を介して渡されない場合は、セットアップ時に正しい **Web Signal Deployment Method** を選択したことを確認してください。 -詳細は、[Allow Secure Signals Sharing](#allow-secure-signals-sharing) の **Important** ノートを参照してください。 +詳細は、[Allow Secure Signals sharing](#allow-secure-signals-sharing) の **Important** ノートを参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript-client-server.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript-client-server.md index ae7f52af6..10c335d27 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript-client-server.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript-client-server.md @@ -13,75 +13,75 @@ import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; import SnptExampleClientServerSendUid2ToSdk from '../snippets/_snpt-example-client-server-send-uid2-to-sdk.mdx'; -# Client-Server Integration Guide for JavaScript +# Client-server integration guide for JavaScript このガイドは、Web アセットを持つパブリッシャー向けに、RTB ビッドストリーム で UID2 を使用して ID トークンを生成し、Server-Side で UID2 Token を生成してパブリッシャーの Web ページに渡し、JavaScript の UID2 SDK を使用して Client-Side でトークンをリフレッシュする方法を説明します。 これは、JavaScript インテグレーションステップが Client-Side であり、その他のステップが Server-Side であるため、Client-Server インテグレーションと呼ばれます。 -Client-Side の JavaScript の変更 **だけ** で UID2 とインテグレーションする場合は、[Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) を参照してください。 +Client-Side の JavaScript の変更 **だけ** で UID2 とインテグレーションする場合は、[Client-side integration guide for JavaScript](integration-javascript-client-side.md) を参照してください。 -SDK の技術的な詳細は [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照してください。 +SDK の技術的な詳細は [SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md) を参照してください。 ## Introduction このガイドでは、SDK を使用せずにインテグレーションを行う場合に考慮すべき基本的な手順を説明します。たとえば、ユーザー認証とデータ取得の実装方法、UID2 ID 情報の管理方法とターゲティング広告への使用方法、トークンのリフレッシュ方法、紛失した ID の処理方法、ユーザーのオプトアウトの処理方法などを決定する必要があります。 -ワークフロー図は、[Integration Steps](#integration-steps) を参照してください。また、[FAQ](#faqs) も参照してください。 +ワークフロー図は、[Integration steps](#integration-steps) を参照してください。また、[FAQ](#faqs) も参照してください。 -UID2 のオプトアウトワークフローとユーザーがオプトアウトする方法の詳細は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +UID2 のオプトアウトワークフローとユーザーがオプトアウトする方法の詳細は、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 -UID2 を使用してクライアントの ID を確立し、Advertising Token を取得するプロセスを容易にするために、このガイドで提供する Web インテグレーション手順は、JavaScript 用の UID2 SDK に依存しています。このガイドに記載されているインテグレーションステップと SDK の使用方法を示す実装例については、[Sample Implementation](#sample-implementation) を参照してください。 +UID2 を使用してクライアントの ID を確立し、Advertising Token を取得するプロセスを容易にするために、このガイドで提供する Web インテグレーション手順は、JavaScript 用の UID2 SDK に依存しています。このガイドに記載されているインテグレーションステップと SDK の使用方法を示す実装例については、[Sample implementation](#sample-implementation) を参照してください。 :::tip -ファーストパーティクッキーとローカルストレージの実装の詳細は 将来変更される可能性があります。潜在的な問題を回避するため、ID 管理には [SDK for JavaScript API Reference](../sdks/sdk-ref-javascript.md#api-reference) に記載されている機能を使用してください。 +ファーストパーティクッキーとローカルストレージの実装の詳細は 将来変更される可能性があります。潜在的な問題を回避するため、ID 管理には [SDK for JavaScript API reference](../sdks/sdk-ref-javascript.md#api-reference) に記載されている機能を使用してください。 ::: -SDK for JavaScript を使用しないパブリッシャーのインテグレーションシナリオは、[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) を参照してください。 +SDK for JavaScript を使用しないパブリッシャーのインテグレーションシナリオは、[Publisher integration guide, server-side](integration-publisher-server-side.md) を参照してください。 :::note -Google Ad Manager を使用していて、セキュアシグナル機能を使用したい場合は、まずこのガイドの手順に従った後、[Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) の追加手順に従ってください。 +Google Ad Manager を使用していて、セキュアシグナル機能を使用したい場合は、まずこのガイドの手順に従った後、[Google Ad Manager Secure Signals integration guide](integration-google-ss.md) の追加手順に従ってください。 ::: -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できる [UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できる [UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -Client-Server インテグレーションを行う場合は、UID2 Portal の [API Keys](../portal/api-keys.md) ページで以下の値を設定する必要があります: +Client-Server インテグレーションを行う場合は、UID2 Portal の [API keys](../portal/api-keys.md) ページで以下の値を設定する必要があります: - API Key、Client Key とも呼ばれます。 - Client Secret、参加者と UID2 Service のみが知る値です。 :::important -これらの値を安全に保管することは非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 +これらの値を安全に保管することは非常に重要です。詳細は、[Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 ::: -## Integration Steps +## Integration steps 以下の図は、ユーザーの UID2 Token をパブリッシャーと確立するために必要なステップと、UID2 Token が RTB ビッドストリームとどのようにインテグレーションされるかを説明しています。 -![Publisher Flow](images/integration-javascript-client-server-mermaid.png) +![Publisher flow](images/integration-javascript-client-server-mermaid.png) 以下のセクションでは、図中の各ステップについての詳細を説明します: 1. [Establish identity: capture user data](#establish-identity-capture-user-data) - 2. [Bid Using UID2 Tokens](#bid-using-uid2-tokens) - 3. [Refresh Tokens](#refresh-tokens) - 4. [Clear Identity: User Logout](#clear-identity-user-logout) + 2. [Bid using UID2 tokens](#bid-using-uid2-tokens) + 3. [Refresh tokens](#refresh-tokens) + 4. [Clear identity: User logout](#clear-identity-user-logout) -### Establish Identity: Capture User Data +### Establish identity: Capture user data Step 1-c でパブリッシャーがユーザーのメールアドレスまたは電話番号を検証した後、Server-Side で UID2 Token を生成する必要があります。次の表は、トークン生成ステップの詳細です。 @@ -92,19 +92,19 @@ Step 1-c でパブリッシャーがユーザーのメールアドレスまた | 1-f | SDK for JavaScript | Step 1-e で返された UID2 Token を、SDK の [init() 関数](../sdks/sdk-ref-javascript.md#initopts-object-void) の `identity` プロパティで SDK に送信し、以下に示すように [コールバック関数](../sdks/sdk-ref-javascript.md#callback-function) を指定します。このメカニズムにより、ユーザーがログアウトするまで、UID2 Token がターゲティング広告に利用できるようになります。| | 1-g | SDK for JavaScript | SDK から ID 更新を受け取り、ターゲティング広告を開始するために使用するコールバック関数を SDK に提供します。 | -#### Generating a UID2 Token on the Server +#### Generating a UID2 token on the server 最初のステップは、サーバーで UID2 Token を生成することです。 -手順や例は、[Server-Side Token Generation](../ref-info/ref-server-side-token-generation.md) を参照してください。 +手順や例は、[Server-side token generation](../ref-info/ref-server-side-token-generation.md) を参照してください。 -`Identity` レスポンスを SDK に渡す必要があります。[Sending the UID2 Token to the SDK](#sending-the-uid2-token-to-the-sdk) を参照してください。 +`Identity` レスポンスを SDK に渡す必要があります。[Sending the UID2 token to the SDK](#sending-the-uid2-token-to-the-sdk) を参照してください。 :::warning -セキュリティ上の理由から、トークン生成に使用される API Key と Client Secret は Server-Side で呼び出す必要があります。これらの値を Client-Side に保存しないでください。詳細は [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 +セキュリティ上の理由から、トークン生成に使用される API Key と Client Secret は Server-Side で呼び出す必要があります。これらの値を Client-Side に保存しないでください。詳細は [Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 ::: -#### Sending the UID2 Token to the SDK +#### Sending the UID2 token to the SDK 以下のコード例は、JavaScript と TypeScript でのステップ 1-f と 1-g の説明です。 @@ -116,7 +116,7 @@ SDK は、指定された [callback function](../sdks/sdk-ref-javascript.md#call コードの構造によっては、Step 1-f と 1-g のコールバックを 1 つのコールバック関数にまとめると便利かもしれません。 ::: -### Bid Using UID2 Tokens +### Bid using UID2 tokens 有効な ID のステータスと利用可能性に基づいて、SDK は以下を実行します: @@ -131,7 +131,7 @@ SDK は、指定された [callback function](../sdks/sdk-ref-javascript.md#call | 2-a | SDK for JavaScript | 以下に示すように、[getAdvertisingToken() 関数](../sdks/sdk-ref-javascript.md#getadvertisingtoken-string) を使用して、現在のユーザーの Advertising Token を取得します。| :::note -UID2 Token が SSP から DSP に送信されるとき、ビッドストリーム内でどのように見えるかの例は、[ビッドストリームで UID2 Token はどのように見えますか？](../getting-started/gs-faqs.md#what-does-a-uid2-token-look-like-in-the-bidstream) を参照してください。 +UID2 Token が SSP から DSP に送信されるとき、ビッドストリーム内でどのように見えるかの例は、[ビッドストリームで UID2 token はどのように見えますか？](../getting-started/gs-faqs.md#what-does-a-uid2-token-look-like-in-the-bidstream) を参照してください。 ::: ```html @@ -141,14 +141,14 @@ UID2 Token が SSP から DSP に送信されるとき、ビッドストリー ``` :::info -返された Advertising Token をどのように SSP に渡すかを検討する必要があります。`Prebid.js` ([UID2 Integration Overview for Prebid](integration-prebid.md) を参照) や Google Ad Manager Secure Signals ([Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) を参照) を使用するなど、Client-Side で UID2 を実装する他のいくつかのアプローチでは、実装に、返された Advertising Token の受け渡しを管理する関数が含まれています。SDK for JavaScript を使用している場合は、これを自分で管理する必要があります。 +返された Advertising Token をどのように SSP に渡すかを検討する必要があります。`Prebid.js` ([UID2 integration overview for Prebid](integration-prebid.md) を参照) や Google Ad Manager Secure Signals ([Google Ad Manager Secure Signals integration guide](integration-google-ss.md) を参照) を使用するなど、Client-Side で UID2 を実装する他のいくつかのアプローチでは、実装に、返された Advertising Token の受け渡しを管理する関数が含まれています。SDK for JavaScript を使用している場合は、これを自分で管理する必要があります。 ::: :::tip `__uid2.getAdvertisingToken()` を呼び出す代わりに、Step 1-g で設定したコールバックに渡された ID の `advertising_token` プロパティを使用することができます。このコールバックは ID が変更されるたびに呼び出されます。 ::: -### Refresh Tokens +### Refresh tokens 初期化の一環として、SDK は ID の [token auto-refresh](../sdks/sdk-ref-javascript.md#background-token-auto-refresh) を設定します。これは、ID 上のタイムスタンプ、または断続的なエラーによるリフレッシュの失敗によってバックグラウンドでトリガーされます。 @@ -158,7 +158,7 @@ UID2 Token が SSP から DSP に送信されるとき、ビッドストリー | 3-b | [SDK for JavaScript](../sdks/sdk-ref-javascript.md) | ユーザーがオプトアウトしていない場合、[POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントは、自動的に新しい ID トークンを返します。 | -### Clear Identity: User Logout +### Clear identity: User logout クライアントのライフサイクルは、ユーザーがパブリッシャーのサイト (UID2 ではなく) からログアウトすることを決定したときに完了します。これにより、クライアントの ID セッションが終了し、ファーストパーティクッキー情報がクリアされます。 @@ -174,7 +174,7 @@ UID2 Token が SSP から DSP に送信されるとき、ビッドストリー ``` -## Sample Implementation +## Sample implementation 実装例は、次の UID2 SDK インテグレーション例を参照してください。 @@ -183,4 +183,4 @@ UID2 Token が SSP から DSP に送信されるとき、ビッドストリー ## FAQs -パブリッシャー向けのよくある質問は、[FAQs for Publishers](../getting-started/gs-faqs.md#faqs-for-publishers) を参照してください。 +パブリッシャー向けのよくある質問は、[FAQs for publishers](../getting-started/gs-faqs.md#faqs-for-publishers) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript-client-side.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript-client-side.md index a55ae59a0..e1dac5a09 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript-client-side.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript-client-side.md @@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Client-Side Integration Guide for JavaScript +# Client-side integration guide for JavaScript このガイドは、ウェブサイト上で JavaScript による変更のみを使用して、最小限の工数で UID2 とインテグレーションし、UID2 Token (Advertising Token) を生成したいすべての参加者を対象としています。 @@ -22,16 +22,16 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai このアプローチは、以下の参加者タイプで使用されます: - **パブリッシャー**: 特に、UID2 Token をビッドストリームに送信したいパブリッシャー向けのワークフローです。 -- **広告主**および**データプロバイダー**: また、広告主やデータプロバイダーは、トラッキングピクセルに UID2 Token を追加するためにこれを使用します (詳細は [Tokenized Sharing in Pixels](sharing/sharing-tokenized-from-data-pixel.md) を参照)。 +- **広告主**および**データプロバイダー**: また、広告主やデータプロバイダーは、トラッキングピクセルに UID2 Token を追加するためにこれを使用します (詳細は [Tokenized sharing in pixels](sharing/sharing-tokenized-from-data-pixel.md) を参照)。 -このガイドは、Private Operator を利用したいパブリッシャーや、Server-Side でトークンを生成したいパブリッシャーには適用されません。これらのパブリッシャーは、[Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) を参照してください。 +このガイドは、Private Operator を利用したいパブリッシャーや、Server-Side でトークンを生成したいパブリッシャーには適用されません。これらのパブリッシャーは、[Client-server integration guide for JavaScript](integration-javascript-client-server.md) を参照してください。 -UID2 は JavaScript 用の SDK (詳細は [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照) を提供しており、以下の機能があります。 +UID2 は JavaScript 用の SDK (詳細は [SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md) を参照) を提供しており、以下の機能があります。 - UID2 Token の生成 - UID2 Token の自動リフレッシュ @@ -44,7 +44,7 @@ UID2 は JavaScript 用の SDK (詳細は [SDK for JavaScript Reference Guide](. 3. [Configure the SDK for JavaScript](#configure-the-sdk-for-javascript) 4. [Check that the token was successfully generated](#check-that-the-token-was-successfully-generated) -## SDK for JavaScript Version +## SDK for JavaScript version Client-Side でのトークン生成は、SDK バージョン 3.4.5 以降でサポートされています。 @@ -58,43 +58,43 @@ SDK のデバッグビルドを使用したい場合は、代わりに以下の - [https://cdn.integ.uidapi.com/uid2-sdk-4.0.1.js](https://cdn.integ.uidapi.com/uid2-sdk-4.0.1.js) -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。まだアカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。まだアカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) へのアクセス手順とリンクが送られます。ポータルでは本番環境用の [credentials](../getting-started/gs-credentials.md) (認証情報) を作成したり、必要な追加値を設定したりできます。詳細は [Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) へのアクセス手順とリンクが送られます。ポータルでは本番環境用の [credentials](../getting-started/gs-credentials.md) (認証情報) を作成したり、必要な追加値を設定したりできます。詳細は [Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -Client-Side インテグレーションを行うには、UID2 Portal の [Client-Side Integration](../portal/client-side-integration.md) ページで以下の値を設定する必要があります: +Client-Side インテグレーションを行うには、UID2 Portal の [Client-side integration](../portal/client-side-integration.md) ページで以下の値を設定する必要があります: -- Subscription ID と Public Key: [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 +- Subscription ID と Public Key: [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 -- この SDK を使用するサイトの **ドメイン名** のリスト: [Adding and Managing Root-Level Domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) を参照してください。 +- この SDK を使用するサイトの **ドメイン名** のリスト: [Adding and managing root-level domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) を参照してください。 -- モバイルアプリ ID (該当する場合): [Adding and Managing Mobile App IDs](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) を参照してください。 +- モバイルアプリ ID (該当する場合): [Adding and managing mobile app ids](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) を参照してください。 :::tip アカウント設定に必要なのはルートレベルのドメインのみです。例えば、example.com、shop.example.com、example.org で JavaScript 用 SDK を使用する場合、ドメイン名 example.com と example.org のみを指定する必要があります。 ::: -## Add SDK for JavaScript to Your Site +## Add SDK for JavaScript to your site 以下のコードスニペットは、ウェブサイトに追加する必要があるコードの概要です。また、SDK がトリガーする可能性のあるさまざまなイベントも示しています。 -より詳細なコードスニペットについては、[Example Integration Code and When to Pass DII to the UID2 SDK](#example-integration-code-and-when-to-pass-dii-to-the-uid2-sdk) を参照してください。 +より詳細なコードスニペットについては、[Example integration code and when to pass DII to the UID2 SDK](#example-integration-code-and-when-to-pass-dii-to-the-uid2-sdk) を参照してください。 -`UID2_JS_SDK_URL` の値については、[SDK for JavaScript Version](#sdk-for-javascript-version) を参照してください。 +`UID2_JS_SDK_URL` の値については、[SDK for JavaScript version](#sdk-for-javascript-version) を参照してください。 ```js @@ -127,11 +127,11 @@ window.__uid2.callbacks.push((eventType, payload) => { ``` -SDK の詳細については、[SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照してください。 +SDK の詳細については、[SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md) を参照してください。 -### Using the UID2 Integration Environment +### Using the UID2 integration environment -デフォルトでは、SDK は UID2 本番環境 `https://prod.uidapi.com` で動作するように設定されています。代わりに UID2 インテグレーション環境を使用したい場合 (認証情報については [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照)、init の呼び出しで以下の URL を指定してください: +デフォルトでは、SDK は UID2 本番環境 `https://prod.uidapi.com` で動作するように設定されています。代わりに UID2 インテグレーション環境を使用したい場合 (認証情報については [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照)、init の呼び出しで以下の URL を指定してください: ```js __uid2.init({ @@ -139,10 +139,10 @@ __uid2.init({ }); ``` :::note -UID2 インテグレーション環境のトークンは、ビッドストリーム に渡すには無効です。インテグレーション環境では、異なる **Subscription ID** と **Public Key** の値を使用します。各環境の認証情報の取得については、[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 +UID2 インテグレーション環境のトークンは、ビッドストリーム に渡すには無効です。インテグレーション環境では、異なる **Subscription ID** と **Public Key** の値を使用します。各環境の認証情報の取得については、[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 ::: -### Optional: Specifying the API Base URL to Reduce Latency +### Optional: Specifying the API base URL to reduce latency デフォルトでは、この SDK は米国の UID2 本番環境サーバーを呼び出します。 @@ -173,7 +173,7 @@ SDK を設定するには、アカウント設定時に受け取った **Public * `__uid2.setIdentityFromPhoneHash` :::important -`__uid2.setIdentityFromEmailHash` または `__uid2.setIdentityFromPhoneHash` の場合、`emailHash` または `PhoneHash` 引数は Base64 エンコードされた値である必要があります。詳細は [Email Address Hash Encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) および [Phone Number Hash Encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) を参照してください。 +`__uid2.setIdentityFromEmailHash` または `__uid2.setIdentityFromPhoneHash` の場合、`emailHash` または `PhoneHash` 引数は Base64 エンコードされた値である必要があります。詳細は [Email address hash encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) および [Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) を参照してください。 ::: 以下のセクションでは、各シナリオのコーディング例を示します。 @@ -183,9 +183,9 @@ SDK を設定するには、アカウント設定時に受け取った **Public - トークンをユーザーのブラウザに保存します。 - サイトがユーザーのブラウザで開かれている間、必要に応じてトークンを自動的にリフレッシュします。 -ユーザーの DII は、ハッシュ化済みまたは未ハッシュの状態で UID2 SDK に渡すことができます。未ハッシュの DII を渡した場合、UID2 SDK がハッシュ化を行います。すでにハッシュ化された DII を SDK に渡したい場合は、ハッシュ化の前に正規化を行う必要があります。詳細は [Normalization and Encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 +ユーザーの DII は、ハッシュ化済みまたは未ハッシュの状態で UID2 SDK に渡すことができます。未ハッシュの DII を渡した場合、UID2 SDK がハッシュ化を行います。すでにハッシュ化された DII を SDK に渡したい場合は、ハッシュ化の前に正規化を行う必要があります。詳細は [Normalization and encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 -## Format Examples for DII +## Format examples for DII SDK は、ハッシュ化された DII を UID2 Service に送信する前に暗号化します。 @@ -200,7 +200,7 @@ SDK は、ハッシュ化された DII を UID2 Service に送信する前に暗 SDK が複数回設定された場合、最新の設定値が使用されます。 -JavaScript でメールアドレスと電話番号のハッシュを生成する方法の例については、[Example Code: Hashing and Base64 Encoding](#example-code-hashing-and-base64-encoding) を参照してください。 +JavaScript でメールアドレスと電話番号のハッシュを生成する方法の例については、[Example code: Hashing and Base64 encoding](#example-code-hashing-and-base64-encoding) を参照してください。 @@ -238,7 +238,7 @@ await __uid2.setIdentityFromEmailHash( ``` このシナリオでは: -- **パブリッシャーはメールアドレスの正規化とハッシュ化を行う責任があります**。詳細は [Normalization and Encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 +- **パブリッシャーはメールアドレスの正規化とハッシュ化を行う責任があります**。詳細は [Normalization and encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 - UID2 SDK は、UID2 Service に送信する前にハッシュを暗号化します。 @@ -257,7 +257,7 @@ await __uid2.setIdentityFromPhone( ``` このシナリオでは: -- **パブリッシャーは電話番号を正規化する責任があります**。詳細は [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) を参照してください。 +- **パブリッシャーは電話番号を正規化する責任があります**。詳細は [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) を参照してください。 - UID2 SDK は、暗号化されたハッシュを UID2 Service に送信する前に電話番号をハッシュ化します。 @@ -276,13 +276,13 @@ await __uid2.setIdentityFromPhoneHash( ``` このシナリオでは: -- **パブリッシャーは電話番号の正規化、ハッシュ化、および Base64 エンコードを行う責任があります**。詳細は [Normalization and Encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 +- **パブリッシャーは電話番号の正規化、ハッシュ化、および Base64 エンコードを行う責任があります**。詳細は [Normalization and encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 - UID2 SDK は、UID2 Service に送信する前にハッシュを暗号化します。 -## Token Storage and Refresh +## Token storage and refresh [Configure the SDK for JavaScript](#configure-the-sdk-for-javascript) に記載されているメソッドのいずれかを正常に呼び出すと、Identity が生成され、`UID2-sdk-identity` というキーでローカルストレージに保存されます。SDK は UID2 Token を定期的にリフレッシュします。 @@ -290,16 +290,16 @@ await __uid2.setIdentityFromPhoneHash( ローカルストレージに保存されるオブジェクトの形式は予告なく変更される可能性があります。ローカルストレージ内のオブジェクトを直接読み取ったり更新したり**しない**ことを推奨します。 ::: -## Example Integration Code and When to Pass DII to the UID2 SDK +## Example integration code and when to pass DII to the UID2 SDK パブリッシャーであり、これが Identity のない最初のページロードである場合、トークン生成呼び出しを開始するには、DII を使用して `setIdentity` メソッドのいずれかを呼び出す必要があります。Identity が生成されると、SDK からの `IdentityUpdated` イベントを待つことで、ビッドストリームに送信する Advertising Token (UID2 Token) を利用できるようになります。例として、以下のコードスニペットで `advertising_token_to_use` の値がどのように設定されるかを確認してください。 場合によっては、ページロード時にユーザーの DII が利用できず、DII の取得にコストがかかることがあります。たとえば、DII を取得するために API コールが必要だったり、ユーザーに入力を求める必要があったりする場合です。 既存の使用可能またはリフレッシュ可能なトークンを確認することで、そのコストを回避できる可能性があります。これを行うには、 -ブール値を返す [__uid2.isLoginRequired](../sdks/sdk-ref-javascript#isloginrequired-boolean) を呼び出します。これが `true` を返す場合、UID2 SDK は既存のリソースで新しい Advertising Token を作成できず、まったく新しい UID2 Token を生成するために DII が必要であることを意味します。 +ブール値を返す [__UID2.isloginrequired](../sdks/sdk-ref-javascript#isloginrequired-boolean) を呼び出します。これが `true` を返す場合、UID2 SDK は既存のリソースで新しい Advertising Token を作成できず、まったく新しい UID2 Token を生成するために DII が必要であることを意味します。 -DII を提供しても、[__uid2.isLoginRequired](../sdks/sdk-ref-javascript#isloginrequired-boolean) が `false` を返す可能性があります。これは、ユーザーが UID2 からオプトアウトしている場合に発生します。JavaScript 用 UID2 SDK はユーザーのオプトアウトを尊重し、同じ DII で `setIdentity` メソッドを再度呼び出したとしても、UID2 Token を生成しません。任意で、そのような呼び出しを繰り返し行わないようにすることもできます。 +DII を提供しても、[__UID2.isloginrequired](../sdks/sdk-ref-javascript#isloginrequired-boolean) が `false` を返す可能性があります。これは、ユーザーが UID2 からオプトアウトしている場合に発生します。JavaScript 用 UID2 SDK はユーザーのオプトアウトを尊重し、同じ DII で `setIdentity` メソッドを再度呼び出したとしても、UID2 Token を生成しません。任意で、そのような呼び出しを繰り返し行わないようにすることもできます。 以下のコードスニペットは、これら 2 つのシナリオ（トークンなしで開始する場合と、既存の UID2 Token を再利用/リフレッシュする場合）で JavaScript 用 UID2 SDK とインテグレーションする方法を示しています。 @@ -376,17 +376,17 @@ window.__uid2.callbacks.push(async (eventType, payload) => { ``` -## Check that the Token Was Successfully Generated +## Check that the token was successfully generated トークンが正常に生成されたことを確認するには、ブラウザのデベロッパーツールを使用してローカルストレージ内のトークンを探します。 -![Publisher Workflow](images/TokenDebugger-uid2.png) +![Publisher workflow](images/TokenDebugger-uid2.png) トークンの生成に問題があった場合は、**Network** タブでリクエストを探してください。文字列 `client-generate` でフィルタリングしてリクエストを見つけることができます。リクエストが失敗した理由に関する情報は、レスポンスに含まれているはずです。 -![Publisher Workflow](images/NetworkTraffic.png) +![Publisher workflow](images/NetworkTraffic.png) -## Example Code: Hashing and Base64 Encoding +## Example code: Hashing and Base64 encoding 以下のコード例は、JavaScript でメールアドレスと電話番号のハッシュを生成する方法を示しています。 @@ -405,7 +405,7 @@ function bytesToBase64(bytes) { } ``` -## Sample Implementation +## Sample implementation JavaScript 用 UID2 SDK を使用した Client-Side インテグレーションの実装サンプルが利用可能です: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript.md index 0e4a94b74..c9a8e276b 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-javascript.md @@ -12,11 +12,11 @@ import Link from '@docusaurus/Link'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# UID2 Integration Overview for JavaScript +# UID2 integration overview for JavaScript このガイドは、UID2 とインテグレーションし、SDK for JavaScript を使ってUID2 Token (Advertising Token) を生成したいパブリッシャー向けのインテグレーションオプションの概要です。 -Prebid.js と追加 SDK オプションを含むすべてのウェブオプションの概要は、[Publisher Web Integration Overview](integration-options-publisher-web.md) を参照してください。 +Prebid.js と追加 SDK オプションを含むすべてのウェブオプションの概要は、[Publisher web integration overview](integration-options-publisher-web.md) を参照してください。 ## Introduction @@ -28,55 +28,55 @@ UID2 は、以下をサポートする JavaScript 用の SDK を提供してい さらに柔軟性を高めるため、UID2 は、Prebid インテグレーションなど、一部の機能や補完的な製品の代替方法も提供しています。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Client-Side or Client-Server Integration +## Client-side or client-server integration SDK for JavaScript を使って UID2 とインテグレーションするためのオプションを、次の表にまとめました。最適なオプションを選択してください。 | Scenario | Option | Integration Guide | | :--- | :--- | :--- | -| Client-Side で DII にアクセスでき、フロントエンド開発のみを行いたい。 | Client-Side integration | [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | -| Client-Server で DII にアクセスでき、Server-Side の開発が可能であるか、Private Operator を使用している。 | Client-Server integration | [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) | +| Client-Side で DII にアクセスでき、フロントエンド開発のみを行いたい。 | Client-Side integration | [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | +| Client-Server で DII にアクセスでき、Server-Side の開発が可能であるか、Private Operator を使用している。 | Client-Server integration | [Client-server integration guide for JavaScript](integration-javascript-client-server.md) | -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、最初に[Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、最初に[Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、提供する必要がある追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、提供する必要がある追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 UID2 Portal で行う手順は、実装が Client-Side、Client-Server、または Server-Side であるかによって異なります。各実装ガイドに具体的な手順が記載されています。 -## Generating the UID2 Token +## Generating the UID2 token DII へのアクセスに応じて、SDK for JavaScript を使用して UID2 Token を生成するには、Client-Side または Server-Side の2つの方法があります。 -[Client-Side or Client-Server Integration](#client-side-or-client-server-integration) の表から、どちらのオプションが最適かを判断し、該当するインテグレーションガイドに従ってください。 +[Client-side or client-server integration](#client-side-or-client-server-integration) の表から、どちらのオプションが最適かを判断し、該当するインテグレーションガイドに従ってください。 -## Refreshing the UID2 Token +## Refreshing the UID2 token SDK for JavaScript には、自動の トークンリフレッシュ 機能があります。 -## Storing the UID2 Token in the Browser +## Storing the UID2 token in the browser -Client-Side のオプションでは、ローカルストレージを使用してデータを保存します。Server-Side オプションはデフォルトでローカルストレージを使いますが、代わりにクッキーを使うこともできます。詳細は、*SDK for JavaScript Reference Guide* の [UID2 Storage Format](../sdks/sdk-ref-javascript.md#uid2-storage-format) を参照してください。 +Client-Side のオプションでは、ローカルストレージを使用してデータを保存します。Server-Side オプションはデフォルトでローカルストレージを使いますが、代わりにクッキーを使うこともできます。詳細は、*SDK for JavaScript Reference Guide* の [UID2 storage format](../sdks/sdk-ref-javascript.md#uid2-storage-format) を参照してください。 クッキーのサイズが大きくなる可能性があり、それが問題になるかもしれません。しかし、ローカルストレージがオプションでない場合、これは一つの可能なアプローチです。 -## Passing the UID2 Token to the Bidstream +## Passing the UID2 token to the bidstream JavaScript SDK は、UID2 Token の生成、更新、保存を管理しますが、トークンをビッドストリームに渡すことは管理しません。 -トークンは、Prebid.jsなどのオプションを使用してビッドストリームに渡すことができます。いくつかの提案は、*Publisher Web インテグレーション概要*の [Pass the UID2 Token Into the Bidstream](integration-options-publisher-web.md#pass-the-uid2-token-into-the-bidstream) を参照してください。 +トークンは、Prebid.jsなどのオプションを使用してビッドストリームに渡すことができます。いくつかの提案は、*Publisher Web インテグレーション概要*の [Pass the UID2 token into the bidstream](integration-options-publisher-web.md#pass-the-uid2-token-into-the-bidstream) を参照してください。 -## JavaScript Integration Overview: High-Level Steps +## JavaScript integration overview: High-level steps SDK for JavaScript を使って UID2 とインテグレーションするには、以下のステップを完了する必要があります: @@ -86,5 +86,5 @@ SDK for JavaScript を使って UID2 とインテグレーションするには 詳細な手順は、以下のインテグレーションガイドのいずれかを参照してください: -- [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) -- [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) +- [Client-side integration guide for JavaScript](integration-javascript-client-side.md) +- [Client-server integration guide for JavaScript](integration-javascript-client-server.md) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md index 809cc91e1..00961e033 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-liveramp-tips.md @@ -10,34 +10,34 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# LiveRamp Integration Tips +# LiveRamp integration tips LiveRamp Authenticated Traffic Solution (ATS) をすでに使用しているパブリッシャーは、そのインテグレーションを活用して、ビッドリクエストに渡す UID2 Token を生成できます。 LiveRamp ATS を使用して、UID2 Token を生成するには、LiveRamp の担当者に連絡し、以下のインテグレーションポイントを確認してください: -- [Enable RideAlong](#enable-uid2-as-an-interoperable-id) -- [Implement the Correct Hashing Methodology](#implement-the-uid2-hashing-methodology) -- [Set Envelope Refresh to 1800 Seconds](#set-envelope-refresh-to-1800-seconds) +- [Enable ridealong](#enable-uid2-as-an-interoperable-id) +- [Implement the correct hashing methodology](#implement-the-uid2-hashing-methodology) +- [Set envelope refresh to 1800 seconds](#set-envelope-refresh-to-1800-seconds) -## Enable UID2 as an Interoperable ID +## Enable UID2 as an interoperable ID LiveRamp の設定では、RideAlong が有効になっていることを確認する必要があります。RideAlong は、UID2 などの他の ID ソリューションが ATS エンベロープに識別子を埋め込むことを可能にする LiveRamp の機能です。RideAlong が有効になっていない場合、UID2 Token はエンベロープに追加されません。 この手順を完了するには、LiveRamp の担当者に連絡してください。 -## Implement the UID2 Hashing Methodology +## Implement the UID2 hashing methodology 有効な UID2 Token を ATS エンベロープに追加するには、パブリッシャーは平文のメールアドレスを提供し、SHA-256 ハッシング方法論を示すか、メールアドレスの SHA-256 ハッシュバージョンを直接 LiveRamp ライブラリに提供する必要があります。 UID2 と LiveRamp の両方でサポートされている SHA-256 ハッシュ化方法論を使用する必要があります。他のハッシュ化方法論を使用したり、ステップを逃したりすると、ATS エンベロープに UID2 Token が追加されないか、無効なトークンが追加されます。 -詳細は、[Normalization and Encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 +詳細は、[Normalization and encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 -## Set Envelope Refresh to 1800 Seconds +## Set envelope refresh to 1800 seconds `Prebid.js` 内で `ATS.js` を有効にする場合は、`storage.refreshInSeconds` を **1800 秒** (30 分) に設定してください。 -## Troubleshooting Assistance +## Troubleshooting assistance 詳細情報や LiveRamp のトラブルシューティング支援は、[LiveRamp support page](https://docs.liveramp.com/connect/en/support.html) を参照してください。ヘルプリソースを確認するか、LiveRamp の担当者に連絡してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-client-server.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-client-server.md index d65b1db58..5d9a7d12e 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-client-server.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-client-server.md @@ -19,13 +19,13 @@ import SnptGMAIMA_Plugins from '../snippets/_snpt-mobile_docs_gmaima-plugin-gss. import SnptPrebidMobileSDK from '../snippets/_snpt-mobile_docs_prebid-mobile.mdx'; import SnptErrorResponseStates from '../snippets/_snpt-mobile-docs-error-response-states.mdx'; -# UID2 Client-Server Integration Guide for Mobile +# UID2 client-server integration guide for mobile このガイドは、Public Operator または Private Operator を介して Server-Side で UID2 Token を生成し、そのトークンとユーザー ID をモバイルアプリに渡して UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けです。モバイルアプリは、そのトークンを ビッドストリーム に使用するために渡します。 これは Client-Server インテグレーションと呼ばれます。これは、いくつかのインテグレーションステップがクライアントサイドで行われ、いくつかがサーバーサイドで行われるためです。 -Client-Side のみの変更で UID2 とインテグレーションしたい場合 (つまり、すべてのインテグレーション変更がモバイルアプリ内で行われる場合) は、代わりに [UID2 Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) を参照してください。 +Client-Side のみの変更で UID2 とインテグレーションしたい場合 (つまり、すべてのインテグレーション変更がモバイルアプリ内で行われる場合) は、代わりに [UID2 client-side integration guide for mobile](integration-mobile-client-side.md) を参照してください。 このページでは、インテグレーション手順の概要と、追加のドキュメントへのリンクを提供します。 @@ -38,64 +38,64 @@ UID2 は、[Android](../sdks/sdk-ref-android.md) および [iOS](../sdks/sdk-ref このガイドの、**UID2 mobile SDKs** は、SDK for Android と SDK for iOS の両方を含むグループ用語です。 ::: -モバイルパブリッシャーインテグレーションに関する FAQs は、[FAQs for Mobile Integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations) を参照してください。 +モバイルパブリッシャーインテグレーションに関する FAQs は、[FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations) を参照してください。 以下の手順を完了する必要があります: 1. [Complete the UID2 account setup and configure account](#complete-uid2-account-setup-and-configure-account). 2. [Implement server-side token generation](#implement-server-side-token-generation). -3. [Add the UID2 mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). -4. [Configure the UID2 mobile SDK](#configure-the-uid2-mobile-sdk). +3. [Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). +4. [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk). 5. [Check that the token was successfully generated and then pass it for bidstream use](#pass-generated-token-for-bidstream-use). -6. [Optionally, integrate the UID2 GMA/IMA Plugin for GAM Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration). +6. [Optionally, integrate the UID2 GMA/IMA plugin for gam Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration). -## Mobile SDK Version +## Mobile SDK version このガイドは、次のいずれかの UID2 mobile SDK を使用する方法について説明します: - SDK for Android (version 1.6.0 以降) - SDK for iOS (version 1.7.0 以降) -正しい SDK/バージョンをモバイルアプリにインストールする手順は、[Add the UID2 Mobile SDK to Your Mobile App](#add-the-uid2-mobile-sdk-to-your-mobile-app) を参照してください。 +正しい SDK/バージョンをモバイルアプリにインストールする手順は、[Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app) を参照してください。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -Client-Server インテグレーションには、UID2 Portal の [API Keys](../portal/api-keys.md) ページでこれらの値を設定する必要があります: +Client-Server インテグレーションには、UID2 Portal の [API keys](../portal/api-keys.md) ページでこれらの値を設定する必要があります: - API Key、Client Key とも呼ばれます - Client Secret、参加者と UID2 Service のみが知っている値 :::important -これらの値を安全に保管することが非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 +これらの値を安全に保管することが非常に重要です。詳細は、[Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 ::: -## Client-Server Mobile Integration Data Flow Overview +## Client-server mobile integration data flow overview 下記の図は、UID2 Client-Server モバイルインテグレーションを実装するためにパブリッシャーが実装する必要があるデータフローを示しています。 この例では、Client-Side のモバイルアプリで [SDK for Android](../sdks/sdk-ref-android.md) を使用し、Server-Side で [SDK for Java](../sdks/sdk-ref-java.md) を使用しています。 -![Mobile Client-Server Integration Example](images/integration-mobile-client-server-uid2.png) +![Mobile client-server integration example](images/integration-mobile-client-server-uid2.png) -## Implement Server-Side Token Generation +## Implement server-side token generation モバイル向けの Client-Server UID2 インテグレーションの場合、最初のステップは、サーバーで UID2 Token を生成できるようにすることです。その後、トークンをモバイルアプリに渡して RTB ビッドストリームに送信できます。 -手順や例は、[Server-Side Token Generation](../ref-info/ref-server-side-token-generation.md) を参照してください。 +手順や例は、[Server-side token generation](../ref-info/ref-server-side-token-generation.md) を参照してください。 `Identity` レスポンスをモバイルアプリに渡す必要があります: [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk) を参照してください。 @@ -103,7 +103,7 @@ Client-Server インテグレーションには、UID2 Portal の [API Keys](../ セキュリティ上の理由から、トークン生成に使用される API Key と Client Secret は Server-Side で呼び出す必要があります。これらの値をモバイルアプリ内に保存しないでください。 ::: -## Server-Side Token Refresh +## Server-side token refresh UID2 mobile SDK では トークンリフレッシュ が自動的に有効になっています。Server-Side で明示的に管理する必要はありません。 @@ -114,24 +114,24 @@ Token Refresh を Server-Side で管理し、クライアント/モバイルサ - [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントを呼び出します。 - UID2 Server-Side SDK のいずれかの Publisher Client クラスを使用します。これらのクラスは、リクエストを単一のメソッド呼び出しに簡素化します。 - 手順は、[SDK for Java, Usage for Publishers, Basic Usage Server-Side Integration section](../sdks/sdk-ref-java.md#basic-usage-server-side-integration) または [SDK for Python, Usage for Publishers, Server-Side Integration section](../sdks/sdk-ref-python.md#server-side-integration) を参照してください。 + 手順は、[SDK for Java, usage for publishers, basic usage server-side integration section](../sdks/sdk-ref-java.md#basic-usage-server-side-integration) または [SDK for Python, usage for publishers, server-side integration section](../sdks/sdk-ref-python.md#server-side-integration) を参照してください。 その後、このガイドの残りの部分に従って、新しくリフレッシュされた `Identity` 値をモバイルアプリに渡します。 -## Add the UID2 Mobile SDK to Your Mobile App +## Add the UID2 Mobile SDK to your mobile app インストール方法は、以下のいずれかを参照してください: -- [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) -- [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) +- [SDK for Android reference guide](../sdks/sdk-ref-android.md) +- [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) この時点で、Server-Side で生成された UID2 Identity をモバイル SDK で使用する準備が整いました。 -### Using the UID2 Integration Environment +### Using the UID2 integration environment デフォルトでは、この SDK は UID2 本番環境: `https://prod.uidapi.com` で動作するように構成されています。代わりに UID2 インテグレーション環境を使用する場合は、UID2Manager の初期化時に次の URL を指定してください。 -各環境の認証情報を取得する方法は、[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 +各環境の認証情報を取得する方法は、[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 @@ -162,7 +162,7 @@ UID2Settings.shared.uid2Environment = .custom( - 各環境（インテグレーションおよび本番）には異なる API Key と Client Secret の値があります。各環境で正しい値を使用してください。 ::: -### Optional: Specifying the API Base URL to Reduce Latency +### Optional: Specifying the API base URL to reduce latency デフォルトでは、この SDK は米国の UID2 本番環境サーバーにリクエストを送信します。 @@ -220,7 +220,7 @@ UID2Manager.shared.setIdentity() -## Token Storage +## Token storage `setIdentity` メソッドを呼び出すと、UID2 Identity がローカルファイルストレージに永続化されます。 @@ -228,7 +228,7 @@ UID2Manager.shared.setIdentity() ローカルファイルストレージに保存されたファイルの形式、またはファイル名自体が予告なく変更される可能性があります。ファイルを直接読み取ったり更新したりしないことを推奨します。 ::: -## Pass Generated Token for Bidstream Use +## Pass generated token for bidstream use トークンを取得するには、モバイルアプリで次のように呼び出します: @@ -263,12 +263,12 @@ UID2Manager への ID の追加が成功した場合、このメソッドは次 - **Android Java**: `UID2Manager.getInstance().getCurrentIdentityStatus()` - **Android Kotlin**: `UID2Manager.getInstance().currentIdentityStatus()` - **iOS**: `UID2Manager.shared.identityStatus` -- ロギングを有効 (`isLoggingEnabled` を `true` に設定する) にして詳細情報を取得します: [Enable Logging](#enable-logging) を参照してください。 +- ロギングを有効 (`isLoggingEnabled` を `true` に設定する) にして詳細情報を取得します: [Enable logging](#enable-logging) を参照してください。 - UID2 Identity 内の Advertising Token の有効期限が切れていて、Refresh Token も有効期限が切れているため、SDK がトークンをリフレッシュできません。 -Identity が無効の場合、[Implement Server-Side Token Generation](#implement-server-side-token-generation) に従って新しい Identity を生成し、その結果をモバイルアプリの UID2Manager に再度渡してください。 +Identity が無効の場合、[Implement server-side token generation](#implement-server-side-token-generation) に従って新しい Identity を生成し、その結果をモバイルアプリの UID2Manager に再度渡してください。 -## When to Pass a new UID2 Identity/Token into the SDK +## When to pass a new UID2 identity/token into the SDK UID2 SDK が新しい UID2 Identity を再度必要とするかどうかを判断するための最良の方法は、すべてのケースで `getAdvertisingToken()` メソッドを呼び出すことです: @@ -289,13 +289,13 @@ UID2Manager.shared.getAdvertisingToken() -アプリの起動/再開時に、`getAdvertisingToken()` が `null` を返す場合、[Implement Server-Side Token Generation](#implement-server-side-token-generation) の手順に従ってサーバーで、新しい Identity を生成してください。その後、モバイルアプリの UID2Manager に結果を再度渡してください: [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk) を参照してください。 +アプリの起動/再開時に、`getAdvertisingToken()` が `null` を返す場合、[Implement server-side token generation](#implement-server-side-token-generation) の手順に従ってサーバーで、新しい Identity を生成してください。その後、モバイルアプリの UID2Manager に結果を再度渡してください: [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk) を参照してください。 -## Enable Logging +## Enable logging -## Enable Automatic Token Refresh in Mobile App/Client Side +## Enable automatic token refresh in mobile app/client side デフォルトでは、有効な UID2 ID が UID2Manager に渡されると、自動的にトークンリフレッシュが実行されます。トークンリフレッシュが無効になっていた場合、次のメソッド呼び出しで有効にできます: @@ -324,11 +324,11 @@ UID2Manager.shared.automaticRefreshEnabled = false -## Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration +## Optional: UID2 GMA/IMA plugin for gam Secure Signals integration -## Optional: UID2 Integration with Prebid Mobile SDK +## Optional: UID2 integration with Prebid Mobile SDK :::important UID2 Prebid Mobile SDK インテグレーションは、UID2 SDK for Android version 1.6.0 または UID2 SDK for iOS version 1.7.0 が必要です。 @@ -338,6 +338,6 @@ Prebid Mobile SDK v3 を使用している場合は、UID2 SDK for Android ま -## Error Response States +## Error response states diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-client-side.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-client-side.md index ab2e18b08..0880aa51c 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-client-side.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-client-side.md @@ -19,11 +19,11 @@ import SnptGMAIMA_Plugins from '../snippets/_snpt-mobile_docs_gmaima-plugin-gss. import SnptPrebidMobileSDK from '../snippets/_snpt-mobile_docs_prebid-mobile.mdx'; import SnptErrorResponseStates from '../snippets/_snpt-mobile-docs-error-response-states.mdx'; -# UID2 Client-Side Integration Guide for Mobile +# UID2 client-side integration guide for mobile このガイドは、モバイルアプリのみの変更で UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けです。 -以下の手順は、Private Operator を使用したいパブリッシャーや、Server-Side でトークンを生成したいパブリッシャーには適用されません。これらのパブリッシャーは、[Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) に従う必要があります。 +以下の手順は、Private Operator を使用したいパブリッシャーや、Server-Side でトークンを生成したいパブリッシャーには適用されません。これらのパブリッシャーは、[Client-server integration guide for mobile](integration-mobile-client-server.md) に従う必要があります。 このページでは、インテグレーション手順の概要と、追加のドキュメントへのリンクを提供します。 @@ -36,30 +36,30 @@ UID2 は、[Android](../sdks/sdk-ref-android.md) および [iOS](../sdks/sdk-ref このガイドの、**UID2 mobile SDKs** は、SDK for Android と SDK for iOS の両方を含むグループ用語です。 ::: -モバイルパブリッシャーインテグレーションに関する FAQs は、[FAQs for Mobile Integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations) を参照してください。 +モバイルパブリッシャーインテグレーションに関する FAQs は、[FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations) を参照してください。 UID2 を Client-Side でインテグレーションするには、以下の手順を完了する必要があります: 1. [Complete the UID2 account setup and configure account](#complete-uid2-account-setup-and-configure-account). -1. [Add the UID2 mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). +1. [Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app). -1. [Configure the UID2 mobile SDK](#configure-the-uid2-mobile-sdk). +1. [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk). 1. [Check that the token was successfully generated and then pass it for bidstream use](#pass-generated-token-for-bidstream-use). -1. [Optionally, integrate the UID2 GMA/IMA Plugin for GAM Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration). +1. [Optionally, integrate the UID2 GMA/IMA plugin for gam Secure Signals integration](#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration). -## Mobile SDK Version +## Mobile SDK version このガイドは、次のいずれかの UID2 mobile SDK を使用する方法について説明します: - SDK for Android (version 1.6.0 以降) - SDK for iOS (version 1.7.0 以降) -正しい SDK/バージョンをモバイルアプリにインストールする手順は、[Add the UID2 Mobile SDK to Your Mobile App](#add-the-uid2-mobile-sdk-to-your-mobile-app) を参照してください。 +正しい SDK/バージョンをモバイルアプリにインストールする手順は、[Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app) を参照してください。 -## Client-Side Integration Example +## Client-side integration example UID2 mobile SDK の設定方法と、モバイル用の Client-Side インテグレーションを使用したトークンの生成方法の例は、UID2 開発アプリを試してください。 @@ -149,9 +149,9 @@ UID2Manager.shared.getAdvertisingToken() -このメソッドコールは、広告リクエストを行うために必要な値を返します: 詳細は [Pass Generated Token for Bidstream Use](#pass-generated-token-for-bidstream-use) を参照してください。 +このメソッドコールは、広告リクエストを行うために必要な値を返します: 詳細は [Pass generated token for bidstream use](#pass-generated-token-for-bidstream-use) を参照してください。 -### Testing With Your Own Configuration +### Testing with your own configuration デフォルトでは、開発アプリは Subscription ID と public key のデフォルト値を使用します。これらの値は、次のオブジェクトに保存されています: @@ -191,25 +191,25 @@ see UID2SDKDevelopmentApp/UID2SDKDevelopmentApp/Info.plist -必要に応じて、デフォルトの Subscription ID と public key を割り当てられた値に変更し、UID2 本番環境に接続することもできます。詳細は [Optional: Specifying the API Base URL to Reduce Latency](#optional-specifying-the-api-base-url-to-reduce-latency) を参照してください。 +必要に応じて、デフォルトの Subscription ID と public key を割り当てられた値に変更し、UID2 本番環境に接続することもできます。詳細は [Optional: Specifying the API base URL to reduce latency](#optional-specifying-the-api-base-url-to-reduce-latency) を参照してください。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -モバイル Client-Side インテグレーションには、UID2 Portal の [Client-Side Integration](../portal/client-side-integration.md) ページで以下の値を設定する必要があります: +モバイル Client-Side インテグレーションには、UID2 Portal の [Client-side integration](../portal/client-side-integration.md) ページで以下の値を設定する必要があります: -- Subscription ID と Public Key: [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 +- Subscription ID と Public Key: [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 - モバイルアプリ ID : 該当する以下の値のいずれか: @@ -217,24 +217,24 @@ UID2 とインテグレーションするには、UID2 アカウントが必要 - iOS Bundle Identifier - iOS App Store ID - 詳細は、[Adding and Managing Mobile App IDs](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) を参照してください。 + 詳細は、[Adding and managing mobile app ids](../portal/client-side-integration.md#adding-and-managing-mobile-app-ids) を参照してください。 -## Add the UID2 Mobile SDK to Your Mobile App +## Add the UID2 Mobile SDK to your mobile app Mobile SDK をアプリに追加するには、適用可能な以下のドキュメントに従ってください: -- [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) -- [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) +- [SDK for Android reference guide](../sdks/sdk-ref-android.md) +- [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) SDK をアプリに追加したら、SDK を使用して UID2 Token を生成する準備が整います。 -### Using the UID2 Integration Environment +### Using the UID2 integration environment -デフォルトでは、この SDK は UID2 本番環境: `https://prod.uidapi.com` で動作するように構成されています。UID2 インテグレーション環境を使用する場合は、(認証情報は [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照)、`UID2Manager` の初期化する際に次の URL を指定してください: +デフォルトでは、この SDK は UID2 本番環境: `https://prod.uidapi.com` で動作するように構成されています。UID2 インテグレーション環境を使用する場合は、(認証情報は [Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照)、`UID2Manager` の初期化する際に次の URL を指定してください: @@ -265,7 +265,7 @@ UID2Settings.shared.uid2Environment = .custom( - 各環境（インテグレーションおよび本番）には異なる API Key と Client Secret の値があります。各環境で正しい値を使用してください。 ::: -### Optional: Specifying the API Base URL to Reduce Latency +### Optional: Specifying the API base URL to reduce latency デフォルトでは、この SDK は米国の UID2 本番環境サーバーにリクエストを送信します。 @@ -348,10 +348,10 @@ UID2Manager.shared.generateIdentity( - アプリが開いている間、必要に応じてトークンを自動的にリフレッシュします。 :::tip -ユーザーの DII を UID2 mobile SDK に渡す際、ハッシュ化またはハッシュされていない DII を渡すことができます。DII をハッシュされていない状態で渡す場合、SDK がハッシュ化します。ハッシュ化された DII を SDK に渡す場合、ハッシュ化する前に正規化する必要があります。詳細は [Normalization and Encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 +ユーザーの DII を UID2 mobile SDK に渡す際、ハッシュ化またはハッシュされていない DII を渡すことができます。DII をハッシュされていない状態で渡す場合、SDK がハッシュ化します。ハッシュ化された DII を SDK に渡す場合、ハッシュ化する前に正規化する必要があります。詳細は [Normalization and encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 ::: -### Format Examples for DII +### Format examples for DII SDK は、ハッシュ化された DII を UID2 Service に送信する前に暗号化します。 @@ -463,7 +463,7 @@ Task { このシナリオでは: -- パブリッシャーはメールアドレスを正規化およびハッシュ化する責任があります。詳細は [Email Address Normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) を参照してください。 +- パブリッシャーはメールアドレスを正規化およびハッシュ化する責任があります。詳細は [Email address normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) を参照してください。 - UID2 mobile SDK は、ハッシュ化された DII を UID2 Service に送信する前に暗号化します。 @@ -515,7 +515,7 @@ Task { このシナリオでは: -- パブリッシャーは電話番号を正規化する責任があります。詳細は [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) を参照してください。 +- パブリッシャーは電話番号を正規化する責任があります。詳細は [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) を参照してください。 - UID2 mobile SDK は、ハッシュ化された電話番号を UID2 Service に送信する前に暗号化します。 @@ -563,21 +563,21 @@ Task { このシナリオでは: -- パブリッシャーは電話番号を正規化およびハッシュ化する責任があります。詳細は [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) を参照してください。 +- パブリッシャーは電話番号を正規化およびハッシュ化する責任があります。詳細は [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) を参照してください。 - UID2 mobile SDK は、ハッシュ化された DII を UID2 Service に送信する前に暗号化します。 -## Token Storage and Refresh +## Token storage and refresh -[Format Examples for DII](#format-examples-for-dii) に記載されている適用可能なメソッドを呼び出した後、Identity が生成され、ローカルファイルストレージに保存されます。UID2 mobile SDK は定期的に UID2 Token をリフレッシュします。 +[Format examples for DII](#format-examples-for-dii) に記載されている適用可能なメソッドを呼び出した後、Identity が生成され、ローカルファイルストレージに保存されます。UID2 mobile SDK は定期的に UID2 Token をリフレッシュします。 :::warning ローカルファイルストレージに保存されているファイルの形式、またはファイル名自体が予告なく変更される可能性があります。ファイルを直接読み取ったり更新したりしないようにしてください。 ::: -## Pass Generated Token for Bidstream Use +## Pass generated token for bidstream use モバイルアプリで `generateIdentity` メソッドが成功すると、Identity が返されます。次のステップは、次のように `getAdvertisingToken()` メソッドを呼び出すことです: @@ -615,15 +615,15 @@ UID2Manager.shared.getAdvertisingToken() - **Android Kotlin**: `UID2Manager.getInstance().currentIdentityStatus()` - **iOS**: `UID2Manager.shared.identityStatus` - UID2 から DII がオプトアウトされている可能性があります: 詳細は [When to Pass DII into the SDK](#when-to-pass-dii-into-the-sdk) を参照してください。 -- ロギングを有効 (`isLoggingEnabled` を `true` に設定する) にして詳細情報を取得できます: [Enable Logging](#enable-logging) を参照してください。 + UID2 から DII がオプトアウトされている可能性があります: 詳細は [When to pass DII into the SDK](#when-to-pass-dii-into-the-sdk) を参照してください。 +- ロギングを有効 (`isLoggingEnabled` を `true` に設定する) にして詳細情報を取得できます: [Enable logging](#enable-logging) を参照してください。 - UID2 Identity 内の Advertising Token の有効期限が切れていて、Refresh Token も有効期限が切れているため、SDK がトークンをリフレッシュできません。 Identity が無い場合は、`generateIdentity` メソッドを再度呼び出す必要があります: 詳細は [Configure the UID2 Mobile SDK](#configure-the-uid2-mobile-sdk) を参照してください。 -詳細は、[When to Pass DII into the SDK](#when-to-pass-dii-into-the-sdk)(次項) を参照してください。 +詳細は、[When to pass DII into the SDK](#when-to-pass-dii-into-the-sdk)(次項) を参照してください。 -## When to Pass DII into the SDK +## When to pass DII into the SDK 新しいユーザーがアプリを初めて開いた場合、UID2 Identity は存在しません。トークン生成を開始するには、`generateIdentity` メソッドを DII と共に呼び出す必要があります: @@ -731,15 +731,15 @@ If the response status indicates that the DII has been opted out of UID2, you mi --> -## Enable Logging +## Enable logging -## Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration +## Optional: UID2 GMA/IMA plugin for gam Secure Signals integration -## Optional: UID2 Integration with Prebid Mobile SDK +## Optional: UID2 integration with Prebid Mobile SDK :::important UID2 Prebid Mobile SDK インテグレーションは、UID2 SDK for Android version 1.6.0 または UID2 SDK for iOS version 1.7.0 が必要です。 @@ -749,6 +749,6 @@ Prebid Mobile SDK v3 を使用している場合は、UID2 SDK for Android ま -## Error Response States +## Error response states diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-overview.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-overview.md index 3e0f85ebd..95da82d5d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-overview.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-overview.md @@ -12,7 +12,7 @@ import Link from '@docusaurus/Link'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# UID2 Mobile Integration Overview for Android and iOS +# UID2 mobile integration overview for Android and iOS このガイドは、SDK for Android または SDK for iOS を使用して UID2 とインテグレーションしたいモバイルアプリのパブリッシャー向けのインテグレーションオプションの概要です。 @@ -28,17 +28,17 @@ UID2 は、Android/iOS 向けの SDK を提供しており、次の機能をサ - UID2 Token のリフレッシュ - UID2 Token の保存 -さらに、UID2 は、一部の機能に対して代替手段を提供し、UID2 Google GMA/IMA プラグインなどの補完製品も提供しています。利用可能なオプションは、個々のガイドで説明されています: [Integration Overview: High-Level Steps](#integration-overview-high-level-steps) を参照してください。 +さらに、UID2 は、一部の機能に対して代替手段を提供し、UID2 Google GMA/IMA プラグインなどの補完製品も提供しています。利用可能なオプションは、個々のガイドで説明されています: [Integration overview: High-level steps](#integration-overview-high-level-steps) を参照してください。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Integration Overview: High-Level Steps +## Integration overview: High-level steps UID2 mobile SDK を使用してモバイルアプリを UID2 とインテグレーションするには、次の手順を完了する必要があります: @@ -56,41 +56,41 @@ UID2 mobile SDK を使用してモバイルアプリを UID2 とインテグレ 詳細は、次のガイドを参照してください: -- [Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) -- [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) -- [Server-Side Integration Guide for Mobile](integration-mobile-server-side.md) +- [Client-side integration guide for mobile](integration-mobile-client-side.md) +- [Client-server integration guide for mobile](integration-mobile-client-server.md) +- [Server-side integration guide for mobile](integration-mobile-server-side.md) -## Mobile Integration Paths +## Mobile integration paths モバイルシナリオに最適なインテグレーションパスを決定するには、次の点を考慮してください: -1. UID2 Token を Client-Side または Server-Side で取得しますか？ [Client-Side, Client-Server, or Server-Side Integration?](#client-side-client-server-or-server-side-integration) を参照してください。 +1. UID2 Token を Client-Side または Server-Side で取得しますか？ [Client-side, client-server, or server-side integration?](#client-side-client-server-or-server-side-integration) を参照してください。 -1. UID2 Token の取得とリフレッシュ何を使いますか？ [Generating, Storing, and Refreshing the UID2 Token](#generating-storing-and-refreshing-the-uid2-token) を参照してください。 +1. UID2 Token の取得とリフレッシュ何を使いますか？ [Generating, storing, and refreshing the UID2 token](#generating-storing-and-refreshing-the-uid2-token) を参照してください。 -1. UID2 Token をどのように使いたいですか？ [Sending the Token to the Bidstream](#sending-the-token-to-the-bidstream) を参照してください。 +1. UID2 Token をどのように使いたいですか？ [Sending the token to the bidstream](#sending-the-token-to-the-bidstream) を参照してください。 -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントのセットアップが完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするためのリンクと手順が送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントのセットアップが完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするためのリンクと手順が送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -UID2 Portal での手順は、実装が Client-Side、Client-Server、または Server-Side であるかによって異なります。各インテグレーションガイドに具体的な手順が記載されています。概要は、[Client-Side, Client-Server, or Server-Side Integration?](#client-side-client-server-or-server-side-integration) を参照してください。 +UID2 Portal での手順は、実装が Client-Side、Client-Server、または Server-Side であるかによって異なります。各インテグレーションガイドに具体的な手順が記載されています。概要は、[Client-side, client-server, or server-side integration?](#client-side-client-server-or-server-side-integration) を参照してください。 -### Client-Side, Client-Server, or Server-Side Integration? +### Client-side, client-server, or server-side integration? UID2 mobile SDK を使用して UID2 とインテグレーションするためのオプションは、次の表にまとめられています。最適な Integration approach を選択してください。 -詳細は、[Integration Approaches](../ref-info/ref-integration-approaches.md) を参照してください。 +詳細は、[Integration approaches](../ref-info/ref-integration-approaches.md) を参照してください。 | Scenario | Option | Integration Guide | | :--- | :--- | :--- | -| Client-Side/モバイルアプリ内で DII（メールアドレスまたは電話番号）にアクセス可能であり、変更内容をアプリ内のみで保持したい。 | Client-Side integration | [UID2 Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) | -| Server-Side でのみ DII にアクセス可能であり、Server-Side で UID2 Token を生成するために必要な開発が可能だが、Client-Side でトークンをリフレッシュしたい場合、または Private Operator を使用している場合。 | Client-Server Integration | [UID2 Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) | -| Server-Side でのみ DII にアクセス可能であり、Server-Side で UID2 Token を生成するために必要な開発が可能な場合、または Private Operator を使用している場合。 | Server-Side Integration | [UID2 Server-Side Integration Guide for Mobile](integration-mobile-server-side.md) | +| Client-Side/モバイルアプリ内で DII（メールアドレスまたは電話番号）にアクセス可能であり、変更内容をアプリ内のみで保持したい。 | Client-Side integration | [UID2 client-side integration guide for mobile](integration-mobile-client-side.md) | +| Server-Side でのみ DII にアクセス可能であり、Server-Side で UID2 Token を生成するために必要な開発が可能だが、Client-Side でトークンをリフレッシュしたい場合、または Private Operator を使用している場合。 | Client-Server Integration | [UID2 client-server integration guide for mobile](integration-mobile-client-server.md) | +| Server-Side でのみ DII にアクセス可能であり、Server-Side で UID2 Token を生成するために必要な開発が可能な場合、または Private Operator を使用している場合。 | Server-Side Integration | [UID2 server-side integration guide for mobile](integration-mobile-server-side.md) | -### Generating, Storing, and Refreshing the UID2 Token +### Generating, storing, and refreshing the UID2 token 以下の表は、UID2 Token の生成、保存、リフレッシュを管理するためのモバイルインテグレーションオプションをまとめたものです。各オプションのドキュメントへのリンクが含まれています。 @@ -105,18 +105,18 @@ UID2 mobile SDK を使用して UID2 とインテグレーションするため UID2 Android SDK - [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) - 以下のいずれか:
  • [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md)
  • [UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md)
+ [SDK for Android reference guide](../sdks/sdk-ref-android.md) + 以下のいずれか:
  • [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side.md)
  • [UID2 client-server integration guide for mobile](../guides/integration-mobile-client-server.md)
UID2 iOS SDK - [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) - 以下のいずれか:
  • [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md)
  • [UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md)
+ [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) + 以下のいずれか:
  • [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side.md)
  • [UID2 client-server integration guide for mobile](../guides/integration-mobile-client-server.md)
-### Sending the Token to the Bidstream +### Sending the token to the bidstream UID2 Token をビッドストリームに送信する方法はいくつかあります。 @@ -124,13 +124,13 @@ UID2 Token をビッドストリームに送信する方法はいくつかあり | Scenario | Integration Guide | | :--- | :--- | -| Google GMAを使用して、動画、バナー、インタースティシャル、ネイティブ広告を Android アプリにインテグレーションしたい | 以下の順番で:
  1. [UID2 GMA Plugin for Android Integration Guide](../guides/mobile-plugin-gma-android.md)
  2. 以下のいずれか:
    • Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
| -| Google GMAを使用して、動画、バナー、インタースティシャル、ネイティブ広告を iOS アプリにインテグレーションしたい | 以下の順番で:
  1. [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios.md)
  2. 以下のいずれか:
    • Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
| -| Google IMA を使用して、Android アプリにマルチメディア広告をインテグレーションしたい | 以下の順番で:
  1. [UID2 IMA Plugin for Android Integration Guide](../guides/mobile-plugin-ima-android.md)
  2. 以下のいずれか:
    • Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
| -| Google IMA を使用して、iOS アプリにマルチメディア広告をインテグレーションしたい | 以下の順番で:
  1. [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios.md)
  2. 以下のいずれか:
    • Client-side: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA Plugin for GAM Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
| -| Prebid Mobile SDK と Prebid Server を使用して、Android または iOS アプリから広告リクエストを送信したい | 以下のいずれか:
  • Client-side: [Optional: UID2 Integration with Prebid Mobile SDK](../guides/integration-mobile-client-side.md#optional-uid2-integration-with-prebid-mobile-sdk)
  • Client-server: [Optional: UID2 Integration with Prebid Mobile SDK](../guides/integration-mobile-client-server.md#optional-uid2-integration-with-prebid-mobile-sdk)
| +| Google GMAを使用して、動画、バナー、インタースティシャル、ネイティブ広告を Android アプリにインテグレーションしたい | 以下の順番で:
  1. [UID2 GMA plugin for Android integration guide](../guides/mobile-plugin-gma-android.md)
  2. 以下のいずれか:
    • Client-side: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
| +| Google GMAを使用して、動画、バナー、インタースティシャル、ネイティブ広告を iOS アプリにインテグレーションしたい | 以下の順番で:
  1. [UID2 GMA plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md)
  2. 以下のいずれか:
    • Client-side: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
| +| Google IMA を使用して、Android アプリにマルチメディア広告をインテグレーションしたい | 以下の順番で:
  1. [UID2 IMA plugin for Android integration guide](../guides/mobile-plugin-ima-android.md)
  2. 以下のいずれか:
    • Client-side: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
| +| Google IMA を使用して、iOS アプリにマルチメディア広告をインテグレーションしたい | 以下の順番で:
  1. [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md)
  2. 以下のいずれか:
    • Client-side: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-side.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
    • Client-server: [Optional: UID2 GMA/IMA plugin for gam Secure Signals integration](../guides/integration-mobile-client-server.md#optional-uid2-gmaima-plugin-for-gam-secure-signals-integration)
| +| Prebid Mobile SDK と Prebid Server を使用して、Android または iOS アプリから広告リクエストを送信したい | 以下のいずれか:
  • Client-side: [Optional: UID2 integration with Prebid Mobile SDK](../guides/integration-mobile-client-side.md#optional-uid2-integration-with-prebid-mobile-sdk)
  • Client-server: [Optional: UID2 integration with Prebid Mobile SDK](../guides/integration-mobile-client-server.md#optional-uid2-integration-with-prebid-mobile-sdk)
| -### Functionality Summary +### Functionality summary 以下の表は、さまざまなインテグレーションオプションで利用可能な機能をまとめたものです。 @@ -154,7 +154,7 @@ UID2 Token をビッドストリームに送信する方法はいくつかあり -## FAQs for Mobile Integrations +## FAQs for mobile integrations UID2 モバイルインテグレーションに関する FAQ 情報は次のとおりです: @@ -181,13 +181,13 @@ UID2 Mobile インテグレーションには、UID2 Mobile SDK、UID2 GMA プ Podspec は、CocoaPods 内のファイル名で、アプリにインテグレーションするライブラリを定義するものです。 ::: -## Troubleshooting Tips for Mobile Integrations +## Troubleshooting tips for mobile integrations UID2 モバイルインテグレーションのトラブルシューティングに役立つ追加情報です: - [Android SDK が本番環境に接続できない](#android-sdk-cannot-connect-in-production-environment) -#### Android SDK Cannot Connect in Production Environment +#### Android SDK cannot connect in production environment Android SDK が本番環境に接続できない トラブルシューティングの最初のステップは、ヘルスチェックエンドポイントを確認することです。 @@ -206,4 +206,4 @@ https://prod.uidapi.com/ops/healthcheck SDK はバックグラウンドで UID2 Token をリフレッシュしようとします。IOException などのエラーが発生した場合、SDK は複数回リトライします。リトライが成功しない場合、この例外が表示されます。 -ログを有効にすると、別のトラブルシューティングステップが可能になります。詳細は、[Enable Logging](integration-mobile-client-side.md#enable-logging) を参照してください。 +ログを有効にすると、別のトラブルシューティングステップが可能になります。詳細は、[Enable logging](integration-mobile-client-side.md#enable-logging) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-server-side.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-server-side.md index 5616bfa16..156da19c9 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-server-side.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-server-side.md @@ -10,7 +10,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Server-Side Integration Guide for Mobile +# UID2 server-side integration guide for mobile このガイドは、UID2 Token を Server-Side で完全に管理したいモバイルアプリのパブリッシャー向けです: @@ -21,9 +21,9 @@ import Link from '@docusaurus/Link'; このアプローチのメリットの一つは、複数のプラットフォーム（Web / CTV / mobile）を扱う場合、すべてを Server-Side で行うことで、プラットフォーム固有の作業を減らすことができることです。 -このアプローチを実装するには、[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) の手順に従ってください。 +このアプローチを実装するには、[Publisher integration guide, server-side](integration-publisher-server-side.md) の手順に従ってください。 Server-Side のコードが Java または Python の場合、UID2 SDK のいずれかを使用して、UID2 への HTTP リクエストを行うことができます。独自のソースコードを書く代わりに、次の SDK ガイドのいずれかを参照してください: -- [SDK for Java Reference Guide: Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers) -- [SDK for Python Reference Guide: Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers) +- [SDK for Java reference guide: Usage for publishers](../sdks/sdk-ref-java.md#usage-for-publishers) +- [SDK for Python reference guide: Usage for publishers](../sdks/sdk-ref-python.md#usage-for-publishers) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-private-operator.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-private-operator.md index a2f78bb3e..314e3e73d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-private-operator.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-private-operator.md @@ -10,7 +10,7 @@ import SnptUpgradePolicy from '../snippets/_snpt-private-operator-upgrade-policy import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# UID2 Private Operator Integration Overview +# UID2 Private Operator integration overview Private Operator をホストする UID2 参加者は、自身のローカル UID2 Operator サービスに、自社のファーストパーティ directly identifying information (DII) を送信します。この Operator は、プライベート環境で実行されます。 @@ -24,7 +24,7 @@ UID2 フレームワークが Private Operator 向けに提供する機能、利 このページは Private Operator についての情報です。Public Operator についての情報、または Operator が何であるか、Operator の違いがわからない場合は、[UID2 Operator](../ref-info/ref-operators-public-private.md) を参照してください。 ::: -## Private Operator Benefits +## Private Operator benefits Private Operator に参加するメリットは次のとおりです。 - 顧客のデータを暗号化し、選択したパートナー間でアクティブ化するためのプライバシーに配慮したワークフローを維持できます。 @@ -39,17 +39,17 @@ Private Operator に参加するメリットは次のとおりです。 レイテンシに関する懸念が大きい場合、またはセキュリティ要件がデータが自社のシステム内に留まることを求める場合、さらに UID2 の実装を構築および維持するためのエンジニアリソースが豊富な場合、Private Operator ソリューションを検討することができます。 -## Private Operator Requirements +## Private Operator requirements 参加者は、Private Operator インスタンスをホスト、構成、維持、および更新し、厳格なセキュリティ対策に準拠する必要があります。インテグレーションを行い、継続的な更新を行うためにエンジニアリソースが必要です。 -Private Operator インスタンスをホストするためには、契約を結ぶ必要があります。契約は、[Account Setup](../getting-started/gs-account-setup.md) を参照してください。 +Private Operator インスタンスをホストするためには、契約を結ぶ必要があります。契約は、[Account setup](../getting-started/gs-account-setup.md) を参照してください。 :::note Private Operator は、Public Operator または他の Private Operator によって処理された raw UID2 または UID2 Token の内容を見ることはできません。各 Private Operator は他のすべての Operator から隔離されています。 ::: -## Hosting Options for Private Operators +## Hosting options for Private Operators Private Operator を選択する場合、いくつかの実装オプションが利用可能です。UID2 は、以下のクラウドサービスプロバイダーで UID2 を enclave にホストすることをサポートしています (実装には中程度の労力が必要です): - [Nitro Enclave](https://aws.amazon.com/ec2/nitro/) AWS から @@ -57,7 +57,7 @@ Private Operator を選択する場合、いくつかの実装オプションが - [Confidential Containers](https://learn.microsoft.com/en-us/azure/confidential-computing/confidential-containers), Microsoft Azure の機密コンピューティング オプション - [Azure Kubernetes Service (AKS)](https://learn.microsoft.com/en-us/azure/aks/what-is-aks), Microsoft Azure コンテナインスタンス上の仮想ノードで実行され、Kubernetes を使用している機密コンピューティングソリューション -## Private Operator Workflow +## Private Operator workflow Private Operator の基本的なワークフローは次のとおりです: @@ -65,66 +65,66 @@ Private Operator の基本的なワークフローは次のとおりです: 1. Operator が認証プロセスに合格すると、Core Service は、起動に必要な情報を取得するための安全な S3 URL を Private Operator に提供します。 -1. Private Operator は、UID2 の処理に必要な情報 (ソルト、暗号化キー、およびユーザーのオプトアウトレコードなど) を Amazon S3 から取得します。セキュリティの詳細は、[Private Operator Security](#private-operator-security) を参照してください。 +1. Private Operator は、UID2 の処理に必要な情報 (ソルト、暗号化キー、およびユーザーのオプトアウトレコードなど) を Amazon S3 から取得します。セキュリティの詳細は、[Private Operator security](#private-operator-security) を参照してください。 1. Operator が再起動されると、再度認証プロセスを実行し、新しいセキュリティ情報を取得します。 1. Operator は Core Service での認証プロセスを定期的に再実行し、引き続き保護された環境で実行されていることを確認します。認証に失敗した場合、Operator はシャットダウンします。 -## Private Operator Security +## Private Operator security サポートされる Private Operator 実装は、厳格なセキュリティ基準を満たす必要があります。セキュリティに関するいくつかのポイントは次のとおりです: -- Private Operator は、[Hosting Options for Private Operators](#hosting-options-for-private-operators) に記載されているサポートされるクラウドプロバイダーのいずれかでホストされているハードウェアベースの信頼された実行環境 (TEE) で実行されます。 +- Private Operator は、[Hosting options for Private Operators](#hosting-options-for-private-operators) に記載されているサポートされるクラウドプロバイダーのいずれかでホストされているハードウェアベースの信頼された実行環境 (TEE) で実行されます。 - Private Operator は、UID2 の処理に必要な情報にアクセスする前に、認証プロセスを完了する必要があります。 - S3 から取得された情報は、保存中および転送中に TLS によって暗号化されています。さらに、アクセスは正しく認証された Private Operator にのみ制限されています。 - 起動時に取得された情報は、いかなる時点でもローカルに保存されません。情報は常にメモリに保持され、Private Operator は、Operator を実行している人 (管理者など) および外部の関係者がメモリ内のデータを見ることが困難な保護された環境で実行されています。 - Private Operator は、処理のために送信された DII (メールアドレスや電話番号) を保存しません。データは UID2 を生成するために enclave 内でのみ使用され、処理後すぐに破棄されます。 -## Private Operator Limitations +## Private Operator limitations Private Operator にはいくつかの制限があります: - Private Operator は、現在、client-side integration　をサポートしていません。 - Private Operator の更新は、年に 3 回リリースされます; Public Operator の更新は、より頻繁にリリースされます。 -## Private Operator Deprecation Schedule +## Private Operator deprecation schedule -サポートされるバージョンと廃止時期は、[Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions) を参照してください。 +サポートされるバージョンと廃止時期は、[Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions) を参照してください。 -## Private Operator Upgrade Policy +## Private Operator upgrade policy -## Keeping the Operator Key Secure +## Keeping the operator key secure -## Preparing DII for Processing +## Preparing DII for processing -## Getting Started +## Getting started Private Operator を開始するには、次の手順に従います: -1. UID2 へのアクセスをリクエストします。[Request Access](/request-access) ページのフォームに記入します。 +1. UID2 へのアクセスをリクエストします。[Request access](/request-access) ページのフォームに記入します。 2. 使用する実装オプションを決定します。 - 利用可能なオプションの詳細は、[Hosting Options for Private Operators](#hosting-options-for-private-operators) を参照してください。 + 利用可能なオプションの詳細は、[Hosting options for Private Operators](#hosting-options-for-private-operators) を参照してください。 3. SDK を使用している場合は、SDK をダウンロードします。該当する SDK ガイドを参照してください。 4. 選択したオプションの実装ガイドに従います。 :::note - UID2 へのリクエストメッセージは必ず暗号化してください。詳細は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 + UID2 へのリクエストメッセージは必ず暗号化してください。詳細は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: 5. テストします。 6. 本番環境に移行します。 :::important -どのオプションを使用する場合でも、UID2 を生成するために送信するデータは、送信前に正規化、ハッシュ化、およびエンコードする必要があります。詳細については、[Normalization and Encoding](../getting-started/gs-normalization-encoding.md)を参照してください。 +どのオプションを使用する場合でも、UID2 を生成するために送信するデータは、送信前に正規化、ハッシュ化、およびエンコードする必要があります。詳細については、[Normalization and encoding](../getting-started/gs-normalization-encoding.md)を参照してください。 ::: -## Implementation Resources +## Implementation resources UID2 の Private Operator 向けの実装リソースは次のとおりです。 @@ -132,7 +132,7 @@ Private Operator のバージョン間に機能的な違いはありません。 | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| AWS | [UID2 Private Operator for AWS Integration Guide](../guides/operator-guide-aws-marketplace.md) | AWS Marketplace の Private Operator Service の設定方法。 | -| GCP Confidential Space | [UID2 Private Operator for GCP Integration Guide](../guides/operator-private-gcp-confidential-space.md) | [Google Cloud](https://cloud.google.com/docs/overview/) Platform の機密コンピューティング オプションである [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space) に UID2 Operator Service を設定する方法。 | -| Azure | [UID2 Private Operator for Azure Integration Guide](../guides/operator-guide-azure-enclave.md) | Microsoft Azure の機密コンピューティング オプションである Confidential Containers インスタンスで UID2 Operator Service を設定する方法。 | -| AKS | [UID2 Private Operator for AKS Integration Guide](../guides/operator-guide-aks-enclave.md) | AKS のインスタンスで UID2 Operator Service を設定する方法。AKS は、Microsoft Azure コンテナインスタンスの仮想ノードで実行され、Kubernetes を使用する機密コンピューティングソリューションです。 | +| AWS | [UID2 Private Operator for AWS integration guide](../guides/operator-guide-aws-marketplace.md) | AWS Marketplace の Private Operator Service の設定方法。 | +| GCP Confidential Space | [UID2 Private Operator for GCP integration guide](../guides/operator-private-gcp-confidential-space.md) | [Google Cloud](https://cloud.google.com/docs/overview/) Platform の機密コンピューティング オプションである [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space) に UID2 Operator Service を設定する方法。 | +| Azure | [UID2 Private Operator for Azure integration guide](../guides/operator-guide-azure-enclave.md) | Microsoft Azure の機密コンピューティング オプションである Confidential Containers インスタンスで UID2 Operator Service を設定する方法。 | +| AKS | [UID2 Private Operator for AKS integration guide](../guides/operator-guide-aks-enclave.md) | AKS のインスタンスで UID2 Operator Service を設定する方法。AKS は、Microsoft Azure コンテナインスタンスの仮想ノードで実行され、Kubernetes を使用する機密コンピューティングソリューションです。 | diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-all.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-all.md index 2acef0cab..8ae079710 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-all.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-all.md @@ -9,6 +9,6 @@ displayed_sidebar: sidebarPublishers import Link from '@docusaurus/Link'; import SnptPublisherImplementationResources from '../snippets/_snpt-publisher-implementation-resources.mdx'; -# Publisher Integration Resources +# Publisher integration resources diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-web.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-web.md index c067264fc..b549ff762 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-web.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-options-publisher-web.md @@ -9,13 +9,13 @@ displayed_sidebar: sidebarPublishers import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Publisher Web Integration Overview +# Publisher web integration overview パブリッシャーとして、UID2 とインテグレーションして ID トークンを生成し、ウェブページのコンテキストで RTB ビッドストリームに渡す方法はたくさんあります。 このページでは、インテグレーションステップとインテグレーションオプションの概要と、各オプションの追加情報へのリンクを紹介します。 -## Key Integration Steps +## Key integration steps UID2 とインテグレーションするには、次の 3 つの主要なアクティビティを実装します。 @@ -25,7 +25,7 @@ UID2 とインテグレーションするには、次の 3 つの主要なアク これらの重要なステップを達成する方法はたくさんあります。最もシンプルで高速な実装は、Prebid.js 8.21.0 以降を使用した完全な Client-Side の実装です。 -## Integration Options Summary +## Integration options summary 次の表は、インテグレーションステップごとに利用可能なソリューションをまとめたものです。 @@ -44,27 +44,27 @@ UID2 とインテグレーションするには、次の 3 つの主要なアク -## Preparing DII for Processing +## Preparing DII for processing -## Publisher Web Options Workflow +## Publisher web options workflow 実装を選択し、開始するには、以下の手順に従ってください: 1. UID2 Token を生成するオプションの概要を確認します: - - [Client-Side Integration Options](#client-side-integration-options) - - [Server-Side Integration Options](#server-side-integration-options) -1. [UID2 Token をリフレッシュする](#refresh-the-uid2-token) オプションを確認します。 + - [Client-side integration options](#client-side-integration-options) + - [Server-side integration options](#server-side-integration-options) +1. [UID2 token をリフレッシュする](#refresh-the-uid2-token) オプションを確認します。 1. [トークンをビッドストリームに渡す](#pass-the-uid2-token-into-the-bidstream) オプションを確認します。 1. 最適なオプションを選択し、実装ドキュメントをクリックしてください。 -## Generate the UID2 Token +## Generate the UID2 token UID2 Token を生成するには、主に2つの方法があります。—UID2 Token 生成リクエストを選択することができます: -- Client-Side (ユーザーのブラウザ内): [Client-Side Integration Options](#client-side-integration-options) を参照してください。 -- Server-Side: [Server-Side Integration Options](#server-side-integration-options) を参照してください。 +- Client-Side (ユーザーのブラウザ内): [Client-side integration options](#client-side-integration-options) を参照してください。 +- Server-Side: [Server-side integration options](#server-side-integration-options) を参照してください。 それぞれのオプションには利点があります。最も簡単で高速なインテグレーションオプションとして、Prebid.js 8.21.0 以降を使用した Client-Side インテグレーションを推奨します。 @@ -72,23 +72,23 @@ UID2 Token を生成するには、主に2つの方法があります。—U すべてのインテグレーションオプションで、UID2 Token をローカルストレージまたはクッキーストレージに保存することを選択できます。 ::: -### Client-Side Integration Options +### Client-side integration options Client-Side で UID2 Token を生成することには、次のような利点があります: - コードは消費者のウェブページ上の Client-Side で実行され、Server-Side のコーディングは必要ありません。 - Prebid.js のインテグレーションにより、すべての機能が処理されます—トークンの生成、トークンのリフレッシュ、トークンのビッドストリームへの受け渡しなど。Prebid.js 8.21.0 以降を使用している場合、これが最もシンプルで高速な実装オプションです。 -Client-Side のインテグレーションを選択した場合、アカウント設定の一環として、セキュリティのためにルートレベルドメインのリストを提供する必要があります。詳細は、アカウント設定ページの [Client-Side Web Integrations](../getting-started/gs-account-setup.md#client-side-web-integrations) を参照してください。 +Client-Side のインテグレーションを選択した場合、アカウント設定の一環として、セキュリティのためにルートレベルドメインのリストを提供する必要があります。詳細は、アカウント設定ページの [Client-side web integrations](../getting-started/gs-account-setup.md#client-side-web-integrations) を参照してください。 次の表は、Client-Side で UID2 Token を生成したいパブリッシャーが、ウェブページから UID2 Token を生成するためのオプションと、それに対応するドキュメントリソースをまとめたものです。 | Option | Documentation | | :--- | :--- | -| Prebid.js client-side implementation (8.21.0 or later) | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | -| SDK for JavaScript, client-side implementation | [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | +| Prebid.js client-side implementation (8.21.0 or later) | [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) | +| SDK for JavaScript, client-side implementation | [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | -### Server-Side Integration Options +### Server-side integration options Server-Side で UID2 Token を生成することには、次のような利点があります: @@ -100,12 +100,12 @@ Server-Side で UID2 Token を生成することには、次のような利点 | Option | Documentation | | :--- | :--- | -| SDK for JavaScript, client-server implementation | [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) | -| SDK for Java | - [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)
- [SDK for Java](../sdks/sdk-ref-java.md) | -| SDK for Python | - [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)
- [SDK for Python](../sdks/sdk-ref-python.md) | -| Direct integration (API endpoints) | [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | +| SDK for JavaScript, client-server implementation | [Client-server integration guide for JavaScript](integration-javascript-client-server.md) | +| SDK for Java | - [Publisher integration guide, server-side](integration-publisher-server-side.md)
- [SDK for Java](../sdks/sdk-ref-java.md) | +| SDK for Python | - [Publisher integration guide, server-side](integration-publisher-server-side.md)
- [SDK for Python](../sdks/sdk-ref-python.md) | +| Direct integration (API endpoints) | [Publisher integration guide, server-side](integration-publisher-server-side.md) | -## Refresh the UID2 Token +## Refresh the UID2 token セキュリティ上の理由から、UID2 Token の寿命は限られていますが、トークンをリフレッシュするメカニズムが組み込まれているので、続けて使用することができます。 @@ -115,15 +115,15 @@ Server-Side で UID2 Token を生成することには、次のような利点 | Option | Documentation | | :--- | :--- | -| Prebid.js client-side implementation (8.21.0 or later) | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | -| Prebid.js client-server implementation (7.53.0 or later) | [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) | -| SDK for JavaScript, client-side implementation | [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | -| SDK for JavaScript, client-server implementation | [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) | -| SDK for Java | - [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)
- [SDK for Java](../sdks/sdk-ref-java.md) | -| SDK for Python | - [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)
- [SDK for Python](../sdks/sdk-ref-python.md) | -| Direct integration (API endpoints) | [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | +| Prebid.js client-side implementation (8.21.0 or later) | [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) | +| Prebid.js client-server implementation (7.53.0 or later) | [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) | +| SDK for JavaScript, client-side implementation | [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | +| SDK for JavaScript, client-server implementation | [Client-server integration guide for JavaScript](integration-javascript-client-server.md) | +| SDK for Java | - [Publisher integration guide, server-side](integration-publisher-server-side.md)
- [SDK for Java](../sdks/sdk-ref-java.md) | +| SDK for Python | - [Publisher integration guide, server-side](integration-publisher-server-side.md)
- [SDK for Python](../sdks/sdk-ref-python.md) | +| Direct integration (API endpoints) | [Publisher integration guide, server-side](integration-publisher-server-side.md) | -## Pass the UID2 Token Into the Bidstream +## Pass the UID2 token into the bidstream パブリッシャーは、DII (メールアドレスや電話番号) を UID2 Token に暗号化し、UID2 Token をビッドストリームに送信することで UID2 を使用します。 @@ -131,9 +131,9 @@ Server-Side で UID2 Token を生成することには、次のような利点 | Option | Documentation | | :--- | :--- | -| Prebid.js client-side implementation (8.21.0 or later) | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | -| Prebid.js client-server implementation (7.53.0 or later) | [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) | -| Google Ad Manager Secure Signals| [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | +| Prebid.js client-side implementation (8.21.0 or later) | [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) | +| Prebid.js client-server implementation (7.53.0 or later) | [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) | +| Google Ad Manager Secure Signals| [Google Ad Manager Secure Signals integration guide](integration-google-ss.md) | :::note トークンを生成し、それをリフレッシュし続ける限り、UID2 Token をビッドストリームに渡すために他のオプションを使用することもできます。 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 1c52a6f01..be1a2a1ea 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 @@ -14,7 +14,7 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai import SnptAddPrebidjsToYourSite from '../snippets/_snpt-prebid-add-prebidjs-to-your-site.mdx'; import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx'; -# UID2 Client-Server Integration Guide for Prebid.js +# UID2 client-server integration guide for Prebid.js このガイドは、Server-Side で DII (メールアドレスまたは電話番号) にアクセスでき、UID2 とインテグレーションして、RTB ビッドストリームで Prebid.js によって渡される UID2 Token (Advertising Token) を生成したいパブリッシャー向けのものです。 @@ -25,27 +25,27 @@ Prebid.js を使って UID2 とインテグレーションするには、以下 - サイトの HTML と JavaScript に変更を加えます。 - トークン生成のために Server-Side を変更します(オプションで トークンリフレッシュ)。 -## Prebid.js Version +## Prebid.js version この実装には、Prebid.js version 7.53.0 以降が必要です。バージョン情報は、[https://github.com/prebid/Prebid.js/releases](https://github.com/prebid/Prebid.js/releases) を参照してください。 -## UID2 Prebid Module Page +## UID2 Prebid module page Prebid と UID2 のインテグレーション方法に関する情報は、以下の場所にもあります: - Prebid サイトの Prebid User ID Submodule の [Unified ID 2.0](https://docs.prebid.org/dev-docs/modules/userid-submodules/unified2.html) ページ。 - Prebid GitHub リポジトリの [UID2 User ID Submodule](https://github.com/prebid/Prebid.js/blob/master/modules/uid2IdSystem.md) ページ。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Integration Overview: High-Level Steps +## Integration overview: High-level steps 以下のステップを完了する必要があります: @@ -53,86 +53,86 @@ Prebid と UID2 のインテグレーション方法に関する情報は、以 2. [Add Prebid.js to your site](#add-prebidjs-to-your-site) 3. [Configure the UID2 module](#configure-the-uid2-module) -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -Prebid.js を使用して UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントがまだ作成されていない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +Prebid.js を使用して UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントがまだ作成されていない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -Client-Server インテグレーションの場合、UID2 Portal の [API Keys](../portal/api-keys.md) ページで以下の値を設定する必要があります: +Client-Server インテグレーションの場合、UID2 Portal の [API keys](../portal/api-keys.md) ページで以下の値を設定する必要があります: - API Key、Client Key とも呼ばれます。 - Client Secret、参加者と UID2 Service のみが知る値。 :::important -これらの値を安全に保管することが非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 +これらの値を安全に保管することが非常に重要です。詳細は、[Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 ::: -## Add Prebid.js to Your Site +## Add Prebid.js to your site -## Configure the UID2 Module +## Configure the UID2 module UID2 Prebid モジュールを設定して、以下の2つのアクションを実行する必要があります: | Step | Action | Link to Instructions | | --- | --- | --- | -| 1 | Server-Side API コールを送信して UID2 Token を生成します。 | [Generating a UID2 Token on the Server](#generating-a-uid2-token-on-the-server) | -| 2 | Prebid module がトークンのリフレッシュと必要に応じてオプトアウトを管理できるように、レスポンス値を保存します。 | [Refreshing a UID2 Token](#refreshing-a-uid2-token) | +| 1 | Server-Side API コールを送信して UID2 Token を生成します。 | [Generating a UID2 token on the server](#generating-a-uid2-token-on-the-server) | +| 2 | Prebid module がトークンのリフレッシュと必要に応じてオプトアウトを管理できるように、レスポンス値を保存します。 | [Refreshing a UID2 token](#refreshing-a-uid2-token) | -### Generating a UID2 Token on the Server +### Generating a UID2 token on the server Prebid の Client-Server インテグレーションの場合、最初のステップは、サーバー上で UID2 Token を生成することです。その後、トークンを Prebid に渡して RTB ビッドストリームに送信します。 -手順や例を含む詳細は、[Server-Side Token Generation](../ref-info/ref-server-side-token-generation.md) を参照してください。 +手順や例を含む詳細は、[Server-side token generation](../ref-info/ref-server-side-token-generation.md) を参照してください。 -トークンを生成するには、いずれかの SDK または [POST /token/generate](../endpoints/post-token-generate.md) エンドポイントを呼び出します。トークンを示す API レスポンスの例は、[Sample Token Response Object](#sample-token-response-object) を参照してください。`Identity` レスポンスを Prebid に渡す必要があります。 +トークンを生成するには、いずれかの SDK または [POST /token/generate](../endpoints/post-token-generate.md) エンドポイントを呼び出します。トークンを示す API レスポンスの例は、[Sample token response object](#sample-token-response-object) を参照してください。`Identity` レスポンスを Prebid に渡す必要があります。 :::warning セキュリティ上の理由から、トークン生成に使用される API Key と Client Secret は Server-Side で呼び出す必要があります。これらの値は Prebid の実装の一部として保存しないでください。 ::: -### Refreshing a UID2 Token +### Refreshing a UID2 token UID2 Token をリフレッシュするには、次の表に示すように 2 つの方法があります。 | Mode | Description | Link to Section | | --- | --- | --- | -| Client refresh mode | Prebid.js は内部で自動的にトークンをリフレッシュします。
これは最もシンプルなアプローチです。 | [Client Refresh Mode](#client-refresh-mode) | -| Server-only mode | Prebid.js はトークンを自動的にリフレッシュしません。トークンのリフレッシュを管理するのはパブリッシャーです。
このオプションを選択する理由の例:
  • [SDK for JavaScript](../sdks/sdk-ref-javascript.md) を使用してトークンをリフレッシュし、Prebid.js でトークンをビッドストリームに送信したい場合。
  • トークンを複数の手段(Prebid.js や Google など) でビッドストリームに送信したい場合。
| [Server-Only Mode](#server-only-mode) | +| Client refresh mode | Prebid.js は内部で自動的にトークンをリフレッシュします。
これは最もシンプルなアプローチです。 | [Client refresh mode](#client-refresh-mode) | +| Server-only mode | Prebid.js はトークンを自動的にリフレッシュしません。トークンのリフレッシュを管理するのはパブリッシャーです。
このオプションを選択する理由の例:
  • [SDK for JavaScript](../sdks/sdk-ref-javascript.md) を使用してトークンをリフレッシュし、Prebid.js でトークンをビッドストリームに送信したい場合。
  • トークンを複数の手段(Prebid.js や Google など) でビッドストリームに送信したい場合。
| [Server-only mode](#server-only-mode) | -### Client Refresh Mode +### Client refresh mode 該当するエンドポイントからの完全な JSON レスポンスボディを Prebid module に提供する必要があります: - 新しい UID2 Token を取得するには、[POST /token/generate](../endpoints/post-token-generate.md)。 - リフレッシュされた UID2 Token は、[POST /token/refresh](../endpoints/post-token-refresh.md)。 -例は、[Sample Token Response Object](#sample-token-response-object) を参照してください。 +例は、[Sample token response object](#sample-token-response-object) を参照してください。 Refresh Token が有効である限り、UID2 Prebid module は必要に応じて UID2 Token をリフレッシュします。 このセクションには以下の情報が含まれます: -- [Client Refresh Mode Response Configuration Options](#client-refresh-mode-response-configuration-options) -- [Client Refresh Mode Cookie Example](#client-refresh-mode-cookie-example) -- [Client Refresh Mode uid2Token Example](#client-refresh-mode-uid2token-example) -- [Passing a New Token: Client Refresh Mode](#passing-a-new-token-client-refresh-mode) +- [Client refresh mode response configuration options](#client-refresh-mode-response-configuration-options) +- [Client refresh mode cookie example](#client-refresh-mode-cookie-example) +- [Client refresh mode uid2token example](#client-refresh-mode-uid2token-example) +- [Passing a new token: Client refresh mode](#passing-a-new-token-client-refresh-mode) -#### Client Refresh Mode Response Configuration Options +#### Client refresh mode response configuration options Client Refresh Mode を使用するようにモジュールを構成する場合、Prebid module にトークンを提供するための以下のオプションの **1つ** を選択する必要があります。 | Option | Details | Use Case | | --- | --- | --- | -| `params.uid2Cookie` に、JSON 文字列としてレスポンスボディを含むクッキーの名前を設定します。 | [Client Refresh Mode Cookie Example](#client-refresh-mode-cookie-example) を参照してください。 | レスポンスボディを保存するのに十分なスペースがクッキーに残っていることが確実な場合のみ、このオプションを使用してください。確信が持てない場合や、クッキーの保存の必要性が異なる可能性がある場合は、他のオプションを選択してください。 | -| `params.uid2Token` を JavaScript オブジェクトとしてレスポンスボディに設定します。 | [Client Refresh Mode uid2Token Example](#client-refresh-mode-uid2token-example) を参照してください。 | `params.uid2Token` を介してレスポンスボディを提供することもできます:
  • すでに多くのデータをクッキーに保存していて、レスポンスボディを追加するとクッキーのサイズ制限を超える可能性がある場合。
  • Prebid module にトークン値を保存させたい場合。
| +| `params.uid2Cookie` に、JSON 文字列としてレスポンスボディを含むクッキーの名前を設定します。 | [Client refresh mode cookie example](#client-refresh-mode-cookie-example) を参照してください。 | レスポンスボディを保存するのに十分なスペースがクッキーに残っていることが確実な場合のみ、このオプションを使用してください。確信が持てない場合や、クッキーの保存の必要性が異なる可能性がある場合は、他のオプションを選択してください。 | +| `params.uid2Token` を JavaScript オブジェクトとしてレスポンスボディに設定します。 | [Client refresh mode uid2token example](#client-refresh-mode-uid2token-example) を参照してください。 | `params.uid2Token` を介してレスポンスボディを提供することもできます:
  • すでに多くのデータをクッキーに保存していて、レスポンスボディを追加するとクッキーのサイズ制限を超える可能性がある場合。
  • Prebid module にトークン値を保存させたい場合。
| -#### Client Refresh Mode Cookie Example +#### Client refresh mode cookie example Client Refresh Mode では、Prebid.js がトークンの更新を行います。そのためには、トークンを保存するように設定する必要があります。以下の例では、Cookie と、`uid2_pub_cookie` という Cookie にトークンを保存するための設定しています。 @@ -157,11 +157,11 @@ pbjs.setConfig({ }); ``` -トークンの例は、[Sample Token Response Object](#sample-token-response-object) を参照してください。 +トークンの例は、[Sample token response object](#sample-token-response-object) を参照してください。 -#### Client Refresh Mode uid2Token Example +#### Client refresh mode uid2token example -次の例は、コンフィギュレーションのサンプルを示しています。トークンの内容は、[Sample Token Response Object](#sample-token-response-object) を参照してください。 +次の例は、コンフィギュレーションのサンプルを示しています。トークンの内容は、[Sample token response object](#sample-token-response-object) を参照してください。 ```js pbjs.setConfig({ @@ -180,13 +180,13 @@ pbjs.setConfig({ }); ``` -#### Passing a New Token: Client Refresh Mode +#### Passing a new token: Client refresh mode Refresh Token の有効期限が切れた場合は、新しい Advertising Token と新しい Refresh Token を将来のリフレッシュのために利用できるように、新しいトークンレスポンスを提供する必要があります。 -新しいトークンを提供する必要があるかどうかを判断する方法は、[Determining Whether the Module Has a Valid Token](#determining-whether-the-module-has-a-valid-token) を参照してください。 +新しいトークンを提供する必要があるかどうかを判断する方法は、[Determining whether the module has a valid token](#determining-whether-the-module-has-a-valid-token) を参照してください。 -### Server-Only Mode +### Server-only mode Server-Only Mode では、Advertising Token のみがモジュールに提供されます。モジュールはトークンをリフレッシュできません。トークンをリフレッシュする方法を実装する責任があります。 @@ -194,17 +194,17 @@ Server-Only Mode を使用するようにモジュールを設定するには、 | Implementation Method | Link to Example | | --- | --- | -| `__uid2_advertising_token` という名前のクッキーを設定し、Advertising Token の値を格納します。 | [Server-Only Mode Cookie Example](#server-only-mode-cookie-example) | -| Advertising Token を含む ID ブロックに `value` を設定します。 | [Server-Only Mode Value Example](#server-only-mode-value-example) | +| `__uid2_advertising_token` という名前のクッキーを設定し、Advertising Token の値を格納します。 | [Server-only mode cookie example](#server-only-mode-cookie-example) | +| Advertising Token を含む ID ブロックに `value` を設定します。 | [Server-only mode value example](#server-only-mode-value-example) | このセクションには以下の情報が含まれます: -- [Server-Only Mode Cookie Example](#server-only-mode-cookie-example) -- [Server-Only Mode Value Example](#server-only-mode-value-example) -- [Passing a New Token: Server-Only Mode](#passing-a-new-token-server-only-mode) +- [Server-only mode cookie example](#server-only-mode-cookie-example) +- [Server-only mode value example](#server-only-mode-value-example) +- [Passing a new token: Server-only mode](#passing-a-new-token-server-only-mode) -#### Server-Only Mode Cookie Example +#### Server-only mode cookie example -以下の例では、Advertising Token の値を格納する `__uid2_advertising_token` という名前のクッキーを設定しています。クッキーの値は、トークンレスポンスオブジェクトで返される値です(詳細は [Sample Token Response Object](#sample-token-response-object) を参照)。 +以下の例では、Advertising Token の値を格納する `__uid2_advertising_token` という名前のクッキーを設定しています。クッキーの値は、トークンレスポンスオブジェクトで返される値です(詳細は [Sample token response object](#sample-token-response-object) を参照)。 この設定により、UID2 モジュールは Advertising Token の値をクッキーから取得できます。 @@ -226,7 +226,7 @@ pbjs.setConfig({ }); ``` -#### Server-Only Mode Value Example +#### Server-only mode value example 次の例では、`value` フィールドをクッキーに保存せずに、Advertising Token を含む ID ブロックに設定しています。 @@ -245,13 +245,13 @@ pbjs.setConfig({ }); ``` -#### Passing a New Token: Server-Only Mode +#### Passing a new token: Server-only mode Server-Only Mode では、Prebid.js UID2 module は Advertising Token のみを受け取るため、トークンは短時間しか有効ではありません。このため、各ページのロード時に Advertising Token を提供するのが最善です。 -必要であれば、新しいトークンを提供する必要があるかどうかを判断するために、[Determining Whether the Module Has a Valid Token](#determining-whether-the-module-has-a-valid-token) を参照してください。 +必要であれば、新しいトークンを提供する必要があるかどうかを判断するために、[Determining whether the module has a valid token](#determining-whether-the-module-has-a-valid-token) を参照してください。 -## Prebid Implementation Notes and Tips +## Prebid implementation notes and tips Prebid の実施を計画する際には、以下を考慮してください: @@ -259,7 +259,7 @@ Prebid の実施を計画する際には、以下を考慮してください: - リフレッシュされたトークンを生成するために使用された元のトークンと一致しない新しいトークンを提供した場合、モジュールは保存されているすべてのトークンを破棄し、代わりに新しいトークンを使用し、リフレッシュされた状態を維持します。 -- インテグレーションテストでは、`params.uid2ApiBase` を `"https://operator-integ.uidapi.com"` に設定します。トークンの生成に使用する環境(本番環境またはインテグレーション環境)と同じ値に設定する必要があります(認証情報については、[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照)。 +- インテグレーションテストでは、`params.uid2ApiBase` を `"https://operator-integ.uidapi.com"` に設定します。トークンの生成に使用する環境(本番環境またはインテグレーション環境)と同じ値に設定する必要があります(認証情報については、[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照)。 - Prebid.js client-server インテグレーションの場合、クライアントサイドインテグレーション機能を無効にして、より小さな Prebid.js ビルドを作成できます。これを行うには、`--disable UID2_CSTG` フラグを渡します: @@ -267,11 +267,11 @@ Prebid の実施を計画する際には、以下を考慮してください: $ gulp build --modules=uid2IdSystem --disable UID2_CSTG ``` -## Storing the UID2 Token in the Browser +## Storing the UID2 token in the browser -## Determining Whether the Module Has a Valid Token +## Determining whether the module has a valid token Prebid.js module が有効なトークンを持っているか、新しいトークンを提供する必要があるかを判断するためにチェックを行うことができます。 @@ -302,7 +302,7 @@ if (!pbjs.getUserIds().uid2) { `setConfig`(または同様の関数) を 2 回呼び出してユーザー ID を設定した場合、User ID Submodule の ID 値を再初期化するために、`refreshUserIds` を呼び出す必要があります。 ::: -## Checking the Integration +## Checking the integration UID2 Module に有効な UID2 Token があるかどうかを確認するには `pbjs.getUserIds().uid2` を呼び出します。値が返された場合、UID2 Module に有効な UID2 Token が存在します。 @@ -318,7 +318,7 @@ Prebid.js の設定を検証・デバッグするツールの例として、オ - Chrome ウェブストアのダウンロード場所: [Professor Prebid](https://chromewebstore.google.com/detail/professor-prebid/kdnllijdimhbledmfdbljampcdphcbdc) - prebid.org のドキュメント: [Professor Prebid User Guide](https://docs.prebid.org/tools/professor-prebid.html) -## Configuration Parameters for userSync +## Configuration parameters for usersync 以下のパラメータは、UID2 Prebid User ID Module のインテグレーションにのみ適用されます。 @@ -327,13 +327,13 @@ Prebid.js の設定を検証・デバッグするツールの例として、オ | Param under userSync.userIds[] | Mode/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) を参照してください。 | -| params.uid2Token | CR: Optional
SO: N/A | Object | 最初の UID2 Token。これは `/token/generate` または `/token/refresh` エンドポイントをコールした際に復号されたレスポンスの `body` 要素でなければなりません。 | [Sample Token Response Object](#sample-token-response-object) を参照してください。 | -| params.uid2Cookie | CR: オプション
SO: N/A | String | サーバが設定した UID2 Token を保持するクッキーの名前。クッキーは uid2Token パラメータと同じ形式の JSON を含む必要があります。`uid2Token` を指定した場合、このパラメータは無視されます。 | [Sample Token Response Object](#sample-token-response-object) を参照してください。 | +| value | CR: N/A
SO: オプション | Object | Advertising Token の値を含むオブジェクト。 | [Configuration parameter examples: Value](#configuration-parameter-examples-value) を参照してください。 | +| params.uid2Token | CR: Optional
SO: N/A | Object | 最初の UID2 Token。これは `/token/generate` または `/token/refresh` エンドポイントをコールした際に復号されたレスポンスの `body` 要素でなければなりません。 | [Sample token response object](#sample-token-response-object) を参照してください。 | +| params.uid2Cookie | CR: オプション
SO: N/A | String | サーバが設定した UID2 Token を保持するクッキーの名前。クッキーは uid2Token パラメータと同じ形式の JSON を含む必要があります。`uid2Token` を指定した場合、このパラメータは無視されます。 | [Sample token response object](#sample-token-response-object) を参照してください。 | | params.uid2ApiBase | CR: オプション
SO: オプション | String | デフォルトの UID2 API エンドポイントを上書きします。有効な値は、[Environments](../getting-started/gs-environments.md) を参照してください。 | `"https://prod.uidapi.com"` (デフォルト)| | params.storage | CR: オプション
SO: オプション | String | モジュール内部の保存方法を指定します: `cookie` または `localStorage`。このパラメータは指定しないことを推奨します。代わりに、モジュールがデフォルトを使用するようにします。 | `"localStorage"` (デフォルト) | -### Configuration Parameter Examples: Value +### Configuration parameter examples: Value 以下のコードスニペットは、`value` UID2 設定パラメータの例を示しています。 @@ -352,7 +352,7 @@ pbjs.setConfig({ }); ``` -### Sample Token Response Object +### Sample token response object 以下のサンプルは架空のものですが、[POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントから返されるトークンレスポンスオブジェクトがどのように見えるかを示しています: @@ -367,7 +367,7 @@ pbjs.setConfig({ } ``` -## Optional: Specifying the API Base URL to Reduce Latency +## Optional: Specifying the API base URL to reduce latency デフォルトでは、UID2 モジュールは米国の UID2 本番環境サーバに対して API コールを行います。 @@ -389,14 +389,14 @@ pbjs.setConfig({ }); ``` -## Optional: Prebid.js Integration with Google Secure Signals +## Optional: Prebid.js integration with Google Secure Signals Prebid.js を使用しており、Google Secure Signals を使用して UID2 Token を Google に渡す場合、追加の設定手順がいくつかあります: -- Google Ad Manager アカウントで、暗号化されたシグナルが適切にサードパーティビッダと共有されていることを確認します: [Secure Signals Sharing を許可](integration-google-ss.md#allow-secure-signals-sharing) を参照してください。 +- Google Ad Manager アカウントで、暗号化されたシグナルが適切にサードパーティビッダと共有されていることを確認します: [Secure Signals sharing を許可](integration-google-ss.md#allow-secure-signals-sharing) を参照してください。 - Prebid.js の設定を更新します: [Optional: Enable Secure Signals in Prebid.js](integration-google-ss.md#optional-enable-secure-signals-in-prebidjs) を参照してください。 -## Sample Implementation +## Sample implementation 以下のサンプル実装は、Client-Server インテグレーションを使用して UID2 を Prebid.js にインテグレーションする方法を示すために利用可能です。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-client-side.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-client-side.md index d6a57397a..470facf59 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-client-side.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-client-side.md @@ -14,29 +14,29 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai import SnptAddPrebidjsToYourSite from '../snippets/_snpt-prebid-add-prebidjs-to-your-site.mdx'; import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx'; -# UID2 Client-Side Integration Guide for Prebid.js +# UID2 client-side integration guide for Prebid.js このガイドは、Client-Side で DII (メールアドレスまたは電話番号) にアクセスでき、UID2 とインテグレーションして、RTB ビッドストリームで Prebid.js によって渡される UID2 Token (Advertising Token) を生成したいパブリッシャー向けのものです。 Prebid.js を使用して UID2 とインテグレーションするには、サイトの HTML と JavaScript を変更する必要があります。このガイドに従う場合、Server-Side の作業は必要ありません。 -## Prebid.js Version +## Prebid.js version この実装には、Prebid.js バージョン 8.21.0 以降が必要です。バージョン情報については、[https://github.com/prebid/Prebid.js/releases](https://github.com/prebid/Prebid.js/releases) を参照してください。 -以前のバージョンの Prebid.js を使用する必要がある場合は、代わりに [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) で説明している実装ソリューションを使用してください。 +以前のバージョンの Prebid.js を使用する必要がある場合は、代わりに [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) で説明している実装ソリューションを使用してください。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Integration Overview: High-Level Steps +## Integration overview: High-level steps 以下のステップを完了する必要があります: @@ -44,31 +44,31 @@ Prebid.js を使用して UID2 とインテグレーションするには、サ 2. [Add Prebid.js to your site](#add-prebidjs-to-your-site) 3. [Configure the UID2 module](#configure-the-uid2-module) -### Complete UID2 Account Setup and Configure Account +### Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。そこで本番 [環境](../getting-started/gs-environments.md) 用の [credentials](../getting-started/gs-credentials.md) を作成し、提供が必要な追加の値を設定できます。詳細は [Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。そこで本番 [環境](../getting-started/gs-environments.md) 用の [credentials](../getting-started/gs-credentials.md) を作成し、提供が必要な追加の値を設定できます。詳細は [Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -Client-Side インテグレーションの場合、UID2 Portal の [Client-Side Integration](../portal/client-side-integration.md) ページで以下の値を設定する必要があります: +Client-Side インテグレーションの場合、UID2 Portal の [Client-side integration](../portal/client-side-integration.md) ページで以下の値を設定する必要があります: -- Subscription ID と Public Key: [Adding and Managing Key Pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 +- Subscription ID と Public Key: [Adding and managing key pairs](../portal/client-side-integration.md#adding-and-managing-key-pairs) を参照してください。 -- Prebid.js を使用するサイトの **ドメイン名** のリスト: [Adding and Managing Root-Level Domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) を参照してください。 +- Prebid.js を使用するサイトの **ドメイン名** のリスト: [Adding and managing root-level domains](../portal/client-side-integration.md#adding-and-managing-root-level-domains) を参照してください。 :::tip アカウント設定に必要なのはルートレベルのドメインのみです。たとえば、example.com、shop.example.com、example.org で Prebid.js とともに UID2 を使用する場合、提供する必要があるドメイン名は example.com と example.org のみです。 ::: -### Add Prebid.js to Your Site +### Add Prebid.js to your site -### Configure the UID2 Module +### Configure the UID2 module UID2 モジュールを設定するには、アカウント設定中に受け取った **Public Key** と **Subscription ID**、およびユーザーのハッシュ化された、またはハッシュ化されていないメールアドレスまたは電話番号を含むオブジェクトを指定して `pbjs.setConfig` を呼び出します。 @@ -89,11 +89,11 @@ UID2 モジュールを設定するには、アカウント設定中に受け取 1. 次に、SHA-256 ハッシュアルゴリズムを使用して結果をハッシュ化します。 1. 次に、ハッシュ値の結果のバイトを Base64 エンコーディングを使用してエンコードします。 - 詳細については、[Normalization and Encoding](../getting-started/gs-normalization-encoding.md) を参照してください。例については、[Configuring the UID2 Module: Code Example](#configuring-the-uid2-module-code-example) を参照してください。 + 詳細については、[Normalization and encoding](../getting-started/gs-normalization-encoding.md) を参照してください。例については、[Configuring the UID2 module: Code example](#configuring-the-uid2-module-code-example) を参照してください。 - UID2 モジュールは、UID2 Service に送信する前に、ハッシュ化された DII を暗号化します。 - モジュールが複数回設定された場合は、最新の設定値が使用されます。 -#### Configuring the UID2 Module: Code Example +#### Configuring the UID2 module: Code example 以下のコードスニペットは、UID2 モジュールを設定するさまざまな方法を示しています。 @@ -117,14 +117,14 @@ const baseConfig = { ``` :::note -この例では、UID2 本番環境を使用していることを前提としています。インテグレーションテスト中は、`params.uid2ApiBase` を `'https://operator-integ.uidapi.com'` に設定して UID2 インテグレーション環境を使用してください。UID2 インテグレーション環境からのトークンは、ビッドストリームに渡すためには無効です。インテグレーション環境の場合は、別途 **Subscription ID** と **Public Key** の値をリクエストする必要があります。これらは UID2 Portal では作成できません。詳細については、[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 +この例では、UID2 本番環境を使用していることを前提としています。インテグレーションテスト中は、`params.uid2ApiBase` を `'https://operator-integ.uidapi.com'` に設定して UID2 インテグレーション環境を使用してください。UID2 インテグレーション環境からのトークンは、ビッドストリームに渡すためには無効です。インテグレーション環境の場合は、別途 **Subscription ID** と **Public Key** の値をリクエストする必要があります。これらは UID2 Portal では作成できません。詳細については、[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 ::: -## Storing the UID2 Token in the Browser +## Storing the UID2 token in the browser -## When to Pass DII to the UID2 Module +## When to pass DII to the UID2 module UID2 モジュールが設定されると、ユーザーのブラウザ内に既存の UID2 Token があるかを確認します。同じ DII から生成されたトークンが存在し、それがまだ有効であるか、リフレッシュ可能である場合、モジュールはそれを使用し、必要に応じてリフレッシュします。 @@ -180,7 +180,7 @@ pbjs.setConfig({ } ``` -## Checking the Integration +## Checking the integration UID2 モジュールが正常に UID2 Token を生成したことを確認するには、`pbjs.getUserIds().uid2` を呼び出します。値が返された場合、有効な UID2 Token が UID2 モジュールに存在します。 @@ -189,7 +189,7 @@ UID2 モジュールが正常に UID2 Token を生成したことを確認する - ブラウザのコンソールログを確認してください。 - **Subscription ID** (**subscriptionId** の値) と **Public Key** (**serverPublicKey** の値) を確認してください: - UID2 チームから受け取った値と完全に同じであることを確認してください。 - - 使用している環境に対して正しい値を持っていることを確認してください。環境ごとに異なる **Subscription ID** と **Public Key** の値があります。[Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 + - 使用している環境に対して正しい値を持っていることを確認してください。環境ごとに異なる **Subscription ID** と **Public Key** の値があります。[Getting your credentials](../getting-started/gs-credentials.md#getting-your-credentials) を参照してください。 - アカウント設定時に、サイトのドメイン名を UID2 チームに提供したことを確認してください。必要に応じて、UID2 の連絡先に確認してください。 - ブラウザの開発者ツールを使用して、UID2 サービスへの API 呼び出しを検査してください。 @@ -200,7 +200,7 @@ Prebid.js の設定を検証およびデバッグするためのツールの例 - Chrome ウェブストアのダウンロード場所: [Professor Prebid](https://chromewebstore.google.com/detail/professor-prebid/kdnllijdimhbledmfdbljampcdphcbdc) - prebid.org のドキュメント: [Professor Prebid User Guide](https://docs.prebid.org/tools/professor-prebid.html) -## Optional: Specifying the API Base URL to Reduce Latency +## Optional: Specifying the API base URL to reduce latency デフォルトでは、UID2 モジュールは米国の UID2 本番環境サーバーへの呼び出しを行います。 @@ -222,7 +222,7 @@ pbjs.setConfig({ }); ``` -## Optional: Deferred Client-Side UID2 Configuration with mergeConfig +## Optional: Deferred client-side UID2 configuration with mergeconfig すでに Prebid.js を設定しているが、初期設定に UID2 を含めなかった場合でも、Prebid.js が提供する 2 つの関数を使用して UID2 モジュールを追加できます: @@ -260,18 +260,18 @@ await pbjs.refreshUserIds({ submoduleNames: ['uid2'] }); UID2 SDK を個別に管理している場合は、`window.__uid2.disconnect()` を使用してください。これは、ページのリフレッシュを必要とせずに、すべてのログアウト機能 (メモリとストレージの両方のクリア) を処理します。 ::: -遅延設定 (Deferred configuration) の実装サンプルも利用可能です。詳細については、[Sample Implementations](#sample-implementations) を参照してください。 +遅延設定 (Deferred configuration) の実装サンプルも利用可能です。詳細については、[Sample implementations](#sample-implementations) を参照してください。 -## Optional: Prebid.js Integration with Google Secure Signals +## Optional: Prebid.js integration with Google Secure Signals Prebid.js を使用しており、Google Secure Signals を使用して Google に UID2 Token を渡す予定の場合は、いくつかの追加の設定手順があります: -- Google Ad Manager アカウントで、暗号化されたシグナルがサードパーティのビダーと適切に共有されていることを確認してください: [Allow Secure Signals Sharing](integration-google-ss.md#allow-secure-signals-sharing) を参照してください。 +- Google Ad Manager アカウントで、暗号化されたシグナルがサードパーティのビダーと適切に共有されていることを確認してください: [Allow Secure Signals sharing](integration-google-ss.md#allow-secure-signals-sharing) を参照してください。 - Prebid.js の設定を更新してください: [Optional: Enable Secure Signals in Prebid.js](integration-google-ss.md#optional-enable-secure-signals-in-prebidjs) を参照してください。 -Secure Signals を使用した Prebid.js の実装サンプルも利用可能です。詳細については、[Sample Implementations](#sample-implementations) を参照してください。 +Secure Signals を使用した Prebid.js の実装サンプルも利用可能です。詳細については、[Sample implementations](#sample-implementations) を参照してください。 -## Sample Implementations +## Sample implementations UID2 を Client-Side で Prebid.js とインテグレーションする方法を示すために、以下の実装サンプルが利用可能です: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-mobile-summary.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-mobile-summary.md index 1d544f977..534add435 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-mobile-summary.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-mobile-summary.md @@ -10,11 +10,11 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Mobile Integration with Prebid Mobile SDK +# UID2 mobile integration with Prebid Mobile SDK UID2 の Prebid とのインテグレーションは、Prebid Mobile SDK オプションの UID2 インテグレーションを使用することで、Android と iOSの モバイルデバイスでもサポートされます。 詳細は以下のモバイルインテグレーションガイドのセクションを参照してください: -- [UID2 Client-Side Integration Guide for Mobile: Prebid Integration](integration-mobile-client-side#optional-uid2-integration-with-prebid-mobile-sdk) -- [UID2 Client-Server Integration Guide for Mobile: Prebid Integration](integration-mobile-client-server#optional-uid2-integration-with-prebid-mobile-sdk) +- [UID2 client-side integration guide for mobile: Prebid integration](integration-mobile-client-side#optional-uid2-integration-with-prebid-mobile-sdk) +- [UID2 client-server integration guide for mobile: Prebid integration](integration-mobile-client-server#optional-uid2-integration-with-prebid-mobile-sdk) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid.md index 4f9577b6a..34d72910b 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid.md @@ -13,19 +13,19 @@ import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx'; -# UID2 Integration Overview for Prebid +# UID2 integration overview for Prebid このガイドは、UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js によって渡される UID2 Token (Advertising Token) を生成したいパブリッシャー向けのインテグレーションオプションの概要です。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Prebid.js Support for Web +## Prebid.js support for web UID2 は、以下をサポートする Prebid.js module を提供しています: @@ -42,7 +42,7 @@ UID2 は GDPR が適用さ -### Generating the UID2 Token +### Generating the UID2 token DII へのアクセスに応じて、Prebid.js で使用する UID2 Token を生成する方法は次の表のように2種類あります。 @@ -50,29 +50,29 @@ DII へのアクセスに応じて、Prebid.js で使用する UID2 Token を生 | Scenario | Integration Guide | | :--- | :--- | -| Client-Side で DII にアクセスでき、フロントエンドの開発のみを行いたい。 | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | -| Server-Side で DII にアクセスし、Server-Side の開発ができる。 | [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) | +| Client-Side で DII にアクセスでき、フロントエンドの開発のみを行いたい。 | [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) | +| Server-Side で DII にアクセスし、Server-Side の開発ができる。 | [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) | -### Refreshing the UID2 Token +### Refreshing the UID2 token -Prebid.js UID2 Module は、UID2 Token を自動的にリフレッシュすることができます。Prebid.js の外部で手動リフレッシュを実装したい場合は、Server-Side インテグレーションガイドの [Refreshing a UID2 Token](integration-prebid-client-server.md#refreshing-a-uid2-token) を参照してください。Client-Side のインテグレーションソリューションには、トークンの自動リフレッシュが含まれています。 +Prebid.js UID2 Module は、UID2 Token を自動的にリフレッシュすることができます。Prebid.js の外部で手動リフレッシュを実装したい場合は、Server-Side インテグレーションガイドの [Refreshing a UID2 token](integration-prebid-client-server.md#refreshing-a-uid2-token) を参照してください。Client-Side のインテグレーションソリューションには、トークンの自動リフレッシュが含まれています。 -### Storing the UID2 Token in the Browser +### Storing the UID2 token in the browser -### Passing the UID2 Token to the Bidstream +### Passing the UID2 token to the bidstream UID2 module を設定するには `pbjs.setConfig` を呼び出します。サポートされているパラメータの詳細は、実装に適用されるガイドを参照してください: -- [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) -- [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) +- [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) +- [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) UID2 module が設定されると、ユーザーの UID2 Token を管理し、ユーザーのブラウザに保存します。 -Client-Side または Server-Side でクライアントリフレッシュモードを使用してトークンを生成する場合、ユーザーのブラウザでサイトが開いている間は、モジュールが自動的にトークンをリフレッシュします。しかし、Server-Side でトークンのリフレッシュを管理するオプションもあります。詳細は、Server-Side インテグレーションガイドの [Refreshing a UID2 Token](integration-prebid-client-server.md#refreshing-a-uid2-token) を参照してください。Client-Side のインテグレーションソリューションには、トークンの自動リフレッシュが含まれています。 +Client-Side または Server-Side でクライアントリフレッシュモードを使用してトークンを生成する場合、ユーザーのブラウザでサイトが開いている間は、モジュールが自動的にトークンをリフレッシュします。しかし、Server-Side でトークンのリフレッシュを管理するオプションもあります。詳細は、Server-Side インテグレーションガイドの [Refreshing a UID2 token](integration-prebid-client-server.md#refreshing-a-uid2-token) を参照してください。Client-Side のインテグレーションソリューションには、トークンの自動リフレッシュが含まれています。 -### Integration Overview: High-Level Steps +### Integration overview: High-level steps Prebid.js を使ってサイトを UID2 とインテグレーションするには、以下のステップを完了する必要があります: @@ -82,9 +82,9 @@ Prebid.js を使ってサイトを UID2 とインテグレーションするに 詳細な手順は、以下のインテグレーションガイドのいずれかを参照してください: -- [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) -- [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) +- [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) +- [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) -## UID2 Integration with Prebid Mobile SDK for Mobile Devices +## UID2 integration with Prebid Mobile SDK for mobile devices -UID2 と Prebid のインテグレーションは、Android および iOS モバイルデバイスで [UID2 Mobile Integration with Prebid Mobile SDK](integration-prebid-mobile-summary.md) を使用してサポートされています。 +UID2 と Prebid のインテグレーションは、Android および iOS モバイルデバイスで [UID2 mobile integration with Prebid Mobile SDK](integration-prebid-mobile-summary.md) を使用してサポートされています。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-publisher-server-side.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-publisher-server-side.md index 80585bd12..b62678cc3 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-publisher-server-side.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-publisher-server-side.md @@ -12,22 +12,22 @@ import Link from '@docusaurus/Link'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Publisher Integration Guide, Server-Side +# Publisher integration guide, server-side このガイドは、UID2 Token (Advertising Token) を RTB ビッドストリーム 用に生成するために、UID2 と直接インテグレーションを行いながら、UID2 対応シングルサインオンや ID プロバイダーではなく、すべてのインテグレーションを Server-Side で行うパブリッシャー向けのガイドです。 パブリッシャーが UID2 と Server-Side でインテグレーションするには、以下のオプションが利用可能です: -- SDK for Java (see [Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers) section). -- SDK for Python (see [Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers) section). +- SDK for Java (see [Usage for publishers](../sdks/sdk-ref-java.md#usage-for-publishers) section). +- SDK for Python (see [Usage for publishers](../sdks/sdk-ref-python.md#usage-for-publishers) section). - Custom server code to generate and refresh the UID2 token by calling the [POST /token/generate](../endpoints/post-token-generate.md) and [POST /token/refresh](../endpoints/post-token-refresh.md) endpoints. -ワークフローをデモするサンプルアプリケーションもあります。[Sample Implementation](#sample-implementation) を参照してください。 +ワークフローをデモするサンプルアプリケーションもあります。[Sample implementation](#sample-implementation) を参照してください。 -パブリッシャーインテグレーションオプションの完全な概要は、[Publisher Integrations](summary-guides.md#publisher-integrations) を参照してください。 +パブリッシャーインテグレーションオプションの完全な概要は、[Publisher integrations](summary-guides.md#publisher-integrations) を参照してください。 :::tip -UID2 と UID2 Token を使用してクライアントのアイデンティティを確立し、UID2 Token を取得するプロセスを容易にするために、SDK for JavaScript を使用することを検討してください。詳細は [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) を参照してください。 +UID2 と UID2 Token を使用してクライアントのアイデンティティを確立し、UID2 Token を取得するプロセスを容易にするために、SDK for JavaScript を使用することを検討してください。詳細は [Client-server integration guide for JavaScript](integration-javascript-client-server.md) を参照してください。 ::: ## Introduction @@ -42,36 +42,36 @@ UID2 と UID2 Token を使用してクライアントのアイデンティティ [FAQs](#faqs) も参照してください。 -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Preparing DII for Processing +## Preparing DII for processing -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、UID2 Portal にアクセスするための手順とリンクが送信されます。UID2 Portal では、本番環境のための [credentials](../getting-started/gs-credentials.md) を作成し、提供する必要がある追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、UID2 Portal にアクセスするための手順とリンクが送信されます。UID2 Portal では、本番環境のための [credentials](../getting-started/gs-credentials.md) を作成し、提供する必要がある追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -Server-Side インテグレーションの場合、UID2 Portal の [API Keys](../portal/api-keys.md) ページで以下の値を設定する必要があります: +Server-Side インテグレーションの場合、UID2 Portal の [API keys](../portal/api-keys.md) ページで以下の値を設定する必要があります: - API Key、Client Key とも呼ばれます。 - Client Secret、参加者と UID2 Service のみが知る値。 :::important -これらの値を安全に保管することが非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 +これらの値を安全に保管することが非常に重要です。詳細は、[Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 ::: -## Integration Steps +## Integration steps 以下の図は、ユーザーがパブリッシャーと UID2 Token を確立するために必要なステップと、UID2 Token が RTB ビッドストリームとどのようにインテグレーションされるかを概説したものです。 Server-Side SDK を使用している場合、SDK はエンドポイントに関連するすべてのステップを処理します。たとえば、Step 1-d では、発行者はユーザーの DII をトークン生成サービスに送信します。 -![Publisher Flow](images/integration-publisher-server-side-mermaid.png) +![Publisher flow](images/integration-publisher-server-side-mermaid.png) @@ -80,9 +80,9 @@ Server-Side SDK を使用している場合、SDK はエンドポイントに関 1. [Establish identity: capture user data](#establish-identity-capture-user-data) 2. [Bid using a UID2 token](#bid-using-a-uid2-token) 3. [Refresh a UID2 token](#refresh-a-uid2-token) -4. [Clear Identity: user logout](#clear-identity-user-logout) +4. [Clear identity: user logout](#clear-identity-user-logout) -### Establish Identity: Capture User Data +### Establish identity: Capture user data Step 1-c で認証が行われ、パブリッシャーがユーザーのメールアドレスや電話番号を検証した後、パブリッシャーは Server-Side で UID2 Token を生成するリクエストを送信することができます。次の表は、トークン生成ステップの詳細です。 @@ -96,7 +96,7 @@ Step 1-c で認証が行われ、パブリッシャーがユーザーのメー | 1-e | [POST /token/generate](../endpoints/post-token-generate.md) | ユーザーのメールアドレス、電話番号、またはそれぞれのハッシュからと、Refresh Token などの関連値から生成された UID2 Token を返します。 | | 1-f | N/A | 返された `advertising_token` と `refresh_token` は、ユーザーに紐づくストレージに保存します。ファーストパーティクッキーのような Client-Side のストレージや、Server-Side のストレージを検討するとよいでしょう。| -### Bid Using a UID2 Token +### Bid using a UID2 token UID2 ID 情報をどのように管理し、ターゲティング広告に使用したいかを検討する必要があります。たとえば、返された UID2 Token を SSP に渡す等。 @@ -105,14 +105,14 @@ UID2 ID 情報をどのように管理し、ターゲティング広告に使用 | 2-a | N/A | Step [1-e](#establish-identity-capture-user-data) の `advertising_token` を入札のために SSP に送信します。そのままの値を送信します。 | :::note -UID2 Token が SSP から DSP に送信されるとき、ビッドストリーム内でどのように見えるかの例は、[ビッドストリームで UID2 Token はどのように見えますか？](../getting-started/gs-faqs.md#what-does-a-uid2-token-look-like-in-the-bidstream) を参照してください。 +UID2 Token が SSP から DSP に送信されるとき、ビッドストリーム内でどのように見えるかの例は、[ビッドストリームで UID2 token はどのように見えますか？](../getting-started/gs-faqs.md#what-does-a-uid2-token-look-like-in-the-bidstream) を参照してください。 ::: -### Refresh a UID2 Token +### Refresh a UID2 token `POST /token/refresh` エンドポイントを使用して、常に有効で最新の UID2 Token を持つようにします。UID2 ローテーションと同期させるには、UID2 Token をリフレッシュする必要があります。さらに、トークンリフレッシュプロセスではユーザーのオプトアウトステータスをチェックし、ユーザーがオプトアウトしている場合は新しいトークンを送信しません。これによりトークンリフレッシュチェーンが終了します。その UID2 Token を二度と使用してはなりません。 -UID2 のオプトアウトワークフローとユーザーがオプトアウトする方法の詳細は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +UID2 のオプトアウトワークフローとユーザーがオプトアウトする方法の詳細は、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 | Step | Endpoint | Description | | :--- | :--- | :--- | @@ -125,7 +125,7 @@ UID2 のオプトアウトワークフローとユーザーがオプトアウト [POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントによって返された ID の `refresh_from` タイムスタンプからトークンのリフレッシュを始めてください。 ::: -### Clear Identity: User Logout +### Clear identity: User logout ユーザーがログアウトした場合は、UID2 Token を使用しないでください。 @@ -134,7 +134,7 @@ UID2 のオプトアウトワークフローとユーザーがオプトアウト | 4-a | N/A | ユーザーがパブリッシャーアセットからログアウトしました。| | 4-b | N/A | そのユーザー用に保存してある UID2 Token を削除します。UID2 Service とのやりとりは必要ありません。 | -## Sample Implementation +## Sample implementation Server-only のインテグレーションのためのサンプルアプリケーションがあります。以下を参照してください: @@ -143,4 +143,4 @@ Server-only のインテグレーションのためのサンプルアプリケ ## FAQs -パブリッシャー向けのよくある質問は、[FAQs for Publishers](../getting-started/gs-faqs.md#faqs-for-publishers) を参照してください。 +パブリッシャー向けのよくある質問は、[FAQs for publishers](../getting-started/gs-faqs.md#faqs-for-publishers) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake-before-february-2025.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake-before-february-2025.md index b536d8a46..fa2b60802 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake-before-february-2025.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake-before-february-2025.md @@ -10,20 +10,20 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Snowflake Integration Guide (Pre-Feb 2025) +# Snowflake integration guide (pre-Feb 2025) [Snowflake](https://www.snowflake.com/) は、クラウドデータウェアハウジングソリューションで、パートナーとしてデータを保存し、UID2 フレームワークとインテグレーションすることができます。Snowflake を使用することで、UID2 は、機密性の高い直接識別情報 (DII)を公開せずに、消費者識別子データを安全に共有できます。消費者識別子データを直接問い合わせる Operator Web Service があるにもかかわらず、Snowflake UID2 インテグレーションはよりシームレスなエクスペリエンスを提供します。 :::important -このドキュメントは、2025年2月以前に公開された広告主とデータプロバイダー向けの別々の Snowflake marketplace を使用しているユーザー向けです。2025年2月に公開された新しいインテグレーションに関するドキュメントは、[Snowflake Integration Guide (Pre-July 2025)](integration-snowflake-previous) を参照してください。以前の実装を使用している場合は、更新と強化を活用するために新しいバージョンに移行することを勧めます。移行情報は、[Migration Guide](integration-snowflake.md#migration-guide) を参照してください。 +このドキュメントは、2025年2月以前に公開された広告主とデータプロバイダー向けの別々の Snowflake marketplace を使用しているユーザー向けです。2025年2月に公開された新しいインテグレーションに関するドキュメントは、[Snowflake integration guide (pre-July 2025)](integration-snowflake-previous) を参照してください。以前の実装を使用している場合は、更新と強化を活用するために新しいバージョンに移行することを勧めます。移行情報は、[Migration guide](integration-snowflake.md#migration-guide) を参照してください。 ::: Snowflake の UID2 インテグレーションの実装は、広告主とデータプロバイダー向けに別々の Snowflake marketplace で提供されていました。これらのリストは、2025年2月に更新されたバージョンが公開された後に削除されました。 -実装したものがある場合は、このドキュメントを使用してメンテナンスすることができますが、最新バージョンにアップグレードすることを勧めます。[Snowflake Integration Guide](integration-snowflake.md) を参照してください。 +実装したものがある場合は、このドキュメントを使用してメンテナンスすることができますが、最新バージョンにアップグレードすることを勧めます。[Snowflake integration guide](integration-snowflake.md) を参照してください。 :::tip -広告主とデータプロバイダー向けのすべてのインテグレーションオプションと手順の概要は、[Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md) を参照してください。 +広告主とデータプロバイダー向けのすべてのインテグレーションオプションと手順の概要は、[Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md) を参照してください。 ::: ## Functionality @@ -37,21 +37,21 @@ Snowflake の UID2 インテグレーションの実装は、広告主とデー *Snowflake を使用して DII から直接 UID2 Token を生成することはできません。ただし、DII を raw UID2 に変換し、raw UID2 を UID2 Tokenに暗号化することはできます。 :::note -ビッドストリームで UID2 Token を共有するパブリッシャーの場合は、[Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください +ビッドストリームで UID2 Token を共有するパブリッシャーの場合は、[Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください ::: -## Workflow Diagram +## Workflow diagram 次の図は、Snowflake が UID2 インテグレーションプロセスにどのように関わるかを示しています: -![Snowflake Integration Architecture](images/uid2-snowflake-integration-architecture-drawio.png) +![Snowflake integration architecture](images/uid2-snowflake-integration-architecture-drawio.png) | Partner Snowflake Account | UID2 Snowflake Account | UID2 Core Opt-Out Cloud Setup | | :--- | :--- | :--- | | パートナーとして、Snowflake アカウントを設定してデータをホストし、UID2 Share を通じて関数やビューを使うことで、UID2 インテグレーションに関与できます。 | Snowflake アカウントでホストされている UID2 インテグレーションでは、プライベートテーブルからデータを引き出す許可をされた関数とビューへのアクセスが許可されます。プライベートテーブルにはアクセスできません。UID2 Share では、UID2 関連のタスクを実行するために必要な重要なデータのみが公開されます。 | ETL (抽出・変換・ロード) ジョブは、UID2 Core/Optout Snowflake ストレージを常に更新し、UID2 Operator Web Service を動かす内部データを提供します。Operator Web Service で使用されるデータは、UID2 Share からも入手できます。 | | 共有関数とビューを使用する場合、Snowflake にトランザクションのコストを支払います。 | UID2 Snowflake アカウントで保護されたこれらのプライベートテーブルは、UID2 関連のタスクを完了するために使用される内部データを保持する UID2 Core/Optout Snowflake ストレージと自動的に同期されます。 | | -## Access the UID2 Shares +## Access the UID2 shares UID2 Shareへのアクセスは、[Snowflake Data Marketplace](https://www.snowflake.com/data-marketplace/) を通して行います。ここでは、選択した UID2 パーソナライズドリストに基づいて特定のデータセットをリクエストすることができます。 @@ -75,7 +75,7 @@ UID2 Share へのアクセスを要求するには、次の手順を実行しま リクエストを受け取った後、UID2 Administrator が適切なアクセス方法をご連絡します。Snowflake でのデータリクエストの管理についての詳細は [Snowflake documentation](https://docs.snowflake.com/en/user-guide/data-marketplace-consumer.html) を参照してください。 -## Shared Objects +## Shared objects 選択した UID2 ソリューションに関係なく、以下の関数を使って、DII を UID2 にマッピングできます: @@ -87,18 +87,18 @@ UID2 Share へのアクセスを要求するには、次の手順を実行しま - `FN_T_UID2_IDENTITY_MAP_EMAIL_HASH` (非推奨) :::note -非推奨の関数を使用していて、新しい関数への移行の手助けが必要な場合は、[Migration Guide](#migration-guide) を参照してください。 +非推奨の関数を使用していて、新しい関数への移行の手助けが必要な場合は、[Migration guide](#migration-guide) を参照してください。 ::: -再生成が必要な UID2 を特定するには、UID Share から `UID2_SALT_BUCKETS` ビューを使用します。詳しくは、[Monitor for Salt Bucket Rotation and Regenerate Raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s) を参照してください。 +再生成が必要な UID2 を特定するには、UID Share から `UID2_SALT_BUCKETS` ビューを使用します。詳しくは、[Monitor for salt bucket rotation and regenerate raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s) を参照してください。 UID2 Sharing 参加者には、以下の機能も利用できます: -- `FN_T_UID2_ENCRYPT` (See [Encrypt Tokens](#encrypt-tokens)) -- `FN_T_UID2_DECRYPT` (See [Decrypt Tokens](#decrypt-tokens)) +- `FN_T_UID2_ENCRYPT` (See [Encrypt tokens](#encrypt-tokens)) +- `FN_T_UID2_DECRYPT` (See [Decrypt tokens](#decrypt-tokens)) -詳細は [Usage for UID2 Sharers](#usage-for-uid2-sharers) を参照してください。 +詳細は [Usage for UID2 sharers](#usage-for-uid2-sharers) を参照してください。 -### Database and Schema Names +### Database and schema names 以下のセクションでは、各ソリューションのクエリ例を示します。これらは、データベースとスキーマ名の変数を除けば、同じものです: @@ -136,9 +136,9 @@ DII が電話番号の場合、UID2 [電話番号正規化](../getting-started/g | :--- | :--- | :--- | | `UID2` | TEXT | DII は正常にマッピングされました:
DII は正常にマップされませんでした: `NULL`。 | | `BUCKET_ID` | TEXT | DII は正常にマップされました: UID2 の生成に使われたセカンドレベルのソルトバケットの ID。この ID は `UID2_SALT_BUCKETS` ビューのバケット ID に対応します。
DII は正常にマップされませんでした: `NULL`。 | -| `UNMAPPED` | TEXT | DII は正常にマッピングされました: `NULL`
DII は正常にマップされませんでした: `NULL`: DII は正常にマップされませんでした: 識別子がマップされなかった理由: `OPTOUT`、`INVALID IDENTIFIER`、`INVALID INPUT TYPE` のいずれか。詳細は [Values for the UNMAPPED Column](#values-for-the-unmapped-column) を参照してください。 | +| `UNMAPPED` | TEXT | DII は正常にマッピングされました: `NULL`
DII は正常にマップされませんでした: `NULL`: DII は正常にマップされませんでした: 識別子がマップされなかった理由: `OPTOUT`、`INVALID IDENTIFIER`、`INVALID INPUT TYPE` のいずれか。詳細は [Values for the unmapped column](#values-for-the-unmapped-column) を参照してください。 | -#### Values for the UNMAPPED Column +#### Values for the unmapped column `UNMAPPED`に指定できる値は以下の通りです: @@ -153,20 +153,20 @@ DII が電話番号の場合、UID2 [電話番号正規化](../getting-started/g このセクションのマッピングリクエストの例: -- [Single Unhashed Email](#mapping-request-example---single-unhashed-email) -- [Multiple Unhashed Emails](#mapping-request-example---multiple-unhashed-emails) -- [Single Unhashed Phone Number](#mapping-request-example---single-unhashed-phone-number) -- [Multiple Unhashed Phone Numbers](#mapping-request-example---multiple-unhashed-phone-numbers) -- [Single Hashed Email](#mapping-request-example---single-hashed-email) -- [Multiple Hashed Emails](#mapping-request-example---multiple-hashed-emails) -- [Single Hashed Phone Number](#mapping-request-example---single-hashed-phone-number) -- [Multiple Hashed Phone Numbers](#mapping-request-example---multiple-hashed-phone-numbers) +- [Single unhashed email](#mapping-request-example---single-unhashed-email) +- [Multiple unhashed emails](#mapping-request-example---multiple-unhashed-emails) +- [Single unhashed phone number](#mapping-request-example---single-unhashed-phone-number) +- [Multiple unhashed phone numbers](#mapping-request-example---multiple-unhashed-phone-numbers) +- [Single hashed email](#mapping-request-example---single-hashed-email) +- [Multiple hashed emails](#mapping-request-example---multiple-hashed-emails) +- [Single hashed phone number](#mapping-request-example---single-hashed-phone-number) +- [Multiple hashed phone numbers](#mapping-request-example---multiple-hashed-phone-numbers) :::note これらの例の入出力データは、説明のみを目的とした架空のものです。提供された値は実際の値ではありません。 ::: -#### Mapping Request Example - Single Unhashed Email +#### Mapping request example - single unhashed email 次のクエリは、[デフォルトのデータベースとスキーマ名](#database-and-schema-names) を使用して、単一のメールアドレスをマッピングする方法を示しています。 @@ -192,7 +192,7 @@ select UID2, BUCKET_ID, UNMAPPED from table(UID2_PROD_DP_SH.DP.FN_T_UID2_IDENTIT +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Emails +#### Mapping request example - multiple unhashed emails 以下のクエリは、[デフォルトのデータベースとスキーマ名](#database-and-schema-names) を使用して、複数のメールアドレスをマッピングする方法を示しています。 @@ -227,7 +227,7 @@ select a.ID, a.EMAIL, m.UID2, m.BUCKET_ID, UNMAPPED from AUDIENCE a LEFT JOIN( +----+--------------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Unhashed Phone Number +#### Mapping request example - single unhashed phone number 以下のクエリは、[デフォルトのデータベース名とスキーマ名](#database-and-schema-names) を使って電話番号をマッピングする方法を示しています。 @@ -255,7 +255,7 @@ select UID2, BUCKET_ID, UNMAPPED from table(UID2_PROD_DP_SH.DP.FN_T_UID2_IDENTIT +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Phone Numbers +#### Mapping request example - multiple unhashed phone numbers 以下のクエリは、[デフォルトのデータベース名とスキーマ名](#database-and-schema-names) を使用して、複数の電話番号をマップする方法を示しています。 @@ -292,7 +292,7 @@ The following table identifies each item in the response, including `NULL` value +----+--------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Email +#### Mapping request example - single hashed email 以下のクエリは、[デフォルトのデータベースとスキーマ名](#database-and-schema-names) を使用して、単一のメールアドレスハッシュをマップする方法を示しています。 @@ -318,7 +318,7 @@ select UID2, BUCKET_ID, UNMAPPED from table(UID2_PROD_DP_SH.DP.FN_T_UID2_IDENTIT +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Emails +#### Mapping request example - multiple hashed emails 以下のクエリは、[デフォルトのデータベースとスキーマ名](#database-and-schema-names) を使用して、複数のメールアドレスハッシュをマッピングする方法を示しています。 @@ -352,7 +352,7 @@ select a.ID, a.EMAIL_HASH, m.UID2, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT +----+----------------------------------------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Phone Number +#### Mapping request example - single hashed phone number 以下のクエリは、[デフォルトのデータベース名とスキーマ名](#database-and-schema-names) を使用して、単一の電話番号ハッシュをマップする方法を示しています。 @@ -378,7 +378,7 @@ select UID2, BUCKET_ID, UNMAPPED from table(UID2_PROD_DP_SH.DP.FN_T_UID2_IDENTIT +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Phone Numbers +#### Mapping request example - multiple hashed phone numbers 以下のクエリは、[デフォルトのデータベース名とスキーマ名](#database-and-schema-names) を使用して、複数の電話番号ハッシュをマップする方法を示しています。 @@ -412,7 +412,7 @@ select a.ID, a.PHONE_HASH, m.UID2, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT +----+----------------------------------------------+----------------------------------------------+------------+--------------------+ ``` -### Monitor for Salt Bucket Rotation and Regenerate Raw UID2s +### Monitor for salt bucket rotation and regenerate raw UID2s `UID2_SALT_BUCKETS` ビュークエリは、セカンドレベルのソルトバケットが最後に更新された日時を返します。セカンドレベルのソルトは UID2 を生成する際に使用されます。バケット内のソルトが更新されると、それまで生成されていた UID2 が古くなり、同じユーザーに対して他者が生成した UID2 とは一致しなくなります。 @@ -425,7 +425,7 @@ select a.ID, a.PHONE_HASH, m.UID2, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT 次の例は、入力テーブルと、セカンドレベルのソルトが更新されたために再生成が必要なテーブルの UID2 を見つけるために使用されるクエリを示しています。 -#### Targeted Input Table +#### Targeted input table このシナリオ例では、広告主/データプロバイダーは UID2 を `AUDIENCE_WITH_UID2` という名前のテーブルに格納しています。最後の列 `LAST_UID2_UPDATE_UTC` は、UID2 が生成された時刻を記録するために使用されます。UID2 が生成されていない場合、3 番目の例に示すように値は `NULL` となります。広告主/データプロバイダーはこのタイムスタンプ値を使って、どの UID2 を再生成する必要があるかを判断できます。 @@ -475,7 +475,7 @@ select a.*, b.LAST_SALT_UPDATE_UTC +----+--------------------+----------------------------------------------+------------+-------------------------+-------------------------+ ``` -## Migration Guide +## Migration guide `FN_T_UID2_IDENTITY_MAP_EMAIL` 関数と `FN_T_UID2_IDENTITY_MAP_EMAIL_HASH` 関数を使用している場合は、できるだけ早く `FN_T_UID2_IDENTITY_MAP` 関数に移行することを勧めます。この関数は、他の2つの関数が行うことをすべて行い、その他の改良も組み込まれています。 @@ -483,14 +483,14 @@ select a.*, b.LAST_SALT_UPDATE_UTC - 電話番号とハッシュ化された電話番号の両方のマッピングをサポートしています。 - ユーザーのオプトアウトをサポートしました。 -- `UNMAPPED` という新しいカラムが追加されました。何らかの理由で DII を UID2 にマッピングできない場合、この列にはその理由についての情報が含まれます。詳細は [Values for the UNMAPPED Column](#values-for-the-unmapped-column) を参照してください。 +- `UNMAPPED` という新しいカラムが追加されました。何らかの理由で DII を UID2 にマッピングできない場合、この列にはその理由についての情報が含まれます。詳細は [Values for the unmapped column](#values-for-the-unmapped-column) を参照してください。 このセクションには、新機能へのアップグレードに役立つ以下の情報が含まれています: - [既存のコードの変更](#changing-existing-code) -- [UNMAPPEDカラムの値を使う](#using-the-values-for-the-unmapped-column) +- [Unmappedカラムの値を使う](#using-the-values-for-the-unmapped-column) -### Changing Existing Code +### Changing existing code このセクションのコードスニペットは、以前の関数がどのように実装されているか、そして新しい関数を使用するためにどのように更新できるかを示す Before / After の例です。 @@ -522,29 +522,29 @@ After: FN_T_UID2_IDENTITY_MAP(EMAIL_HASH, 'email_hash') ``` -### Using the Values for the UNMAPPED Column +### Using the values for the unmapped column 新しい関数を実装したら、`FN_T_UID2_IDENTITY_MAP`が返す `UNMAPPED` カラムをチェックすることができます。DII が UID2 にマッピングできなかった場合、この列にはその理由が示されます。 -値とその説明の詳細は [Values for the UNMAPPED Column](#values-for-the-unmapped-column) を参照してください。 +値とその説明の詳細は [Values for the unmapped column](#values-for-the-unmapped-column) を参照してください。 -## Usage for UID2 Sharers +## Usage for UID2 sharers UID2 共有参加者 とは、送信者または受信者として共有に参加し、UID2を他の参加者と共有する企業のことです。 -広告主やデータプロバイダーは、Snowflake (Tokenized Sharing) を介して、UID2 を他の UID2 共有許可参加者と共有することができます。これらの参加者は、[raw UID2](../ref-info/glossary-uid#gl-raw-uid2) を UID2 Token に暗号化し、それを別の参加者に送信してピクセルで共有することができます ([Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。Snowflake 内でピクセル単位でデータを送信しない場合でも、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、UID2 Sharing に参加することができます。 +広告主やデータプロバイダーは、Snowflake (Tokenized Sharing) を介して、UID2 を他の UID2 共有許可参加者と共有することができます。これらの参加者は、[raw UID2](../ref-info/glossary-uid#gl-raw-uid2) を UID2 Token に暗号化し、それを別の参加者に送信してピクセルで共有することができます ([Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。Snowflake 内でピクセル単位でデータを送信しない場合でも、[Security requirements for UID2 sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、UID2 Sharing に参加することができます。 :::caution -このプロセスで生成される UID2 Token は共有専用です—ビッドストリームでは使用できません。ビッドストリーム用のトークン生成には別のワークフローがあります: [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 +このプロセスで生成される UID2 Token は共有専用です—ビッドストリームでは使用できません。ビッドストリーム用のトークン生成には別のワークフローがあります: [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 ::: -Snowflake 内でピクセルまたはビッドストリームでデータを送信しない場合、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、生の UID2 共有に参加することもできます。 +Snowflake 内でピクセルまたはビッドストリームでデータを送信しない場合、[Security requirements for UID2 sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、生の UID2 共有に参加することもできます。 以下のアクティビティは Tokenized Sharing に対応しています: -- [Encrypt Tokens](#encrypt-tokens) -- [Decrypt Tokens](#decrypt-tokens) +- [Encrypt tokens](#encrypt-tokens) +- [Decrypt tokens](#decrypt-tokens) -### Encrypt Tokens +### Encrypt tokens raw UID2 を UID2 Token に暗号化するには、関数 `FN_T_UID2_ENCRYPT` を使用します。該当する接頭辞を使用して自分の役割を示します:s - 広告主の場合: `ADV.FN_T_UID2_ENCRYPT` @@ -559,9 +559,9 @@ raw UID2 を UID2 Token に暗号化するには、関数 `FN_T_UID2_ENCRYPT` |Column Name|Data Type|Description| | :--- | :--- | :--- | | `UID2_TOKEN` | TEXT | 値は次のいずれかです:
  • 暗号化成功: raw UID2 を含む UID2 Token。
  • 暗号化失敗: `NULL`
| -| `ENCRYPTION_STATUS` | TEXT | 値は次のいずれかです。
  • 暗号化成功: `NULL`
  • 暗号化失敗: raw UID2 が暗号化されなかった理由。例: `INVALID_RAW_UID2` または `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`。
    詳細は [Values for the ENCRYPTION_STATUS Column](#values-for-the-encryption_status-column) を参照してください。
| +| `ENCRYPTION_STATUS` | TEXT | 値は次のいずれかです。
  • 暗号化成功: `NULL`
  • 暗号化失敗: raw UID2 が暗号化されなかった理由。例: `INVALID_RAW_UID2` または `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`。
    詳細は [Values for the encryption_status column](#values-for-the-encryption_status-column) を参照してください。
| -#### Values for the ENCRYPTION_STATUS Column +#### Values for the encryption_status column 次の表は、`ENCRYPTION_STATUS` 列の有効な値です。 @@ -574,7 +574,7 @@ raw UID2 を UID2 Token に暗号化するには、関数 `FN_T_UID2_ENCRYPT` | `NOT_AUTHORIZED_FOR_MASTER_KEY` | 呼び出し元が必要な 暗号化キー にアクセスできません。UID2 の管理者に連絡してください。 | | `NOT_AUTHORIZED_FOR_SITE_KEY` | 呼び出し元が必要な暗号化キーにアクセスできません。UID2 の管理者に連絡してください。 | -#### Encrypt Token Request Example - Single Raw UID2 +#### Encrypt token request example - single raw UID2 以下のクエリは、[default database and schema names](#database-and-schema-names) を使用して、単一の raw UID2 を UID2 Token に暗号化する方法を示しています。 @@ -600,7 +600,7 @@ select UID2_TOKEN, ENCRYPTION_STATUS from table(UID2_PROD_DP_SH.DP.FN_T_UID2_ENC +--------------------------------------------+ ``` -#### Encrypt Token Request Example - Multiple Raw UID2s +#### Encrypt token request example - multiple raw UID2s 以下のクエリは、[default database and schema names](#database-and-schema-names) を使用して、複数の raw UID2 を暗号化する方法を示しています。 @@ -630,7 +630,7 @@ select a.RAW_UID2, t.UID2_TOKEN, t.ENCRYPTION_STATUS from AUDIENCE_WITH_UID2 a, +----+----------------------------------------------+-----------------------+-----------------------------+ ``` -### Decrypt Tokens +### Decrypt tokens UID2 Token を raw UID2 に復号するには、関数 `FN_T_UID2_DECRYPT` を使用します。該当する接頭辞を使用して自分の役割を示します: - 広告主の場合: `ADV.FN_T_UID2_DECRYPT` @@ -646,13 +646,13 @@ UID2 Token を raw UID2 に復号するには、関数 `FN_T_UID2_DECRYPT` を | :--- | :--- | :--- | | `UID2` | TEXT | 値は次のいずれかです:
  • 復号化成功: UID2 Token に対応する raw UID2。
  • 復号化失敗: `NULL`.
| | `SITE_ID` | INT | 値は次のいずれかです:
  • 復号化成功: トークンを暗号化した UID2 参加者の識別子。
  • 復号化失敗: `NULL`.
| -| `DECRYPTION_STATUS` | TEXT | 値は次のいずれかです:
  • 復号化成功: `NULL`.
  • 復号化失敗: UID2 Token が復号化されなかった理由。例えば、`EXPIRED_TOKEN` です。
    詳細は [Values for the DECRYPTION_STATUS Column](#values-for-the-decryption_status-column) を参照してください。
| +| `DECRYPTION_STATUS` | TEXT | 値は次のいずれかです:
  • 復号化成功: `NULL`.
  • 復号化失敗: UID2 Token が復号化されなかった理由。例えば、`EXPIRED_TOKEN` です。
    詳細は [Values for the decryption_status column](#values-for-the-decryption_status-column) を参照してください。
| :::note UID2 Token がうまく復号化できない場合、この関数は行を返しません。 ::: -#### Values for the DECRYPTION_STATUS Column +#### Values for the decryption_status column 次の表は、`DECRYPTION_STATUS` 列の有効な値です。 @@ -661,7 +661,7 @@ UID2 Token がうまく復号化できない場合、この関数は行を返し | `NULL` | UID2 Token は正常に復号化されました。 | | `EXPIRED_TOKEN` | UID2 Token の有効期限が切れています。 | -#### Decrypt Token Request Example—Single UID2 Token +#### Decrypt token request example—single UID2 token 以下のクエリは、[default database and schema names](#database-and-schema-names) を使用して、単一の UID2 Token を raw UID2 に復号する方法を示しています。 @@ -687,7 +687,7 @@ select UID2, SITE_ID, DECRYPTION_STATUS from table(UID2_PROD_DP_SH.DP.FN_T_UID2_ +----------------------------------------------+-------------------+ ``` -#### Decrypt Token Request Example—Multiple UID2 Tokens +#### Decrypt token request example—multiple UID2 tokens 以下のクエリは、[default database and schema names](#database-and-schema-names) を使用して、複数の UID2 Token を復号化する方法を示しています。 @@ -725,12 +725,12 @@ select a.ID, b.UID2, b.SITE_ID, CASE WHEN b.UID2 IS NULL THEN 'DECRYPT_FAILED' E +----+----------------------------------------------+----------+-------------------+ ``` -### UID2 Sharing Example +### UID2 sharing example 以下の手順では、送信者と受信者の両方が Snowflake を使用している場合に、sharing がどのように機能するかの例を示しています。このシナリオ例では、広告主(送信者) が raw UID2 (`AUDIENCE_WITH_UID2`) を持つオーディエンステーブルを持っており、[Snowflake Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro) 機能を使ってテーブル内のデータをデータプロバイダー(受信者) が利用できるようにしたいと考えています。 -#### Sender Instructions +#### Sender instructions 1. `AUDIENCE_WITH_UID2_TOKENS` という名前の新しいテーブルを作成します。 2. `AUDIENCE_WITH_UID2S` テーブルの raw UID2 を暗号化し、その結果を `AUDIENCE_WITH_UID2_TOKENS` テーブルに格納します。例えば、以下のクエリはこのタスクを達成するのに役立ちます: @@ -744,7 +744,7 @@ select a.ID, b.UID2, b.SITE_ID, CASE WHEN b.UID2 IS NULL THEN 'DECRYPT_FAILED' E 共有した UID2 Token の期限切れを避けるため、送信者は暗号化後できるだけ早く、新しく暗号化された UID2 Token を受信者に送るべきです。 ::: -#### Receiver Instructions +#### Receiver instructions 1. 送信者がアクセス権を提供した安全な共有からデータベースを作成します。 2. `RECEIVED_AUDIENCE_WITH_UID2` という新しいテーブルを作成します。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake-previous.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake-previous.md index f2068099d..71d5c1ea8 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake-previous.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake-previous.md @@ -10,21 +10,21 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Snowflake Integration Guide (Pre-July 2025) +# Snowflake integration guide (pre-July 2025) [Snowflake](https://www.snowflake.com/) は、パートナーとしてデータを保存し、UID2 フレームワークとインテグレーションできるクラウドデータウェアハウジングソリューションです。Snowflake を使用することで、UID2 では機密性の高い直接識別情報 (DII)を公開せずに、消費者識別子データを安全に共有できます。消費者識別子データについて Operator Web Service に直接クエリを実行するオプションもありますが、Snowflake の UID2 インテグレーションはより円滑な体験を提供します。 :::important -このドキュメントは、2025年2月以前に公開された広告主とデータプロバイダー向けの別々の Snowflake marketplace を使用しているユーザー向けです。2025年2月に公開された新しいインテグレーションに関するドキュメントは、[Snowflake Integration Guide](integration-snowflake.md) を参照してください。以前の実装を使用している場合は、更新と強化を活用するために新しいバージョンに移行することを推奨します。移行情報は、[Migration Guide](integration-snowflake.md#migration-guide) を参照してください。 +このドキュメントは、2025年2月以前に公開された広告主とデータプロバイダー向けの別々の Snowflake marketplace を使用しているユーザー向けです。2025年2月に公開された新しいインテグレーションに関するドキュメントは、[Snowflake integration guide](integration-snowflake.md) を参照してください。以前の実装を使用している場合は、更新と強化を活用するために新しいバージョンに移行することを推奨します。移行情報は、[Migration guide](integration-snowflake.md#migration-guide) を参照してください。 ::: -## Snowflake Marketplace Listing +## Snowflake marketplace listing 以下のリストは、Snowflake マーケットプレイスで利用可能です： - [Unified ID 2.0: Advertiser and Data Provider Identity Solution](https://app.snowflake.com/marketplace/listing/GZT0ZRYXTN8/unified-id-2-0-unified-id-2-0-advertiser-and-data-provider-identity-solution) :::tip -広告主とデータプロバイダー向けのインテグレーションオプションとステップの概要は、[Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md)を参照してください。 +広告主とデータプロバイダー向けのインテグレーションオプションとステップの概要は、[Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md)を参照してください。 ::: ## Functionality @@ -38,15 +38,15 @@ import Link from '@docusaurus/Link'; *DII から 直接 UID2 Token を生成するために Snowflake を使用することはできません。ただし、DII を Raw UID2 に変換し、その Raw UID2 を UID2 Token に暗号化することは可能です。 :::note -ビッドストリームで UID2 Token を共有するパブリッシャーの場合は、[Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md)を参照してください。 +ビッドストリームで UID2 Token を共有するパブリッシャーの場合は、[Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md)を参照してください。 ::: -## Changes from Previous Version +## Changes from previous version 2025年2月の UID2 Snowflake マーケットプレイスインテグレーションの更新には、いくつかの更新と機能強化が含まれています。主な変更点の一つは、以前の 2 つのデータ共有（広告主向けとデータプロバイダー向け）の機能を組み合わせた単一のリスティングとデータ共有が含まれることです。これにより、すべての参加者のインテグレーションが簡素化されます。 :::note -これらの変更は、2025 年 2 月以前に公開された Snowflake 関数のバージョンを使用しているコードインテグレーションを想定しています（[Snowflake Integration Guide (Version Prior to February 2025)](integration-snowflake-before-february-2025.md) を参照）。`FN_T_UID2_IDENTITY_MAP_EMAIL` と `FN_T_UID2_IDENTITY_MAP_EMAIL_HASH` 関数を使用するさらに古いバージョンを使用している場合は、[Migration Guide section in the earlier guide](integration-snowflake-before-february-2025.md#migration-guide) の指示に従い、その後再度現在のバージョンにアップグレードすることもできます。ただし、このシナリオでは、このガイドの指示に従い、一度に更新することを勧めます。詳細は、[Migration Guide](#migration-guide) を参照してください。 +これらの変更は、2025 年 2 月以前に公開された Snowflake 関数のバージョンを使用しているコードインテグレーションを想定しています（[Snowflake integration guide (version prior to february 2025)](integration-snowflake-before-february-2025.md) を参照）。`FN_T_UID2_IDENTITY_MAP_EMAIL` と `FN_T_UID2_IDENTITY_MAP_EMAIL_HASH` 関数を使用するさらに古いバージョンを使用している場合は、[Migration guide section in the earlier guide](integration-snowflake-before-february-2025.md#migration-guide) の指示に従い、その後再度現在のバージョンにアップグレードすることもできます。ただし、このシナリオでは、このガイドの指示に従い、一度に更新することを勧めます。詳細は、[Migration guide](#migration-guide) を参照してください。 ::: 以下の表は、以前のバージョンからの Snowflake 関数の変更詳細を示しています。 @@ -54,27 +54,27 @@ import Link from '@docusaurus/Link'; | Old function | New function | Fields in old function | Fields in new function | Comments | | :-- | :-- | :-- | :-- | :-- | | `FN_T_UID2_IDENTITY_MAP` | `FN_T_IDENTITY_MAP` | `UID2` | `UID` | 詳細は [Map DII](#map-dii) を参照してください。| -| `FN_T_UID2_ENCRYPT` | `FN_T_ENCRYPT` | `UID2_TOKEN` | `UID_TOKEN` | 詳細は [Encrypt Tokens](#encrypt-tokens) を参照してください。| -| `FN_T_UID2_DECRYPT` | `FN_T_DECRYPT` | `UID2_TOKEN` | `UID_TOKEN` | 詳細は [Decrypt Tokens](#decrypt-tokens) を参照してください。| +| `FN_T_UID2_ENCRYPT` | `FN_T_ENCRYPT` | `UID2_TOKEN` | `UID_TOKEN` | 詳細は [Encrypt tokens](#encrypt-tokens) を参照してください。| +| `FN_T_UID2_DECRYPT` | `FN_T_DECRYPT` | `UID2_TOKEN` | `UID_TOKEN` | 詳細は [Decrypt tokens](#decrypt-tokens) を参照してください。| 以下の表は、以前のバージョンからの Snowflake ビューの変更詳細を示しています。 | Old view | New view | Comments | | :-- | :-- | :-- | -| `UID2_SALT_BUCKETS` | `SALT_BUCKETS` | 詳細は [Monitor for Salt Bucket Rotation and Regenerate Raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s) を参照してください。 | +| `UID2_SALT_BUCKETS` | `SALT_BUCKETS` | 詳細は [Monitor for salt bucket rotation and regenerate raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s) を参照してください。 | -## Workflow Diagram +## Workflow diagram 以下の図と表は、Snowflake における UID2 インテグレーションプロセスの各部分とワークフローを示しています。 -![Snowflake Integration Architecture](images/uid2-snowflake-integration-architecture-drawio.png) +![Snowflake integration architecture](images/uid2-snowflake-integration-architecture-drawio.png) |Partner Snowflake Account|UID2 Snowflake Account|UID2 Core Opt-Out Cloud Setup| | :--- | :--- | :--- | | パートナーとして、Snowflake アカウントを設定してデータをホストし、UID2 Share を通じて関数とビューを利用することで UID2 のインテグレーションを行います。 | UID2 インテグレーションは、Snowflake アカウントでホストされており、プライベートテーブルからデータを取得する認証済み関数とビューへのアクセス権を付与します。プライベートテーブルには直接アクセスできません。UID2 Share は、UID2 関連タスクを実行するために必要な重要なデータのみを公開します。
**Note**：プライベートテーブルにはソルトと暗号化キーを保存しています。いかなる時点でもDIIは保存されません。 | ETL（Extract Transform Load）ジョブが常に UID2 Core/Optout の Snowflake ストレージを、UID2 Operator Web Service を動かす内部データで更新しています。Operator Web Service で使用されるデータは UID2 Share を通じても利用可能です。| | 共有関数とビューを使用する場合、トランザクション計算コストは Snowflake に支払います。 | UID2 Snowflake アカウントで保護されているこれらのプライベートテーブルは、UID2 関連タスクを完了するために使用される内部データを保持する UID2 Core/Optout の Snowflake ストレージと自動的に同期します。 | | -## Access the UID2 Share +## Access the UID2 share UID2 Share へのアクセスは、[Snowflake Data Marketplace](https://www.snowflake.com/data-marketplace/) の以下のリスティングから利用できます： @@ -95,29 +95,29 @@ UID2 Share へのアクセスをリクエストするには、以下の手順を リクエストが受信された後、UID2 Administrator が適切なアクセス手順について連絡します。Snowflake でのデータリクエストの管理の詳細は、[Snowflake documentation](https://docs.snowflake.com/en/user-guide/data-marketplace-consumer.html) を参照してください。 -## Shared Objects +## Shared objects 次の関数を使用して、DII を UID2 にマッピングできます： - `FN_T_IDENTITY_MAP`（詳細は [Map DII](#map-dii) を参照） -以下の関数は `FN_T_IDENTITY_MAP` に代わって非推奨となっています。以前の Snowflake バージョンを使用している場合は引き続き使用できますが（[Snowflake Integration (Pre-Feb 2025)](integration-snowflake-before-february-2025.md) を参照）、できるだけ早くアップグレードすることを勧めます： +以下の関数は `FN_T_IDENTITY_MAP` に代わって非推奨となっています。以前の Snowflake バージョンを使用している場合は引き続き使用できますが（[Snowflake integration (pre-Feb 2025)](integration-snowflake-before-february-2025.md) を参照）、できるだけ早くアップグレードすることを勧めます： - `FN_T_UID2_IDENTITY_MAP`（非推奨） :::note -非推奨の関数を使用していて、新しい関数への移行に助けが必要な場合は、[Migration Guide](#migration-guide) を参照してください。 +非推奨の関数を使用していて、新しい関数への移行に助けが必要な場合は、[Migration guide](#migration-guide) を参照してください。 ::: -再生成が必要な UID2 を識別するには、UID2 Share の `SALT_BUCKETS` ビューを使用します。詳細は、[Monitor for Salt Bucket Rotation and Regenerate Raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s) を参照してください。 +再生成が必要な UID2 を識別するには、UID2 Share の `SALT_BUCKETS` ビューを使用します。詳細は、[Monitor for salt bucket rotation and regenerate raw UID2s](#monitor-for-salt-bucket-rotation-and-regenerate-raw-uid2s) を参照してください。 UID2 共有参加者向けに、以下の関数も利用可能です： -- `FN_T_ENCRYPT`（[Encrypt Tokens](#encrypt-tokens) を参照） -- `FN_T_DECRYPT`（[Decrypt Tokens](#decrypt-tokens) を参照） +- `FN_T_ENCRYPT`（[Encrypt tokens](#encrypt-tokens) を参照） +- `FN_T_DECRYPT`（[Decrypt tokens](#decrypt-tokens) を参照） -詳細は、[Usage for UID2 Sharers](#usage-for-uid2-sharers) を参照してください。 +詳細は、[Usage for UID2 sharers](#usage-for-uid2-sharers) を参照してください。 -### Database and Schema Names +### Database and schema names 以下のセクションには各ソリューションのクエリ例が含まれており、データベースとスキーマ名の変数を除いて同一です： @@ -142,9 +142,9 @@ select UID, BUCKET_ID, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_ID すべてのタイプのDIIをマッピングするには、`FN_T_IDENTITY_MAP` 関数を使用します。 -DII がメールアドレスの場合、サービスは UID2 の[Email Address Normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization)ルールを使用してデータを正規化します。 +DII がメールアドレスの場合、サービスは UID2 の[Email address normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization)ルールを使用してデータを正規化します。 -DII が電話番号の場合、UID2 の[Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization)ルールを使用してサービスに送信する前に正規化する必要があります。 +DII が電話番号の場合、UID2 の[Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization)ルールを使用してサービスに送信する前に正規化する必要があります。 | Argument | Data Type | Description | | :--- | :--- | :--- | @@ -157,9 +157,9 @@ DII が電話番号の場合、UID2 の[Phone Number Normalization](../getting-s | :--- | :--- | :--- | | `UID` | TEXT | 値は以下のいずれかです：
  • DII が正常にマッピングされた場合： DII に関連付けられた UID2。
  • DII が正常にマッピングされなかった場合：`NULL`。
| | `BUCKET_ID` | TEXT | 値は以下のいずれかです：
  • DII が正常にマッピングされた場合：UID2 を生成するために使用されたソルトバケットの ID。この ID は `SALT_BUCKETS` ビューのバケット ID にマッピングされます。
  • DII が正常にマッピングされなかった場合：`NULL`。
| -| `UNMAPPED` | TEXT | 値は以下のいずれかです：
  • DII が正常にマッピングされた場合：`NULL`。
  • DII が正常にマッピングされなかった場合：識別子がマッピングされなかった理由：`OPTOUT`、`INVALID IDENTIFIER`、または`INVALID INPUT TYPE`。
    詳細は、[Values for the UNMAPPED Column](#values-for-the-unmapped-column)を参照してください。
| +| `UNMAPPED` | TEXT | 値は以下のいずれかです：
  • DII が正常にマッピングされた場合：`NULL`。
  • DII が正常にマッピングされなかった場合：識別子がマッピングされなかった理由：`OPTOUT`、`INVALID IDENTIFIER`、または`INVALID INPUT TYPE`。
    詳細は、[Values for the unmapped column](#values-for-the-unmapped-column)を参照してください。
| -#### Values for the UNMAPPED Column +#### Values for the unmapped column 以下の表は、`UNMAPPED` カラムの可能な値を示しています。 @@ -174,20 +174,20 @@ DII が電話番号の場合、UID2 の[Phone Number Normalization](../getting-s このセクションのマッピングリクエスト例： -- [Single Unhashed Email](#mapping-request-example---single-unhashed-email) -- [Multiple Unhashed Emails](#mapping-request-example---multiple-unhashed-emails) -- [Single Unhashed Phone Number](#mapping-request-example---single-unhashed-phone-number) -- [Multiple Unhashed Phone Numbers](#mapping-request-example---multiple-unhashed-phone-numbers) -- [Single Hashed Email](#mapping-request-example---single-hashed-email) -- [Multiple Hashed Emails](#mapping-request-example---multiple-hashed-emails) -- [Single Hashed Phone Number](#mapping-request-example---single-hashed-phone-number) -- [Multiple Hashed Phone Numbers](#mapping-request-example---multiple-hashed-phone-numbers) +- [Single unhashed email](#mapping-request-example---single-unhashed-email) +- [Multiple unhashed emails](#mapping-request-example---multiple-unhashed-emails) +- [Single unhashed phone number](#mapping-request-example---single-unhashed-phone-number) +- [Multiple unhashed phone numbers](#mapping-request-example---multiple-unhashed-phone-numbers) +- [Single hashed email](#mapping-request-example---single-hashed-email) +- [Multiple hashed emails](#mapping-request-example---multiple-hashed-emails) +- [Single hashed phone number](#mapping-request-example---single-hashed-phone-number) +- [Multiple hashed phone numbers](#mapping-request-example---multiple-hashed-phone-numbers) :::note これらの例の入力および出力データは架空のものであり、説明のためだけのものです。提供されている値は実際の値ではありません。 ::: -#### Mapping Request Example - Single Unhashed Email +#### Mapping request example - single unhashed email 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、単一のメールアドレスをマッピングする方法を示しています。 @@ -205,7 +205,7 @@ select UID, BUCKET_ID, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_T_IDENTITY_MA +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Emails +#### Mapping request example - multiple unhashed emails 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、複数のメールアドレスをマッピングする方法を示しています。 @@ -230,11 +230,11 @@ select a.ID, a.EMAIL, m.UID, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT JOIN( +----+----------------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Unhashed Phone Number +#### Mapping request example - single unhashed phone number 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、電話番号をマッピングする方法を示しています。 -UID2の[Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization)ルールを使用して電話番号を正規化する必要があります。 +UID2の[Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization)ルールを使用して電話番号を正規化する必要があります。 ```sql select UID, BUCKET_ID, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_T_IDENTITY_MAP('+12345678901', 'phone')); @@ -250,11 +250,11 @@ select UID, BUCKET_ID, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_T_IDENTITY_MA +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Phone Numbers +#### Mapping request example - multiple unhashed phone numbers 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、複数の電話番号をマッピングする方法を示しています。 -UID2の[Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization)ルールを使用して電話番号を正規化する必要があります。 +UID2の[Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization)ルールを使用して電話番号を正規化する必要があります。 ```sql select a.ID, a.PHONE, m.UID, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT JOIN( @@ -277,7 +277,7 @@ select a.ID, a.PHONE, m.UID, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT JOIN( +----+--------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Email +#### Mapping request example - single hashed email 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、単一のメールアドレスハッシュをマッピングする方法を示しています。 @@ -295,7 +295,7 @@ select UID, BUCKET_ID, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_T_IDENTITY_MA +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Emails +#### Mapping request example - multiple hashed emails 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、複数のメールアドレスハッシュをマッピングする方法を示しています。 @@ -319,7 +319,7 @@ select a.ID, a.EMAIL_HASH, m.UID, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT J +----+----------------------------------------------+----------------------------------------------+------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Phone Number +#### Mapping request example - single hashed phone number 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、単一の電話番号ハッシュをマッピングする方法を示しています。 @@ -337,7 +337,7 @@ select UID, BUCKET_ID, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_T_IDENTITY_MA +----------------------------------------------+------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Phone Numbers +#### Mapping request example - multiple hashed phone numbers 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、複数の電話番号ハッシュをマッピングする方法を示しています。 @@ -361,7 +361,7 @@ select a.ID, a.PHONE_HASH, m.UID, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT J +----+----------------------------------------------+----------------------------------------------+------------+--------------------+ ``` -### Monitor for Salt Bucket Rotation and Regenerate Raw UID2s +### Monitor for salt bucket rotation and regenerate raw UID2s `SALT_BUCKETS` ビュークエリは、Raw UID2 のソルトバケットが最後に更新された日時を返します。ソルト値は UID2 を生成する際に使用されます。バケット内のソルトが更新されると、以前に生成された UID2 は古くなり、同じユーザーに対して他の当事者が生成した UID2 と一致しなくなります。 @@ -374,7 +374,7 @@ select a.ID, a.PHONE_HASH, m.UID, m.BUCKET_ID, m.UNMAPPED from AUDIENCE a LEFT J 以下の例は、ソルトバケットが更新されたため再生成が必要なテーブル内の UID2 を見つけるために使用される入力テーブルとクエリを示しています。 -#### Targeted Input Table +#### Targeted input table この例のシナリオでは、広告主/データプロバイダーは `AUDIENCE_WITH_UID2` という名前のテーブルに UID2 を保存しています。最後のカラム `LAST_UID2_UPDATE_UTC` は、UID2 が生成された時間を記録するために使用されます。UID2 が生成されていない場合、値は3番目の例に示すように `NULL` です。広告主/データプロバイダーはこのタイムスタンプ値を使用して、どの UID2 を再生成する必要があるかを判断できます。 @@ -413,24 +413,24 @@ select a.*, b.LAST_SALT_UPDATE_UTC +----+----------------------+----------------------------------------------+------------+-------------------------+-------------------------+ ``` -## Usage for UID2 Sharers +## Usage for UID2 sharers UID2 の共有参加者は、送信者または受信者として共有に参加し、別の参加者と UID2 を共有する企業です。 -広告主とデータプロバイダーは、Snowflake を通じて他の認証された UID2 共有参加者と UID2 を共有できます（Tokenized sharing）。[Raw UID2](../ref-info/glossary-uid#gl-raw-uid2)をUID2 Tokenに暗号化し、ピクセルでの共有のために別の参加者に送信することができます（[Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md)を参照）。Snowflake 内のピクセルでデータを送信していない場合でも、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md)に記載されている要件に従えば、UID2 共有に参加することができます。 +広告主とデータプロバイダーは、Snowflake を通じて他の認証された UID2 共有参加者と UID2 を共有できます（Tokenized sharing）。[Raw UID2](../ref-info/glossary-uid#gl-raw-uid2)をUID2 Tokenに暗号化し、ピクセルでの共有のために別の参加者に送信することができます（[Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md)を参照）。Snowflake 内のピクセルでデータを送信していない場合でも、[Security requirements for UID2 sharing](../sharing/sharing-security.md)に記載されている要件に従えば、UID2 共有に参加することができます。 :::caution -このプロセスで生成される UID2 Token は共有専用であり、ビッドストリームでは使用できません。ビッドストリーム用のトークンを生成するための別のワークフローがあります：[Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md)を参照してください。 +このプロセスで生成される UID2 Token は共有専用であり、ビッドストリームでは使用できません。ビッドストリーム用のトークンを生成するための別のワークフローがあります：[Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md)を参照してください。 ::: -Snowflake内のピクセルやビッドストリームでデータを送信していない場合でも、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md)に記載されている要件に従えば、Raw UID2共有にも参加できます。 +Snowflake内のピクセルやビッドストリームでデータを送信していない場合でも、[Security requirements for UID2 sharing](../sharing/sharing-security.md)に記載されている要件に従えば、Raw UID2共有にも参加できます。 以下のアクティビティはトークン化共有をサポートしています： -- [Encrypt Tokens](#encrypt-tokens) -- [Decrypt Tokens](#decrypt-tokens) +- [Encrypt tokens](#encrypt-tokens) +- [Decrypt tokens](#decrypt-tokens) -### Encrypt Tokens +### Encrypt tokens Raw UID2 を UID2 Token に暗号化するには、`FN_T_ENCRYPT` 関数を使用します。 @@ -443,9 +443,9 @@ Raw UID2 を UID2 Token に暗号化するには、`FN_T_ENCRYPT` 関数を使 | Column Name | Data Type | Description | | :--- | :--- | :--- | | `UID_TOKEN` | TEXT | 値は以下のいずれかです：
  • 暗号化成功：Raw UID2 を含む UID2 Token。
  • 暗号化失敗：`NULL`。
| -| `ENCRYPTION_STATUS` | TEXT | 値は以下のいずれかです：
  • 暗号化成功：`NULL`。
  • 暗号化失敗：Raw UID2が暗号化されなかった理由。例：`INVALID_RAW_UID2` や `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`。
    詳細は、[Values for the ENCRYPTION_STATUS Column](#values-for-the-encryption_status-column)を参照してください。
| +| `ENCRYPTION_STATUS` | TEXT | 値は以下のいずれかです：
  • 暗号化成功：`NULL`。
  • 暗号化失敗：Raw UID2が暗号化されなかった理由。例：`INVALID_RAW_UID2` や `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`。
    詳細は、[Values for the encryption_status column](#values-for-the-encryption_status-column)を参照してください。
| -#### Values for the ENCRYPTION_STATUS Column +#### Values for the encryption_status column 以下の表は、`ENCRYPTION_STATUS` カラムの可能な値を示しています。 @@ -458,7 +458,7 @@ Raw UID2 を UID2 Token に暗号化するには、`FN_T_ENCRYPT` 関数を使 | `NOT_AUTHORIZED_FOR_MASTER_KEY` | 呼び出し元が必要な暗号化キーにアクセスできません。UID2 Administrator に連絡してください。 | | `NOT_AUTHORIZED_FOR_SITE_KEY` | 呼び出し元が必要な暗号化キーにアクセスできません。UID2 Administrator に連絡してください。 | -#### Encrypt Token Request Example - Single Raw UID2 +#### Encrypt token request example - single raw UID2 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、単一の Raw UID2 を UID2 Token に暗号化する方法を示しています。 @@ -476,7 +476,7 @@ select UID_TOKEN, ENCRYPTION_STATUS from table(UID2_PROD_UID_SH.UID.FN_T_ENCRYPT +--------------------------------------------+ ``` -#### Encrypt Token Request Example - Multiple Raw UID2s +#### Encrypt token request example - multiple raw UID2s 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、複数の Raw UID2 を暗号化する方法を示しています。 @@ -498,7 +498,7 @@ select a.RAW_UID2, t.UID_TOKEN, t.ENCRYPTION_STATUS from AUDIENCE_WITH_UID2 a, l +----+----------------------------------------------+-----------------------+-----------------------------+ ``` -### Decrypt Tokens +### Decrypt tokens UID2 Token を Raw UID2 に復号化するには、`FN_T_DECRYPT` 関数を使用します。 @@ -512,13 +512,13 @@ UID2 Token を Raw UID2 に復号化するには、`FN_T_DECRYPT` 関数を使 | :--- | :--- | :--- | | `UID` | TEXT | 値は以下のいずれかです：
  • 復号化成功：UID2 Token に対応する Raw UID2。
  • 復号化失敗：`NULL`。
| | `SITE_ID`| INT | 値は以下のいずれかです：
  • 復号化成功：トークンを暗号化した UID2 参加者の識別子。
  • 復号化失敗：`NULL`。
| -| `DECRYPTION_STATUS` | TEXT | 値は以下のいずれかです：
  • 復号化成功：`NULL`。
  • 復号化失敗：UID2 Token が復号化されなかった理由。例：`EXPIRED_TOKEN`。
    詳細は、[Values for the DECRYPTION_STATUS Column](#values-for-the-decryption_status-column)を参照してください。
| +| `DECRYPTION_STATUS` | TEXT | 値は以下のいずれかです：
  • 復号化成功：`NULL`。
  • 復号化失敗：UID2 Token が復号化されなかった理由。例：`EXPIRED_TOKEN`。
    詳細は、[Values for the decryption_status column](#values-for-the-decryption_status-column)を参照してください。
| :::note UID2 Tokenが正常に復号化できない状況のほとんどの場合、関数は行を一切返しません。 ::: -#### Values for the DECRYPTION_STATUS Column +#### Values for the decryption_status column `DECRYPTION_STATUS`の可能な値は次のとおりです： @@ -527,7 +527,7 @@ UID2 Tokenが正常に復号化できない状況のほとんどの場合、関 | `NULL` | UID2 Token は正常に復号化されました。 | | `EXPIRED_TOKEN` | UID2 Token が指定された寿命を超えています—トークンが期限切れです。 | -#### Decrypt Token Request Example—Single UID2 Token +#### Decrypt token request example—single UID2 token 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、単一の UID2 Token を Raw UID2 に復号化する方法を示しています。 @@ -545,7 +545,7 @@ select UID, SITE_ID, DECRYPTION_STATUS from table(UID2_PROD_UID_SH.UID.FN_T_DECR +----------------------------------------------+-------------------+ ``` -#### Decrypt Token Request Example—Multiple UID2 Tokens +#### Decrypt token request example—multiple UID2 tokens 以下のクエリは、[Default database and schema names](#database-and-schema-names)を使用して、複数の UID2 Token を復号化する方法を示しています。 @@ -572,12 +572,12 @@ select a.ID, b.UID, b.SITE_ID, CASE WHEN b.UID IS NULL THEN 'DECRYPT_FAILED' ELS +----+----------------------------------------------+----------+-------------------+ ``` -### UID2 Sharing Example +### UID2 sharing example 以下の指示は、Snowflakeを使用する送信者と受信者の両方について、共有がどのように機能するかの例を提供します。この例のシナリオでは、広告主（送信者）は Raw UID2 を持つオーディエンステーブル（`AUDIENCE_WITH_UID2S`）を持っており、[Snowflake Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro)機能を使用してデータプロバイダー（受信者）にテーブル内のデータを利用可能にしたいと考えています。 -#### Sender Instructions +#### Sender instructions 1. `AUDIENCE_WITH_UID2_TOKENS` という名前の新しいテーブルを作成します。 2. `AUDIENCE_WITH_UID2S`テーブル内の Raw UID2 を暗号化し、結果を `AUDIENCE_WITH_UID2_TOKENS` テーブルに保存します。例えば、以下のクエリでこのタスクを達成することができます： @@ -591,7 +591,7 @@ select a.ID, b.UID, b.SITE_ID, CASE WHEN b.UID IS NULL THEN 'DECRYPT_FAILED' ELS 共有中に UID2 Token が期限切れになるのを防ぐため、新しく暗号化された UID2 Token をできるだけ早く受信者に送信してください。 ::: -#### Receiver Instructions +#### Receiver instructions 1. 送信者がアクセス権を提供したセキュア共有からデータベースを作成します。 2. `RECEIVED_AUDIENCE_WITH_UID2` という名前の新しいテーブルを作成します。 @@ -608,22 +608,22 @@ select a.ID, b.UID, b.SITE_ID, CASE WHEN b.UID IS NULL THEN 'DECRYPT_FAILED' ELS UID2 Token が期限切れになるのを防ぐため、送信者から利用可能になり次第、UID2 Token をできるだけ早く復号化してください。 ::: -## Migration Guide +## Migration guide このセクションには、新しい UID2 Snowflake マーケットプレイス機能にアップグレードするのに役立つ以下の情報が含まれています： -- [Accessing the New Data Share](#accessing-the-new-data-share) -- [Changing Existing Code](#changing-existing-code) +- [Accessing the new data share](#accessing-the-new-data-share) +- [Changing existing code](#changing-existing-code) -### Accessing the New Data Share +### Accessing the new data share -新しいデータシェアにアクセスするには、[Access the UID2 Share](#access-the-uid2-share)の指示に従ってください。 +新しいデータシェアにアクセスするには、[Access the UID2 share](#access-the-uid2-share)の指示に従ってください。 -### Changing Existing Code +### Changing existing code -変更の概要は、[Changes from Previous Version](#changes-from-previous-version)を参照してください。このセクションのコードスニペットは、以前の関数がどのように実装されていたか、および新しい関数を使用するように更新する方法についての例です。 +変更の概要は、[Changes from previous version](#changes-from-previous-version)を参照してください。このセクションのコードスニペットは、以前の関数がどのように実装されていたか、および新しい関数を使用するように更新する方法についての例です。 -#### Example for Mapping Unhashed Emails +#### Example for mapping unhashed emails 変更前： @@ -637,7 +637,7 @@ select UID2, BUCKET_ID, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_U select UID, BUCKET_ID, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_IDENTITY_MAP(EMAIL, 'email')); ``` -#### Example for Mapping Unhashed Phone Numbers +#### Example for mapping unhashed phone numbers 変更前： @@ -651,9 +651,9 @@ select UID2, BUCKET_ID, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_U select UID, BUCKET_ID, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_IDENTITY_MAP(PHONE_NUMBER, 'phone')); ``` -#### Example for Monitoring Salt Bucket Rotation and Regenerating Raw UID2s +#### Example for monitoring salt bucket rotation and regenerating raw UID2s -以下のクエリは、[Targeted Input Table](#targeted-input-table)で使用したのと同じ例のテーブル `AUDIENCE_WITH_UID2` を使用しています。 +以下のクエリは、[Targeted input table](#targeted-input-table)で使用したのと同じ例のテーブル `AUDIENCE_WITH_UID2` を使用しています。 変更前： @@ -673,7 +673,7 @@ select a.*, b.LAST_SALT_UPDATE_UTC where a.LAST_UID2_UPDATE_UTC < b.LAST_SALT_UPDATE_UTC or a.UID2 IS NULL; ``` -#### Example for Token Encryption +#### Example for token encryption 変更前： @@ -687,7 +687,7 @@ select UID2_TOKEN, ENCRYPTION_STATUS from table({DATABASE_NAME}.{SCHEMA_NAME}.FN select UID_TOKEN, ENCRYPTION_STATUS from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_ENCRYPT('2ODl112/VS3x2vL+kG1439nPb7XNngLvOWiZGaMhdcU=')); ``` -#### Example for Token Decryption +#### Example for token decryption 変更前： diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake.md index 4fc68fc26..b54d7b52b 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-snowflake.md @@ -11,21 +11,21 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; -# Snowflake Integration Guide +# Snowflake integration guide [Snowflake](https://www.snowflake.com/) は、パートナーがデータを保存し、UID2 フレームワークとインテグレーションできるクラウドデータウェアハウジングソリューションです。Snowflake を使用することで、UID2 は、機密性の高い 直接識別情報 (DII) を公開することなく、消費者識別子データを安全に共有できます。Operator Web Service を直接クエリして消費者識別子データを取得するオプションもありますが、Snowflake UID2 インテグレーションはよりシームレスなエクスペリエンスを提供します。 :::important -このドキュメントは、最新の [Snowflake Marketplace listing](#snowflake-marketplace-listing) を使用している方を対象としています。以前のバージョンを使用している場合は、[Snowflake Integration Guide (Pre-July 2025)](integration-snowflake-previous.md) を参照してください。以前の実装を使用している場合は、更新と強化を利用するために新しいバージョンへの移行を推奨します。詳細は、[Changes from Previous Version](#changes-from-previous-version) を参照してください。移行情報は、[Migration Guide](#migration-guide) を参照してください。 +このドキュメントは、最新の [Snowflake marketplace listing](#snowflake-marketplace-listing) を使用している方を対象としています。以前のバージョンを使用している場合は、[Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md) を参照してください。以前の実装を使用している場合は、更新と強化を利用するために新しいバージョンへの移行を推奨します。詳細は、[Changes from previous version](#changes-from-previous-version) を参照してください。移行情報は、[Migration guide](#migration-guide) を参照してください。 ::: -## Snowflake Marketplace Listing +## Snowflake marketplace listing 以下の UID2 リスティングは、Snowflake Marketplace で利用できます: - [Unified ID 2.0: Advertiser and Data Provider Identity Solution](https://app.snowflake.com/marketplace/listing/GZT0ZRYXTN8/unified-id-2-0-unified-id-2-0-advertiser-and-data-provider-identity-solution) :::tip - インテグレーションオプションとステップの概要は、[Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md) を参照してください。 + インテグレーションオプションとステップの概要は、[Advertiser/data provider integration overview](integration-advertiser-dataprovider-overview.md) を参照してください。 ::: ## Functionality @@ -39,47 +39,47 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai *Snowflake を使用して、DII から直接 UID2 Token を生成することはできません。ただし、DII を raw UID2 に変換し、その後 raw UID2 を UID2 Token に暗号化することはできます。 :::note -パブリッシャーで、bidstream で UID2 Token を共有している場合は、[Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 +パブリッシャーで、bidstream で UID2 Token を共有している場合は、[Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 ::: -## Changes from Previous Version +## Changes from previous version 2025年7月の UID2 Snowflake Marketplace インテグレーションの更新では、UID2 のリフレッシュ管理を簡素化し、ローテーション後 90 日間の以前の raw UID2 にアクセスできる新しい ID マッピング関数が導入されました。 :::note -これらの変更は、コードインテグレーションが 2025 年 7 月以前に公開された Snowflake 関数のバージョンを使用していることを前提としています: [Snowflake Integration Guide (Pre-July 2025)](integration-snowflake-previous.md) を参照してください。このバージョンへの移行の詳細は、[Migration Guide](#migration-guide) を参照してください。 +これらの変更は、コードインテグレーションが 2025 年 7 月以前に公開された Snowflake 関数のバージョンを使用していることを前提としています: [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md) を参照してください。このバージョンへの移行の詳細は、[Migration guide](#migration-guide) を参照してください。 ::: 以下の表は、旧バージョンと新バージョンの ID マッピング関数の違いを示しています。 | Function | Version | Return Fields | Key Differences | Comments | | :-- | :-- | :-- | :-- | :-- | -| `FN_T_IDENTITY_MAP` | 以前のバージョン | `UID`, `BUCKET_ID`, `UNMAPPED` | 基本的な ID マッピングとソルトバケットの追跡 | ソルトバケット監視を使用したレガシー関数。詳細は、[Snowflake Integration Guide (Pre-July 2025)](integration-snowflake-previous.md) を参照してください。| +| `FN_T_IDENTITY_MAP` | 以前のバージョン | `UID`, `BUCKET_ID`, `UNMAPPED` | 基本的な ID マッピングとソルトバケットの追跡 | ソルトバケット監視を使用したレガシー関数。詳細は、[Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md) を参照してください。| | `FN_T_IDENTITY_MAP_V3` | 現在 | `UID`, `PREV_UID`, `REFRESH_FROM`, `UNMAPPED` | 強化された以前の UID2 アクセスとリフレッシュタイムスタンプ | ローテーション後 90 日間の以前の UID2 を返し、ソルトバケット監視の代わりにリフレッシュタイムスタンプを使用します。詳細は、[Map DII](#map-dii) を参照してください。| -### Key Benefits +### Key benefits このアップデートにより、以下の 2 つの主要な利点が提供されます: - **Simplified Refresh Management**: `REFRESH_FROM` タイムスタンプに達した UID2 を監視できるようになり、ローテーションのために Salt Bucket をポーリングする必要がなくなります。 - **Previous UID2 Access**: ローテーション後 90 日間、以前の raw UID2 にアクセスできるようになり、キャンペーンの測定が可能になります。 -## Workflow Diagram +## Workflow diagram 以下の図は、Snowflake における UID2 インテグレーションプロセスの異なる部分とワークフローを示しています。 -![Snowflake Integration Architecture](images/uid2-snowflake-integration-architecture-drawio.png) +![Snowflake integration architecture](images/uid2-snowflake-integration-architecture-drawio.png) | Partner Snowflake Account | UID2 Snowflake Account | UID2 Core Opt-Out Cloud Setup | | :--- | :--- | :--- | | パートナーとして、データをホストし、UID2 インテグレーションに参加するための Snowflake アカウントをセットアップします。UID2 Share を通じて関数とビューを消費します。 | UID2 インテグレーションは、Snowflake アカウントでホストされ、UID2 関連のタスクを実行するために必要なデータのみを引き出す認可された関数とビューへのアクセスを提供します。プライベートテーブルにはアクセスできません。UID2 Share は、UID2 関連のタスクを実行するために必要な基本的なデータのみを公開します。
**Note**: ソルト と暗号化キーはプライベートテーブルに保存されています。DII はどの時点でも保存されません。 | ETL (Extract Transform Load) ジョブは、UID2 Core/Optout Snowflake ストレージを常に更新し、UID2 Operator Web Service を動かす内部データを提供します。Operator Web Service で使用されるデータは、UID2 Share を通じても利用可能です。 | | 共有関数とビューを使用すると、トランザクションコンピューティングコストを Snowflake に支払います。 | これらのプライベートテーブルは、UID2 Snowflake アカウントで保護され、UID2 関連のタスクを完了するために使用される内部データを保持する UID2 Core/Optout Snowflake ストレージと自動的に同期します。 | | -## Preparing DII for Processing +## Preparing DII for processing -## Summary of Integration Steps +## Summary of integration steps :::important データのリクエストを行うには、`ACCOUNTADMIN` ロールまたは Snowflake アカウントで `CREATE DATABASE` および `IMPORT SHARE` 権限を持つ他のロールを使用する必要があります。 @@ -88,24 +88,24 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai 以下のリストは、本番環境での Snowflake における UID2 マッピングのインテグレーション手順をまとめたものです: :::note -本番環境を使用する前にインテグレーションを試してみたい場合は、[Testing in the Integ Environment](#testing-in-the-integ-environment)を参照してください。 +本番環境を使用する前にインテグレーションを試してみたい場合は、[Testing in the integ environment](#testing-in-the-integ-environment)を参照してください。 ::: -1. UID2 POC が UID2 担当者によって署名されていることを確認してください。担当者がわからない場合は、[Contact Info](../getting-started/gs-account-setup.md#contact-info)を参照してください。 +1. UID2 POC が UID2 担当者によって署名されていることを確認してください。担当者がわからない場合は、[Contact info](../getting-started/gs-account-setup.md#contact-info)を参照してください。 1. UID2 Share へのアクセスをリクエストします: - - [Snowflake Marketplace Listing](#snowflake-marketplace-listing) でアクセスをリクエストします。リクエストには、Snowflake アカウント番号とリージョンを含めてください。 + - [Snowflake marketplace listing](#snowflake-marketplace-listing) でアクセスをリクエストします。リクエストには、Snowflake アカウント番号とリージョンを含めてください。 - UID2 担当者にアクセスをリクエストしたことを伝えてください。 1. UID2 担当者が、UID2 mapping share へのアクセスをあなたの Snowflake アカウントにプロビジョニングします。 :::note -初期のテストを行った場合（[Testing in the Integ Environment](#testing-in-the-integ-environment)を参照）、関数を本番の UID2 Share に更新し、関連するテーブル名も更新してください。 +初期のテストを行った場合（[Testing in the integ environment](#testing-in-the-integ-environment)を参照）、関数を本番の UID2 Share に更新し、関連するテーブル名も更新してください。 ::: -## Testing in the Integ Environment +## Testing in the integ environment UID2 POC に署名する前に mapping share をテストしたい場合は、UID2 担当者に integ (インテグレーション) 環境の Snowflake シェアへのアクセスをリクエストできます。この環境はテスト専用であり、本番データはありません。リクエストには、アカウント番号とリージョンを必ず含めてください。 @@ -117,29 +117,29 @@ UID2 POC に署名する前に mapping share をテストしたい場合は、UI 3. アクセスをリクエストすると、UID2 担当者が integ シェアをあなたのアカウントにプロビジョニングします。 -## Shared Objects +## Shared objects DII を UID2 にマッピングするには、以下の関数を使用します: - `FN_T_IDENTITY_MAP_V3` (詳細は[Map DII](#map-dii)を参照してください) -以下の関数は `FN_T_IDENTITY_MAP_V3` に置き換えられ、非推奨となっています。以前の Snowflake バージョンを使用している場合は引き続き使用できますが、できるだけ早くアップグレードすることをお勧めします（詳細は [Snowflake Integration Guide (Pre-July 2025)](integration-snowflake-previous.md) を参照してください）: +以下の関数は `FN_T_IDENTITY_MAP_V3` に置き換えられ、非推奨となっています。以前の Snowflake バージョンを使用している場合は引き続き使用できますが、できるだけ早くアップグレードすることをお勧めします（詳細は [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md) を参照してください）: - `FN_T_IDENTITY_MAP` (deprecated) :::note -非推奨の関数を使用していて、新しい関数への移行についてのヘルプが必要な場合は、[Migration Guide](#migration-guide)を参照してください。 +非推奨の関数を使用していて、新しい関数への移行についてのヘルプが必要な場合は、[Migration guide](#migration-guide)を参照してください。 ::: -再生成が必要な UID2 を特定するには、`FN_T_IDENTITY_MAP_V3` 関数から返される `REFRESH_FROM` タイムスタンプを監視します。詳細は [Monitor Raw UID2 Refresh and Regenerate Raw UID2s](#monitor-raw-uid2-refresh-and-regenerate-raw-uid2s) を参照してください。 +再生成が必要な UID2 を特定するには、`FN_T_IDENTITY_MAP_V3` 関数から返される `REFRESH_FROM` タイムスタンプを監視します。詳細は [Monitor raw UID2 refresh and regenerate raw UID2s](#monitor-raw-uid2-refresh-and-regenerate-raw-uid2s) を参照してください。 以下の関数は、UID2 Share 参加者向けに利用可能です: -- `FN_T_ENCRYPT` (See [Encrypt Tokens](#encrypt-tokens)) -- `FN_T_DECRYPT` (See [Decrypt Tokens](#decrypt-tokens)) +- `FN_T_ENCRYPT` (See [Encrypt tokens](#encrypt-tokens)) +- `FN_T_DECRYPT` (See [Decrypt tokens](#decrypt-tokens)) -詳細は、[Usage for UID2 Sharers](#usage-for-uid2-sharers)を参照してください。 +詳細は、[Usage for UID2 sharers](#usage-for-uid2-sharers)を参照してください。 -### Database and Schema Names +### Database and schema names 以下のセクションは、各ソリューションのクエリ例を含みます。これらは、データベース名とスキーマ名の変数を除いて同一です: @@ -164,9 +164,9 @@ select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_ すべての種類の DII をマッピングするには、`FN_T_IDENTITY_MAP_V3` 関数を使用します。 -DII がメールアドレスの場合、サービスは UID2 [Email Address Normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) ルールを使用してデータを正規化します。 +DII がメールアドレスの場合、サービスは UID2 [Email address normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization) ルールを使用してデータを正規化します。 -DII が電話番号の場合、UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) ルールを使用して、サービスに送信する前に正規化する必要があります。 +DII が電話番号の場合、UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) ルールを使用して、サービスに送信する前に正規化する必要があります。 | Argument | Data Type | Description | | :--- | :--- | :--- | @@ -180,9 +180,9 @@ DII が電話番号の場合、UID2 [Phone Number Normalization](../getting-star | `UID` | TEXT | 値は次のいずれかです:
  • DII が正常にマッピングされた: DII に関連付けられた UID2。
  • それ以外の場合: `NULL`。
| | `PREV_UID` | TEXT | 値は次のいずれかです:
  • DII が正常にマッピングされ、現在の raw UID2 は過去 90 日間にローテーションしました: 以前の raw UID2
  • それ以外の場合: `NULL`。
| | `REFRESH_FROM` | TIMESTAMP | 値は次のいずれかです:
  • DII が正常にマッピングされた: この UID2 を更新する必要がある時刻 (エポック秒) を示します。
  • それ以外の場合: `NULL`。
| -| `UNMAPPED` | TEXT | 値は次のいずれかです:
  • DII が正常にマッピングされた: `NULL`。
  • それ以外の場合: 識別子がマッピングされなかった理由: `OPTOUT`、`INVALID IDENTIFIER`、または `INVALID INPUT TYPE`。
    詳細は、[UNMAPPED 列の値](#values-for-the-unmapped-column)を参照してください。
| +| `UNMAPPED` | TEXT | 値は次のいずれかです:
  • DII が正常にマッピングされた: `NULL`。
  • それ以外の場合: 識別子がマッピングされなかった理由: `OPTOUT`、`INVALID IDENTIFIER`、または `INVALID INPUT TYPE`。
    詳細は、[Unmapped 列の値](#values-for-the-unmapped-column)を参照してください。
| -#### Values for the UNMAPPED Column +#### Values for the unmapped column 以下の表は、`UNMAPPED` 列の可能な値です。 @@ -197,20 +197,20 @@ DII が電話番号の場合、UID2 [Phone Number Normalization](../getting-star 以下はマッピングリクエストの例です: -- [Single Unhashed Email](#mapping-request-example---single-unhashed-email) -- [Multiple Unhashed Emails](#mapping-request-example---multiple-unhashed-emails) -- [Single Unhashed Phone Number](#mapping-request-example---single-unhashed-phone-number) -- [Multiple Unhashed Phone Numbers](#mapping-request-example---multiple-unhashed-phone-numbers) -- [Single Hashed Email](#mapping-request-example---single-hashed-email) -- [Multiple Hashed Emails](#mapping-request-example---multiple-hashed-emails) -- [Single Hashed Phone Number](#mapping-request-example---single-hashed-phone-number) -- [Multiple Hashed Phone Numbers](#mapping-request-example---multiple-hashed-phone-numbers) +- [Single unhashed email](#mapping-request-example---single-unhashed-email) +- [Multiple unhashed emails](#mapping-request-example---multiple-unhashed-emails) +- [Single unhashed phone number](#mapping-request-example---single-unhashed-phone-number) +- [Multiple unhashed phone numbers](#mapping-request-example---multiple-unhashed-phone-numbers) +- [Single hashed email](#mapping-request-example---single-hashed-email) +- [Multiple hashed emails](#mapping-request-example---multiple-hashed-emails) +- [Single hashed phone number](#mapping-request-example---single-hashed-phone-number) +- [Multiple hashed phone numbers](#mapping-request-example---multiple-hashed-phone-numbers) :::note これらの例の入力および出力データは架空のものであり、説明を目的としています。提供されている値は実際の値ではありません。 ::: -#### Mapping Request Example - Single Unhashed Email +#### Mapping request example - single unhashed email 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、単一のメールアドレスをマッピングする方法です。 @@ -228,7 +228,7 @@ select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_ +----------------------------------------------+--------------------------------------------------+--------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Emails +#### Mapping request example - multiple unhashed emails 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、複数のメールアドレスをマッピングする方法です。 @@ -254,11 +254,11 @@ select a.ID, a.EMAIL, m.UID, m.PREV_UID, m.REFRESH_FROM, m.UNMAPPED from AUDIENC +----+----------------------+----------------------------------------------+----------------------------------------------+--------------+--------------------+ ``` -#### Mapping Request Example - Single Unhashed Phone Number +#### Mapping request example - single unhashed phone number 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、単一の電話番号をマッピングする方法です。 -電話番号は、UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) ルールを使用して正規化する必要があります。 +電話番号は、UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) ルールを使用して正規化する必要があります。 ```sql select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_T_IDENTITY_MAP_V3('+12345678901', 'phone')); @@ -274,11 +274,11 @@ select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_ +----------------------------------------------+----------+--------------+----------+ ``` -#### Mapping Request Example - Multiple Unhashed Phone Numbers +#### Mapping request example - multiple unhashed phone numbers 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、複数の電話番号をマッピングする方法です。 -電話番号は、UID2 [Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) ルールを使用して正規化する必要があります。 +電話番号は、UID2 [Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) ルールを使用して正規化する必要があります。 ```sql select a.ID, a.PHONE, m.UID, m.PREV_UID, m.REFRESH_FROM, m.UNMAPPED from AUDIENCE a LEFT JOIN( @@ -302,7 +302,7 @@ select a.ID, a.PHONE, m.UID, m.PREV_UID, m.REFRESH_FROM, m.UNMAPPED from AUDIENC +----+--------------+----------------------------------------------+----------------------------------------------+--------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Email +#### Mapping request example - single hashed email 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、単一のメールアドレスハッシュをマッピングする方法です。 @@ -320,7 +320,7 @@ select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_ +----------------------------------------------+----------------------------------------------+--------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Emails +#### Mapping request example - multiple hashed emails 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、複数のメールアドレスハッシュをマッピングする方法です。 @@ -345,7 +345,7 @@ select a.ID, a.EMAIL_HASH, m.UID, m.PREV_UID, m.REFRESH_FROM, m.UNMAPPED from AU +----+----------------------------------------------+----------------------------------------------+----------------------------------------------+--------------+--------------------+ ``` -#### Mapping Request Example - Single Hashed Phone Number +#### Mapping request example - single hashed phone number 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、単一の電話番号ハッシュをマッピングする方法です。 @@ -363,7 +363,7 @@ select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table(UID2_PROD_UID_SH.UID.FN_ +----------------------------------------------+----------------------------------------------+--------------+----------+ ``` -#### Mapping Request Example - Multiple Hashed Phone Numbers +#### Mapping request example - multiple hashed phone numbers 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、複数の電話番号ハッシュをマッピングする方法です。 @@ -388,7 +388,7 @@ select a.ID, a.PHONE_HASH, m.UID, m.PREV_UID, m.REFRESH_FROM, m.UNMAPPED from AU +----+----------------------------------------------+----------------------------------------------+----------------------------------------------+--------------+--------------------+ ``` -### Monitor Raw UID2 Refresh and Regenerate Raw UID2s +### Monitor raw UID2 refresh and regenerate raw UID2s `FN_T_IDENTITY_MAP_V3` 関数は、各 UID2 をリフレッシュする必要がある時刻を示すリフレッシュタイムスタンプ (`REFRESH_FROM`) を返します。 @@ -405,7 +405,7 @@ UID2 のリフレッシュが必要なものを特定するには、関数から 以下の例は、入力テーブルと、リフレッシュ時間が到達したために再生成する必要がある UID2 をテーブル内で見つけるために使用されるクエリです。 -#### Targeted Input Table +#### Targeted input table この例では、広告主/データプロバイダーは、`AUDIENCE_WITH_UID2` という名前のテーブルに UID2 を保存しています。`REFRESH_FROM` 列には、各 UID2 をリフレッシュする必要があるタイムスタンプが含まれています。UID2 が生成されていない場合、値は `NULL` です（3 番目の例を参照）。広告主/データプロバイダーは、これらのタイムスタンプを現在の時刻と比較して、どの UID2 を再生成する必要があるかを判断できます。 @@ -442,24 +442,24 @@ select * from AUDIENCE_WITH_UID2 +----+----------------------+----------------------------------------------+--------------+ ``` -## Usage for UID2 Sharers +## Usage for UID2 sharers UID2 sharing participant は、送信者または受信者として共有に参加し、他の参加者と UID2 を共有する組織です。 -広告主とデータプロバイダーは、Snowflake (tokenized sharing)を介して、他の承認された UID2 共有参加者と UID2 を共有できます。彼らは [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) を UID2 Token に暗号化し、ピクセルで共有するために別の参加者に送信できます (詳細は [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照してください)。Snowflake 内でピクセルでデータを送信していない場合でも、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、UID2 共有に参加できます。 +広告主とデータプロバイダーは、Snowflake (tokenized sharing)を介して、他の承認された UID2 共有参加者と UID2 を共有できます。彼らは [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) を UID2 Token に暗号化し、ピクセルで共有するために別の参加者に送信できます (詳細は [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照してください)。Snowflake 内でピクセルでデータを送信していない場合でも、[Security requirements for UID2 sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、UID2 共有に参加できます。 :::caution -このプロセスで生成された UID2 Token は共有用であり、ビッドストリームでは使用できません。ビッドストリーム用のトークンを生成するための別のワークフローがあります: [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 +このプロセスで生成された UID2 Token は共有用であり、ビッドストリームでは使用できません。ビッドストリーム用のトークンを生成するための別のワークフローがあります: [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 ::: -Snowflake でピクセルやビッドストリームでデータを送信していない場合でも、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、UID2 共有に参加できます。 +Snowflake でピクセルやビッドストリームでデータを送信していない場合でも、[Security requirements for UID2 sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、UID2 共有に参加できます。 以下の機能は、トークン化された共有をサポートしています: -- [Encrypt Tokens](#encrypt-tokens) -- [Decrypt Tokens](#decrypt-tokens) +- [Encrypt tokens](#encrypt-tokens) +- [Decrypt tokens](#decrypt-tokens) -### Encrypt Tokens +### Encrypt tokens raw UID2 を UID2 Token に暗号化するには、`FN_T_ENCRYPT` 関数を使用します。 @@ -472,9 +472,9 @@ raw UID2 を UID2 Token に暗号化するには、`FN_T_ENCRYPT` 関数を使 | Column Name | Data Type | Description | | :--- | :--- | :--- | | `UID_TOKEN` | TEXT | 値は以下のいずれか:
  • Encryption successful: raw UID2 を含む UID2 Token
  • Encryption not successful: `NULL`
| -| `ENCRYPTION_STATUS` | TEXT | 値は以下のいずれか:
  • Encryption successful: `NULL`.
  • Encryption not successful: raw UID2 が暗号化されなかった理由。例えば: `INVALID_RAW_UID2` または `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.
    詳細は、[Values for the ENCRYPTION_STATUS Column](#values-for-the-encryption_status-column) を参照してください。
| +| `ENCRYPTION_STATUS` | TEXT | 値は以下のいずれか:
  • Encryption successful: `NULL`.
  • Encryption not successful: raw UID2 が暗号化されなかった理由。例えば: `INVALID_RAW_UID2` または `INVALID NOT_AUTHORIZED_FOR_MASTER_KEY`.
    詳細は、[Values for the encryption_status column](#values-for-the-encryption_status-column) を参照してください。
| -#### Values for the ENCRYPTION_STATUS Column +#### Values for the encryption_status column 以下の表は、`ENCRYPTION_STATUS` 列の可能な値を示しています。 @@ -487,7 +487,7 @@ raw UID2 を UID2 Token に暗号化するには、`FN_T_ENCRYPT` 関数を使 | `NOT_AUTHORIZED_FOR_MASTER_KEY` | 呼び出し元が必要な暗号化キーにアクセスできません。UID2 管理者にお問い合わせください。 | | `NOT_AUTHORIZED_FOR_SITE_KEY` | 呼び出し元が必要な暗号化キーにアクセスできません。UID2 管理者にお問い合わせください。 | -#### Encrypt Token Request Example - Single Raw UID2 +#### Encrypt token request example - single raw UID2 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、単一の raw UID2 を UID2 Token に暗号化する方法です。 @@ -505,7 +505,7 @@ select UID_TOKEN, ENCRYPTION_STATUS from table(UID2_PROD_UID_SH.UID.FN_T_ENCRYPT +--------------------------------------------+ ``` -#### Encrypt Token Request Example - Multiple Raw UID2s +#### Encrypt token request example - multiple raw UID2s 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、複数の raw UID2 を UID2 Token に暗号化する方法です。 @@ -527,7 +527,7 @@ select a.RAW_UID2, t.UID_TOKEN, t.ENCRYPTION_STATUS from AUDIENCE_WITH_UID2 a, l +----+----------------------------------------------+-----------------------+-----------------------------+ ``` -### Decrypt Tokens +### Decrypt tokens UID2 Token を raw UID2 に復号化するには、`FN_T_DECRYPT` 関数を使用します。 @@ -541,13 +541,13 @@ UID2 Token を raw UID2 に復号化するには、`FN_T_DECRYPT` 関数を使 | :--- | :--- | :--- | | `UID` | TEXT | 以下の値のいずれか:
  • Decryption successful: UID2 Token に関連付けられた raw UID2。
  • Decryption not successful: `NULL`
| | `SITE_ID` | INT | 以下の値のいずれか:
  • Decryption successful: トークンを暗号化した UID2 参加者の識別子。
  • Decryption not successful: `NULL`
| -| `DECRYPTION_STATUS` | TEXT | 以下の値のいずれか:
  • Decryption successful: `NULL`。
  • Decryption not successful: UID2 Token が復号化されなかった理由。たとえば、`EXPIRED_TOKEN`。
    詳細は、[Values for the DECRYPTION_STATUS Column](#values-for-the-decryption_status-column) を参照してください。
| +| `DECRYPTION_STATUS` | TEXT | 以下の値のいずれか:
  • Decryption successful: `NULL`。
  • Decryption not successful: UID2 Token が復号化されなかった理由。たとえば、`EXPIRED_TOKEN`。
    詳細は、[Values for the decryption_status column](#values-for-the-decryption_status-column) を参照してください。
| :::note UID2 Token が復号化できない場合、関数は通常、行を返しません。 ::: -#### Values for the DECRYPTION_STATUS Column +#### Values for the decryption_status column `DECRYPTION_STATUS` の可能な値は以下の通りです: @@ -556,7 +556,7 @@ UID2 Token が復号化できない場合、関数は通常、行を返しませ | `NULL` | UID2 Token は復号化されました。| | `EXPIRED_TOKEN` | UID2 Token は指定された有効期限を超えています。| -#### Decrypt Token Request Example—Single UID2 Token +#### Decrypt token request example—single UID2 token 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、単一の UID2 Token を raw UID2 に復号化する方法です。 @@ -574,7 +574,7 @@ select UID, SITE_ID, DECRYPTION_STATUS from table(UID2_PROD_UID_SH.UID.FN_T_DECR +----------------------------------------------+-------------------+ ``` -#### Decrypt Token Request Example—Multiple UID2 Tokens +#### Decrypt token request example—multiple UID2 tokens 以下のクエリは、[default database and schema names](#database-and-schema-names)を使用して、複数の UID2 Token を raw UID2 に復号化する方法です。 @@ -601,12 +601,12 @@ select a.ID, b.UID, b.SITE_ID, CASE WHEN b.UID IS NULL THEN 'DECRYPT_FAILED' ELS +----+----------------------------------------------+----------+-------------------+ ``` -### UID2 Sharing Example +### UID2 sharing example 以下の手順は、Snowflake を使用する送信者と受信者の両方の共有方法の例を示しています。この例では、広告主 (送信者) が raw UID2s を含むオーディエンステーブル (`AUDIENCE_WITH_UID2S`) を持ち、データプロバイダー (受信者) にテーブル内のデータを [Snowflake Secure Data Sharing](https://docs.snowflake.com/en/user-guide/data-sharing-intro) 機能を使用して利用可能にしたいと考えています。 -#### Sender Instructions +#### Sender instructions 1. `AUDIENCE_WITH_UID2_TOKENS` テーブルを作成します。 2. `AUDIENCE_WITH_UID2S` テーブル内の raw UID2s を暗号化し、結果を `AUDIENCE_WITH_UID2_TOKENS` テーブルに保存します。次のクエリは、このタスクを達成するのに役立ちます: @@ -620,7 +620,7 @@ select a.ID, b.UID, b.SITE_ID, CASE WHEN b.UID IS NULL THEN 'DECRYPT_FAILED' ELS UID2 Token が共有中に期限切れにならないようにするために、暗号化された UID2 Token をできるだけ早く受信者に送信してください。 ::: -#### Receiver Instructions +#### Receiver instructions 1. 送信者が提供したセキュアな共有からデータベースを作成します。 2. `RECEIVED_AUDIENCE_WITH_UID2` という新しいテーブルを作成します。 @@ -637,19 +637,19 @@ UID2 Token が共有中に期限切れにならないようにするために、 UID2 Token が共有中に期限切れにならないようにするために、受信者は送信者からトークンをできるだけ早く復号化してください。 ::: -## Migration Guide +## Migration guide このセクションでは、以前のバージョンから新しい UID2 Snowflake v3 機能にアップグレードするための情報を提供します。 :::note -2025年2月以前のバージョンからアップグレードする場合は、以前のバージョンのドキュメントの [Migration Guide](integration-snowflake-previous.md#migration-guide) を参照してください。 +2025年2月以前のバージョンからアップグレードする場合は、以前のバージョンのドキュメントの [Migration guide](integration-snowflake-previous.md#migration-guide) を参照してください。 ::: -### Changing Existing Code +### Changing existing code -変更の概要は、[Changes from Previous Version](#changes-from-previous-version)を参照してください。このセクションのコードスニペットは、以前の関数がどのように実装されていたかの前後の例であり、新しい関数を使用するように更新する方法を示しています。主な変更点は、`FN_T_IDENTITY_MAP`から`FN_T_IDENTITY_MAP_V3`への移行であり、これによりソルトバケット ID の代わりにリフレッシュタイムスタンプが提供され、以前の UID2 アクセスも含まれます。 +変更の概要は、[Changes from previous version](#changes-from-previous-version)を参照してください。このセクションのコードスニペットは、以前の関数がどのように実装されていたかの前後の例であり、新しい関数を使用するように更新する方法を示しています。主な変更点は、`FN_T_IDENTITY_MAP`から`FN_T_IDENTITY_MAP_V3`への移行であり、これによりソルトバケット ID の代わりにリフレッシュタイムスタンプが提供され、以前の UID2 アクセスも含まれます。 -#### Example for Mapping Unhashed Emails +#### Example for mapping unhashed emails Before: @@ -663,7 +663,7 @@ After: select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_IDENTITY_MAP_V3(EMAIL, 'email')); ``` -#### Example for Mapping Unhashed Phone Numbers +#### Example for mapping unhashed phone numbers Before: @@ -677,7 +677,7 @@ After: select UID, PREV_UID, REFRESH_FROM, UNMAPPED from table({DATABASE_NAME}.{SCHEMA_NAME}.FN_T_IDENTITY_MAP_V3(PHONE_NUMBER, 'phone')); ``` -#### Example for Monitoring UID2 Refresh and Regenerating Raw UID2s +#### Example for monitoring UID2 refresh and regenerating raw UID2s v3 関数はリフレッシュタイムスタンプを直接提供するため、ソルトバケットを監視する必要がなくなりました。ソルトバケットビューと結合する代わりに、関数から返された `REFRESH_FROM` タイムスタンプを現在のタイムスタンプと比較できます。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-gma-android.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-gma-android.md index 4a0328fc3..600b94822 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-gma-android.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-gma-android.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 GMA Plugin for Android Integration Guide +# UID2 GMA plugin for Android integration guide UID2 Google Mobile Ads (GMA) Plugin for Android は、[Google Mobile Ads (GMA) SDK](https://developers.google.com/ad-manager/mobile-ads-sdk) を使用するパブリッシャーが、Android アプリからの広告リクエストで UID2 Token を [secure signals](https://support.google.com/admob/answer/11556288?hl=en-GB) として送信できるようにします。これは自動的に行われるため、アプリ開発者が直接コーディングする必要はありません。 @@ -22,19 +22,19 @@ UID2 Google Mobile Ads (GMA) Plugin for Android は、[Google Mobile Ads (GMA) S このドキュメントは、UID2 GMA Plugin for Android バージョン 2.0.0 以降用です。 -## GitHub Repository +## Github repository このプラグインは以下のオープンソースの GitHub リポジトリにあります: - [https://github.com/IABTechLab/uid2-android-sdk/tree/main/securesignals-gma](https://github.com/IABTechLab/uid2-android-sdk/tree/main/securesignals-gma) -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。各実装ガイドに具体的な手順が記載されています。概要は、[Client-Side, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 +UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。各実装ガイドに具体的な手順が記載されています。概要は、[Client-side, client-server, or server-side integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 ## Requirements @@ -45,9 +45,9 @@ UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、S - [Release notes](https://developers.google.com/admob/android/rel-notes) 1. SDK for Android 2.0.0 or later: - [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk) - - [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) + - [SDK for Android reference guide](../sdks/sdk-ref-android.md) 1. [UID2 Android GMA Plugin v2.0.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-gma/) -1. R8 または Proguard を使用している場合は、[Notes for Using R8 or ProGuard](#notes-for-using-r8-or-proguard) に指定された適用オプションを追加します。 +1. R8 または Proguard を使用している場合は、[Notes for using r8 or ProGuard](#notes-for-using-r8-or-proguard) に指定された適用オプションを追加します。 ## Installation @@ -78,7 +78,7 @@ Maven でインストールするには、`pom.xml` ファイルに依存関係 ``` -## Notes for Using R8 or ProGuard +## Notes for using r8 or ProGuard R8 を使用している場合、縮小と難読化のルールは自動的に含まれます。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-gma-ios.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-gma-ios.md index f54d3c0de..357228ddb 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-gma-ios.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/mobile-plugin-gma-ios.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 GMA Plugin for iOS Integration Guide +# UID2 GMA plugin for iOS integration guide UID2 Google Mobile Ads (GMA) Plugin for iOS は、[Google Mobile Ads (GMA) SDK](https://developers.google.com/ad-manager/mobile-ads-sdk) を使用しているパブリッシャーが、iOS アプリからの広告リクエストで UID2 Token を [secure signals](https://support.google.com/admob/answer/11556288) として送信できるようにします。これは自動的に行われるため、アプリ開発者が直接コーディングする必要はありません。 @@ -22,19 +22,19 @@ UID2 Google Mobile Ads (GMA) Plugin for iOS は、[Google Mobile Ads (GMA) SDK]( このドキュメントは UID2 GMA Plugin for iOS バージョン 1.0.0 以降用です。 -## GitHub Repository +## Github repository このプラグインは以下のオープンソースの GitHub リポジトリにあります: - [https://github.com/IABTechLab/uid2-ios-plugin-google-gma](https://github.com/IABTechLab/uid2-ios-plugin-google-gma) -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。各実装ガイドに具体的な手順が記載されています。概要は、[Client-Side, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 +UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。各実装ガイドに具体的な手順が記載されています。概要は、[Client-side, client-server, or server-side integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 ## Requirements @@ -45,7 +45,7 @@ UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、S - [Release Notes](https://developers.google.com/admob/ios/rel-notes) 1. SDK for iOS v1.7.0 or later: - [SDK](https://github.com/IABTechLab/uid2-ios-sdk) - - [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) + - [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) 1. [UID2 GMA Plugin for iOS v1.0.0](https://github.com/IABTechLab/uid2-ios-plugin-google-gma) ## Installation @@ -56,11 +56,11 @@ SDK for iOS と Google Mobile Ads SDK がインストールされた既存のア インストールオプションは 3 つあります: -- [Package.swift](#installing-with-packageswift) +- [Package.Swift](#installing-with-packageswift) - [Xcode](#installing-with-xcode) -- [CocoaPods](#installing-with-cocoapods) +- [Cocoapods](#installing-with-cocoapods) -### Installing with Package.swift +### Installing with package.Swift Package.swift に次の依存関係を追加します: @@ -70,7 +70,7 @@ dependencies: [ ] ``` -### Installing with Xcode +### Installing with xcode XCode ユーザーインターフェースで、パッケージ依存関係の下に、次のエントリを追加します: @@ -78,7 +78,7 @@ XCode ユーザーインターフェースで、パッケージ依存関係の | :--- | :--- | :--- | | uid2-ios-plugin-google-gma | `git@github.com:IABTechLab/uid2-ios-plugin-google-gma.git` | Exact Version: 1.0.0 | -### Installing with CocoaPods +### Installing with cocoapods `Podfile` に次のエントリを追加します: 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 a09cf817c..6c2e47681 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 @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 IMA Plugin for Android Integration Guide +# UID2 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) として送信できるようにします。これは自動的に行われるため、アプリ開発者が直接コーディングする必要はありません。 @@ -22,19 +22,19 @@ UID2 Interactive Media Ads (IMA) Plugin for Android は、[Google IMA SDK for An このドキュメントは、UID2 IMA Plugin for Android version 2.0.0 以降用です。 -## GitHub Repository +## Github repository このプラグインは以下のオープンソースの GitHub リポジトリにあります: - [https://github.com/IABTechLab/uid2-android-sdk/tree/main/securesignals-ima](https://github.com/IABTechLab/uid2-android-sdk/tree/main/securesignals-ima) -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。各実装ガイドに具体的な手順が記載されています。概要は、[Client-Side, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 +UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。各実装ガイドに具体的な手順が記載されています。概要は、[Client-side, client-server, or server-side integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 ## Requirements @@ -45,9 +45,9 @@ UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、S - [Release history](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side/history) 1. SDK for Android v2.0.0 or later: - [SDK](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk) - - [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) + - [SDK for Android reference guide](../sdks/sdk-ref-android.md) 1. [UID2 IMA Plugin for Android v2.0.0](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk-ima) -1. R8 または Proguard を使用している場合は、[Notes for Using R8 or ProGuard](#notes-for-using-r8-or-proguard) に指定された適用オプションを追加します。 +1. R8 または Proguard を使用している場合は、[Notes for using r8 or ProGuard](#notes-for-using-r8-or-proguard) に指定された適用オプションを追加します。 ## Installation @@ -78,7 +78,7 @@ Maven でインストールするには、`pom.xml` ファイルに依存関係 ``` -## Notes for Using R8 or ProGuard +## Notes for using r8 or ProGuard R8 を使用している場合、縮小と難読化のルールは自動的に含まれます。 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 d0f14f28c..23a46f0a5 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 @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 IMA Plugin for iOS Integration Guide +# UID2 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) として送信できるようにします。これは自動的に行われるため、アプリ開発者が直接コーディングする必要はありません。 @@ -22,19 +22,19 @@ UID2 Interactive Media Ads (IMA) Plugin for iOS は、[Google IMA SDK for iOS](h このドキュメントは UID2 IMA Plugin for iOS version 1.0.0 以降用です。 -## GitHub Repository +## Github repository このプラグインは以下のオープンソースの GitHub リポジトリにあります: - [https://github.com/IABTechLab/uid2-ios-plugin-google-ima](https://github.com/IABTechLab/uid2-ios-plugin-google-ima) -## Complete UID2 Account Setup and Configure Account +## Complete UID2 account setup and configure account -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting Started with the UID2 Portal](../portal/portal-getting-started.md) を参照してください。 +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。ここで、本番環境用の [credentials](../getting-started/gs-credentials.md) を作成し、必要に応じて追加の値を設定できます。詳細は、[Getting started with the UID2 portal](../portal/portal-getting-started.md) を参照してください。 -UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。各実装ガイドに具体的な手順が記載されています。概要は、[Client-Side, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 +UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。各実装ガイドに具体的な手順が記載されています。概要は、[Client-side, client-server, or server-side integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 ## Requirements @@ -45,7 +45,7 @@ UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、S - [Release history](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side/history) 1. SDK for iOS v1.7.0 or later: - [SDK](https://github.com/IABTechLab/uid2-ios-sdk) - - [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) + - [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) 1. [UID2 IMA Plugin for iOS v1.0.0](https://github.com/IABTechLab/uid2-ios-plugin-google-ima) ## Installation @@ -56,11 +56,11 @@ SDK for iOS と Google Interactive Ads SDK がインストールされた既存 3つのインストールオプションがあります: -- [Package.swift](#installing-with-packageswift) +- [Package.Swift](#installing-with-packageswift) - [Xcode](#installing-with-xcode) -- [CocoaPods](#installing-with-cocoapods) +- [Cocoapods](#installing-with-cocoapods) -### Installing with Package.swift +### Installing with package.Swift Package.swift に次の依存関係を追加します: @@ -70,7 +70,7 @@ dependencies: [ ] ``` -### Installing with Xcode +### Installing with xcode XCode ユーザーインターフェースで、パッケージ依存関係の下に、次のエントリを追加します: @@ -78,7 +78,7 @@ XCode ユーザーインターフェースで、パッケージ依存関係の | :--- | :--- | :--- | | uid2-ios-plugin-google-ima | `git@github.com:IABTechLab/uid2-ios-plugin-google-ima.git` | Exact Version: 1.0.0 | -### Installing with CocoaPods +### Installing with cocoapods `Podfile` に次のエントリを追加します: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aks-enclave.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aks-enclave.md index 1310a0697..43a67917a 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aks-enclave.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aks-enclave.md @@ -14,12 +14,12 @@ import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emai import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure.mdx'; import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; -# UID2 Private Operator for AKS Integration Guide +# UID2 Private Operator for AKS integration guide UID2 Operator は UID2 エコシステムの API サーバーです。詳細は、[The UID2 Operator](../ref-info/ref-operators-public-private.md) を参照してください。 :::note -AKS の Private Operator をセットアップしたい場合は、UID2 の連絡先にお問い合わせください。詳細は、[Contact Info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 +AKS の Private Operator をセットアップしたい場合は、UID2 の連絡先にお問い合わせください。詳細は、[Contact info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 ::: このガイドでは、Azure Kubernetes Service（AKS） クラスター上で Azure Container Instances（ACI） の仮想ノード上で実行される UID2 Operator Service を Private Operator として設定する方法について説明します。[Azure Container Instances 上の仮想ノード](https://learn.microsoft.com/ja-jp/azure/container-instances/container-instances-virtual-nodes)を使用することで、ハードウェアでバックアップされた Trusted Execution Environment （TEE） で実行される機密コンテナの機能を活用できます。この TEE は、データ整合性、データ機密性、コード整合性などの内在的な機能を提供します。 @@ -41,10 +41,10 @@ The latest ZIP file is linked in the AKS Download column in the following table. | Q2 2025 | xxx | xxx | xxx | xxx | :::note -For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions). +For information about supported versions and deprecation dates, see [Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions). ::: --> -## Private Operator Upgrade Policy +## Private Operator upgrade policy @@ -52,15 +52,15 @@ For information about supported versions and deprecation dates, see [Private Ope AKS の UID2 Private Operator をデプロイする前に、次の前提条件を完了してください: -- [Set Up the UID2 Operator Account](#set-up-the-uid2-operator-account) +- [Set up the UID2 Operator account](#set-up-the-uid2-operator-account) - [Install the Azure CLI](#install-the-azure-cli) -- [Get the Required Azure Permissions](#get-the-required-azure-permissions) +- [Get the required Azure permissions](#get-the-required-azure-permissions) - [Install the kubectl CLI](#install-the-kubectl-cli) -- [Install the Helm CLI](#install-the-helm-cli) +- [Install the helm CLI](#install-the-helm-cli) -### Set Up the UID2 Operator Account +### Set up the UID2 Operator account -UID2 の連絡先に、組織を UID2 Operator として登録するよう依頼してください。誰に聞けばよいかわからない場合は、[Contact Info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 +UID2 の連絡先に、組織を UID2 Operator として登録するよう依頼してください。誰に聞けばよいかわからない場合は、[Contact info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 登録プロセスが完了すると、UID2 Service に対して Private Operator として識別する、あなた専用の operator key が届きます。構成中は、これを `OPERATOR_KEY` の値として使用します。この値は、あなたのためのユニークな識別子であり、パスワードでもあります。安全に保管し、共有しないでください。 @@ -72,7 +72,7 @@ UID2 の連絡先に、組織を UID2 Operator として登録するよう依頼 Azure コマンドラインインターフェイスをインストールします。詳細は、Azure ドキュメントの [How to install the Azure CLI](https://learn.microsoft.com/ja-jp/cli/azure/install-azure-cli) を参照してください。 -### Get the Required Azure Permissions +### Get the required Azure permissions リソースグループを作成するには、サブスクリプションの所有者権限が必要です。 @@ -86,15 +86,15 @@ Azure コマンドラインインターフェイスをインストールしま Kubernetesの `kubectl` コマンドラインインターフェイスをインストールします。詳細は、Kubernetes ドキュメントの [Install Tools](https://kubernetes.io/docs/tasks/tools/) を参照してください。 -### Install the Helm CLI +### Install the helm CLI `helm` コマンドラインインターフェイスをインストールします。詳細は、[Installing Helm](https://helm.sh/docs/intro/install/) を参照してください。 -## Preparing DII for Processing +## Preparing DII for processing -## Deployment Environments +## Deployment environments 以下の環境が利用可能です。ベストプラクティスとして、テスト環境で実装をテストして検証してから、本番環境にデプロイすることをお勧めします。 @@ -111,14 +111,14 @@ Kubernetesの `kubectl` コマンドラインインターフェイスをイン AKS の新しい UID2 Private Operator をデプロイするには、次の主要な手順を完了する必要があります: -- [Download ZIP File and Extract Files](#download-zip-file-and-extract-files) -- [Prepare Environment Variables](#prepare-environment-variables) -- [Set Up AKS and Node Pool](#set-up-aks-and-node-pool) -- [Set Up AKS Cluster](#set-up-aks-cluster) -- [Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup) -- [Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup) +- [Download ZIP file and extract files](#download-zip-file-and-extract-files) +- [Prepare environment variables](#prepare-environment-variables) +- [Set up AKS and node pool](#set-up-aks-and-node-pool) +- [Set up AKS cluster](#set-up-aks-cluster) +- [Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup) +- [Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup) -### Download ZIP File and Extract Files +### Download ZIP file and extract files インストールファイルをセットアップするには、次の手順に従ってください: @@ -132,7 +132,7 @@ AKS の新しい UID2 Private Operator をデプロイするには、次の主 - `operator.yaml` --> -### Prepare Environment Variables +### Prepare environment variables 以下のコマンドを実行して、後で使用する環境変数を準備します。変数名は必要に応じて選択してください。 @@ -151,22 +151,22 @@ export SUBSCRIPTION_ID="$(az account show --query id --output tsv)" export DEPLOYMENT_ENV="integ" ``` -### Set Up AKS and Node Pool +### Set up AKS and node pool AKS とノードプールをセットアップするには、次の手順を完了します: -- [Create Resource Group](#create-resource-group) -- [Create Virtual Network](#create-virtual-network) -- [Create Subnets](#create-subnets) -- [Create Public IP Address](#create-public-ip-address) -- [Create NAT Gateway](#create-nat-gateway) -- [Configure NAT Service for Source Subnet](#configure-nat-service-for-source-subnet) +- [Create resource group](#create-resource-group) +- [Create virtual network](#create-virtual-network) +- [Create subnets](#create-subnets) +- [Create public ip address](#create-public-ip-address) +- [Create nat gateway](#create-nat-gateway) +- [Configure nat service for source Subnet](#configure-nat-service-for-source-subnet) - [Get the AKS Subnet ID](#get-the-aks-subnet-id) -- [Create an AKS Service](#create-an-aks-service) -- [Get the Principal ID of the Managed Identity](#get-the-principal-id-of-the-managed-identity) -- [Create Contributor Role for the Two Resource Groups](#create-contributor-role-for-the-two-resource-groups) +- [Create an AKS service](#create-an-aks-service) +- [Get the principal ID of the managed identity](#get-the-principal-id-of-the-managed-identity) +- [Create contributor role for the two resource groups](#create-contributor-role-for-the-two-resource-groups) -#### Create Resource Group +#### Create resource group Azure で、UID2 Private Operator を実行するリソースグループを作成するには、次のコマンドを実行します: ``` @@ -188,7 +188,7 @@ az group create --name "${RESOURCE_GROUP}" --location "${LOCATION}" az account list-locations -o table ``` -#### Create Virtual Network +#### Create virtual network 仮想ネットワークを作成するには、次のコマンドを実行します: @@ -200,7 +200,7 @@ az network vnet create \ --address-prefixes 10.0.0.0/8 ``` -#### Create Subnets +#### Create subnets サブネットを作成するには、次のコマンドを実行します: @@ -228,7 +228,7 @@ az network vnet subnet create \ --delegations Microsoft.ContainerInstance/containerGroups ``` -#### Create Public IP Address +#### Create public ip address パブリック IP アドレスを作成するには、次のコマンドを実行します: @@ -236,7 +236,7 @@ az network vnet subnet create \ az network public-ip create --name ${PUBLIC_IP_ADDRESS_NAME} --resource-group ${RESOURCE_GROUP} --sku standard --allocation static ``` -#### Create NAT Gateway +#### Create nat gateway [Azure NAT Gateway](https://learn.microsoft.com/ja-jp/azure/nat-gateway/nat-overview) を作成するには、次のコマンドを実行します: @@ -248,7 +248,7 @@ az network nat gateway create \ --idle-timeout 4 ``` -#### Configure NAT Service for Source Subnet +#### Configure nat service for source Subnet NAT サービスを構成するには、次のコマンドを実行します: @@ -273,7 +273,7 @@ export AKS_SUBNET_ID=$(az network vnet subnet show \ --output tsv) ``` -#### Create an AKS Service +#### Create an AKS service AKS サービスを作成するには、次のコマンドを実行します: @@ -303,7 +303,7 @@ az aks create \ 必ず最新のサポートされている Kubernetes バージョンを使用してください。`--kubernetes-version` フラグを使用します。以前のバージョンを使用する場合は、長期サポート（LTS）を有効にする必要があります。詳細は、Microsoft ドキュメントの [Long-term support for Azure Kubernetes Service (AKS) versions](https://learn.microsoft.com/en-us/azure/aks/long-term-support) を参照してください。 ::: -#### Get the Principal ID of the Managed Identity +#### Get the principal ID of the managed identity Principal ID を取得するには、次のコマンドを実行します: @@ -313,7 +313,7 @@ export MANAGED_IDENTITY_PRINCIPAL_ID="$(az aks show --resource-group ${RESOURCE_ 詳細は、Microsoft Azure ドキュメントの [Get the principal ID of the system-assigned managed identity](https://learn.microsoft.com/en-us/azure/aks/use-managed-identity#get-the-principal-id-of-the-system-assigned-managed-identity) を参照してください。 -#### Create Contributor Role for the Two Resource Groups +#### Create contributor role for the two resource groups 各グループに対してコントリビューターロールを作成するには、次のコマンドを実行します: @@ -333,7 +333,7 @@ az role assignment create \ - [Tutorial: Deploy virtual nodes on Azure Container Instances in your Azure Kubernetes Service cluster](https://learn.microsoft.com/ja-jp/azure/container-instances/container-instances-tutorial-virtual-nodes-helm) - [Setting up a virtual node Environment](https://github.com/microsoft/VirtualNodesOnAzureContainerInstances?tab=readme-ov-file#setting-up-a-virtual-node-environment) -### Set Up AKS Cluster +### Set up AKS cluster AKS クラスターをセットアップするには、次のコマンドを実行します: @@ -350,7 +350,7 @@ helm install virtualnode virtualnodesOnAzureContainerInstances/Helm/virtualnode kubectl get nodes ``` -### Complete Key Vault and Managed Identity Setup +### Complete key vault and managed identity setup 次のステップは、[Key Vault](https://learn.microsoft.com/ja-jp/azure/key-vault/general/overview) をセットアップし、Operator Key を保存することです。Key Vault を作成したら、[Managed Identity](https://learn.microsoft.com/ja-jp/entra/identity/managed-identities-azure-resources/overview) を作成し、Key Vault へのアクセス権を付与できます。 @@ -372,14 +372,14 @@ export IDENTITY_PRINCIPAL_ID="$(az identity show --name "${MANAGED_IDENTITY}" -- az role assignment create --assignee-object-id "${IDENTITY_PRINCIPAL_ID}" --role "Key Vault Secrets User" --scope "${KEYVAULT_RESOURCE_ID}" --assignee-principal-type ServicePrincipal ``` -### Complete the UID2 Private Operator Setup +### Complete the UID2 Private Operator setup Private Operator のセットアップを完了するには、次の手順に従ってください: -- [Update Placeholder Values](#update-placeholder-values) -- [Deploy Operator](#deploy-operator) +- [Update placeholder values](#update-placeholder-values) +- [Deploy operator](#deploy-operator) -#### Update Placeholder Values +#### Update placeholder values 前のステップを完了した後、プレースホルダ値を更新するには、次の手順に従ってください: @@ -423,7 +423,7 @@ Private Operator のセットアップを完了するには、次の手順に従 ``` -#### Deploy Operator +#### Deploy operator 以下の手順に従って、Private Operator をデプロイします: @@ -439,7 +439,7 @@ Private Operator のセットアップを完了するには、次の手順に従 kubectl apply -f operator.yaml ``` -## Running the Health Check +## Running the health check ヘルスチェックエンドポイントを呼び出して、実装のヘルスチェックをテストします。 @@ -457,7 +457,7 @@ Private Operator のセットアップを完了するには、次の手順に従 HTTP 200 とレスポンスボディ `OK` が表示される場合、ステータスは正常です。 -### Private Operator Attestation Failure +### Private Operator attestation failure @@ -467,9 +467,9 @@ AKS 用の UID2 Private Operator の新しいバージョンがリリースさ アップグレードするには、次の手順を完了します: -1. [Download ZIP File and Extract Files](#download-zip-file-and-extract-files) を参照して、新しいバージョンのデプロイメントファイルをダウンロードし、解凍します。 +1. [Download ZIP file and extract files](#download-zip-file-and-extract-files) を参照して、新しいバージョンのデプロイメントファイルをダウンロードし、解凍します。 -2. [Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup) の手順に従い、新しいファイルを使用して AKS 実装を新しいバージョンでデプロイします。 +2. [Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup) の手順に従い、新しいファイルを使用して AKS 実装を新しいバージョンでデプロイします。 3. 新しい AKS デプロイメントのヘルスを確認し、ステータスが正常であることを確認します。 @@ -479,6 +479,6 @@ AKS 用の UID2 Private Operator の新しいバージョンがリリースさ kubectl get pods ``` -## Keeping the Operator Key Secure +## Keeping the operator key secure diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aws-marketplace.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aws-marketplace.md index 0a0ebf327..4d7844f04 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aws-marketplace.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-aws-marketplace.md @@ -15,7 +15,7 @@ import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; import SnptRuntimeErrors from '../snippets/_snpt-private-operator-runtime-errors.mdx'; -# UID2 Private Operator for AWS Integration Guide +# UID2 Private Operator for AWS integration guide UID2 Operator は、UID2 エコシステム内の API サーバーです。詳細は、[UID2 Operator](../ref-info/ref-operators-public-private.md) を参照してください。 @@ -32,7 +32,7 @@ UID2 Private Operator for AWS を契約することで、以下を利用でき - [CloudFormation](https://aws.amazon.com/cloudformation/) template:
このテンプレートでは、UID2 Operator AMI がデプロイ展開されます。 -## Operator Version +## Operator version 最新の ZIP ファイルは、次の表の Release Notes 欄にリンクされています。 @@ -41,10 +41,10 @@ UID2 Private Operator for AWS を契約することで、以下を利用でき | Q4 2025 | [v5.62.24](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.62.24-r2) | v5.62.24-r2 | January 15, 2026 | :::note -For information about supported versions and deprecation dates, see [Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions). +For information about supported versions and deprecation dates, see [Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions). ::: -## Private Operator Upgrade Policy +## Private Operator upgrade policy @@ -55,7 +55,7 @@ AWS で 1 つまたは複数の UID2 Operator をサブスクライブしてデ 1. UID2 Operator としてあなたの組織を登録します。 2. [最小限の権限](#minimal-iam-role-privileges) を持つ[IAM](https://aws.amazon.com/iam/)ロールで AWS アカウントを作成します。 -#### Minimal IAM Role Privileges +#### Minimal iam role privileges ワンクリックデプロイを成功させるためには、AWS アカウントに以下のアクションを実行する権限が必要です: @@ -120,7 +120,7 @@ AWS で 1 つまたは複数の UID2 Operator をサブスクライブしてデ } ``` -### Resources Created +### Resources created 次の表は、[deployment](#deployment) 中に作成されるすべてのリソースの一覧です。 @@ -131,11 +131,11 @@ AWS で 1 つまたは複数の UID2 Operator をサブスクライブしてデ | `TokenSecret` | `AWS::SecretsManager::Secret` | Operator Key を保存するための Secrets Manager のシークレットです。 | | `WorkerRole` | `AWS::IAM::Role` | UID2 Operator が実行する IAM ロールです。このロールで AWS Secrets Manager にアクセスして Operator Key を取得できます。 | | `WorkerInstanceProfile` | `AWS::IAM::InstanceProfile` | Operator EC2 インスタンスにアタッチする Worker Role を持つインスタンスプロファイルです。 | -| `SecurityGroup` | `AWS::EC2::SecurityGroup` | オペレーターインスタンスに対するルールを提供するセキュリティグループポリシーです。[Security Group Policy](#security-group-policy) を参照してください。| +| `SecurityGroup` | `AWS::EC2::SecurityGroup` | オペレーターインスタンスに対するルールを提供するセキュリティグループポリシーです。[Security group policy](#security-group-policy) を参照してください。| | `LaunchTemplate` | `AWS::EC2::LaunchTemplate` | すべての設定が配置された起動テンプレートです。このテンプレートから新しい UID2 Operator インスタンスを起動できます。| | `AutoScalingGroup` | `AWS::AutoScaling::AutoScalingGroup` | 起動テンプレートがアタッチされている Auto Scaling Group(ASG)。必要であれば、これを使用して後でインスタンスの必要数を更新できます。 | -### Customization Options +### Customization options 以下は、[デプロイ](#deployment) の実行中または実行後にカスタマイズできる内容です。 @@ -144,7 +144,7 @@ AWS で 1 つまたは複数の UID2 Operator をサブスクライブしてデ - SSH キー: UID2 Operator の EC2 インスタンスにアクセスする際に使用する SSH キーです。 - [Instance type](https://aws.amazon.com/ec2/instance-types/): m5.2xlarge、m5.4xlarge、といった具合です。カスタマイズがない場合は、デフォルト値の m5.2xlarge を推奨します。 -### Security Group Policy +### Security group policy :::note ドメインに関連する証明書をエンクレーブに渡すのを避けるため、HTTPS の代わりにインバウンド HTTP が許可されています。これは、組織内部のプライベートネットワークで使用する場合、セキュアレイヤーのコストを回避することにもなります。 @@ -152,17 +152,17 @@ AWS で 1 つまたは複数の UID2 Operator をサブスクライブしてデ | Port Number | Direction | Protocol | Description | | ----------- | --------- | -------- | ------ | -| 80 | Inbound | HTTP | Healthcheck エンドポイント `/ops/healthcheck` を含むすべての UID2 API を提供します。
すべてが稼働している場合、エンドポイントは HTTP 200 を返し、レスポンスボディは `OK` となります。詳細は、[Checking UID2 Operator Status](#checking-uid2-operator-status) を参照してください。 | +| 80 | Inbound | HTTP | Healthcheck エンドポイント `/ops/healthcheck` を含むすべての UID2 API を提供します。
すべてが稼働している場合、エンドポイントは HTTP 200 を返し、レスポンスボディは `OK` となります。詳細は、[Checking UID2 Operator status](#checking-uid2-operator-status) を参照してください。 | | 9080 | Inbound | HTTP | Prometheus metrics サービス (`/metrics`)。 | | 443 | Outbound | HTTPS | UID2 Core Service、AWS S3 を呼び出し、オプトアウトデータとキーストア用のファイルをダウンロードします。 | -### VPC Chart +### VPC chart 次の図は、Private Operator をホストする仮想プライベートクラウドを示したものです。 -![EUID Operator VPC Chart](images/aws-vpc-chart-uid2.png) +![EUID operator VPC chart](images/aws-vpc-chart-uid2.png) -## Preparing DII for Processing +## Preparing DII for processing @@ -173,7 +173,7 @@ UID2 Operator を AWS Marketplace にデプロイするには、以下の手順 1. [Unified ID 2.0 Operator on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-wdbccsarov5la) をサブスクライブします。AWS がサブスクライブが完了するまで数分かかる場合があります。 2. **Configuration** をクリックし、構成値を指定します。 - ソフトウェアバージョンは、[Operator Version](#operator-version) を参照し、AWS Version 列で値を選択します。 + ソフトウェアバージョンは、[Operator version](#operator-version) を参照し、AWS Version 列で値を選択します。 3. Configuration ページで **Launch** をクリックし、**Launch CloudFormation** アクションを選択します。 4. スタック作成ウィザードでテンプレートを指定し、**Next** をクリックします。テンプレートファイルの S3 パスが自動的に入力されます。 5. [スタックの詳細](#stack-details) を入力し、**Next** をクリックします。 @@ -184,15 +184,15 @@ UID2 Operator を AWS Marketplace にデプロイするには、以下の手順 スタックの作成には数分かかります。Auto Scaling Group (ASG) が作成されたら、選択して EC2 インスタンスを確認できます。デフォルトでは、最初は 1 つのインスタンスのみが起動します。 -### Stack Details +### Stack details 以下の画像は、スタックの作成ウィザード ([デプロイ](#deployment) Step 5) の**Specify stack details**ページを示しています。次の表は、パラメータ値のリファレンスを提供します。 -![Application Configuration](images/cloudformation-step-2.png) +![Application configuration](images/cloudformation-step-2.png) 下段です: -![Infrastructure Configuration](images/cloudformation-step-2-2.png) +![Infrastructure configuration](images/cloudformation-step-2-2.png) 次の表は、[デプロイ](#deployment) の Step 5 で指定するパラメータ値について説明したものです。 @@ -209,11 +209,11 @@ UID2 Operator を AWS Marketplace にデプロイするには、以下の手順 | VpcSubnet1 | 既存の VPC AZ1 サブネット ID。 | | VpcSubnet2 | 既存の VPC AZ2 サブネット ID。 | -### Stack Configuration Options +### Stack configuration options 次の図は、スタックの作成ウィザード ([Deployment](#deployment) Step 6) の**スタックオプションの設定**ページを示しています。 -![Configure Stack Options](images/cloudformation-step-3.png) +![Configure stack options](images/cloudformation-step-3.png) 次の表は、[Deployment](#deployment) の Step 6 で指定するパラメータ値について説明したものです。 @@ -224,7 +224,7 @@ UID2 Operator を AWS Marketplace にデプロイするには、以下の手順 | Stack failure options | デプロイメントに失敗したときの処理を選択します。`Roll back all stack resources (すべてのスタックリソースをロールバックする)` オプションを推奨します。 | | Advanced options | これらはオプションです。 | -## Creating a Load Balancer +## Creating a load balancer ロードバランサーとターゲットオペレーターのオートスケーリンググループを作成するには、次の手順を実行します: @@ -248,16 +248,16 @@ UID2 Operator を AWS Marketplace にデプロイするには、以下の手順 10. ロードバランサーのページに戻り、**Listeners and routing** の下にある、`UID2ALBTG` をデフォルトのアクションとして転送するターゲットグループとして選択します。新しく作成したターゲットグループが表示されるように、ターゲットグループをリフレッシュする必要があるかもしれないことに注意してください。リスナーの **Port** を `443` に変更します。 11. [AWS user guide](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html) の指示に従って、HTTPS リスナーをセットアップします。 12. **Create load balancer** をクリックします。 -13. ロードバランサーのステータスを確認するには、以下のセクションに進んでください: [Checking UID2 Operator Status](#checking-uid2-operator-status) +13. ロードバランサーのステータスを確認するには、以下のセクションに進んでください: [Checking UID2 Operator status](#checking-uid2-operator-status) -## Checking UID2 Operator Status +## Checking UID2 Operator status ロードバランサー配下の UID2 Operator のステータスを確認するには、次の手順を実行します: 1. **EC2 > Load balancers** で、ロードバランサーの **DNS name** 列を見て、ロードバランサーの DNS 名を特定します。 2. ブラウザで、`https://{dns-name-of-your-load-balancer}/ops/healthcheck` にアクセスします。`OK` のレスポンスであれば、Operator のステータスは良好です。 -### Private Operator Attestation Failure +### Private Operator attestation failure @@ -274,30 +274,30 @@ UID2 Operator を AWS Marketplace にデプロイするには、以下の手順 スムーズな移行を行うには、まず新しいスタックを作成します。新しいスタックが起動し、サービスを提供する準備ができたら、古いスタックを削除してください。ロードバランサーを使用している場合は、まず新しいインスタンスを立ち上げて実行してから、DNS 名を以前のものから新しいものに変換してください。 ::: -## Managing the Logs +## Managing the logs 以下のセクションは、ログを最大限に活用するためのヒントを提供します: -- [Where to Read Logs](#where-to-read-logs) -- [Default Log Settings](#default-log-settings) -- [Changing the Log Rotation Schedule](#changing-the-log-rotation-schedule) -- [Additional Commands for Logging](#additional-commands-for-logging) +- [Where to read logs](#where-to-read-logs) +- [Default log settings](#default-log-settings) +- [Changing the log rotation schedule](#changing-the-log-rotation-schedule) +- [Additional commands for logging](#additional-commands-for-logging) -### Where to Read Logs +### Where to read logs ログにアクセスするには、EC2 インスタンスに SSH でログインします。ログは `/var/logs/` にあり、`operator.log-` の形式です。 -### Default Log Settings +### Default log settings UID2 system はログの生成に `syslog-ng` を使用し、ログのサイズが過大にならないようにログのローテーションと管理を行うために `logrotate` と cron ジョブを使用しています。以下のセクションでは、デフォルト設定とその背後にある理由について説明し、特定の要件に合わせてログローテーション設定をカスタマイズするためのガイダンスを提供します: -- [Log Rotation Configuration](#log-rotation-configuration) -- [Log Rotation Default Settings](#log-rotation-default-settings) +- [Log rotation configuration](#log-rotation-configuration) +- [Log rotation default settings](#log-rotation-default-settings) - [cronjob Configuration](#cronjob-configuration) -#### Log Rotation Configuration +#### Log rotation configuration Operator インスタンスがデプロイされると、デフォルトのログローテーション設定が適用されます: - ログは毎日ローテーションされ、30個のログエントリが保持されるため、ログ履歴はログエントリが異常に大きくない限り30日分のデータに相当します。 - ログエントリが非常に大きい場合、ログサイズが24時間以内に30MBに達した場合、その時点でログがローテーションされます。 -#### Log Rotation Default Settings +#### Log rotation default settings 以下はデフォルトの logrotate の設定です。`/etc/logrotate.d/operator-logrotate.conf` に定義されています: @@ -346,7 +346,7 @@ MAILTO=root - スクリプトは `maxsize` 条件が頻繁にチェックされるようにします。 - コマンドは `/var/lib/logrotate/logrotate.status` を参照してログのステータスをチェックし、ログがローテーション条件に達したかどうかを確認して、`logrotate` が毎分実行されたときにも余分なローテーションが行われないようにします。 -### Changing the Log Rotation Schedule +### Changing the log rotation schedule ログローテーションスケジュールを変更するには、`/etc/logrotate.d/uid2operator.conf` ファイルを更新します。 @@ -356,7 +356,7 @@ logrotate のドキュメントに従って指示に従ってください: [logr 変更を反映するためにサービスを再起動する必要はありません。 ::: -### Additional Commands for Logging +### Additional commands for logging 次の表は、ログを管理するために役立つ追加のコマンドを示しています。 @@ -366,11 +366,11 @@ logrotate のドキュメントに従って指示に従ってください: [logr | スケジュールされた間隔を変更することなく、手動で `logrotate` を1回実行します。 | `sudo logrotate -f /etc/logrotate.conf --force` | | `syslog-ng` をリロードします。 | `sudo /usr/sbin/syslog-ng-ctl reload` | -## Keeping the Operator Key Secure +## Keeping the operator key secure -## UID2 Operator Error Codes +## UID2 Operator error codes 以下の表は、Private Operator の起動シーケンス中に発生する可能性のあるエラーを示しています。 @@ -378,7 +378,7 @@ logrotate のドキュメントに従って指示に従ってください: [logr Private Operator 起動時のエラーコードは、リリース v5.49.7 以降のバージョンに適用されます。 ::: -### Startup Errors +### Startup errors Operator 起動時に以下のエラーが発生する可能性があります: @@ -391,12 +391,12 @@ Operator 起動時に以下のエラーが発生する可能性があります: | E05 | OperatorKeyValidationError | Operator Key が環境に適しており、提供されたものと一致していることを確認してください。 | | E06 | UID2ServicesUnreachableError | UID2 Core Service および Opt-Out Service の IP アドレスをアウトバウンドファイアウォールで許可します。IP アドレスおよび DNS の詳細は、ログを参照してください。 | -### Runtime Errors +### Runtime errors Operator の実行中に以下のエラーが発生する可能性があります: -## Technical Support +## Technical support 製品のサブスクリプションやデプロイに問題がある場合は、[contact us](mailto:aws-mktpl-uid@thetradedesk.com) にお問い合わせください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-azure-enclave.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-azure-enclave.md index fd0b3b81d..110ef52cf 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-azure-enclave.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-guide-azure-enclave.md @@ -15,7 +15,7 @@ import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; import SnptRuntimeErrors from '../snippets/_snpt-private-operator-runtime-errors.mdx'; -# UID2 Private Operator for Azure Integration Guide +# UID2 Private Operator for Azure integration guide UID2 Operator は、UID2 エコシステム内の API サーバーです。詳細は、[UID2 Operator](../ref-info/ref-operators-public-private.md) を参照してください。 @@ -29,7 +29,7 @@ UID2 Operator Confidential Containers インスタンスの Docker コンテナ UID2 Private Operator for Azure は、次の地域ではサポートされていません: ヨーロッパ、中国。 ::: -## Operator Version +## Operator version 最新の ZIP ファイルは、次の表の Azure Download 列にリンクされています。 @@ -38,10 +38,10 @@ UID2 Private Operator for Azure は、次の地域ではサポートされてい | Q4 2025 | v5.62.24 | [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 | :::note -サポートされているバージョンと非推奨日については、[Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions) を参照してください。 +サポートされているバージョンと非推奨日については、[Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions) を参照してください。 ::: -## Private Operator Upgrade Policy +## Private Operator upgrade policy @@ -49,13 +49,13 @@ UID2 Private Operator for Azure は、次の地域ではサポートされてい Azure に UID2 Private Operator をデプロイする前に、次の前提条件を満たす必要があります: -- [Set Up UID2 Operator Account](#set-up-uid2-operator-account) +- [Set up UID2 Operator account](#set-up-uid2-operator-account) - [Install Azure CLI](#install-azure-cli) -- [Get the Required Azure Permissions](#get-the-required-azure-permissions) +- [Get the required Azure permissions](#get-the-required-azure-permissions) -### Set Up UID2 Operator Account +### Set up UID2 Operator account -UID2 Private Operator をデプロイする前に、UID2 Service の Private Operator として登録する必要があります。UID2 Private Operator として登録するには、UID2 連絡先に組織を UID2 Operator として登録するよう依頼します。誰に依頼すればよいかわからない場合は、[Contact Info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 +UID2 Private Operator をデプロイする前に、UID2 Service の Private Operator として登録する必要があります。UID2 Private Operator として登録するには、UID2 連絡先に組織を UID2 Operator として登録するよう依頼します。誰に依頼すればよいかわからない場合は、[Contact info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 登録プロセスが完了すると、UID2 Service から UID2 Private Operator としての専用の Operator Key が送信されます。このキーは、UID2 Service との通信に使用されるもので、UID2 Service において Private Operator としてあなたを識別します。構成時に、このキーを `OPERATOR_KEY` の値として使用します。この値は、あなたの固有の識別子であり、パスワードでもあります。安全に保管し、共有しないでください。 @@ -67,7 +67,7 @@ UID2 Private Operator をデプロイする前に、UID2 Service の Private Ope Azure CLI をインストールします。詳細は、Azure ドキュメントの [Azure CLI のインストール方法](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) を参照してください。 -### Get the Required Azure Permissions +### Get the required Azure permissions リソースグループを作成するには、サブスクリプション所有者の権限が必要です。 @@ -77,11 +77,11 @@ Azure CLI をインストールします。詳細は、Azure ドキュメント 前提条件のすべての手順が完了したら、UID2 Private Operator をデプロイする準備が整います。[Deployment](#deployment) を参照してください。 -## Preparing DII for Processing +## Preparing DII for processing -## Deployment Environments +## Deployment environments 以下の環境が利用可能です。ベストプラクティスとして、本番環境にデプロイする前に、インテグレーション環境で実装をテストして検証することを推奨します。 @@ -98,14 +98,14 @@ Azure CLI をインストールします。詳細は、Azure ドキュメント 新しい UID2 Private Operator for Azure をデプロイするには、次の手順を完了する必要があります: -- [Download ZIP File and Extract Files](#download-zip-file-and-extract-files) -- [Create Resource Group](#create-resource-group) -- [Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup) -- [Set Up the VPC Network](#set-up-the-vpc-network) -- [Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup) -- [Set Up the Gateway Load Balancer](#set-up-the-gateway-load-balancer) +- [Download ZIP file and extract files](#download-zip-file-and-extract-files) +- [Create resource group](#create-resource-group) +- [Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup) +- [Set up the VPC network](#set-up-the-vpc-network) +- [Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup) +- [Set up the gateway load balancer](#set-up-the-gateway-load-balancer) -### Download ZIP File and Extract Files +### Download ZIP file and extract files 最初に、デプロイメントに必要なファイルを取得します: @@ -118,7 +118,7 @@ Azure CLI をインストールします。詳細は、Azure ドキュメント - `operator.json` and `operator.parameters.json` - `gateway.json` and `gateway.parameters.json` -### Create Resource Group +### Create resource group Azure で UID2 Operator を実行するためのリソースグループを作成するには、次のコマンドを実行します: @@ -141,7 +141,7 @@ az group create --name {RESOURCE_GROUP_NAME} --location {LOCATION} az account list-locations -o table ``` -### Complete Key Vault and Managed Identity Setup +### Complete key vault and managed identity setup 次のステップは、[key vault](https://learn.microsoft.com/en-us/azure/key-vault/general/overview) を設定し、Operator Key を保存することです。 @@ -156,7 +156,7 @@ Key Vault を作成したら、[managed identity](https://learn.microsoft.com/en | Parameter | Description | | :--- | :--- | | `vaultName` | Operator Key シークレットをホストするための Key Vault の名前。選択する名前はグローバルに一意である必要があります。 | - | `operatorKeyValue` | アカウント設定の一環として UID チームから受け取った `OPERATOR_KEY` シークレット値 ([Set Up UID2 Operator Account](#set-up-uid2-operator-account) を参照)。この値はあなたに固有であり、パスワードとして機能します。安全で秘密に保つ必要があります。 | + | `operatorKeyValue` | アカウント設定の一環として UID チームから受け取った `OPERATOR_KEY` シークレット値 ([Set up UID2 Operator account](#set-up-uid2-operator-account) を参照)。この値はあなたに固有であり、パスワードとして機能します。安全で秘密に保つ必要があります。 | 2. (オプション) デフォルトを受け入れたくない場合は、`vault.parameters.json` ファイルを次の値で更新します。これらのパラメータはデフォルト値を受け入れたくない場合にのみ更新する必要があります。 @@ -171,13 +171,13 @@ Key Vault を作成したら、[managed identity](https://learn.microsoft.com/en az deployment group create --name vault --resource-group {RESOURCE_GROUP_NAME} --parameters vault.parameters.json --template-file vault.json ``` -### Set Up the VPC Network +### Set up the VPC network 次のステップは、VPC ネットワークを設定することです。 Microsoft Azure で UID2 Private Operator をホストする Virtual Private Cloud (VPC) を示す次の図を参照してください。 -![VPC Network](images/operator-azure-drawio.png) +![VPC network](images/operator-azure-drawio.png) 次の手順に従います: @@ -198,7 +198,7 @@ Microsoft Azure で UID2 Private Operator をホストする Virtual Private Clo az deployment group create --name vnet --resource-group {RESOURCE_GROUP_NAME} --parameters vnet.parameters.json --template-file vnet.json ``` -### Complete the UID2 Private Operator Setup +### Complete the UID2 Private Operator setup 次のステップは、VPC サブネットで複数の Azure Container Instances (ACIs) を起動することです。 @@ -208,17 +208,17 @@ Microsoft Azure で UID2 Private Operator をホストする Virtual Private Clo | Parameter | Description | | :--- | :--- | - | `vaultName` | Operator Key シークレットをホストするための Key Vault の名前。[Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup) で作成した名前と一致している必要があります。 | - | `deploymentEnvironment` | デプロイ先の環境を示します: `integ` または `prod`。詳細は [Deployment Environments](#deployment-environments) を参照してください。 | + | `vaultName` | Operator Key シークレットをホストするための Key Vault の名前。[Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup) で作成した名前と一致している必要があります。 | + | `deploymentEnvironment` | デプロイ先の環境を示します: `integ` または `prod`。詳細は [Deployment environments](#deployment-environments) を参照してください。 | 2. (オプション) デフォルトを受け入れたくない場合は、`operator.parameters.json` ファイルを次の値で更新します。これらのパラメータはデフォルト値を受け入れたくない場合にのみ更新する必要があります。 Parameter | Description | | :--- | :--- | - | `operatorKeyName` | Operator Key シークレット名。値は [Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `operator-key` です。 | - | `operatorIdentifier` | コンテナを起動するマネージド ID の名前。値は [Complete Key Vault and Managed Identity Setup](#complete-key-vault-and-managed-identity-setup) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `uid-operator` です。 | - | `vnetName` | Virtual Network 名。値は [Set Up the VPC Network](#set-up-the-vpc-network) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `unified-id-network` です。 | - | `computeSubnetName` | UID2 Operator を実行するサブネットの名前。値は [Set Up the VPC Network](#set-up-the-vpc-network) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `unified-id-subnet-operators` です。 | + | `operatorKeyName` | Operator Key シークレット名。値は [Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `operator-key` です。 | + | `operatorIdentifier` | コンテナを起動するマネージド ID の名前。値は [Complete key vault and managed identity setup](#complete-key-vault-and-managed-identity-setup) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `uid-operator` です。 | + | `vnetName` | Virtual Network 名。値は [Set up the VPC network](#set-up-the-vpc-network) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `unified-id-network` です。 | + | `computeSubnetName` | UID2 Operator を実行するサブネットの名前。値は [Set up the VPC network](#set-up-the-vpc-network) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `unified-id-subnet-operators` です。 | | `count` | 起動するインスタンス数のカウント。デフォルトは `2` です。 | 3. 次のコマンドを実行してデプロイメントをトリガーします: @@ -239,7 +239,7 @@ Microsoft Azure で UID2 Private Operator をホストする Virtual Private Clo { "ipAddress": { "type": "Array", "value": [ "10.0.0.5", "10.0.0.4" ] } } ``` -### Set Up the Gateway Load Balancer +### Set up the gateway load balancer 次のステップは、[Gateway Load Balancer](https://learn.microsoft.com/en-us/azure/load-balancer/gateway-overview) を設定し、作成した ACI のプライベート IP アドレスを使用して [backend pool](https://learn.microsoft.com/en-us/azure/load-balancer/backend-pool-management) として使用することです。 @@ -249,7 +249,7 @@ Microsoft Azure で UID2 Private Operator をホストする Virtual Private Clo | Parameter | Description | | :--- | :--- | - | `containerGroupIPs` | 作成した ACI インスタンスの IP アドレス。[Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup) Step 4 の出力値として出力される値を使用します。 | + | `containerGroupIPs` | 作成した ACI インスタンスの IP アドレス。[Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup) Step 4 の出力値として出力される値を使用します。 | たとえば、更新されたファイルは次のようになります: @@ -266,8 +266,8 @@ Microsoft Azure で UID2 Private Operator をホストする Virtual Private Clo Parameter | Description | | :--- | :--- | - | `vnetName` | Virtual Network 名。値は [Set Up the VPC Network](#set-up-the-vpc-network) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `unified-id-network` です。 | - | `gatewaySubnetName` | UID2 Gateway を実行するサブネットの名前。値は [Set Up the VPC Network](#set-up-the-vpc-network) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `unified-id-subnet-gateway` です。 | + | `vnetName` | Virtual Network 名。値は [Set up the VPC network](#set-up-the-vpc-network) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `unified-id-network` です。 | + | `gatewaySubnetName` | UID2 Gateway を実行するサブネットの名前。値は [Set up the VPC network](#set-up-the-vpc-network) で指定した値と一致する必要があります。デフォルト値を受け入れた場合、値は `unified-id-subnet-gateway` です。 | 3. 次のコマンドを実行してデプロイメントをトリガーします: @@ -295,7 +295,7 @@ Microsoft Azure で UID2 Private Operator をホストする Virtual Private Clo この例では、HTTP を使用して Gateway Load Balancer をデプロイします。SSL を設定することを強く推奨します。手順は、Azure ドキュメントの [Tutorial: Configure an Application Gateway with TLS termination using the Azure portal](https://learn.microsoft.com/en-us/azure/application-gateway/create-ssl-portal) を参照してください。 ::: -## Running the Health Check +## Running the health check 実装のヘルスチェックをテストするために、ヘルスチェックエンドポイントを呼び出します。 @@ -303,17 +303,17 @@ Microsoft Azure で UID2 Private Operator をホストする Virtual Private Clo 次の手順に従います: -1. Gateway Load Balancer のパブリック IP アドレスを取得します。これは、[Set Up the Gateway Load Balancer](#set-up-the-gateway-load-balancer) Step 4 の出力値です。 +1. Gateway Load Balancer のパブリック IP アドレスを取得します。これは、[Set up the gateway load balancer](#set-up-the-gateway-load-balancer) Step 4 の出力値です。 2. オペレーターステータスをテストするために、ブラウザでヘルスチェックエンドポイントに移動します: `http://{LB_IP}/ops/healthcheck`。 HTTP 200 と `OK` というレスポンス本文が表示された場合、正常な状態です。 -### Private Operator Attestation Failure +### Private Operator attestation failure -### Scraping Metrics +### Scraping metrics Azure の Private Operator は、ポート 9080 で `/metrics` エンドポイントを介して [Prometheus 形式のメトリクス](https://prometheus.io/docs/concepts/data_model/) を公開します。これらのメトリクスを収集して集計するには、Prometheus 互換のスクレイパーを使用できます。 スクレイパーは、Private Operator が実行されている VNet にアクセスできる必要があります。ロードバランサーに `/metrics` エンドポイントへのアクセスを許可することは推奨しません。 @@ -324,11 +324,11 @@ UID2 Azure Confidential Containers の新しいバージョンがリリースさ アップグレードするには、次の手順を完了します: -1. [Download ZIP File and Extract Files](#download-zip-file-and-extract-files) の手順に従って、新しいバージョンのデプロイメントファイルをダウンロードし、解凍します。 +1. [Download ZIP file and extract files](#download-zip-file-and-extract-files) の手順に従って、新しいバージョンのデプロイメントファイルをダウンロードし、解凍します。 -2. [Complete the UID2 Private Operator Setup](#complete-the-uid2-private-operator-setup) の手順に従って、新しいバージョンのファイルを使用して ACI をデプロイします。 +2. [Complete the UID2 Private Operator setup](#complete-the-uid2-private-operator-setup) の手順に従って、新しいバージョンのファイルを使用して ACI をデプロイします。 -3. [Set Up the Gateway Load Balancer](#set-up-the-gateway-load-balancer) の手順に従って、新しい ACI を Gateway Load Balancer に追加します。 +3. [Set up the gateway load balancer](#set-up-the-gateway-load-balancer) の手順に従って、新しい ACI を Gateway Load Balancer に追加します。 4. 新しい ACI のヘルスチェックを確認し、ステータスが healthy であることを確認します: @@ -336,7 +336,7 @@ UID2 Azure Confidential Containers の新しいバージョンがリリースさ az network application-gateway show-backend-health --resource-group {RESOURCE_GROUP_NAME} --name uid-operator-gateway ``` -5. Gateway Load Balancer から古い ACI を削除します。[Set Up the Gateway Load Balancer](#set-up-the-gateway-load-balancer) の手順に従って、古い ACI をバックエンドプールから削除します。 +5. Gateway Load Balancer から古い ACI を削除します。[Set up the gateway load balancer](#set-up-the-gateway-load-balancer) の手順に従って、古い ACI をバックエンドプールから削除します。 6. 以下のコマンドを実行して、古い ACI をシャットダウンします: @@ -344,11 +344,11 @@ UID2 Azure Confidential Containers の新しいバージョンがリリースさ for i in {0..COUNT}; az container delete --name uid-operator-OLD-VERSION-$i --resource-group {RESOURCE_GROUP} --yes ``` -## Keeping the Operator Key Secure +## Keeping the operator key secure -## UID2 Operator Error Codes +## UID2 Operator error codes 以下のセクションでは、Private Operator の起動時またはランタイム中に発生する可能性のあるエラーコードを一覧表示しています。 @@ -356,7 +356,7 @@ UID2 Azure Confidential Containers の新しいバージョンがリリースさ Private Operator 起動時のエラーコードは、リリース v5.49.7 以降のバージョンに適用されます。 ::: -### Startup Errors +### Startup errors 起動時に発生する可能性のあるエラーを次に示します: @@ -369,7 +369,7 @@ Private Operator 起動時のエラーコードは、リリース v5.49.7 以降 | E06 | UID2ServicesUnreachableError | UID2 Core Service および Opt-Out Service の IP アドレスをアウトバウンドファイアウォールで許可します。IP アドレスと DNS の詳細は、ログを参照してください。 | | E08 | OperatorKeyPermissionError | コンテナを起動するマネージド ID (operatorIdentifier パラメータで指定) は、 Operator Key が格納されている Key Vault へのアクセス権を持っている必要があります。`operatorIdentifier` の値は、すべての構成 JSON ファイルで同じである必要があります。 | -### Runtime Errors +### Runtime errors ランタイム中に発生する可能性のあるエラーを次に示します: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-private-gcp-confidential-space.md b/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-private-gcp-confidential-space.md index e4898d686..c075287ac 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-private-gcp-confidential-space.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/guides/operator-private-gcp-confidential-space.md @@ -15,7 +15,7 @@ import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx'; import SnptRuntimeErrors from '../snippets/_snpt-private-operator-runtime-errors.mdx'; -# UID2 Private Operator for GCP Integration Guide +# UID2 Private Operator for GCP integration guide UID2 Operator は、UID2 エコシステムの API サーバーです。詳細は、[UID2 Operator](../ref-info/ref-operators-public-private.md) を参照してください。 @@ -31,7 +31,7 @@ UID2 Operator Confidential Space 用の Docker コンテナが起動すると、 認証が成功すると、UID2 Core Service は、UID2 Operator をセキュアな Confidential Space コンテナ内でブートストラップするためのソルトやキーなどのシード情報を提供します。 -## Operator Version +## Operator version 最新の ZIP ファイルは、次の表の GCP ダウンロード列にリンクされています。 @@ -40,14 +40,14 @@ UID2 Operator Confidential Space 用の Docker コンテナが起動すると、 | 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 | :::note -サポートされているバージョンと非推奨日については、[Private Operator Versions](../ref-info/deprecation-schedule.md#private-operator-versions) を参照してください。 +サポートされているバージョンと非推奨日については、[Private Operator versions](../ref-info/deprecation-schedule.md#private-operator-versions) を参照してください。 ::: -## Private Operator Upgrade Policy +## Private Operator upgrade policy -## Setup Overview +## Setup overview セットアップは、次の手順で行います: @@ -59,10 +59,10 @@ UID2 Operator Confidential Space 用の Docker コンテナが起動すると、 Terraform テンプレートオプションを推奨します。 1. 選択したデプロイメントオプションに従って、適用可能な手順に従います: - - [Terraform Template](#deployterraform-template) + - [Terraform template](#deployterraform-template) - [gcloud CLI](#deploygcloud-cli) 1. 必要であれば、エグレスルールを有効にします。 - - 詳細は [Confidential Space Account Setup](#confidential-space-account-setup)、Step 4 を参照してください。 + - 詳細は [Confidential space account setup](#confidential-space-account-setup)、Step 4 を参照してください。 すべての手順が完了すると、実装が稼働するようになります。 @@ -70,10 +70,10 @@ UID2 Operator Confidential Space 用の Docker コンテナが起動すると、 Google Cloud Platform で Confidential Space を使用して UID2 Operator Service を設定する前に、次の前提条件を満たす必要があります: -- [Confidential Space Account Setup](#confidential-space-account-setup) -- [UID2 Operator Account Setup](#uid2-operator-account-setup) +- [Confidential space account setup](#confidential-space-account-setup) +- [UID2 Operator account setup](#uid2-operator-account-setup) -### Confidential Space Account Setup +### Confidential space account setup UID2 Operator Service は、任意の GCP アカウントとプロジェクトで実行できます。ただし、認証をサポートするためには、Confidential Space 仮想マシン（VM）を実行するために使用できるサービスアカウントを作成する必要があります。 @@ -90,9 +90,9 @@ UID2 Operator Service は、任意の GCP アカウントとプロジェクト 1. エグレスルールを有効にします。VPC インフラストラクチャが既知のエンドポイントへのイグレスのみを許可する場合、オペレーターが認証に必要な証明書を取得できるようにエグレスルールを有効にする必要があります。これを有効にするには、Google のこのドキュメントに従ってください: [VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products#table_confidential_space)。 -### UID2 Operator Account Setup +### UID2 Operator account setup -UID2 の連絡先に、あなたの組織を UID2 Operator として登録するよう依頼してください。誰に依頼すればよいかわからない場合は、[Contact Info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 +UID2 の連絡先に、あなたの組織を UID2 Operator として登録するよう依頼してください。誰に依頼すればよいかわからない場合は、[Contact info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 :::tip 新しいバージョンやその他の技術的な通知や要求について知らせておくべき人の社内メール配信リストを設定し、そのメールアドレスを提供しておくとよいでしょう。 @@ -109,11 +109,11 @@ UID2 アカウント登録が完了し、gcloud CLI をインストールした - [deployment environments](#deployment-environments) に関する情報を確認します。 - 利用可能な[deployment options](#deployment-options) に関する情報を確認し、それぞれの利点を比較して、使用するオプションを決定します。 -## Preparing DII for Processing +## Preparing DII for processing -## Deployment Environments +## Deployment environments 以下の環境が利用可能で、[deployment options](#deployment-options) の両方が両方の環境をサポートしています。 @@ -126,9 +126,9 @@ UID2 アカウント登録が完了し、gcloud CLI をインストールした | Environment | Details | | :--- | :--- | | Integration (`integ`) | テスト専用。デバッグモードはインテグレーション環境で使用できます。 | -| Production (`prod`) | 本番トラフィックの管理用。この環境では、Terraform テンプレート経由で、ロードバランシングを行い、HTTPS を有効にしてデプロイすることを推奨します。[Deployment Options](#deployment-options) を参照してください。 | +| Production (`prod`) | 本番トラフィックの管理用。この環境では、Terraform テンプレート経由で、ロードバランシングを行い、HTTPS を有効にしてデプロイすることを推奨します。[Deployment options](#deployment-options) を参照してください。 | -## Deployment Options +## Deployment options デプロイメントオプションは次の2つがあります: @@ -140,10 +140,10 @@ UID2 アカウント登録が完了し、gcloud CLI をインストールした どちらのデプロイメントオプションも、両方のデプロイメント環境をサポートしています。 次のステップを決定するには、使用するデプロイオプションを選択してください。次に、該当する手順に従ってください: -- [Deploy—Terraform Template](#deployterraform-template) +- [Deploy—Terraform template](#deployterraform-template) - [Deploy—gcloud CLI](#deploygcloud-cli) -### Deploy—Terraform Template +### Deploy—Terraform template デプロイとアップグレードを容易にするために、Terraform テンプレートを使用して、ロードバランシングと自動スケーリング機能を備えた UID2 Private Operator 実装をデプロイできます。このシナリオでは、すべての VM インスタンスが Confidential Space VM で実行され、複数の可用性ゾーン（AZ）にデプロイされます。 @@ -159,29 +159,29 @@ Terraform テンプレートは次の操作を行います: - HTTPS が有効になっている場合、Terraform に HTTPS 証明書を提供します。 :::note -Terraform テンプレートは、[Confidential Space Account Setup](#confidential-space-account-setup) Step 3 でインストールした gcloud CLI を使用します。 +Terraform テンプレートは、[Confidential space account setup](#confidential-space-account-setup) Step 3 でインストールした gcloud CLI を使用します。 ::: 新しい UID2 Operator を GCP Confidential Space Enclave にデプロイするための Terraform テンプレートを使用する手順は次のとおりです: 1. [Install Terraform](#install-terraform) -1. [Set Up the Terraform Environment](#set-up-the-terraform-environment) -1. [Download the Template Files](#download-the-template-files) -1. [Provide Input Values](#provide-input-values) +1. [Set up the Terraform environment](#set-up-the-terraform-environment) +1. [Download the template files](#download-the-template-files) +1. [Provide input values](#provide-input-values) 1. [Run Terraform](#run-terraform) -1. [Test Terraform Using the Health Check Endpoint](#test-terraform-using-the-health-check-endpoint) +1. [Test Terraform using the health check endpoint](#test-terraform-using-the-health-check-endpoint) 詳細は次のとおりです: -- [Delete All Created Resources](#delete-all-created-resources) +- [Delete all created resources](#delete-all-created-resources) - [Outputs](#outputs) #### Install Terraform Terraform がインストールされていない場合は、[terraform.io](https://www.terraform.io/) を参照してインストールしてください。 -#### Set Up the Terraform Environment +#### Set up the Terraform environment -1. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。プロジェクト ID の `{PROJECT_ID}` プレースホルダを自分のプロジェクト ID に置き換えてください（[Confidential Space Account Setup](#confidential-space-account-setup) を参照）: +1. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。プロジェクト ID の `{PROJECT_ID}` プレースホルダを自分のプロジェクト ID に置き換えてください（[Confidential space account setup](#confidential-space-account-setup) を参照）: ``` gcloud config set project {PROJECT_ID} @@ -193,9 +193,9 @@ Terraform がインストールされていない場合は、[terraform.io](http gcloud auth application-default login ``` -#### Download the Template Files +#### Download the template files -[Operator Version](#operator-version) の GCP ダウンロード列にある ZIP ファイルをダウンロードします。最新バージョンを選択してください。ファイルを便利な場所に解凍します。次の表に示すファイルが生成されます。 +[Operator version](#operator-version) の GCP ダウンロード列にある ZIP ファイルをダウンロードします。最新バージョンを選択してください。ファイルを便利な場所に解凍します。次の表に示すファイルが生成されます。 | File | Details | | :--- | :--- | @@ -204,7 +204,7 @@ Terraform がインストールされていない場合は、[terraform.io](http | `outputs.tf` | 出力定義です。 | | `terraform.tfvars` | テンプレート入力変数の値です。 | -#### Provide Input Values +#### Provide input values 入力パラメータの値を提供するために、ダウンロードした `terraform.tfvars` ファイルに入力します。必要なものとオプションの両方があります。 @@ -215,7 +215,7 @@ Terraform がインストールされていない場合は、[terraform.io](http | `project_id` | `string` | `uid2-test` | yes | UID2 Operator を実行する GCP プロジェクトの ID。たとえば、`UID2-Operator-Production`。 | | `service_account_name` | `string` | `tf-test` | yes | GCP Confidential Space の UID2 Operator インスタンスに使用するサービスアカウントの名前。 | | `uid_operator_image` | `string` | `us-docker.pkg.dev/uid2-prod-project/iabtechlab/uid2-operator:{version_number}` | yes | コンフィギュレーションで使用する UID2 Private Operator for GCP の Docker イメージ URL。バージョン番号は、デプロイされるバージョンによって変わります。 | - | `uid_operator_key` | `string` | n/a | yes | UID2 Operator Key は、[UID2 Operator Account Setup](#uid2-operator-account-setup) で受け取ったものです。 | + | `uid_operator_key` | `string` | n/a | yes | UID2 Operator Key は、[UID2 Operator account setup](#uid2-operator-account-setup) で受け取ったものです。 | | `uid_operator_key_secret_name` | `string` | `secret-operator-key` | yes | Secret Manager で作成するキーの名前。 | | `uid_deployment_env` | `string` | `integ` | yes | 有効な値: `integ` はインテグレーション環境、`prod` は本番環境。
マシンタイプはデプロイ環境によって決まります。`integ` は `n2d-standard-2` を使用し、`prod` は `n2d-standard-16` を使用します。 | | `debug_mode` | `bool` | `true` | yes | より多くの診断情報を有効にするには `true` に設定します。本番環境では `false` に設定しなければなりません。 | @@ -253,13 +253,13 @@ terraform apply Terraform の `state` ファイルに関する推奨に従ってください: デプロイされたインフラストラクチャを維持するために必要であり、機密情報を含む可能性があります。詳細は、Terraform ドキュメントの [state](https://developer.hashicorp.com/terraform/language/state) を参照してください。 ::: -#### Test Terraform Using the Health Check Endpoint +#### Test Terraform using the health check endpoint 実装のヘルスをテストするために、ヘルスチェックエンドポイントを使用します。ヘルスチェックの期待される結果は、HTTP 200 で、レスポンスボディが `OK` です。 -手順は、[Health Check—Terraform Template](#health-checkterraform-template) を参照してください。 +手順は、[Health check—Terraform template](#health-checkterraform-template) を参照してください。 -#### Delete All Created Resources +#### Delete all created resources クリーンアップを行いたい場合は、Terraform によって作成されたリソースを削除できます。たとえば、`integ` をテストしたい場合、後でスタック全体を削除することができます。 @@ -285,17 +285,17 @@ gcloud CLI を使用して GCP Confidential Space Enclave に新しい UID2 Oper 本番環境へのデプロイメントにはこのオプションを使用しないことを推奨します。本番環境へのデプロイメントには、Terraform テンプレートを使用し、ロードバランシングを行い、HTTPS を有効にすることを推奨します。 ::: - 1. [Set Up Service Account Rules and Permissions](#set-up-service-account-rules-and-permissions) - 1. [Create Secret for the Operator Key in Secret Manager](#create-secret-for-the-operator-key-in-secret-manager) - 1. [Update the Script with Valid Values](#update-the-script-with-valid-values) - 1. [Run the Script](#run-the-script) - 1. [Test gcloud Using the Health Check Endpoint](#test-gcloud-using-the-health-check-endpoint) + 1. [Set up service account rules and permissions](#set-up-service-account-rules-and-permissions) + 1. [Create secret for the operator key in secret manager](#create-secret-for-the-operator-key-in-secret-manager) + 1. [Update the script with valid values](#update-the-script-with-valid-values) + 1. [Run the script](#run-the-script) + 1. [Test gcloud using the health check endpoint](#test-gcloud-using-the-health-check-endpoint) -#### Set Up Service Account Rules and Permissions +#### Set up service account rules and permissions gcloud CLI を使用して、UID2 Operator Service を実行するためのサービスアカウントを設定するには、次の手順に従います。プレースフォルダー値を自分の有効な値に置き換えてください。 -1. 作成したプロジェクトに切り替えます（[Confidential Space Account Setup](#confidential-space-account-setup) で作成したプロジェクト）: +1. 作成したプロジェクトに切り替えます（[Confidential space account setup](#confidential-space-account-setup) で作成したプロジェクト）: ``` $ gcloud config set project {PROJECT_ID} ``` @@ -368,11 +368,11 @@ gcloud CLI を使用して、UID2 Operator Service を実行するためのサ `source-ranges` は、クライアントが Private Operator を呼び出すために使用する IP アドレスの範囲を指定します。CIDR 表記であり、複数の範囲を提供するためにカンマ区切りの値を使用できます。例: `--source-ranges="10.0.0.0/8,10.10.0.0/16"`。範囲が正確であり、自分のものである IP アドレスのみが含まれていることを確認してください。 ::: -#### Create Secret for the Operator Key in Secret Manager +#### Create secret for the operator key in secret manager -UID2 Operator には、Operator Key が必要です。UID2 アカウントの設定（[UID2 Operator Account Setup](#uid2-operator-account-setup) を参照）の一環として、各環境の Operator Key を受け取ります。 +UID2 Operator には、Operator Key が必要です。UID2 アカウントの設定（[UID2 Operator account setup](#uid2-operator-account-setup) を参照）の一環として、各環境の Operator Key を受け取ります。 -次のステップは、`{OPERATOR_KEY}` 値を GCP Secret Manager に保存し、それに対する完全なシークレット名を取得し、それをデプロイメントスクリプト内の `{OPERATOR_KEY_SECRET_FULL_NAME}` プレースホルダで置き換えることです ([Update the Script with Valid Values](#update-the-script-with-valid-values) を参照)。 +次のステップは、`{OPERATOR_KEY}` 値を GCP Secret Manager に保存し、それに対する完全なシークレット名を取得し、それをデプロイメントスクリプト内の `{OPERATOR_KEY_SECRET_FULL_NAME}` プレースホルダで置き換えることです ([Update the script with valid values](#update-the-script-with-valid-values) を参照)。 次の手順に従います: 1. 次のスクリプトを実行して、新しいシークレットを作成します。最初に、自分の値でカスタマイズしてください: @@ -401,15 +401,15 @@ UID2 Operator には、Operator Key が必要です。UID2 アカウントの設 この例では、完全なシークレット名は次のようになります: `projects/111111111111/secrets/uid2-operator-operator-key-secret-integ/versions/1`。これは、次のセクションの `{OPERATOR_KEY_SECRET_FULL_NAME}` プレースホルダを置き換えるために使用する値です。 -#### Update the Script with Valid Values +#### Update the script with valid values サンプルスクリプトを更新して、プレースホルダ値を自分の有効な値に置き換えます。 このセクションには次の内容が含まれます: -- [Placeholder Values and Definitions](#placeholder-values-and-definitions) -- [Sample Deployment Script—Integ](#sample-deployment-scriptinteg) -- [Sample Deployment Script—Prod](#sample-deployment-scriptprod) +- [Placeholder values and definitions](#placeholder-values-and-definitions) +- [Sample deployment script—integ](#sample-deployment-scriptinteg) +- [Sample deployment script—prod](#sample-deployment-scriptprod) ##### Placeholder Values and Definitions @@ -420,9 +420,9 @@ UID2 Operator には、Operator Key が必要です。UID2 アカウントの設 | `{INSTANCE_NAME}` | 有効な VM の名前。 | | `{ZONE}` | VM インスタンスがデプロイされる Google Cloud ゾーン。 | | `{IMAGE_FAMILY}` | `confidential-space` はインテグレーションと本番で使用し、`confidential-space-debug` はインテグレーションでのみデバッグ用に使用します。`confidential-space-debug` は本番では動作しないことに注意してください。 | -| `{SERVICE_ACCOUNT}` | アカウント作成時に作成したサービスアカウントのメールアドレス: `{SERVICE_ACCOUNT_NAME}@{PROJECT_ID}.iam.gserviceaccount.com`.
詳細は [Set Up Service Account Rules and Permissions](#set-up-service-account-rules-and-permissions) (Step 4) を参照してください。| -| `{OPERATOR_IMAGE}` | コンフィギュレーションで使用する UID2 Private Operator for GCP の Docker イメージ URL。
これは、GCP ダウンロードファイルの `terraform.tfvars` ファイルにあります。([Operator Version](#operator-version) を参照) | -| `{OPERATOR_KEY_SECRET_FULL_NAME}` | Operator Key secret に指定したフルネーム ([Create Secret for the Operator Key in Secret Manager](#create-secret-for-the-operator-key-in-secret-manager) を参照)。パスを含め `projects//secrets//versions/` の形式でしています。たとえば: `projects/111111111111/secrets/uid2-operator-operator-key-secret-integ/versions/1` | +| `{SERVICE_ACCOUNT}` | アカウント作成時に作成したサービスアカウントのメールアドレス: `{SERVICE_ACCOUNT_NAME}@{PROJECT_ID}.iam.gserviceaccount.com`.
詳細は [Set up service account rules and permissions](#set-up-service-account-rules-and-permissions) (Step 4) を参照してください。| +| `{OPERATOR_IMAGE}` | コンフィギュレーションで使用する UID2 Private Operator for GCP の Docker イメージ URL。
これは、GCP ダウンロードファイルの `terraform.tfvars` ファイルにあります。([Operator version](#operator-version) を参照) | +| `{OPERATOR_KEY_SECRET_FULL_NAME}` | Operator Key secret に指定したフルネーム ([Create secret for the operator key in secret manager](#create-secret-for-the-operator-key-in-secret-manager) を参照)。パスを含め `projects//secrets//versions/` の形式でしています。たとえば: `projects/111111111111/secrets/uid2-operator-operator-key-secret-integ/versions/1` | ##### Sample Deployment Script—Integ @@ -464,17 +464,17 @@ $ gcloud compute instances create {INSTANCE_NAME} \ --metadata ^~^tee-image-reference={OPERATOR_IMAGE}~tee-container-log-redirect=true~tee-restart-policy=Never~tee-env-DEPLOYMENT_ENVIRONMENT=prod~tee-env-API_TOKEN_SECRET_NAME={OPERATOR_KEY_SECRET_FULL_NAME}~tee-env-CORE_BASE_URL=https://core-prod.uidapi.com~tee-env-OPTOUT_BASE_URL=https://optout-prod.uidapi.com ``` -#### Run the Script +#### Run the script スクリプトの準備ができたら、追加の有効な値を含むスクリプトを実行します。 -#### Test gcloud Using the Health Check Endpoint +#### Test gcloud using the health check endpoint ヘルスチェックエンドポイントを呼び出して、実装の健全性をテストします。期待される結果は、HTTP 200 で、レスポンスボディが `OK` です。 -手順は、[Health Check—gcloud CLI](#health-checkgcloud-cli) を参照してください。 +手順は、[Health check—gcloud CLI](#health-checkgcloud-cli) を参照してください。 -## Running the Health Check +## Running the health check ヘルスチェックエンドポイントを呼び出して、実装の健全性をテストします。 @@ -482,10 +482,10 @@ $ gcloud compute instances create {INSTANCE_NAME} \ 選択したデプロイメントオプションに応じて、適用される手順に従ってください: -- [Health Check—Terraform Template](#health-checkterraform-template) -- [Health Check—gcloud CLI](#health-checkgcloud-cli) +- [Health check—Terraform template](#health-checkterraform-template) +- [Health check—gcloud CLI](#health-checkgcloud-cli) -### Health Check—Terraform Template +### Health check—Terraform template 次の例は、Terraform テンプレートオプションのヘルスチェックを示しています: @@ -500,7 +500,7 @@ $ gcloud compute instances create {INSTANCE_NAME} \ HTTP 200 とレスポンスボディが `OK` の場合、健全な状態です。 -### Health Check—gcloud CLI +### Health check—gcloud CLI 次の例は、`gcloud` コマンドラインオプションのヘルスチェックを示しています: 1. デプロイされたインスタンスのパブリック IP アドレスを取得します: @@ -514,7 +514,7 @@ $ gcloud compute instances create {INSTANCE_NAME} \ HTTP 200 とレスポンスボディが `OK` の場合、健全な状態です。 -### Private Operator Attestation Failure +### Private Operator attestation failure @@ -524,10 +524,10 @@ UID2 Google Cloud Platform Confidential Space の新しいバージョンがリ 新しいバージョンにアップグレードする場合、アップグレードプロセスは選択したデプロイメントオプションに依存します。該当する手順に従ってください: -- [Upgrading—Terraform Template](#upgradingterraform-template) +- [Upgrading—Terraform template](#upgradingterraform-template) - [Upgrading—gcloud CLI](#upgradinggcloud-cli) -### Upgrading—Terraform Template +### Upgrading—Terraform template Terraform テンプレートを使用してデプロイした場合、アップグレードするには、新しい `{OPERATOR_IMAGE}` を使用してデプロイメントを更新するだけです。 @@ -537,14 +537,14 @@ gcloud CLI を使用してデプロイした場合、アップグレードする 手動でロードバランサーを設定した場合、ロードバランサーのマッピングも更新する必要があります。 -## Scraping Metrics +## Scraping metrics GCP の Private Operator は、ポート 9080 の `/metrics` エンドポイントで [Prometheus 形式のメトリクス](https://prometheus.io/docs/concepts/data_model/) を公開します。Prometheus 互換のスクレイパーを使用して、これらのメトリクスを収集して集計できます。 -## Keeping the Operator Key Secure +## Keeping the operator key secure -## UID2 Operator Error Codes +## UID2 Operator error codes 以下の表は、Private Operator 起動シーケンス中に発生する可能性のあるエラーを一覧表示しています。 @@ -552,7 +552,7 @@ GCP の Private Operator は、ポート 9080 の `/metrics` エンドポイン Private Operator 起動時のエラーコードは、リリース v5.49.7 以降のバージョンに適用されます。 ::: -### Startup Errors +### Startup errors オペレータの起動時に以下のエラーが発生する可能性があります： @@ -565,7 +565,7 @@ Private Operator 起動時のエラーコードは、リリース v5.49.7 以降 | E06 | UID2ServicesUnreachableError | UID2 Core Service および Opt-Out Service の IP アドレスをアウトバウンドファイアウォールで許可します。IP アドレスと DNS の詳細は、ログを参照してください。 | | E08 | OperatorKeyPermissionError | Compute Engine インスタンステンプレートにサービスアカウントをアタッチします。UID2 Operator は、GCP Secret Manager から Operator Key にアクセスするためにこれらの権限が必要です。 | -### Runtime Errors +### Runtime errors オペレータの実行中に以下のエラーが発生する可能性があります: 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 fc8851438..b5a2e33ed 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 @@ -10,113 +10,113 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Integration Guides: Summary +# UID2 integration guides: Summary 以下のガイドでは、各組織のニーズと要件、およびパブリッシャー、DSP、データプロバイダー/広告主としての主な役割に基づいたインテグレーション手順を説明しています。UID2 参加者として、Open Operator Service との連携や Private Operator Service のホスティングを可能にするエンタープライズパートナーを介してインテグレーションすることもできます。 インテグレーションは、以下のカテゴリーに分類されます: -- [Publisher Integrations](#publisher-integrations) -- [Advertiser/Data Provider Integrations](#advertiserdata-provider-integrations) -- [DSP Integrations](#dsp-integrations) -- [Private Operator Service Integrations](#private-operator-service-integrations) +- [Publisher integrations](#publisher-integrations) +- [Advertiser/data provider integrations](#advertiserdata-provider-integrations) +- [DSP integrations](#dsp-integrations) +- [Private Operator service integrations](#private-operator-service-integrations) -## Publisher Integrations +## Publisher integrations パブリッシャーのインテグレーションは、次の主なカテゴリに分類されます: -- [Web Integrations](#web-integrations) -- [Mobile Integrations](#mobile-integrations) -- [CTV Integrations](#ctv-integrations) -- [Prebid Integrations](#prebid-integrations) -- [Google Ad Manager Integrations](#google-ad-manager-integrations) +- [Web integrations](#web-integrations) +- [Mobile integrations](#mobile-integrations) +- [CTV integrations](#ctv-integrations) +- [Prebid integrations](#prebid-integrations) +- [Google Ad Manager integrations](#google-ad-manager-integrations) -ソースコード付きのライブで動作する UID2 実装の例については、[UID2 Integration Samples](../ref-info/integration-sample-sites.md) を参照してください。 +ソースコード付きのライブで動作する UID2 実装の例については、[UID2 integration samples](../ref-info/integration-sample-sites.md) を参照してください。 -### Web Integrations +### Web integrations パブリッシャーの Web インテグレーションには、以下のドキュメントリソースが利用できます。 :::tip -Web インテグレーションオプションの詳細は [Publisher Web Integration Overview](integration-options-publisher-web.md) を参照してください。 +Web インテグレーションオプションの詳細は [Publisher web integration overview](integration-options-publisher-web.md) を参照してください。 ::: | Integration Guide | Content Description | | :--- | :--- | -| [UID2 Integration Overview for Prebid](integration-prebid.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js または Prebid Mobile SDK から渡される UID2 Token (Advertising Token) を生成したいパブリッシャー向けのインテグレーションオプションの概要です。 | | -| [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | UID2 とインテグレーションし、トークンの生成とトークンの自動更新を Prebid.js に管理させ、トークンを RTB ビッドストリームに渡したいパブリッシャー向けのインテグレーションガイドです。このガイドは、Client-Side で UID2 Token をリクエストしたいパブリッシャー向けのもので、最も簡単な実装方法です。 | -| [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid から渡される ID トークンを生成したいパブリッシャー向けのインテグレーションガイドです。このガイドは、Private Operator を使用しているか、Server-Side でトークンを生成したいパブリッシャー向けです。 | -| [UID2 Integration Overview for JavaScript](integration-javascript.md) | JavaScript SDK を使って UID2 とインテグレーションしたいパブリッシャー向けのオプションの概要です。 | -| [Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | 最も簡単な実装方法で、Client-Side の JavaScript の変更だけで UID2 とインテグレーションしたいパブリッシャー向けのインテグレーションガイドです。SDK for JavaScript は、トークンの生成と更新を自動的に管理します。 | -| [Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md) | パブリッシャー向けのこのインテグレーションガイドでは、SDK for JavaScript を使用する標準的なウェブインテグレーションシナリオについて説明し、トークンを Server-Side で生成し、パブリッシャーのウェブページに渡す必要があります。 | -| [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | このインテグレーションガイドは、[SDK for JavaScript](../sdks/sdk-ref-javascript.md) を使用していないパブリッシャー向けです。 | -| [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | このインテグレーションガイドでは、UID2 を Google Ad Manager のセキュアシグナル機能(旧称: Encrypted Signals for Publishers、ESP) で使用するパブリッシャーに必要な追加手順について説明します。 | +| [UID2 integration overview for Prebid](integration-prebid.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js または Prebid Mobile SDK から渡される UID2 Token (Advertising Token) を生成したいパブリッシャー向けのインテグレーションオプションの概要です。 | | +| [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) | UID2 とインテグレーションし、トークンの生成とトークンの自動更新を Prebid.js に管理させ、トークンを RTB ビッドストリームに渡したいパブリッシャー向けのインテグレーションガイドです。このガイドは、Client-Side で UID2 Token をリクエストしたいパブリッシャー向けのもので、最も簡単な実装方法です。 | +| [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid から渡される ID トークンを生成したいパブリッシャー向けのインテグレーションガイドです。このガイドは、Private Operator を使用しているか、Server-Side でトークンを生成したいパブリッシャー向けです。 | +| [UID2 integration overview for JavaScript](integration-javascript.md) | JavaScript SDK を使って UID2 とインテグレーションしたいパブリッシャー向けのオプションの概要です。 | +| [Client-side integration guide for JavaScript](integration-javascript-client-side.md) | 最も簡単な実装方法で、Client-Side の JavaScript の変更だけで UID2 とインテグレーションしたいパブリッシャー向けのインテグレーションガイドです。SDK for JavaScript は、トークンの生成と更新を自動的に管理します。 | +| [Client-server integration guide for JavaScript](integration-javascript-client-server.md) | パブリッシャー向けのこのインテグレーションガイドでは、SDK for JavaScript を使用する標準的なウェブインテグレーションシナリオについて説明し、トークンを Server-Side で生成し、パブリッシャーのウェブページに渡す必要があります。 | +| [Publisher integration guide, server-side](integration-publisher-server-side.md) | このインテグレーションガイドは、[SDK for JavaScript](../sdks/sdk-ref-javascript.md) を使用していないパブリッシャー向けです。 | +| [Google Ad Manager Secure Signals integration guide](integration-google-ss.md) | このインテグレーションガイドでは、UID2 を Google Ad Manager のセキュアシグナル機能(旧称: Encrypted Signals for Publishers、ESP) で使用するパブリッシャーに必要な追加手順について説明します。 | -### Mobile Integrations +### Mobile integrations Android または iOS デバイスとインテグレーションするパブリッシャーは、以下のドキュメントリソースを利用できます。 | Integration Guide | Content Description | | :--- | :--- | -| [Mobile Integration Overview for Android and iOS](integration-mobile-overview.md) | SDK for Android または SDK for iOS を使用して UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けのオプションの概要です。 | -| [Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) | モバイルアプリ内のみの変更で UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けのインテグレーションガイドです (Server-Side の変更はありません)。 | -| [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) | UID2 とインテグレーションしたいモバイルアプリのパブリッシャー向けのインテグレーションガイドです:
  1. UID2 Token を Server-Side で生成するには、Public または Private Operator を使用します。
  2. その結果、identities をモバイルアプリに渡し、ビッドストリームに渡します。
| -| [Server-Side Integration Guide for Mobile](../guides/integration-mobile-server-side.md) | モバイルアプリのパブリッシャーで、UID2 Token を完全に Server-Side で管理したい場合のインテグレーションガイドです。 | +| [Mobile integration overview for Android and iOS](integration-mobile-overview.md) | SDK for Android または SDK for iOS を使用して UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けのオプションの概要です。 | +| [Client-side integration guide for mobile](integration-mobile-client-side.md) | モバイルアプリ内のみの変更で UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けのインテグレーションガイドです (Server-Side の変更はありません)。 | +| [Client-server integration guide for mobile](integration-mobile-client-server.md) | UID2 とインテグレーションしたいモバイルアプリのパブリッシャー向けのインテグレーションガイドです:
  1. UID2 Token を Server-Side で生成するには、Public または Private Operator を使用します。
  2. その結果、identities をモバイルアプリに渡し、ビッドストリームに渡します。
| +| [Server-side integration guide for mobile](../guides/integration-mobile-server-side.md) | モバイルアプリのパブリッシャーで、UID2 Token を完全に Server-Side で管理したい場合のインテグレーションガイドです。 | -### CTV Integrations +### CTV integrations CTV とインテグレーションするパブリッシャー向けには、以下のドキュメントリソースが利用できます。 | Integration Guide | Content Description | | :--- | :--- | -| [CTV Integration Guide](integration-ctv-guide.md) | CTV インテグレーションオプションの概要と、追加情報および手順へのリンク。 | +| [CTV integration guide](integration-ctv-guide.md) | CTV インテグレーションオプションの概要と、追加情報および手順へのリンク。 | -### Prebid Integrations +### Prebid integrations パブリッシャーの Prebid インテグレーションには以下のリソースがあります。 | Integration Guide | Content Description | | :--- | :--- | -| [UID2 Integration Overview for Prebid](integration-prebid.md) | UID2 とインテグレーションし、Prebid.js または Prebid Mobile SDK が RTB ビッドストリームで発行する UID2 Token を生成したいパブリッシャー向けのオプションの概要です。 | -| [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | UID2 とインテグレーションし、トークンの生成とトークンの自動更新を Prebid.js に管理させ、トークンを RTB ビッドストリームに渡したいパブリッシャー向けのインテグレーションガイドです。このガイドは、Client-Side で UID2 Token をリクエストしたいパブリッシャー向けのもので、最も簡単な実装方法です。 | -| [UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid から渡される ID トークンを生成したいパブリッシャー向けのインテグレーションガイドです。このガイドは、Private Operator を使用しているパブリッシャー、または Server-Side でトークンを生成したいパブリッシャー向けです。 | -| [UID2 Mobile Integration for Prebid.js](integration-prebid-mobile-summary.md) | モバイルデバイス上の Prebid.js と UID2 のインテグレーションに関する情報リソースのまとめです。 | +| [UID2 integration overview for Prebid](integration-prebid.md) | UID2 とインテグレーションし、Prebid.js または Prebid Mobile SDK が RTB ビッドストリームで発行する UID2 Token を生成したいパブリッシャー向けのオプションの概要です。 | +| [UID2 client-side integration guide for Prebid.js](integration-prebid-client-side.md) | UID2 とインテグレーションし、トークンの生成とトークンの自動更新を Prebid.js に管理させ、トークンを RTB ビッドストリームに渡したいパブリッシャー向けのインテグレーションガイドです。このガイドは、Client-Side で UID2 Token をリクエストしたいパブリッシャー向けのもので、最も簡単な実装方法です。 | +| [UID2 client-server integration guide for Prebid.js](integration-prebid-client-server.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid から渡される ID トークンを生成したいパブリッシャー向けのインテグレーションガイドです。このガイドは、Private Operator を使用しているパブリッシャー、または Server-Side でトークンを生成したいパブリッシャー向けです。 | +| [UID2 mobile integration for Prebid.js](integration-prebid-mobile-summary.md) | モバイルデバイス上の Prebid.js と UID2 のインテグレーションに関する情報リソースのまとめです。 | -### Google Ad Manager Integrations +### Google Ad Manager integrations Google Ad Manager とインテグレーションするパブリッシャーは、以下のリソースを利用できます。 | Integration Guide | Content Description | | :--- | :--- | -| [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | このインテグレーションガイドは、UID2 を Google Ad Manager の**Secure Signals**機能 (旧称: encrypted signals from publishers、ESP) で使用するパブリッシャーに必要な追加ステップをカバーしています。 | -| [UID2 GMA Plugin for Android Integration Guide](mobile-plugin-gma-android.md) | UID2 Google Mobile Ads (GMA) Plugin for Android は、[Google GMA SDK](https://developers.google.com/ad-manager/mobile-ads-sdk) を使用するパブリッシャーが、Android アプリからの広告リクエストで UID2 Token を [secure signals](https://support.google.com/admob/answer/11556288) として送信できるようにします。 | -| [UID2 GMA Plugin for iOS Integration Guide](mobile-plugin-gma-ios.md) | UID2 Google Mobile Ads (GMA) Plugin for iOS は、[Google GMA SDK](https://developers.google.com/ad-manager/mobile-ads-sdk) を使用するパブリッシャーが、iOS アプリからの広告リクエストで UID2 Token を [secure signals](https://support.google.com/admob/answer/11556288) として送信できるようにします。 | -| [UID2 IMA Plugin for Android Integration Guide](mobile-plugin-ima-android.md) | 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 IMA Plugin for iOS Integration Guide](mobile-plugin-ima-ios.md) | 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) として送信できるようにします。 | +| [Google Ad Manager Secure Signals integration guide](integration-google-ss.md) | このインテグレーションガイドは、UID2 を Google Ad Manager の**Secure Signals**機能 (旧称: encrypted signals from publishers、ESP) で使用するパブリッシャーに必要な追加ステップをカバーしています。 | +| [UID2 GMA plugin for Android integration guide](mobile-plugin-gma-android.md) | UID2 Google Mobile Ads (GMA) Plugin for Android は、[Google GMA SDK](https://developers.google.com/ad-manager/mobile-ads-sdk) を使用するパブリッシャーが、Android アプリからの広告リクエストで UID2 Token を [secure signals](https://support.google.com/admob/answer/11556288) として送信できるようにします。 | +| [UID2 GMA plugin for iOS integration guide](mobile-plugin-gma-ios.md) | UID2 Google Mobile Ads (GMA) Plugin for iOS は、[Google GMA SDK](https://developers.google.com/ad-manager/mobile-ads-sdk) を使用するパブリッシャーが、iOS アプリからの広告リクエストで UID2 Token を [secure signals](https://support.google.com/admob/answer/11556288) として送信できるようにします。 | +| [UID2 IMA plugin for Android integration guide](mobile-plugin-ima-android.md) | 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 IMA plugin for iOS integration guide](mobile-plugin-ima-ios.md) | 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) として送信できるようにします。 | -## Advertiser/Data Provider Integrations +## Advertiser/data provider integrations UID2 とインテグレーションする広告主やデータプロバイダーは、以下のドキュメントリソースを利用できます。 | Integration Guide | Content Description | | :--- | :--- | -| [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 を生成する手順です。 | -| [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 を使用したい広告主やデータプロバイダー向けのガイドです。 | +| [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 を生成する手順です。 | +| [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 を使用したい広告主やデータプロバイダー向けのガイドです。 | -## DSP Integrations +## DSP integrations UID2 とインテグレーションする DSP は、以下のドキュメントリソースを利用できます。 | Integration Guide | Content Description | | :--- | :--- | -| [DSP Integration Guide](dsp-guide.md) | この DSP 向けのインテグレーションガイドでは、入札およびユーザーオプトアウトの処理に関する UID2 の取り扱いについて説明しています。 | -| [DSP Direct Integration Instructions](integration-dsp-no-sdk.md) | SDK を使用せずにインテグレーションを希望する DSP 向けの手順です。 | +| [DSP integration guide](dsp-guide.md) | この DSP 向けのインテグレーションガイドでは、入札およびユーザーオプトアウトの処理に関する UID2 の取り扱いについて説明しています。 | +| [DSP direct integration instructions](integration-dsp-no-sdk.md) | SDK を使用せずにインテグレーションを希望する DSP 向けの手順です。 | -## Private Operator Service Integrations +## Private Operator service integrations Private Operator のインテグレーションは、以下のリソースを利用できます。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/intro.md b/i18n/ja/docusaurus-plugin-content-docs/current/intro.md index 0c991327e..051724d0e 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/intro.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/intro.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Unified ID 2.0 Overview +# Unified ID 2.0 overview UID2 は、広告エコシステム全体の多くの [参加者](overviews/participants-overview.md#uid2-external-participants) が、オープンインターネット上の広告機会に対して決定論的なアイデンティティを利用できるようにするフレームワークです。UID2 フレームワークにより、パブリッシャーのウェブサイト、モバイルアプリ、Connected TV (CTV) アプリは、プログラマティックなワークフローを通じて収益化が可能になります。独自の名前空間を持つオープンソースのスタンドアローンソリューションとして構築されたこのフレームワークは、参加者が各地の市場要件を満たすのに役立つよう設計されたプライバシー管理機能を提供します。 @@ -16,7 +16,7 @@ UID2 は、広告エコシステム全体の多くの [参加者](overviews/part 「UID2」という用語は、フレームワークまたは実際の識別子のいずれかを指す場合があります。特に断りのない限り、このページでは UID2 フレームワークの概要を説明します。 ::: -## Guiding Principles +## Guiding principles UID2 フレームワークは、以下の原則を基盤としています。 @@ -24,7 +24,7 @@ UID2 フレームワークは、以下の原則を基盤としています。 - **Non-proprietary (universal) standard**: 適切な参加契約を締結した広告エコシステム内のすべての [参加者](overviews/participants-overview.md#uid2-external-participants) が、UID2 にアクセスできます。 -- **Open source**: [UID2 Component Services](overviews/participants-overview.md#uid2-component-services) のソースコードは一般公開されています。 +- **Open source**: [UID2 component services](overviews/participants-overview.md#uid2-component-services) のソースコードは一般公開されています。 - **Interoperable**: このフレームワークは、他の ID ソリューション (商用および独自仕様) が連携し、その提供物 (オファリング) と共に UID2 Token を提供することを可能にします。 @@ -32,7 +32,7 @@ UID2 フレームワークは、以下の原則を基盤としています。 - **Consumer control**: 消費者は、[Transparency and Control Portal](https://www.transparentadvertising.com/) を通じて、いつでも UID2 からオプトアウトできます。 -## Technical Design Principles +## Technical design principles UID2 フレームワークは、以下の技術的原則に基づいて構築されています。 @@ -46,18 +46,18 @@ UID2 フレームワークは、以下の技術的原則に基づいて構築さ - **Self-reliant**: UID2 は、リアルタイムビディング (RTB) データの処理において、外部サービスに依存しません。 -## Elements of the UID2 Infrastructure +## Elements of the UID2 infrastructure UID2 インフラストラクチャの主要な要素や、UID2 のその他の側面については、以下のページを参照してください。 -- [UID2 Identifier Types](ref-info/uid-identifier-types.md) -- [UID2 Components](ref-info/uid-components.md) -- [UID2 Participants](overviews/participants-overview.md) +- [UID2 identifier types](ref-info/uid-identifier-types.md) +- [UID2 components](ref-info/uid-components.md) +- [UID2 participants](overviews/participants-overview.md) - [Workflows](ref-info/uid-workflows.md) ## FAQs -[Frequently Asked Questions](getting-started/gs-faqs.md) を参照してください。 +[Frequently asked questions](getting-started/gs-faqs.md) を参照してください。 ## License すべての成果物およびアーティファクトは、[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt) の下でライセンスされています。 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 175d72a71..384e33fb1 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 @@ -21,10 +21,10 @@ import Link from '@docusaurus/Link'; UID2 を採用する広告主のためのメリット、ワークフロー、ドキュメント、およびその他のリソースと、開始するための手順について説明します。 :::note -左側のサイドバーで UID2 ドキュメントの全セットにアクセスしたい場合は、[Unified ID 2.0 Overview](../intro.md) を参照してください。 +左側のサイドバーで UID2 ドキュメントの全セットにアクセスしたい場合は、[Unified ID 2.0 overview](../intro.md) を参照してください。 ::: -## Benefits of UID2 for Advertisers +## Benefits of UID2 for advertisers 広告戦略の一環として UID2 を使用することで得られるメリットの一部を次に示します。 - メディアバイイングプラットフォームで、プライバシーを意識した形式の CRM データを使用できます。 @@ -34,7 +34,7 @@ UID2 を採用する広告主のためのメリット、ワークフロー、ド - キャンペーンをより包括的にターゲティングし、測定できます。 - 消費者のプライバシー管理を向上させることを目的とした、オプトアウトを提供します。 -## Workflow for Advertisers +## Workflow for advertisers 以下の手順は、ユーザーデータを収集し、DSP にプッシュする組織（広告主、ID グラフプロバイダー、サードパーティデータプロバイダーなど）を対象としたワークフローの概要です。 @@ -49,38 +49,38 @@ UID2 を採用する広告主のためのメリット、ワークフロー、ド Server-Side: 広告主は、UID2 とリフレッシュタイムスタンプをマッピングテーブル、DMP、データレイク、またはその他のサーバーサイドアプリケーションに保存します。 -![Data Provider Workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg) +![Data provider workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg) -## Getting Started +## Getting started 開始するには、以下の手順に従ってください: -1. [Request Access](/request-access) ページのフォームに記入して、UID2 へのアクセスをリクエストします。 +1. [Request access](/request-access) ページのフォームに記入して、UID2 へのアクセスをリクエストします。 担当者がニーズについて話し合い、適切な次のステップをアドバイスするために連絡します。 1. [参加者 (participant)](participants-overview.md#uid2-external-participants) としての役割を決定します。 1. どの実装オプションを使用するかを決定します。 -1. 認証情報 ([UID2 Credentials](../getting-started/gs-credentials.md) を参照) を受け取り、選択したオプションの実装ガイドの指示に従います。 +1. 認証情報 ([UID2 credentials](../getting-started/gs-credentials.md) を参照) を受け取り、選択したオプションの実装ガイドの指示に従います。 :::note - UID2 へのリクエストメッセージは必ず暗号化してください。詳細は [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 + UID2 へのリクエストメッセージは必ず暗号化してください。詳細は [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: 1. テストします。 1. 本番稼働します。 -## Implementation Resources +## Implementation resources UID2 を実装する広告主およびデータプロバイダー向けに、以下のドキュメントリソースが用意されています。 | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| ユーザーデータを収集し、他の 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 を生成する手順について説明します。 | -| 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) を生成する手順について説明します。 | +| ユーザーデータを収集し、他の 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 を生成する手順について説明します。 | +| 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) を生成する手順について説明します。 | -## FAQs for Advertisers +## FAQs for advertisers -UID2 フレームワークを使用する広告主向けのよくある質問のリストについては、[FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) を参照してください。 +UID2 フレームワークを使用する広告主向けのよくある質問のリストについては、[FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) を参照してください。 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 920340712..ca282ef9c 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 @@ -27,10 +27,10 @@ import Link from '@docusaurus/Link'; UID2 を採用するデータプロバイダーのためのメリット、ワークフロー、ドキュメント、およびその他のリソースと、開始するための手順について説明します。 :::note -左側のサイドバーで UID2 ドキュメントの全セットにアクセスしたい場合は、[Unified ID 2.0 Overview](../intro.md) を参照してください。 +左側のサイドバーで UID2 ドキュメントの全セットにアクセスしたい場合は、[Unified ID 2.0 overview](../intro.md) を参照してください。 ::: -## Benefits of UID2 for Data Providers +## Benefits of UID2 for data providers データプロバイダーとして UID2 を使用することで得られるメリットの一部を次に示します。 - 消費者のプライバシー管理のためのオプトアウトを提供する、よりプライバシーを意識した識別子にアップグレードできます。 @@ -39,7 +39,7 @@ UID2 を採用するデータプロバイダーのためのメリット、ワー - オンラインデータとオフラインデータを共通の ID で接続し、より高い精度を目指せます。 - サードパーティクッキーの有無にかかわらず、キャンペーンをより正確に測定できます。 -## Workflow for Data Providers +## Workflow for data providers 以下の手順は、ユーザーデータを収集し、DSP にプッシュする組織（広告主、ID グラフプロバイダー、サードパーティデータプロバイダーなど）を対象としたワークフローの概要です。 @@ -54,38 +54,38 @@ UID2 を採用するデータプロバイダーのためのメリット、ワー Server-Side: データプロバイダーは、UID2 とリフレッシュタイムスタンプをマッピングテーブル、DMP、データレイク、またはその他のサーバーサイドアプリケーションに保存します。 -![Data Provider Workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg) +![Data provider workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg) -## Getting Started +## Getting started 開始するには、以下の手順に従ってください: -1. [Request Access](/request-access) ページのフォームに記入して、UID2 へのアクセスをリクエストします。 +1. [Request access](/request-access) ページのフォームに記入して、UID2 へのアクセスをリクエストします。 担当者がニーズについて話し合い、適切な次のステップをアドバイスするために連絡します。 1. [参加者 (participant)](participants-overview.md#uid2-external-participants) としての役割を決定します。 1. どの実装オプションを使用するかを決定します。 -1. 認証情報 ([UID2 Credentials](../getting-started/gs-credentials.md) を参照) を受け取り、選択したオプションの実装ガイドの指示に従います。 +1. 認証情報 ([UID2 credentials](../getting-started/gs-credentials.md) を参照) を受け取り、選択したオプションの実装ガイドの指示に従います。 :::note - UID2 へのリクエストメッセージは必ず暗号化してください。詳細は [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 + UID2 へのリクエストメッセージは必ず暗号化してください。詳細は [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: 1. テストします。 1. 本番稼働します。 -## Implementation Resources +## Implementation resources UID2 を実装する広告主およびデータプロバイダー向けに、以下のドキュメントリソースが用意されています。 | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| ユーザーデータを収集し、他の 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 を生成する手順について説明します。 | -| 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) を生成する手順について説明します。 | +| ユーザーデータを収集し、他の 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 を生成する手順について説明します。 | +| 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) を生成する手順について説明します。 | -## FAQs for Data Providers +## FAQs for data providers -UID2 フレームワークを使用するデータプロバイダー向けのよくある質問のリストについては、[FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) を参照してください。 +UID2 フレームワークを使用するデータプロバイダー向けのよくある質問のリストについては、[FAQs for advertisers and data providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-dsps.md b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-dsps.md index b176e2446..119a8415d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-dsps.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-dsps.md @@ -24,7 +24,7 @@ import Link from '@docusaurus/Link'; UID2 を採用する DSP のためのメリット、ワークフロー、ドキュメント、およびその他のリソースと、開始するための手順について説明します。 :::note -左側のサイドバーで UID2 ドキュメントの全セットにアクセスしたい場合は、[Unified ID 2.0 Overview](../intro.md) を参照してください。 +左側のサイドバーで UID2 ドキュメントの全セットにアクセスしたい場合は、[Unified ID 2.0 overview](../intro.md) を参照してください。 ::: ## Benefits of UID2 for DSPs @@ -58,40 +58,40 @@ UID2 を使用する DSP のメリットの一部を次に示します。以下 - raw UID2 をオーディエンスセグメントにマッチさせます。 4. DSP は UID2 Token を付加したビッドレスポンス (入札レスポンス) をビッドストリームに送信します。 -![Buy-Side Workflow](images/UID2BuySIdeDSPWorkflow.jpg) +![Buy-side workflow](images/UID2BuySIdeDSPWorkflow.jpg) -## Getting Started +## Getting started 開始するには、以下の手順に従ってください: -1. [Request Access](/request-access) ページのフォームに記入して、UID2 へのアクセスをリクエストします。 +1. [Request access](/request-access) ページのフォームに記入して、UID2 へのアクセスをリクエストします。 2. UID2 のオプトアウト情報を受け取るための Webhook を実装し、Webhook を UID2 administrator と共有します。 3. Webhook 経由でオプトアウトフィードを受信していることを確認します。 - Webhook が設置されたら、認証情報を受け取ります ([UID2 Credentials](../getting-started/gs-credentials.md) を参照)。 + Webhook が設置されたら、認証情報を受け取ります ([UID2 credentials](../getting-started/gs-credentials.md) を参照)。 4. どの実装オプションを使用するかを決定します。 5. SDK を使用している場合は、SDK をダウンロードします。該当する SDK のガイドを参照してください。 6. 選択したオプションの実装ガイドに記載されている手順に従います。 :::note - UID2 へのリクエストメッセージは必ず暗号化してください。詳細は [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 + UID2 へのリクエストメッセージは必ず暗号化してください。詳細は [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: -7. (条件付き) CRM オンボーディングソリューションを実装する場合は、データプロバイダーワークフローのための別の認証情報セットをリクエストします。[UID2 Credentials](../getting-started/gs-credentials.md) を参照してください。 +7. (条件付き) CRM オンボーディングソリューションを実装する場合は、データプロバイダーワークフローのための別の認証情報セットをリクエストします。[UID2 credentials](../getting-started/gs-credentials.md) を参照してください。 8. テストします。 9. 本番稼働します。 -## Implementation Resources +## Implementation resources UID2 を実装する DSP 向けに、以下のドキュメントリソースが用意されています。 | Type| Documentation | Content Description | | :--- | :--- | :--- | -|SDK for Java | [SDK for Java Reference Guide](../sdks/sdk-ref-java.md) | Java Server-Side を使用し、UID2 Advertising Token を復号化して raw UID2 にアクセスしたい利用者のための SDK。| -|SDK for Python | [SDK for Python Reference Guide](../sdks/sdk-ref-python.md) | Python Server-Side を使用し、UID2 Advertising Token を復号化して raw UID2 にアクセスしたい利用者のための SDK。| -|SDK for C# / .NET | [SDK for C# / .NET Reference Guide](../sdks/sdk-ref-csharp-dotnet.md) | .NET Server-Side を使用し、UID2 Advertising Token を復号化して raw UID2 にアクセスしたい利用者のための SDK。| -|SDK for C++ | [SDK for C++ Reference Guide](../sdks/sdk-ref-cplusplus.md) | C++ Server-Side を使用し、UID2 Advertising Token を復号化して raw UID2 にアクセスしたい利用者のための SDK。| -| Integration Guide | [DSP Integration Guide](../guides/dsp-guide.md) | DSP 向けのこのインテグレーションガイドでは、入札のための UID2 の取り扱いと、ユーザーのオプトアウトの受け入れについて説明します。 | -| DSP Direct Integration Instructions | [DSP Direct Integration Tips](../guides/integration-dsp-no-sdk.md) | UID2 SDK のいずれも使用せずにインテグレーションすることを希望する DSP 向けの手順。 | +|SDK for Java | [SDK for Java reference guide](../sdks/sdk-ref-java.md) | Java Server-Side を使用し、UID2 Advertising Token を復号化して raw UID2 にアクセスしたい利用者のための SDK。| +|SDK for Python | [SDK for Python reference guide](../sdks/sdk-ref-python.md) | Python Server-Side を使用し、UID2 Advertising Token を復号化して raw UID2 にアクセスしたい利用者のための SDK。| +|SDK for C# / .NET | [SDK for C# / .NET reference guide](../sdks/sdk-ref-csharp-dotnet.md) | .NET Server-Side を使用し、UID2 Advertising Token を復号化して raw UID2 にアクセスしたい利用者のための SDK。| +|SDK for C++ | [SDK for C++ reference guide](../sdks/sdk-ref-cplusplus.md) | C++ Server-Side を使用し、UID2 Advertising Token を復号化して raw UID2 にアクセスしたい利用者のための SDK。| +| Integration Guide | [DSP integration guide](../guides/dsp-guide.md) | DSP 向けのこのインテグレーションガイドでは、入札のための UID2 の取り扱いと、ユーザーのオプトアウトの受け入れについて説明します。 | +| DSP Direct Integration Instructions | [DSP direct integration tips](../guides/integration-dsp-no-sdk.md) | UID2 SDK のいずれも使用せずにインテグレーションすることを希望する DSP 向けの手順。 | +Optionally, if DSPs want to generate UID2s themselves from DII, they can also follow the [Third-party data provider workflow](overview-data-providers.md#workflow-for-data-providers). --> ## FAQs for DSPs diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-publishers.md b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-publishers.md index c2cb4ffe4..fc3a31ac8 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-publishers.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/overview-publishers.md @@ -24,10 +24,10 @@ import SnptPublisherImplementationResources from '../snippets/_snpt-publisher-im UID2 を採用するパブリッシャーにとってのメリット、ワークフロー、ドキュメント、その他のリソース、および UID2 の導入手順について説明します。 :::note -左側のサイドバーで UID2 ドキュメントの全セットにアクセスしたい場合は、[Unified ID 2.0 Overview](../intro.md) を参照してください。 +左側のサイドバーで UID2 ドキュメントの全セットにアクセスしたい場合は、[Unified ID 2.0 overview](../intro.md) を参照してください。 ::: -## Benefits of UID2 for Publishers +## Benefits of UID2 for publishers UID2 とインテグレーションすることで得られるメリットの一部を次に示します: - デスクトップ、モバイル、CTV で、単一の識別子でアドレサブルなオーディエンスターゲティング。 @@ -36,7 +36,7 @@ UID2 とインテグレーションすることで得られるメリットの一 - 関連するコンテンツでパーソナライズされた広告体験を提供する機能。 - 消費者のプライバシー管理を向上させることを目的とした、オプトアウトを提供する機能。 -## Workflow for Publishers +## Workflow for publishers 以下の手順は、ID プロバイダー、パブリッシャー、SSO プロバイダーなど、SSP を介して UID2 Token をビッドストリームに伝播する組織を想定したワークフローの概要です。パブリッシャーは、UID2 と相互運用可能で、パブリッシャーに代わって UID2 インテグレーションを処理できる SSO プロバイダーまたは独立した ID プロバイダーと連携することを選択できます。 @@ -66,32 +66,32 @@ UID2 とインテグレーションすることで得られるメリットの一 -![Publisher Workflow](images/UID2PublisherAndSSPWorkflow.jpg) +![Publisher workflow](images/UID2PublisherAndSSPWorkflow.jpg) -## Integrating with Single Sign-On (SSO) +## Integrating with single sign-on (SSO) -## Private Operator Option +## Private Operator option -## Getting Started +## Getting started 開始するには、以下の手順に従ってください: -1. [Request Access](/request-access) ページのフォームに記入して、UID2 へのアクセスをリクエストします。 +1. [Request access](/request-access) ページのフォームに記入して、UID2 へのアクセスをリクエストします。 1. UID2 とインテグレーションしたいプロパティを特定します。 1. UID2 契約を締結します。 1. client-side、client-server、server-side いずれのインテグレーションを行うか決定し、UID2 の担当者に伝えてください。 - これらのオプションについての詳細は、[Integration Approaches](../ref-info/ref-integration-approaches.md) を参照してください。 + これらのオプションについての詳細は、[Integration approaches](../ref-info/ref-integration-approaches.md) を参照してください。 1. [UID2 credentials](../getting-started/gs-credentials.md) (認証情報) を受け取ります。 1. 該当する [implementation resources](#implementation-resources) を使用して、SDK または UID2 API と直接インテグレーションしてください。 :::note - UID2 へのリクエストメッセージは必ず暗号化してください。詳細は [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。 + UID2 へのリクエストメッセージは必ず暗号化してください。詳細は [Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。 ::: 1. テスト: @@ -100,10 +100,10 @@ UID2 とインテグレーションすることで得られるメリットの一 - 必要に応じてトラブルシューティングを行い、ビッドリクエストで UID2 Token が正しく渡されるように SSP と協力します。 1. 本番稼動します。 -## Implementation Resources +## Implementation resources -## FAQs for Publishers +## FAQs for publishers -UID2 フレームワークを使用するパブリッシャー向けのよくある質問のリストは、[FAQs for Publishers](../getting-started/gs-faqs.md#faqs-for-publishers) を参照してください。 +UID2 フレームワークを使用するパブリッシャー向けのよくある質問のリストは、[FAQs for publishers](../getting-started/gs-faqs.md#faqs-for-publishers) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/participants-overview.md b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/participants-overview.md index 5a1c2a6c4..6f61a5095 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/overviews/participants-overview.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/overviews/participants-overview.md @@ -8,28 +8,28 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Overview of UID2 Participants +# Overview of UID2 participants 透明性と相互運用可能なアプローチにより、UID2 は広告エコシステム全体の多くの参加者（広告主、パブリッシャー、DSP、SSP、シングルサインオン (SSO) プロバイダー、カスタマーデータプラットフォーム (CDP)、同意管理プロバイダー (CMP)、ID プロバイダー、サードパーティデータプロバイダー、測定プロバイダー）に協調的なフレームワークを提供します。 以下の表は、[UID2 ワークフロー](../ref-info/uid-workflows.md) における主要な参加者とその役割の一覧です。これらは次の 3 つのカテゴリに分類されます: -- [UID2 Component Services](#uid2-component-services) -- [UID2 External Participants](#uid2-external-participants) -- [UID2 Consumers](#uid2-consumers) +- [UID2 component services](#uid2-component-services) +- [UID2 external participants](#uid2-external-participants) +- [UID2 consumers](#uid2-consumers) -## UID2 Component Services +## UID2 component services 以下の表は、UID2 Service の主要な参加者コンポーネントに関する情報の要約です。 -さまざまなサービスがどのように連携して機能するかの図については、[UID2 Workflows](../ref-info/uid-workflows.md) を参照してください。 +さまざまなサービスがどのように連携して機能するかの図については、[UID2 workflows](../ref-info/uid-workflows.md) を参照してください。 | Participant | Role Description | | :--- | :--- | | **Core Administrator** | UID2 Core Service およびその他のコンポーネントサービスを管理する組織（現在は The Trade Desk）。たとえば、暗号化キーとソルトを UID2 Operator に配布し、ユーザーオプトアウト要求を Operator と DSP に送信します。 | | **Operators** | (UID2 API 経由で) Operator Service を実行する組織。Operator は定期的に UID2 Core Service から最新の暗号化キーとソルトを受信して保存し、DII (directly identifying information) をソルト化およびハッシュ化して raw UID2 を返し、raw UID2 を暗号化して UID2 Token を生成し、UID2 Token 復号化キーを配布します。
Public Operator (Open Operator) は、Operator Service のパブリックインスタンスを実行します。例えば、The Trade Desk は現在、UID2 フレームワークの Public Operator として機能しており、すべての参加者が利用できます。他の Public Operator が利用可能な場合、参加者は連携する Operator を選択できます。
任意の参加者は、UID2 を生成および管理するために Private Operator になることも選択できます。 | -## UID2 External Participants +## UID2 external participants 以下の表は、UID2 の外部参加者パートナーの主なタイプの要約です。各参加者タイプの詳細については、概要ページへのリンクを参照してください。 @@ -38,9 +38,9 @@ import Link from '@docusaurus/Link'; | [Publishers](overview-publishers.md) | SSP を介して UID2 Token をビッドストリームに伝播する組織—たとえば、ID プロバイダー、パブリッシャー、SSO プロバイダーなど。パブリッシャーは、SSO プロバイダーまたは UID2 と相互運用可能な独立した ID プロバイダーと連携することを選択できます。独立した ID プロバイダーは、パブリッシャーに代わって UID2 インテグレーションを処理できます。 | | [Advertisers](overview-advertisers.md) | さまざまなパブリッシャーサイトでインプレッションを購入し、DSP を使用して購入する広告インプレッションとその入札額を決定する組織。 | | [DSPs](overview-dsps.md) | DSP は UID2 システムと連携 (integrate) し、広告主（ファーストパーティデータとして）およびサードパーティデータプロバイダー（サードパーティデータとして）から UID2 を受信し、それらを活用してビッドストリーム内の UID2 に対する入札 (bidding) を通知します。 | -| [Data Providers](overview-data-providers.md) | ユーザーデータを収集し、他の UID2 参加者にプッシュする組織—たとえば、広告主、ID グラフプロバイダー、サードパーティデータプロバイダーなど。 | +| [Data providers](overview-data-providers.md) | ユーザーデータを収集し、他の UID2 参加者にプッシュする組織—たとえば、広告主、ID グラフプロバイダー、サードパーティデータプロバイダーなど。 | -## UID2 Consumers +## UID2 consumers UID2 消費者 (consumer) とは、メールアドレスまたは電話番号から UID2 Token または raw UID2 を作成されたユーザーのことです。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/portal/api-keys.md b/i18n/ja/docusaurus-plugin-content-docs/current/portal/api-keys.md index 764f58022..c0eb9d0c0 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/portal/api-keys.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/portal/api-keys.md @@ -8,25 +8,25 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# API Keys +# API keys :::note -これらは、Client-Server または Server-Side の実装についての手順です。UID2 の実装が Client-Side であるか、一般に公開される場合は、異なる値を設定する必要があります。詳細は、[Client-Side Integration](client-side-integration.md) を参照してください。 +これらは、Client-Server または Server-Side の実装についての手順です。UID2 の実装が Client-Side であるか、一般に公開される場合は、異なる値を設定する必要があります。詳細は、[Client-side integration](client-side-integration.md) を参照してください。 ::: UID2 Portal の **API Keys** ページでは、UID2 アカウントの API Key を管理するためのすべての操作を実行できます: -- [Adding an API Key](#adding-an-api-key) -- [Modifying an API Key](#modifying-an-api-key) -- [Deleting an API Key](#deleting-an-api-key) -- [Rotating an API Key](#rotating-an-api-key) +- [Adding an API key](#adding-an-api-key) +- [Modifying an API key](#modifying-an-api-key) +- [Deleting an API key](#deleting-an-api-key) +- [Rotating an API key](#rotating-an-api-key) ## Overview API Key と Client Secret を使用すると、UID2 Operator Service に接続して、直接または UID2 SDK を介して API エンドポイントを呼び出すことができます。これらの値は、サービスに対してあなたを識別します。 :::important -UID2 Portal で API Key を追加するときは、キーとそれに対応するシークレットを安全に保存し、これらの値が漏洩しないようにするために必要な措置をすべて講じる必要があります。詳細は、[API Key と Client Secret](../getting-started/gs-credentials.md#api-key-and-client-secret) を参照してください。 +UID2 Portal で API Key を追加するときは、キーとそれに対応するシークレットを安全に保存し、これらの値が漏洩しないようにするために必要な措置をすべて講じる必要があります。詳細は、[API key と client secret](../getting-started/gs-credentials.md#api-key-and-client-secret) を参照してください。 ::: 各 API Key は、1 年ごとにローテーションすることを推奨します。 @@ -38,9 +38,9 @@ API Key を追加するときには、次のいずれかの権限を割り当て - Sharer - Bidder -詳細は [API Permissions](../getting-started/gs-permissions.md) を参照してください。 +詳細は [API permissions](../getting-started/gs-permissions.md) を参照してください。 -## Adding an API Key +## Adding an API key API Key を追加するには、次の手順を実行します: @@ -49,7 +49,7 @@ API Key を追加するには、次の手順を実行します: 1. **Add API Key** ページで、新しいキーの名前を指定します。 1. API Permissions セクションで、キーに割り当てる権限を 1 つ以上選択します。 - 必要な権限のみを選択してください。たとえば、パブリッシャーの場合は Generator ロールを選択します。詳細は [API Permissions](../getting-started/gs-permissions.md) を参照してください。 + 必要な権限のみを選択してください。たとえば、パブリッシャーの場合は Generator ロールを選択します。詳細は [API permissions](../getting-started/gs-permissions.md) を参照してください。 :::note 選択可能な権限が表示されない場合は、UID2 の担当者に問い合わせてください。 @@ -69,7 +69,7 @@ API Key を追加するには、次の手順を実行します: **API Keys** ページには、新しいキーが名前、キー ID、権限、および作成日付とともに表示されます。 -## Modifying an API Key +## Modifying an API key API Key を追加した後は、次の情報を編集できます: @@ -83,7 +83,7 @@ API Key を変更するには、次の手順を実行します: 1. アクション列で ![the Edit icon](images/icon-pencil-solid.png) (Edit アイコン) をクリックします。 1. 情報を更新し、**Save Key** をクリックします。 -## Deleting an API Key +## Deleting an API key キーが漏洩した場合、そのキーを削除する必要があります。 @@ -100,22 +100,22 @@ API Key を削除するには、次の手順を実行します: キーは表示から削除され、無効になります。 -## Rotating an API Key +## Rotating an API key API Key をローテーションすることを推奨します。API Key をローテーションするには、次の手順を実行します: 1. UID2 Portal で **API Keys** ページに移動します。 1. リストでローテーションするキーを見つけます。 -1. ローテーションするキーと同じ権限を持つ新しいキーを追加します。詳細は [Adding an API Key](#adding-an-api-key) を参照してください。 +1. ローテーションするキーと同じ権限を持つ新しいキーを追加します。詳細は [Adding an API key](#adding-an-api-key) を参照してください。 1. UID2 の実装を更新して、ローテーションするキーの代わりに新しいキーを使用するようにします。 1. 新しいキーが問題なく使用されていることを確認します。たとえば、サービスに対する劣化や API Key の使用に関連するエラーログがないことを確認します。 -1. 古いキーを削除します。詳細は [Deleting an API Key](#deleting-an-api-key) を参照してください。 +1. 古いキーを削除します。詳細は [Deleting an API key](#deleting-an-api-key) を参照してください。 -## Security Recommendations for API Keys +## Security recommendations for API keys セキュリティのベストプラクティスとして、異なる役割に対して異なるキーを持つことが推奨されます。 -追加のセキュリティに関する推奨事項は、[API Key と Client Secret のセキュリティ](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 +追加のセキュリティに関する推奨事項は、[API key と client secret のセキュリティ](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 -## Endpoint Versions +## Endpoint versions -`POST /identity/map` エンドポイントのバージョン 2 は、バージョン 3 に置き換えられました。バージョン 3 では、[Version 3 Improvements](../endpoints/post-identity-map.md#version-3-improvements)で説明されている追加の利点が含まれています。 +`POST /identity/map` エンドポイントのバージョン 2 は、バージョン 3 に置き換えられました。バージョン 3 では、[Version 3 improvements](../endpoints/post-identity-map.md#version-3-improvements)で説明されている追加の利点が含まれています。 `POST /identity/map` エンドポイントのバージョン 3 では、`POST /identity/buckets` エンドポイントは完全に使用されなくなりました。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/glossary-uid.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/glossary-uid.md index 04fc612f8..f9e39d5b9 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/glossary-uid.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/glossary-uid.md @@ -9,7 +9,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import MdxJumpAnchor from '@site/src/components/MdxJumpAnchor'; -# Unified ID 2.0 Glossary +# Unified ID 2.0 glossary

このページでは、UID2 のドキュメントで使用されるいくつかの重要な用語を定義しています。

-## High-Level Steps +## High-level steps シングルサインオンソリューションとインテグレーションする一般的な手順は次のとおりです: @@ -35,31 +35,31 @@ UID2 の作成に使用するメールアドレスが、UID2 契約、会社の メールアドレスに [正規化とエンコード](../getting-started/gs-normalization-encoding.md) を適用する必要があるか、またはインテグレーションで自動的に適用されるかを確認するには、UID2 パブリッシャーインテグレーションのドキュメントを参照してください。 ::: -## Sign In with Google +## Sign in with Google [Sign in with Google](https://support.google.com/accounts/answer/12849458?hl=ja) を実装するための次のオプションが利用可能です: - [Sign in with Google for Android](#sign-in-with-google-for-android) -- [Sign in with Google for iOS and macOS](#sign-in-with-google-for-ios-and-macos) -- [Sign in with Google for Web](#sign-in-with-google-for-web) +- [Sign in with Google for iOS and macos](#sign-in-with-google-for-ios-and-macos) +- [Sign in with Google for web](#sign-in-with-google-for-web) -### Sign In with Google for Android +### Sign in with Google for Android [Create the Sign in with Google flow](https://developer.android.com/identity/sign-in/credential-manager-siwg#create-sign) の手順に従います。トークンが検証された後、アイデンティティトークンのペイロードの [getEmail() メソッド](https://cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload#com_google_api_client_googleapis_auth_oauth2_GoogleIdToken_Payload_getEmail__) を使用してメールアドレスを取得できます。 -### Sign In with Google for iOS and macOS +### Sign in with Google for iOS and macos iOS または macOS で [Sign in with Google](https://developers.google.com/identity/sign-in/ios/start-integrating) からメールアドレスを取得するには、`GIDGoogleUser` オブジェクトから取得します。詳細は、[プロファイル情報の取得](https://developers.google.com/identity/sign-in/ios/people)を参照してください。 -### Sign In with Google for Web +### Sign in with Google for web [verify the Google ID token on your server side](https://developers.google.com/identity/gsi/web/guides/verify-google-id-token) の手順に従い、ID トークンの `email` フィールドからユーザーのメールアドレスを取得します。 -## Facebook Login +## Facebook login UID2 と Facebook Login を組み合わせる方法は、OpenID Connect (OIDC) トークンを使用するか、使用しないかの 2 つの方法があります。 -### Facebook Login Using an OIDC Token on iOS +### Facebook login using an oidc token on iOS iOS で [Facebook Login](https://developers.facebook.com/docs/facebook-login/) から [OIDC token](https://developers.facebook.com/docs/facebook-login/guides/access-tokens/get-oidc/) を使用してメールアドレスを取得するには: @@ -67,7 +67,7 @@ iOS で [Facebook Login](https://developers.facebook.com/docs/facebook-login/) 1. OIDC token からユーザーのメールアドレスを抽出します。たとえば、`Profile` ヘルパークラスを使用して抽出します。詳細は、[OIDC Tokens in Facebook Login for iOS](https://developers.facebook.com/docs/facebook-login/guides/access-tokens/get-oidc) を参照してください。 -### Facebook Login Without an OIDC Token +### Facebook login without an oidc token OIDC token を使用せずに [Facebook Login](https://developers.facebook.com/docs/facebook-login/) からメールアドレスを取得するには: @@ -75,7 +75,7 @@ OIDC token を使用せずに [Facebook Login](https://developers.facebook.com/d 1. ユーザーが `email` パーミッションを許可した場合、ユーザーアクセストークンを使用して、`email` をフィールドとして指定して、[`/me` endpoint](https://developers.facebook.com/docs/graph-api/overview#me) に対して Graph API コールを行います。 -### Sample Applications +### Sample applications 以下のアプリケーションは、Facebook Login とのインテグレーション方法を示しています: @@ -83,21 +83,21 @@ OIDC token を使用せずに [Facebook Login](https://developers.facebook.com/d - [Facebook Login sample application for iOS](https://github.com/facebook/facebook-ios-sdk/tree/main/samples/FacebookLoginSample) -## Sign In with Apple +## Sign in with apple Apple ID でサインインする方法は、アプリとウェブサイトで異なります。 -### Sign In with Apple in an App +### Sign in with apple in an app `email` スコープをリクエストして認証をリクエストします。詳細は、[Request Authorization with Apple ID](https://developer.apple.com/documentation/sign_in_with_apple/implementing_user_authentication_with_sign_in_with_apple#3546458) を参照してください。 承認に成功した場合、`ASAuthorizationAppleIDCredential` オブジェクトの `email` プロパティからユーザーのメールアドレスを取得します。 -### Sign In with Apple JS on a Webpage +### Sign in with apple js on a webpage [Configure your webpage for Sign in with Apple](https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_js/configuring_your_webpage_for_sign_in_with_apple) ページの [Handle the Authorization Response](https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_js/configuring_your_webpage_for_sign_in_with_apple#3331292) を参照してください。 -## Sign In with OpenPass +## Sign in with openpass [OpenPass](https://openpass.thetradedesk.com/en) インテグレーションからメールアドレスを取得するには: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-operators-public-private.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-operators-public-private.md index 96033b3ad..6dbdad646 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-operators-public-private.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-operators-public-private.md @@ -25,16 +25,16 @@ UID2 Operator は、Operator Service を実行する組織です。Operator は - UID2 Token を生成するために raw UID2 を暗号化します。 - UID2 Token の復号鍵を Server-Side SDK に配布します (詳細は [SDKs: Summary](../sdks/summary-sdks.md) を参照)。 - UID2 Opt-Out Service から最新のユーザーオプトアウト情報をダウンロードします。 -- 複数の UID2 エンドポイントをサポートします。詳細は [UID2 Endpoints: Summary](../endpoints/summary-endpoints.md) を参照してください。 +- 複数の UID2 エンドポイントをサポートします。詳細は [UID2 endpoints: Summary](../endpoints/summary-endpoints.md) を参照してください。 UID2 Operator は、次の 2 つのカテゴリに分類されます: -- [Public Operators](#public-operators) +- [Public operators](#public-operators) - [Private Operators](#private-operators) Operator は UID2 の中核的なコードです。このコードは、メールアドレスを raw UID2 または UID2 Token に変換し、共有している参加者が復号キーを更新するために使用します。 -## Public Operators +## Public operators Public Operator は、関連するすべての UID2 参加者が利用できる UID2 Operator インスタンスです。Public Operator は、一般に利用可能な Operator Service のインスタンスを実行し、参加者が利用できるようにします。 @@ -42,13 +42,13 @@ Public Operator は、関連するすべての UID2 参加者が利用できる Public Operator は、UID2 administration が所有し管理します。たとえば、現在 The Trade Desk は UID2 フレームワークの Public Operator として機能しており、すべての参加者が利用できます。他の Public Operator が利用可能な場合、参加者はどのオペレーターと連携するかを選択できます。 -## Public Operator: Benefits +## Public operator: Benefits Public Operator を使用する場合、Operator をホスト、構成、維持、または更新するための追加作業は必要ありません。必要なのは、SDK を使用するか、UID2 エンドポイントを呼び出すようにインテグレーションするだけです。 Public Operator を利用するための費用は、参加者には一切かかりません。 -参加者は、契約に署名し ([Account setup](../getting-started/gs-account-setup.md) を参照)、Public Operator でホストされている UID2 API を使用するために該当する認証情報 ([UID2 Credentials](../getting-started/gs-credentials.md)) を取得する必要があります。 +参加者は、契約に署名し ([Account setup](../getting-started/gs-account-setup.md) を参照)、Public Operator でホストされている UID2 API を使用するために該当する認証情報 ([UID2 credentials](../getting-started/gs-credentials.md)) を取得する必要があります。 :::note Public Operator の場合、データは参加者のインフラを離れ、オペレーターに送られます。Public Operator 内のデータを保護するために、厳格なセキュリティ対策が実施されています。 @@ -60,7 +60,7 @@ Private Operator は、UID2 Operator のプライベートインスタンスで また、参加者は、UID2 を生成および管理するために Private Operator になることも選択できます。ただし、Private Operator になるにはいくつかの追加手順が必要であり、参加者が用意するリソースが必要です。 -詳細は [UID2 Private Operator Integration Overview](../guides/integration-options-private-operator.md) を参照してください。 +詳細は [UID2 Private Operator integration overview](../guides/integration-options-private-operator.md) を参照してください。 ## Summary diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md index 0dc29be1f..6ad7fdfa4 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Preparing Emails and Phone Numbers for Processing +# Preparing emails and phone numbers for processing UID2 Service に提供する入力データは、ターゲティング広告に使用できる有効な UID2 に正しく変換されるように、正しい形式である必要があります。 @@ -18,16 +18,16 @@ UID2 Service に提供する入力データは、ターゲティング広告に - UID2 SDK インテグレーション、Prebid.js インテグレーション、または Android/iOS インテグレーションを使用する場合。 - Snowflake を使用する場合。 -## Processing Steps +## Processing steps -データを UID2 Service で利用できるように準備するための正確な手順は、[Normalization and Encoding](../getting-started/gs-normalization-encoding.md) ドキュメントに記載されています。手順は順に以下の通りです: +データを UID2 Service で利用できるように準備するための正確な手順は、[Normalization and encoding](../getting-started/gs-normalization-encoding.md) ドキュメントに記載されています。手順は順に以下の通りです: 1. 生データを正規化 (Normalize) します。 2. 正規化された生データの 32 バイト SHA-256 ハッシュを作成します。 3. 32 バイト SHA-256 値に Base64 エンコーディングを適用します。 UID2 API を直接呼び出す場合、または独自の Private Operator を介して UID2 API を呼び出す場合は、各ステップを説明通り正確に、正しい順序で完了する必要があります。 -## Valid Input +## Valid input UID2 SDK、または Prebid.js インテグレーション、Android/iOS インテグレーション、Snowflake などの他のインテグレーションソリューションを使用している場合、入力データのオプションは次の表の通りです。 @@ -43,12 +43,12 @@ UID2 SDK、または Prebid.js インテグレーション、Android/iOS イン Email 以下のいずれかでなければなりません:
  • 生のメールアドレス
  • 正規化されたメールアドレス
  • 正規化され、ハッシュ化され、Base64 エンコードされたもの
- [Email Address Normalization](../getting-started/gs-normalization-encoding#email-address-normalization)
[Email Address Hash Encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding) + [Email address normalization](../getting-started/gs-normalization-encoding#email-address-normalization)
[Email address hash encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding) Phone Number 以下のいずれかでなければなりません:
  • 国番号を含む正規化されたもの
  • 正規化され、ハッシュ化され、Base64 エンコードされたもの
- [Phone Number Normalization](../getting-started/gs-normalization-encoding#phone-number-normalization)
[Phone Number Hash Encoding](../getting-started/gs-normalization-encoding#phone-number-hash-encoding) + [Phone number normalization](../getting-started/gs-normalization-encoding#phone-number-normalization)
[Phone number hash encoding](../getting-started/gs-normalization-encoding#phone-number-hash-encoding) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-server-side-token-generation.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-server-side-token-generation.md index 0a1e471bc..3c1e2b52f 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-server-side-token-generation.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-server-side-token-generation.md @@ -10,7 +10,7 @@ import Link from '@docusaurus/Link'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Server-Side Token Generation +# Server-side token generation パブリッシャーが Client-Server または Server-Side UID2 インテグレーションを設定する場合、最初のステップはサーバーで UID2 Token を生成することです。その後、トークンを Client-Side または Server-Side でリフレッシュし、RTB ビッドストリームに送信するためにトークンを Client-Side に渡すことができます。 @@ -20,7 +20,7 @@ import TabItem from '@theme/TabItem'; - API エンドポイントへのダイレクトインテグレーション :::warning -セキュリティ上の理由により、トークン生成に使用される API Key と Client Secret は Server-Side で呼び出す必要があります。これらの値を Client-Side（Web ページ、モバイルアプリ、Prebid）に保存しないでください。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 +セキュリティ上の理由により、トークン生成に使用される API Key と Client Secret は Server-Side で呼び出す必要があります。これらの値を Client-Side（Web ページ、モバイルアプリ、Prebid）に保存しないでください。詳細は、[Security of API key and client secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。 ::: オプションは次の表にまとめられています。 @@ -37,8 +37,8 @@ import TabItem from '@theme/TabItem'; 手順は、次のいずれかを参照してください: - - [SDK for Java, Usage for Publishers, Basic Usage](../sdks/sdk-ref-java.md#basic-usage) - - [SDK for Python, Usage for Publishers](../sdks/sdk-ref-python.md#usage-for-publishers) + - [SDK for Java, usage for publishers, basic usage](../sdks/sdk-ref-java.md#basic-usage) + - [SDK for Python, usage for publishers](../sdks/sdk-ref-python.md#usage-for-publishers) SDK オプションを使用している場合、このガイドの残りの部分で必要な `Identity` レスポンスは、次のいずれかのメソッドの出力です: @@ -61,7 +61,7 @@ import TabItem from '@theme/TabItem'; - **API**: [POST /token/generate](../endpoints/post-token-generate.md) エンドポイントを呼び出します。 - このガイドの残りの部分で必要な Identity の出力は、成功したエンドポイントのレスポンスの body セクション内のコンテンツです。例は、[Successful Response](../endpoints/post-token-generate.md#successful-response) を参照してください。 + このガイドの残りの部分で必要な Identity の出力は、成功したエンドポイントのレスポンスの body セクション内のコンテンツです。例は、[Successful response](../endpoints/post-token-generate.md#successful-response) を参照してください。 :::important トークンを生成する DII が UID2 からオプトアウトされている場合、エンドポイントと SDK API はオプトアウトステータスを返します。この場合、情報を保存し、同じ DII に対してトークン生成エンドポイントを呼び出さないでください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-token-validator.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-token-validator.md index 7cdf6324c..d75e37c53 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-token-validator.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-token-validator.md @@ -23,15 +23,15 @@ UID2 Token Validator を使用するには、以下が必要です: - **UID2 API Key** (Client Key) - **UID2 Client Secret** -これらをお持ちでない場合は、UID2 Portal での作成手順について [API Keys](../portal/api-keys.md) を参照してください。 +これらをお持ちでない場合は、UID2 Portal での作成手順について [API keys](../portal/api-keys.md) を参照してください。 -## Using the Token Validator +## Using the token validator Token Validation セクションの上部にあるフィールドに **API Key** (Client Key) と **Client Secret** を入力します。 検証対象の **Operator**（環境）を選択します。UID2 の環境については、[Environments](../getting-started/gs-environments.md) を参照してください。 -### Validate a Single Token +### Validate a single token 1. **Input Mode** で **Single Validation** を選択します。 2. **Identifier** フィールドに、トークンの生成に使用した DII を入力します。以下のいずれかを入力できます: @@ -43,7 +43,7 @@ Token Validation セクションの上部にあるフィールドに **API Key** 4. **Token** フィールドに、検証する UID2 Token を貼り付けます。 5. **Validate Tokens** をクリックします。 -### Validate Multiple Tokens (CSV) +### Validate multiple tokens (csv) トークンと識別子のペアを一括検証するには: @@ -55,7 +55,7 @@ Token Validation セクションの上部にあるフィールドに **API Key** 3. CSV ファイルをアップロードします。 4. **Validate Tokens** をクリックします。 -## Interpret Validation Results +## Interpret validation results **Validate Tokens** をクリックすると、**Validation Results** テーブルにトークンと識別子の各ペアの行が、以下の表に示す形式で表示されます。 @@ -77,5 +77,5 @@ Token Validation セクションの上部にあるフィールドに **API Key** | `Failed: {"status":"unauthorized"}` | 提供された API 認証情報が無効または許可されていません。 | :::tip -結果が **Failed: Token does not match identifier** の場合、結果に表示される **Normalized Hash** と、同じ DII に対して自身の実装で生成した値を比較してください。異なる場合は、正規化またはハッシュ化のステップに問題があります。詳細については、[Normalization and Encoding](../getting-started/gs-normalization-encoding.md) および [Preparing Emails and Phone Numbers for Processing](ref-preparing-emails-and-phone-numbers-for-processing.md) を参照してください。 +結果が **Failed: Token does not match identifier** の場合、結果に表示される **Normalized Hash** と、同じ DII に対して自身の実装で生成した値を比較してください。異なる場合は、正規化またはハッシュ化のステップに問題があります。詳細については、[Normalization and encoding](../getting-started/gs-normalization-encoding.md) および [Preparing emails and phone numbers for processing](ref-preparing-emails-and-phone-numbers-for-processing.md) を参照してください。 ::: \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-tokens.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-tokens.md index b9ea0960c..76cb74e32 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-tokens.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/ref-tokens.md @@ -10,11 +10,11 @@ import Link from '@docusaurus/Link'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# UID2 Tokens and Refresh Tokens +# UID2 tokens and refresh tokens パブリッシャーがユーザーの DII—ハッシュ化またはハッシュされていないメールアドレスまたは電話番号—を UID2 Operator に送信すると、UID2 SDK のいずれかを使用するか、[POST /token/generate](../endpoints/post-token-generate.md) エンドポイントを使用するかに関わらず、UID2 Operator は DII を raw UID2 に変換し、UID2 Token に暗号化して返します。UID2 Token には、Refresh Token を含む関連値が付属しています。パブリッシャーは、UID2 Token をビッドストリームで使用できます。 -## UID2 Tokens: Key Information +## UID2 tokens: Key information UID2 Token に関する主なポイントは次のとおりです: @@ -23,14 +23,14 @@ UID2 Token に関する主なポイントは次のとおりです: - パブリッシャーは、UID2 Token をビッドストリームに送信します。 - トークンの値は、opaque (不透明)な文字列です: 文字列の形式や長さについての仮定をしないでください。 - ブラウザ、CTV、電話、タブレットなどの電子デバイスでのユーザーのアクティビティの異なるインスタンスを表す UID2 Token は、依然として同じ raw UID2 に一致させることができます。 -- トークン生成時に、UID2 Operator はユーザーのオプトアウトを確認します。ユーザーが UID2 からオプトアウトしている場合、UID2 Token は生成されません。詳細は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +- トークン生成時に、UID2 Operator はユーザーのオプトアウトを確認します。ユーザーが UID2 からオプトアウトしている場合、UID2 Token は生成されません。詳細は、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 - トークンは有効期限がありますが、Refresh Token を使用してリフレッシュできます。 - 現在の UID2 Token が有効期限切れになる前に、常に現在の Refresh Token をリフレッシュすることで、新しい UID2 Token と対応する新しい Refresh Token を取得するために何度でもリフレッシュできます。 - UID2 Token をリフレッシュしても、元の UID2 Token は無効になりません。有効期限が切れるまで、以前のトークンを引き続き使用できます。 -詳細は、[How the UID2 Token Is Created](ref-how-uid-is-created.md) を参照してください。 +詳細は、[How the UID2 token is created](ref-how-uid-is-created.md) を参照してください。 -## Refresh Tokens: Key Information +## Refresh tokens: Key information Refresh Token に関する主なポイントは次のとおりです: @@ -40,29 +40,29 @@ Refresh Token に関する主なポイントは次のとおりです: - Refresh Token は、UID2 Token が有効期限切れになる前に、新しい UID2 Token と新しい Refresh Token を生成するために使用できます。 - Refresh Token の使用は任意です: 既存のトークンをリフレッシュする代わりに、毎回 DII から新しいトークンを生成することを選択することもできます。 - Token Refresh は、さまざまな方法で管理できます: - - UID2 SDK ([SDK Functionality](../sdks/summary-sdks.md#sdk-functionality) を参照) を使用して。 + - UID2 SDK ([SDK functionality](../sdks/summary-sdks.md#sdk-functionality) を参照) を使用して。 - [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントを呼び出して。 - - UID2 Prebid.js モジュール ([UID2 Integration Overview for Prebid](../guides/integration-prebid.md) を参照) を使用して。 + - UID2 Prebid.js モジュール ([UID2 integration overview for Prebid](../guides/integration-prebid.md) を参照) を使用して。 - 新しい UID2 Token が生成され、Refresh Token に対するレスポンスとして返されると、新しい Refresh Token も返されます。 -- ほとんどの場合、Server-Side で生成されたトークンでも、Client-Side でトークンをリフレッシュできます。各 SDK のリフレッシュ機能についての詳細は、[SDK Functionality](../sdks/summary-sdks.md#sdk-functionality) (*Refresh UID2 Token* 列) を参照してください。 -- UID2 Operator Service が、新しい UID2 Token をリクエストする際に Refresh Token を受け取ると、ユーザーのオプトアウトを確認します。ユーザーが UID2 からオプトアウトしている場合、新しい UID2 Token は生成されません。詳細は、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +- ほとんどの場合、Server-Side で生成されたトークンでも、Client-Side でトークンをリフレッシュできます。各 SDK のリフレッシュ機能についての詳細は、[SDK functionality](../sdks/summary-sdks.md#sdk-functionality) (*Refresh UID2 Token* 列) を参照してください。 +- UID2 Operator Service が、新しい UID2 Token をリクエストする際に Refresh Token を受け取ると、ユーザーのオプトアウトを確認します。ユーザーが UID2 からオプトアウトしている場合、新しい UID2 Token は生成されません。詳細は、[User opt-out](../getting-started/gs-opt-out.md) を参照してください。 -### Keeping the Token Current +### Keeping the token current UID2 Token を有効期限内に保つことが非常に重要です。トークンが有効な場合のみ、UID2 の利点を享受できます。 UID2 Token を最新の状態に保つには、次の2つの方法があります： -- [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントまたは多くの UID2 SDK のトークン更新機能を使用して、頻繁に更新してください。詳細は [Recommended Token Refresh Frequency](#recommended-token-refresh-frequency) を参照してください。 +- [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントまたは多くの UID2 SDK のトークン更新機能を使用して、頻繁に更新してください。詳細は [Recommended token refresh frequency](#recommended-token-refresh-frequency) を参照してください。 - 既存トークンの更新に代わる方法として、[POST /token/generate](../endpoints/post-token-generate.md) エンドポイントまたは多くの UID2 SDK のトークン生成機能を使用して、毎回新しいトークンを生成してください。 -### Recommended Token Refresh Frequency +### Recommended token refresh frequency 現在、推奨されているリフレッシュ間隔は 1 時間です。1 時間ごとの間隔にすることで、トークンが期限切れになるのを避け、ビッドストリームに送信できるようになります。また、新しいトークンが生成される前にユーザーのオプトアウトが確認されるため、ユーザーのオプトアウト設定が迅速に反映されるようになります。 リフレッシュのタイミングを決定するには、以下の UID2 API エンドポイントのいずれかを呼び出した際のレスポンスの `refresh_from` フィールドのタイムスタンプを使用できます: -- [POST /token/generate](../endpoints/post-token-generate.md) endpoint (see [Successful Response](../endpoints/post-token-generate.md#successful-response)) -- [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint (see [Successful Response With Tokens](../endpoints/post-token-refresh.md#successful-response-with-tokens)) +- [POST /token/generate](../endpoints/post-token-generate.md) endpoint (see [Successful response](../endpoints/post-token-generate.md#successful-response)) +- [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint (see [Successful response with tokens](../endpoints/post-token-refresh.md#successful-response-with-tokens)) `refresh_from` フィールドは Unix タイムスタンプで、トークンが生成された時間から 1 時間後の値をミリ秒で表します。 @@ -70,7 +70,7 @@ UID2 Token を最新の状態に保つには、次の2つの方法がありま 推奨されるリフレッシュ間隔は将来変更される可能性があります。固定値を使用する代わりに、`refresh_from` 値に基づいて計算することが最善です。 ::: -### Managing Token Refresh with an SDK +### Managing token refresh with an SDK トークンの更新を管理する簡単な方法は、その目的のために関数を持つ UID2 SDK のいずれかを使用することです: Java SDK または Python SDK。 @@ -113,8 +113,8 @@ UID2 Token を最新の状態に保つには、次の2つの方法がありま コード例を使用する前に、使用している言語の前提条件と注意事項を確認してください。詳細は、該当する SDK のドキュメントを参照してください: -- [SDK for Java, Usage for Publishers, Basic Usage Server-Side Integration section](../sdks/sdk-ref-java.md#basic-usage-server-side-integration) -- [SDK for Python, Usage for Publishers, Server-Side Integration section](../sdks/sdk-ref-python.md#server-side-integration) +- [SDK for Java, usage for publishers, basic usage server-side integration section](../sdks/sdk-ref-java.md#basic-usage-server-side-integration) +- [SDK for Python, usage for publishers, server-side integration section](../sdks/sdk-ref-python.md#server-side-integration) ## FAQs diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-components.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-components.md index 0c576ad24..6da251530 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-components.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-components.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Components +# UID2 components UID2 フレームワークは以下のコンポーネントで構成されており、すべて The Trade Desk によって管理されています。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-identifier-types.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-identifier-types.md index c6a805e92..bc9b806ec 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-identifier-types.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-identifier-types.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Identifier Types +# UID2 identifier types UID2 は、メールアドレスや電話番号などの 直接識別情報 (DII) に基づく決定論的 ID です。UID2 には、raw UID2 と UID2 Token (Advertising Token とも呼ばれます) の 2 種類があります。以下の表では、それぞれのタイプについて説明します。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-workflows.md b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-workflows.md index 9d83ccea6..0898ca1e2 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-workflows.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/ref-info/uid-workflows.md @@ -8,17 +8,17 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Workflows +# UID2 workflows 以下の表は、UID2 フレームワークの 4 つの主要なワークフローを概要へのリンクとともに示しています。また、それぞれのワークフローに関する図、インテグレーション手順、FAQ、およびその他の関連情報を含むインテグレーションガイドへのリンクも提供しています。 | Workflow | Intended Primary Participants | Integration Guides | | :--- |:--- |:--- | -| [Workflow for DSPs](../overviews/overview-dsps.md#workflow-for-dsps) (Buy-Side) | ビッドストリームで UID2 Token 取引を行う DSP。 | [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) | ユーザーデータを収集し、DSPに提供する組織。 | [Advertiser/Data Provider Integrations](../guides/summary-guides#advertiserdata-provider-integrations) を参照 | -| [Workflow for Publishers](../overviews/overview-publishers.md#workflow-for-publishers) | SSP を介して UID2 Token をビッドストリームに送る組織。
注意: パブリッシャーは、Prebid を使用したインテグレーション、SDK for JavaScript の活用、または SDK を使用しない独自の Server-Side インテグレーションを選択できます。 | [Publisher Integrations](../guides/summary-guides#publisher-integrations) を参照 | -| [Opt-Out Workflow](../getting-started/gs-opt-out.md#opt-out-workflow) | パブリッシャーやその SSO プロバイダー、その他のアイデンティティプロバイダーと関わる消費者。 | N/A | +| [Workflow for DSPs](../overviews/overview-dsps.md#workflow-for-dsps) (Buy-Side) | ビッドストリームで UID2 Token 取引を行う DSP。 | [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) | ユーザーデータを収集し、DSPに提供する組織。 | [Advertiser/data provider integrations](../guides/summary-guides#advertiserdata-provider-integrations) を参照 | +| [Workflow for publishers](../overviews/overview-publishers.md#workflow-for-publishers) | SSP を介して UID2 Token をビッドストリームに送る組織。
注意: パブリッシャーは、Prebid を使用したインテグレーション、SDK for JavaScript の活用、または SDK を使用しない独自の Server-Side インテグレーションを選択できます。 | [Publisher integrations](../guides/summary-guides#publisher-integrations) を参照 | +| [Opt-out workflow](../getting-started/gs-opt-out.md#opt-out-workflow) | パブリッシャーやその SSO プロバイダー、その他のアイデンティティプロバイダーと関わる消費者。 | N/A | 以下の図は、4 つのワークフローすべてをまとめたものです。各ワークフローについて、[外部参加者](../overviews/participants-overview.md#uid2-external-participants)、[コンポーネント](../ref-info/uid-components.md)、[UID2 識別子タイプ](../ref-info/uid-identifier-types.md)、および番号付きのステップが色分けされています。 -![The UID2 Ecosystem](images/UID2Workflows.svg) +![The UID2 ecosystem](images/UID2Workflows.svg) 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 e7d311afe..9d097b7ae 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 @@ -10,7 +10,7 @@ import Link from '@docusaurus/Link'; import CustomTagsFilters from '@site/src/components/CustomTags/CustomTagsFilters'; import CustomTagsContainer from '@site/src/components/CustomTags/CustomTagsContainer'; -# Documentation Updates +# Documentation updates @@ -26,7 +26,7 @@ UID2 ドキュメントリソースの最新アップデートを確認してく -### Removal of optout_check Parameter +### Removal of optout_check parameter February 10, 2026 @@ -48,13 +48,13 @@ February 10, 2026 -### Databricks Integration Guide +### Databricks integration guide 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) を参照してください。 @@ -66,7 +66,7 @@ UID2 Databricks Clean Rooms インテグレーションガイドを追加しま -### Identity Map v3 (Python SDK, Snowflake) +### Identity map v3 (Python SDK, Snowflake) July 31, 2025 @@ -74,8 +74,8 @@ July 11 に発表された Identity Map API (v3) の新バージョンに対応 以下の実装と対応するドキュメントを更新しました: -- Python SDK: [SDK for Python Reference Guide](../sdks/sdk-ref-python.md) を参照してください。 -- Snowflake: [Snowflake Integration Guide](../guides/integration-snowflake.md) を参照してください。 +- Python SDK: [SDK for Python reference guide](../sdks/sdk-ref-python.md) を参照してください。 +- Snowflake: [Snowflake integration guide](../guides/integration-snowflake.md) を参照してください。 @@ -83,11 +83,11 @@ July 11 に発表された Identity Map API (v3) の新バージョンに対応 -### Identity Map v3 (Endpoint Doc) +### Identity map v3 (endpoint doc) July 11, 2025 -Identity Map API (v3) の新バージョンをリリースしました。このバージョンは、広告主とデータプロバイダーに大幅な改善を提供します。この更新には、[POST /identity/map](../endpoints/post-identity-map.md) エンドポイント、[SDK for Java Reference Guide](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers)、および [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) のドキュメントが含まれています。 +Identity Map API (v3) の新バージョンをリリースしました。このバージョンは、広告主とデータプロバイダーに大幅な改善を提供します。この更新には、[POST /identity/map](../endpoints/post-identity-map.md) エンドポイント、[SDK for Java reference guide](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers)、および [Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) のドキュメントが含まれています。 @@ -99,13 +99,13 @@ Identity Map API (v3) の新バージョンをリリースしました。この -### Private Operator for AKS Integration Guide +### Private Operator for AKS integration guide March 19, 2025 UID2 参加者 は、Azure Kubernetes Service (AKS) クラスターの [仮想ノード](https://learn.microsoft.com/en-us/azure/container-instances/container-instances-virtual-nodes) 上で UID2 Operator Service を Private Operator としてセットアップできるようになりました。 -詳細は、[UID2 Private Operator for AKS Integration Guide](../guides/operator-guide-aks-enclave.md) を参照してください。 +詳細は、[UID2 Private Operator for AKS integration guide](../guides/operator-guide-aks-enclave.md) を参照してください。 @@ -113,13 +113,13 @@ UID2 参加者 は、Azure Kubernetes Servic -### Server-Side Integration Guide for Mobile +### Server-side integration guide for mobile March 18, 2025 モバイルアプリのパブリッシャーが、UID2 Token を Server-Side で完全に管理するためのガイドを追加しました。 -詳細は、[UID2 Server-Side Integration Guide for Mobile](../guides/integration-mobile-server-side.md) を参照してください。 +詳細は、[UID2 server-side integration guide for mobile](../guides/integration-mobile-server-side.md) を参照してください。 @@ -127,13 +127,13 @@ March 18, 2025 -### Portal, Sharing Permissions Page +### Portal, sharing permissions page March 11, 2025 UID2 Portal での共有権限の設定に関するドキュメントを大幅に拡充し、明確化しました。 -詳細は、[Sharing Permissions](../portal/sharing-permissions.md) を参照してください。 +詳細は、[Sharing permissions](../portal/sharing-permissions.md) を参照してください。 @@ -141,13 +141,13 @@ UID2 Portal での共有権限の設定に関するドキュメントを大幅 -### JavaScript SDK Version 4 +### JavaScript SDK version 4 March 7, 2025 UID2 JavaScript SDK の最新アップデート、Version 4 に関するドキュメントを追加しました。 -詳細は、[SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照してください。 +詳細は、[SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md) を参照してください。 @@ -155,13 +155,13 @@ UID2 JavaScript SDK の最新アップデート、Version 4 に関するドキ -### How the UID2 Token Is Created +### How the UID2 token is created March 7, 2025 UID2 Token を生成する手順に関する情報を記載したページを追加しました。手順、役割、および図を含みます。 -詳細は、[How the UID2 Token Is Created](../ref-info/ref-how-uid-is-created.md) を参照してください。 +詳細は、[How the UID2 token is created](../ref-info/ref-how-uid-is-created.md) を参照してください。 @@ -169,13 +169,13 @@ UID2 Token を生成する手順に関する情報を記載したページを追 -### Snowflake Integration Guide +### Snowflake integration guide February 12, 2025 UID2 Snowflake インテグレーションを大幅に更新し、ドキュメントを更新しました。 -詳細は、[Snowflake Integration Guide](../guides/integration-snowflake.md) を参照してください。 +詳細は、[Snowflake integration guide](../guides/integration-snowflake.md) を参照してください。 @@ -183,13 +183,13 @@ UID2 Snowflake インテグレーションを大幅に更新し、ドキュメ -### Instructions for Using the UID2 Portal +### Instructions for using the UID2 portal February 10, 2025 UID2 インテグレーションガイド、SDK ドキュメント、エンドポイントドキュメントに、UID2 Portal でのアカウント設定に関する情報を追加しました。 -詳細は、実装ガイドを参照してください: たとえば、[Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md#complete-uid2-account-setup-and-configure-account) または [SDK for Android Reference Guide](../sdks/sdk-ref-android.md#api-permissions)。 +詳細は、実装ガイドを参照してください: たとえば、[Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md#complete-uid2-account-setup-and-configure-account) または [SDK for Android reference guide](../sdks/sdk-ref-android.md#api-permissions)。 また、これらの変更により、環境によって認証情報を取得する手順が異なることが明確になりました: [Credentials](../getting-started/gs-credentials.md) および [Environments](../getting-started/gs-environments.md) ページで詳細を確認してください。 @@ -199,13 +199,13 @@ UID2 インテグレーションガイド、SDK ドキュメント、エンド -### Advertiser/Data Provider Doc +### Advertiser/data provider doc January 10, 2025 広告主とデータプロバイダーのドキュメントを大幅に拡充し、再構築しました。新しい概要ドキュメントと、Snowflake、AWS Entity Resolution、HTTP エンドポイントの 3 つの主要なインテグレーションオプションに関する個別のドキュメントがあります: -広告主とデータプロバイダー向けのすべてのインテグレーションオプションの概要は、[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 +広告主とデータプロバイダー向けのすべてのインテグレーションオプションの概要は、[Advertiser/data provider integration overview](../guides/integration-advertiser-dataprovider-overview.md) を参照してください。 @@ -213,13 +213,13 @@ January 10, 2025 -### Publisher SSO Integration Page +### Publisher SSO integration page January 8, 2025 SSO ログインを提供するために SSO プロバイダーとインテグレーションし、SSO プロバイダーからログインユーザーのメールアドレスを取得して UID2 Token を生成したいパブリッシャー向けの新しいリファレンスページを追加しました。 -詳細は、[Publisher Integration with SSO Providers](ref-integration-sso-providers.md) を参照してください。 +詳細は、[Publisher integration with SSO providers](ref-integration-sso-providers.md) を参照してください。 @@ -239,7 +239,7 @@ We've removed the legacy v1 to v2 upgrade doc, which is no longer needed. --> -### Zoom-In Tool for Images +### Zoom-in tool for images December 15, 2024 @@ -253,13 +253,13 @@ UID2 ドキュメントサイトに、画像のズームインツールが追加 -### Portal Audit Trail Page +### Portal audit trail page November 15, 2024 -UID2 Portal ドキュメントに新しいページ、[Audit Trail](../portal/audit-trail.md) が追加されました。 +UID2 Portal ドキュメントに新しいページ、[Audit trail](../portal/audit-trail.md) が追加されました。 -UID2 Portal の **Audit Trail** ページでは、Admin 権限 ([User Roles](../portal/team-members.md#user-roles) を参照) を持つユーザーが、現在の 参加者 または参加者に代わって実行された過去のすべてのアクションの詳細なログを表示できます。 +UID2 Portal の **Audit Trail** ページでは、Admin 権限 ([User roles](../portal/team-members.md#user-roles) を参照) を持つユーザーが、現在の 参加者 または参加者に代わって実行された過去のすべてのアクションの詳細なログを表示できます。 @@ -267,13 +267,13 @@ UID2 Portal の **Audit Trail** ページでは、Admin 権限 ([User Roles](../ -### LiveRamp Integration Tips +### LiveRamp integration tips November 14, 2024 LiveRamp の Authenticated Traffic Solution (ATS) を使用して UID2 Token を生成し、ビッドリクエストで渡すパブリッシャー向けの新しいリファレンスページを追加しました。 -詳細は、[LiveRamp Integration Tips](../guides/integration-liveramp-tips.md) を参照してください。 +詳細は、[LiveRamp integration tips](../guides/integration-liveramp-tips.md) を参照してください。 @@ -285,13 +285,13 @@ LiveRamp の Authenticated Traffic Solution (ATS) を使用して UID2 Token を -### Tokens Page +### Tokens page September 10, 2024 トークンに関する情報を含む新しいリファレンスページを追加しました。 -詳細は、[UID2 Tokens and Refresh Tokens](../ref-info/ref-tokens.md) を参照してください。 +詳細は、[UID2 tokens and refresh tokens](../ref-info/ref-tokens.md) を参照してください。 @@ -299,13 +299,13 @@ September 10, 2024 -### Private Operator Integration Overview +### Private Operator integration overview August 28, 2024 Private Operator のインテグレーションに関する新しいページを追加しました。 -詳細は [Private Operator Integrations](../guides/integration-options-private-operator) を参照してください。 +詳細は [Private Operator integrations](../guides/integration-options-private-operator) を参照してください。 @@ -313,13 +313,13 @@ Private Operator のインテグレーションに関する新しいページを -### DSP Direct Integration Instructions +### DSP direct integration instructions August 22, 2024 UID2 SDK を使用していない DSP 向けの新しいガイドを追加しました。 -詳細は [DSP Direct Integration Instructions](../guides/integration-dsp-no-sdk.md) を参照してください。 +詳細は [DSP direct integration instructions](../guides/integration-dsp-no-sdk.md) を参照してください。 @@ -337,13 +337,13 @@ For details, see [UID2 Tokens and Refresh Tokens]. --> -### Integration Approaches Page +### Integration approaches page July 23, 2024 Client-Side、Client-Server、Server-Side の異なるインテグレーションアプローチに関する情報を含む新しいページを追加しました。 -詳細は [Integration Approaches](ref-integration-approaches.md) を参照してください。 +詳細は [Integration approaches](ref-integration-approaches.md) を参照してください。 @@ -351,13 +351,13 @@ Client-Side、Client-Server、Server-Side の異なるインテグレーショ -### Server-Side Token Generation Page +### Server-side token generation page July 3, 2024 Server-Side で UID2 Token を生成するパブリッシャー向けの情報を含む新しいリファレンスページを追加しました。 -詳細は [Server-Side Token Generation](ref-server-side-token-generation.md) を参照してください。 +詳細は [Server-side token generation](ref-server-side-token-generation.md) を参照してください。 @@ -371,8 +371,8 @@ July 2, 2024 2 つのモバイルインテグレーションガイドに、Prebid を使用したモバイルインテグレーションの新しいセクションを追加しました。現在は Android のみです。 -- [UID2 Client-Side Integration Guide for Mobile: Prebid Integration](../guides/integration-mobile-client-side#optional-uid2-integration-with-prebid-mobile-sdk) -- [UID2 Client-Server Integration Guide for Mobile: Prebid Integration](../guides/integration-mobile-client-server#optional-uid2-integration-with-prebid-mobile-sdk) +- [UID2 client-side integration guide for mobile: Prebid integration](../guides/integration-mobile-client-side#optional-uid2-integration-with-prebid-mobile-sdk) +- [UID2 client-server integration guide for mobile: Prebid integration](../guides/integration-mobile-client-server#optional-uid2-integration-with-prebid-mobile-sdk) @@ -384,13 +384,13 @@ July 2, 2024 -### CTV Integration Guide +### CTV integration guide June 21, 2024 UID2 とのインテグレーションを希望する CTV パブリッシャー向けに、新しいガイドを追加しました。 -詳細は [CTV Integration Guide](../guides/integration-ctv-guide.md) を参照してください。 +詳細は [CTV integration guide](../guides/integration-ctv-guide.md) を参照してください。 @@ -398,7 +398,7 @@ UID2 とのインテグレーションを希望する CTV パブリッシャー -### Opt-Out API +### Opt-out API May 24, 2024 @@ -414,15 +414,15 @@ raw UID2 のリストが与えられた場合、このエンドポイントは -### Client-Side and Server-Side Guides for Mobile +### Client-side and server-side guides for mobile May 17, 2024 Android または iOS モバイルアプリのパブリッシャーが UID2 を実装するためのサポートを提供するため、以下のインテグレーションガイドを追加しました: -- [UID2 Mobile Integration Overview for Android and iOS](../guides/integration-mobile-overview) -- [UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side) -- [UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server) +- [UID2 mobile integration overview for Android and iOS](../guides/integration-mobile-overview) +- [UID2 client-side integration guide for mobile](../guides/integration-mobile-client-side) +- [UID2 client-server integration guide for mobile](../guides/integration-mobile-client-server) @@ -430,11 +430,11 @@ Android または iOS モバイルアプリのパブリッシャーが UID2 を -### Portal Client-Side Integration Page +### Portal client-side integration page May 6, 2024 -UID2 Portal のドキュメントに新しいページ、[Client-Side Integration](../portal/client-side-integration.md) を追加しました。 +UID2 Portal のドキュメントに新しいページ、[Client-side integration](../portal/client-side-integration.md) を追加しました。 UID2 Portal の Client-Side Integration ページでは、ドメインなど、クライアントサイドで UID2 Token を生成する場合に必要な値を設定・管理できます。 @@ -444,11 +444,11 @@ UID2 Portal の Client-Side Integration ページでは、ドメインなど、 -### Portal API Keys Page +### Portal API keys page April 25, 2024 -UID2 Portal ドキュメントに新しいページ、[API Keys](../portal/api-keys.md) を追加しました。 +UID2 Portal ドキュメントに新しいページ、[API keys](../portal/api-keys.md) を追加しました。 UID2 Portal の API Keys ページでは、UID2 アカウントの API Key、関連するシークレット値、および権限設定を管理するすべてのアクティビティを実行できます。 @@ -458,7 +458,7 @@ UID2 Portal の API Keys ページでは、UID2 アカウントの API Key、関 -### Documentation for UID2 Sharing +### Documentation for UID2 sharing April 22, 2024 @@ -466,7 +466,7 @@ April 22, 2024 このドキュメントでは、送信者と受信者が適用される法的、セキュリティ、および技術的要件に従う場合に、raw UID2 を共有する機能など、追加の共有シナリオをサポートするようになりました。 -詳細は [UID2 Sharing: Overview](../sharing/sharing-overview.md) を参照してください。 +詳細は [UID2 sharing: Overview](../sharing/sharing-overview.md) を参照してください。 @@ -478,13 +478,13 @@ April 22, 2024 -### UID2 Hashing Tool +### UID2 hashing tool March 4, 2024 新しい UID2 ハッシュツールを追加しました。正規化とエンコーディングが正しく行われているかどうかをチェックすることができます。 -詳細は *Normalization and Encoding* ドキュメントの [UID2 Hashing Tool](../getting-started/gs-normalization-encoding#uid2-hashing-tool) を参照してください。 +詳細は *Normalization and Encoding* ドキュメントの [UID2 hashing tool](../getting-started/gs-normalization-encoding#uid2-hashing-tool) を参照してください。 @@ -492,13 +492,13 @@ March 4, 2024 -### Java SDK Support, Advertiser/Data Provider +### Java SDK support, advertiser/data provider February 28, 2024 Java SDKは、[POST /identity/map (v2)](../endpoints/post-identity-map-v2.md) エンドポイントの使用を希望する広告主およびデータプロバイダーをサポートするようになりました。 -詳細は、*SDK for Javaリファレンスガイド*: [Usage for Advertisers and Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers) の更新されたドキュメントを参照してください。 +詳細は、*SDK for Javaリファレンスガイド*: [Usage for advertisers and data providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers) の更新されたドキュメントを参照してください。 @@ -506,7 +506,7 @@ Java SDKは、[POST /identity/map (v2)](../endpoints/post-identity-map-v2.m -### Audience-Specific Sidebars +### Audience-specific sidebars February 9, 2024 @@ -516,7 +516,7 @@ UID2 home page の "ドキュメント" リンクをクリックするだけで 多くのドキュメントは複数の対象者に適用可能であり、ドキュメント間には多くの相互リンクがあるため、サイト内を移動するにつれてサイドバーの表示が変わる可能性があることに注意してください。上部のリンクをクリックすると、いつでも特定のビューに戻ることができます。これらのリンクはすべてのページに表示されます。 -カスタムサイドバーを表示するには、[https://unifiedid.com](https://unifiedid.com/) にアクセスし、上部にあるオーディエンスのリンクの1つをクリックしてください: [Publishers](../overviews/overview-publishers.md)。[Advertisers](../overviews/overview-advertisers.md)、[DSPs](../overviews/overview-dsps.md)、[Data Providers](../overviews/overview-data-providers.md)。 +カスタムサイドバーを表示するには、[https://unifiedid.com](https://unifiedid.com/) にアクセスし、上部にあるオーディエンスのリンクの1つをクリックしてください: [Publishers](../overviews/overview-publishers.md)。[Advertisers](../overviews/overview-advertisers.md)、[DSPs](../overviews/overview-dsps.md)、[Data providers](../overviews/overview-data-providers.md)。 @@ -524,7 +524,7 @@ UID2 home page の "ドキュメント" リンクをクリックするだけで -### Integration Overview for JavaScript +### Integration overview for JavaScript January 26, 2024 @@ -532,9 +532,9 @@ January 26, 2024 詳細は以下を参照してください: -- [UID2 Integration Overview for JavaScript](../guides/integration-javascript) -- [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) -- [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) +- [UID2 integration overview for JavaScript](../guides/integration-javascript) +- [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) +- [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) @@ -542,13 +542,13 @@ January 26, 2024 -### SDK for Java, Publisher Sections +### SDK for Java, publisher sections 22 January 2024 SDK for Java のドキュメントに、SDK を実装するパブリッシャーに役立つ新しいセクションを追加しました。 -詳細は SDK for Java Reference Guide の [Usage for Publishers](../sdks/sdk-ref-java.md#usage-for-publishers) を参照してください。 +詳細は SDK for Java Reference Guide の [Usage for publishers](../sdks/sdk-ref-java.md#usage-for-publishers) を参照してください。 @@ -556,13 +556,13 @@ SDK for Java のドキュメントに、SDK を実装するパブリッシャー -### Normalization and Encoding Examples +### Normalization and encoding examples January 19, 2024 既存の正規化とエンコードに関するドキュメントを拡張して明確にし、新しい例のセクションを追加しました。 -詳細は [Normalization and Encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 +詳細は [Normalization and encoding](../getting-started/gs-normalization-encoding.md) を参照してください。 @@ -570,13 +570,13 @@ January 19, 2024 -### Web Integration Overview for Publishers +### Web integration overview for publishers January 16, 2024 UID2 とインテグレーションするパブリッシャーが利用できる Web インテグレーションオプションをまとめた新しいページを追加しました。 -詳細は [Publisher Web Integration Overview](../guides/integration-options-publisher-web.md) を参照してください。 +詳細は [Publisher web integration overview](../guides/integration-options-publisher-web.md) を参照してください。 @@ -584,7 +584,7 @@ UID2 とインテグレーションするパブリッシャーが利用できる -### UID2 Operator Page +### UID2 Operator page January 3, 2024 @@ -602,7 +602,7 @@ UID2 Operator が何をするのか、Public Operator と Private Operator の -### Integration Overview for Prebid +### Integration overview for Prebid December 20, 2023 @@ -612,81 +612,81 @@ December 20, 2023 詳細は 以下を参照してください: -- [UID2 Integration Overview for Prebid](../guides/integration-prebid.md) -- [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) -- [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) +- [UID2 integration overview for Prebid](../guides/integration-prebid.md) +- [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) +- [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) -### Encrypt/Decrypt Examples, Java and C# +### Encrypt/decrypt examples, Java and C# December 14, 2023 UID2 リクエストの暗号化とレスポンスの復号化について、追加のプログラミング言語での説明とコード例を追加しました。既存の Python の例に、Java と C# を追加しました。 -詳細は [Encryption and Decryption Code Examples](../getting-started/gs-encryption-decryption.md#encryption-and-decryption-code-examples) を参照してください。 +詳細は [Encryption and decryption code examples](../getting-started/gs-encryption-decryption.md#encryption-and-decryption-code-examples) を参照してください。 -### Private Operator for Azure Integration Guide +### Private Operator for Azure integration guide November 30, 2023 [Private Operator](../ref-info/glossary-uid.md#gl-private-operator) の運用を希望する UID2 参加者は、Microsoft Azure の機密コンピューティングオプションである Confidential Containers のインスタンスで UID2 Operator Service をセットアップできるようになりました。 -詳細は [UID2 Private Operator for Azure Integration Guide](../guides/operator-guide-azure-enclave.md) を参照してください。 +詳細は [UID2 Private Operator for Azure integration guide](../guides/operator-guide-azure-enclave.md) を参照してください。 -### API Permissions +### API permissions November 22, 2023 UID2 ウェブサイトの Getting Started セクションに新しい記事が掲載され、主要な UID2 権限、よく使う参加者のタイプ、関連する主なアクティビティについての情報が提供されています。 -詳細は [API Permissions](../getting-started/gs-permissions.md) を参照してください。 +詳細は [API permissions](../getting-started/gs-permissions.md) を参照してください。 -### UID2 Credentials Page +### UID2 credentials page November 21, 2023 以前の **API Keys** ページを新しいページに置き換えました。このページには、Server-Sideの実装戦略に従った場合の認証情報についての情報が含まれています。 -詳細は [UID2 Credentials](../getting-started/gs-credentials.md) を参照してください。 +詳細は [UID2 credentials](../getting-started/gs-credentials.md) を参照してください。 -### Client-Side Integration Guide for JS +### Client-side integration guide for js November 21, 2023 Client-Side Integration Guide for JavaScript は、既存の URL の全く新しいドキュメントで、Client-Sideパブリッシャー実装のために SDK for JavaScript を使用する、よりシンプルな新しい方法を網羅しています。 -詳細は [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) を参照してください。 +詳細は [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) を参照してください。 -以前の *SDK for JavaScript Integration Guide* にあった内容は、JavaScript SDK を Server-Side に実装したいパブリッシャーのための補足文書になりました: [JavaScript Standard Integration Guide](../guides/integration-javascript-client-server.md). +以前の *SDK for JavaScript Integration Guide* にあった内容は、JavaScript SDK を Server-Side に実装したいパブリッシャーのための補足文書になりました: [JavaScript standard integration guide](../guides/integration-javascript-client-server.md). :::note -このドキュメントは2024年1月に [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) に更新され、JavaScript Standard Integration Guide は[Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) になりました。 +このドキュメントは2024年1月に [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) に更新され、JavaScript Standard Integration Guide は[Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) になりました。 ::: -### Client-Side Integration Guide for Prebid.js +### Client-side integration guide for Prebid.js November 2, 2023 @@ -696,28 +696,28 @@ UID2 Client-Side Integration Guide for Prebid.js は、既存の URL にまっ :::note これらのドキュメントは、その後の改訂でさらに更新されました。更新されたリンクは以下のとおりです: -- [UID2 Integration Overview for Prebid](../guides/integration-prebid.md) -- [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) -- [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) +- [UID2 integration overview for Prebid](../guides/integration-prebid.md) +- [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) +- [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) ::: -### Opt-Out Page +### Opt-out page October 31, 2023 ユーザーのオプトアウトの概要を説明するリファレンストピックです。 -詳細は [User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。 +詳細は [User opt-out](../getting-started/gs-opt-out.md) を参照してください。 -### AWS Entity Resolution Integration Guide +### AWS Entity Resolution integration guide October 19, 2023 @@ -725,21 +725,21 @@ October 19, 2023 このサービスでは、DII (メールアドレスまたは電話番号) を raw UID2 に迅速かつ安全にマッピングすることができます。 -詳細は [AWS Entity Resolution Integration Guide](../guides/integration-aws-entity-resolution.md) を参照してください。 +詳細は [AWS Entity Resolution integration guide](../guides/integration-aws-entity-resolution.md) を参照してください。 -### SDK for JavaScript Version 3 +### SDK for JavaScript version 3 October 10, 2023 -SDK for JavaScript Version 3 の機能強化に伴い、ドキュメントが大幅に更新されました。新しいドキュメントには、以前のバージョンの SDK からのアップグレードのための [Migration Guide](../sdks/sdk-ref-javascript#migration-guide) が含まれています。 +SDK for JavaScript Version 3 の機能強化に伴い、ドキュメントが大幅に更新されました。新しいドキュメントには、以前のバージョンの SDK からのアップグレードのための [Migration guide](../sdks/sdk-ref-javascript#migration-guide) が含まれています。 詳細は以下を参照してください: -- [SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) -- [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) +- [SDK for JavaScript reference guide](../sdks/sdk-ref-javascript.md) +- [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) @@ -749,13 +749,13 @@ SDK for JavaScript Version 3 の機能強化に伴い、ドキュメントが大 -### Private Operator Guide for Google Confidential Space +### Private Operator guide for Google confidential space September 30, 2023 この新しいガイドでは、Google Cloud Platformの Confidential Computing オプションである [Confidential Space](https://cloud.google.com/confidential-computing#confidential-space) でUID2 Operator Service を設定するための情報を提供します。 -詳細は [UID2 Private Operator for GCP Integration Guide](../guides/operator-private-gcp-confidential-space.md) を参照してください。 +詳細は [UID2 Private Operator for GCP integration guide](../guides/operator-private-gcp-confidential-space.md) を参照してください。 @@ -763,7 +763,7 @@ September 30, 2023 -### Normalization and Encoding Rules +### Normalization and encoding rules September 7, 2023 @@ -771,62 +771,62 @@ September 7, 2023 詳細は: -- [Email Address Hash Encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding) -- [Phone Number Hash Encoding](../getting-started/gs-normalization-encoding#phone-number-hash-encoding) +- [Email address hash encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding) +- [Phone number hash encoding](../getting-started/gs-normalization-encoding#phone-number-hash-encoding) -### IMA Mobile Plugin for Android +### IMA mobile plugin for Android August 8, 2023 Android 向け UID2 Interactive Media Ads(IMA)Plugin に関する情報を提供する、パブリッシャー向けの新しいガイドです。このプラグインを使用すると、Google IMA SDK for Android を使用するパブリッシャーが、Android アプリからの広告リクエストで UID2 token を secure signals として送信できるようになります。 -詳細は [UID2 IMA Plugin for Android Integration Guide](../guides/mobile-plugin-ima-android.md) を参照してください。 +詳細は [UID2 IMA plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) を参照してください。 -### IMA Mobile Plugin for iOS +### IMA mobile plugin for iOS August 8, 2023 iOS 向け UID2 Interactive Media Ads(IMA)Plugin に関する情報を提供する、パブリッシャー向けの新しいガイドです。このプラグインを使用すると、Google IMA SDK for iOS を使用するパブリッシャーが、iOS アプリからの広告リクエストで UID2 token を secure signals として送信できるようになります。 -詳細は [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios.md) を参照してください。 +詳細は [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) を参照してください。 -### GMA Mobile Plugin for Android +### GMA mobile plugin for Android August 4, 2023 Android 向け UID2 Google Mobile Ads(GMA)Plugin に関する情報を提供する、パブリッシャー向けの新しいガイドです。このプラグインを使用すると、Google GMA SDK を使用するパブリッシャーが、Android アプリからの広告リクエストで UID2 token を secure signals として送信できるようになります。 -詳細は [UID2 GMA Plugin for Android Integration Guide](../guides/mobile-plugin-gma-android.md) を参照してください。 +詳細は [UID2 GMA plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) を参照してください。 -### GMA Mobile Plugin for iOS +### GMA mobile plugin for iOS August 4, 2023 iOS 向け UID2 Google Mobile Ads(GMA)Plugin に関する情報を提供する、パブリッシャー向けの新しいガイドです。このプラグインを使用すると、Google GMA SDK を使用するパブリッシャーが、iOS アプリからの広告リクエストで UID2 token を secure signals として送信できるようになります。 -詳細は [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios.md) を参照してください。 +詳細は [UID2 GMA plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) を参照してください。 -### UID2 Website in Japanese +### UID2 website in japanese August 3, 2023 @@ -838,45 +838,45 @@ UID2 のウェブサイト全体が、英語だけでなく日本語でも利用 -### Portal Documentation +### Portal documentation 3 August 2023 UID2 アカウントを管理できる新しい UID2 Portal ユーザーインターフェースをナビゲートするための新しいドキュメントページをいくつか公開しました。 -詳細は [UID2 Portal: Overview](../portal/portal-overview.md) を参照してください。 +詳細は [UID2 portal: Overview](../portal/portal-overview.md) を参照してください。 -### Documentation for UID2 Sharing +### Documentation for UID2 sharing August 3, 2023 新しい UID2 Sharing 機能の使用をサポートするため、以下の新規および更新ドキュメントを公開しました: -- 概要、使用例、実装手順、ベストプラクティスなど、UID2 Sharing に関連する情報を提供する一連の新しいページ。[UID2 Sharing: Overview](../sharing/sharing-overview.md) を参照してください。 +- 概要、使用例、実装手順、ベストプラクティスなど、UID2 Sharing に関連する情報を提供する一連の新しいページ。[UID2 sharing: Overview](../sharing/sharing-overview.md) を参照してください。 - UID2 Sharing をサポートするために4つの Server-side SDK を更新しました: - - [SDK for C# / .NET: Usage for UID2 Sharers](../sdks/sdk-ref-csharp-dotnet.md#usage-for-uid2-sharers) - - [SDK for C++: Usage for UID2 Sharers](../sdks/sdk-ref-cplusplus.md#usage-for-uid2-sharers) - - [SDK for Java: Usage for UID2 Sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) - - [SDK for Python: Usage for UID2 Sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) + - [SDK for C# / .NET: Usage for UID2 sharers](../sdks/sdk-ref-csharp-dotnet.md#usage-for-uid2-sharers) + - [SDK for C++: Usage for UID2 sharers](../sdks/sdk-ref-cplusplus.md#usage-for-uid2-sharers) + - [SDK for Java: Usage for UID2 sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) + - [SDK for Python: Usage for UID2 sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) -- UID2 Sharing をサポートするための Snowflake 機能の更新。[Snowflake Integration Guide: Usage for UID2 Sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) を参照してください。 +- UID2 Sharing をサポートするための Snowflake 機能の更新。[Snowflake integration guide: Usage for UID2 sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) を参照してください。 -### Android SDK Guide +### Android SDK guide August 3, 2023 パブリッシャー向けの新しいガイドでは、Android アプリをサポートする必要があるパブリッシャー向けに、UID2 を使用したクライアント ID の確立と UID2 Token の取得プロセスを容易にする SDK、SDK for Android に関する情報を提供しています。 -詳細は [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) を参照してください。 +詳細は [SDK for Android reference guide](../sdks/sdk-ref-android.md) を参照してください。 @@ -888,7 +888,7 @@ August 3, 2023 パブリッシャー向けの新しいガイドでは、iOS アプリをサポートする必要があるパブリッシャー向けに、UID2 を使用したクライアント ID の確立と UID2 Token の取得プロセスを容易にする SDK、SDK for iOS に関する情報を提供しています。 -詳細は [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) を参照してください。 +詳細は [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) を参照してください。 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 983e4af08..c0a21144a 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 @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for Android Reference Guide +# SDK for Android reference guide Android SDK を使用すると、UID2 を使用したクライアント ID の生成または確立、bidstream 用の Advertising Token の取得、および UID2 Token の自動リフレッシュを容易に行うことができます。 @@ -16,12 +16,12 @@ Android SDK を使用すると、UID2 を使用したクライアント ID の | Purpose | Product/Documentation | | :--- | :--- | -| Google Mobile Ads (GMA) SDK を使用して、Android アプリからの広告リクエストで UID2 token を [Secure Signals](https://support.google.com/admob/answer/11556288) として送信するには、次の手順に従います。 | [UID2 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) として送信するには、次の手順に従います。 | [UID2 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) として送信するには、次の手順に従います。 | [UID2 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) として送信するには、次の手順に従います。 | [UID2 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) を参照してください。 +モバイルパブリッシャーインテグレーションに関する FAQs は、[FAQs for mobile integrations](../guides/integration-mobile-overview.md#faqs-for-mobile-integrations) を参照してください。 -## Non-Mobile Android Device Support +## Non-mobile Android device support この SDK for Android は、Android プラットフォームの非モバイルデバイスにも使用できます。 @@ -37,22 +37,22 @@ SDK for Android は、Android アプリに代わって UID2 ID を生成また デフォルトでは、SDK は有効期限に基づいて UID2 ID を自動的にリフレッシュします。ただし、これを無効にして、実装アプリが UID2 ID のライフサイクルを手動で管理できるようにすることもできます。 -## UID2 Account Setup +## UID2 account setup -UID2 とのインテグレーションを行うには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とのインテグレーションを行うには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -## API Permissions +## API permissions -初期アカウント設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作を行うことができます: +初期アカウント設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作を行うことができます: - アカウント用の [credentials](../getting-started/gs-credentials.md) を生成します。 - オプション: Client-Side の実装の場合、ドメイン名やモバイルアプリ ID などの設定値を設定します。 - オプションとして、チームメンバーに関する情報を設定するなど、他の値を設定します。 -UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。モバイルインテグレーションオプションの概要は、[Client-Side, Client-Server, or Server-Side Integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 +UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。モバイルインテグレーションオプションの概要は、[Client-side, client-server, or server-side integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 -## SDK Version +## SDK version @@ -60,7 +60,7 @@ UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、S リリースノートの情報は、[https://github.com/IABTechLab/uid2-android-sdk/releases](https://github.com/IABTechLab/uid2-android-sdk/releases) を参照してください。 -## GitHub Repository/Binary +## Github repository/binary この SDK は以下のオープンソースの GitHub リポジトリにあります: @@ -70,14 +70,14 @@ UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、S - [https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk](https://central.sonatype.com/artifact/com.uid2/uid2-android-sdk) -## Minimum Requirements +## Minimum requirements この SDK のバイナリパッケージをアプリで使用するには: - 最低限のターゲット Android バージョン: 4.4+ / API 19+ (SDK) 5.0+ -開発アプリ ([Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#client-side-integration-example) を参照) を実行するか、ソースコードからバイナリをビルドするには、次の最小要件が必要です: +開発アプリ ([Client-side integration guide for mobile](../guides/integration-mobile-client-side#client-side-integration-example) を参照) を実行するか、ソースコードからバイナリをビルドするには、次の最小要件が必要です: - [code repository](https://github.com/IABTechLab/uid2-android-sdk/blob/main/gradle/libs.versions.toml) (記載されている `agp` バージョンを参照) で指定されている UID2 SDK に必要な Android Gradle Plugin (AGP) バージョンを確認し、対応する Android Studio バージョンが必要かどうかを確認してください。 - 最低限のターゲット Android バージョン: 4.4+ / API 19+ (SDK) 5.0+ / API 21+ (Dev-App) @@ -113,7 +113,7 @@ Maven を使用してインストールするには、`pom.xml` ファイルに ``` -## Usage Guidelines +## Usage guidelines **UID2Manager** シングルトンは、SDK for Android の主要な開発者 API です。UID2 Token を含む UID2 Identity の保存、リフレッシュ、取得を行います。 @@ -135,17 +135,17 @@ class MyApplication : Application() { 最初の UID2 Identity を確立する方法は 2 つあります: -1. DII を使用して UID2 ID を生成します—メール (ハッシュ化または非ハッシュ化) または電話番号 (ハッシュ化または非ハッシュ化) を使用します。インテグレーション手順は、[Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md) を参照してください。 +1. DII を使用して UID2 ID を生成します—メール (ハッシュ化または非ハッシュ化) または電話番号 (ハッシュ化または非ハッシュ化) を使用します。インテグレーション手順は、[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) を参照してください。 -2. Server-Side で UID2 ID を生成し、それを UID2 SDK に渡します。インテグレーション手順は、[Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md) を参照してください。 +2. Server-Side で UID2 ID を生成し、それを UID2 SDK に渡します。インテグレーション手順は、[Client-server integration guide for mobile](../guides/integration-mobile-client-server.md) を参照してください。 UID2 Mobile SDK は、UID2 identifier が確立された後に UID2 identities をリフレッシュできます。これは、リフレッシュ機能が UID2 Identity の一部である Refresh Token に依存しているためです。 -## Code Samples +## Code samples 以下のコードサンプルは、SDK for Android を使用して具体的なアクティビティを実行する例を示しています。 -初期の UID2 Identity を生成します ([Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md#configure-the-uid2-mobile-sdk) を参照): +初期の UID2 Identity を生成します ([Client-side integration guide for mobile](../guides/integration-mobile-client-side.md#configure-the-uid2-mobile-sdk) を参照): ``` javascript UID2Manager.getInstance().generateIdentity( identityRequest: IdentityRequest, @@ -154,7 +154,7 @@ UID2Manager.getInstance().generateIdentity( onResult: (GenerateIdentityResult) -> Unit ) ``` -UID2 Identity を設定します ([Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server#configure-the-uid2-mobile-sdk) を参照): +UID2 Identity を設定します ([Client-server integration guide for mobile](../guides/integration-mobile-client-server#configure-the-uid2-mobile-sdk) を参照): ```js UID2Manager.getInstance().setIdentity(identity: UID2Identity) @@ -166,7 +166,7 @@ Advertising SDK に渡す UID2 Token (Advertising Token) を取得します: UID2Manager.getInstance().getAdvertisingToken() ``` -## UID2Manager API +## Uid2manager API このセクションには、UID2Manager API の一部である関数と変数が含まれています。 @@ -182,7 +182,7 @@ UID2Manager API の一部として利用可能な関数は次のとおりです: #### generateIdentity() -直接識別情報 (DII) を使用して UID2 Identity を生成します。手順は、*Client-Side Integration Guide for Mobile* の [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md#configure-the-uid2-mobile-sdk) を参照してください。 +直接識別情報 (DII) を使用して UID2 Identity を生成します。手順は、*Client-Side Integration Guide for Mobile* の [Client-side integration guide for mobile](../guides/integration-mobile-client-side.md#configure-the-uid2-mobile-sdk) を参照してください。 #### setIdentity() diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-cplusplus.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-cplusplus.md index 59f96c133..6c8e1a4e3 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-cplusplus.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-cplusplus.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for C++ Reference Guide +# SDK for C++ reference guide UID2 Server-Side SDK を使用すると、UID2 Token を復号化して raw UID2 にアクセスしやすくなります。 @@ -24,17 +24,17 @@ UID2 Server-Side SDK を使用すると、UID2 Token を復号化して raw UID2 | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | — | — | — | — | -## UID2 Account Setup +## UID2 account setup -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -## API Permissions +## API permissions -アカウントの初期設定が完了すると、パブリッシャー、広告主、またはデータプロバイダーの場合、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: +アカウントの初期設定が完了すると、パブリッシャー、広告主、またはデータプロバイダーの場合、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: - アカウント用の [credentials](../getting-started/gs-credentials.md) を生成します。 - オプションとして、チームメンバーに関する情報を設定するなど、他の値を設定します。 -SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。SDK には使用権限がない機能がある可能性があることに注意してください。詳細は、[API Permissions](../getting-started/gs-permissions.md) を参照してください。 +SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。SDK には使用権限がない機能がある可能性があることに注意してください。詳細は、[API permissions](../getting-started/gs-permissions.md) を参照してください。 DSP の場合は、資格情報を送信します。 @@ -42,7 +42,7 @@ DSP の場合は、資格情報を送信します。 この SDK には C++ version 11 が必要です。 -## GitHub Repository/Binary +## Github repository/binary この SDK は以下のオープンソースの GitHub リポジトリにあります: @@ -59,7 +59,7 @@ Release tags は以下の GitHub で入手できますが、バイナリーは | Parameter | Description | Recommended Value | | :--- | :--- | :--- | | `endpoint` | UID2 Service のエンドポイント。 | N/A | -| `authKey` | クライアントに付与された認証トークン。UID2 へのアクセスは [Contact Info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 | N/A | +| `authKey` | クライアントに付与された認証トークン。UID2 へのアクセスは [Contact info](../getting-started/gs-account-setup.md#contact-info) を参照してください。 | N/A | ## Interface @@ -69,7 +69,7 @@ Release tags は以下の GitHub で入手できますが、バイナリーは SDK を使用する際に、復号鍵を保存したり管理したりする必要はありません。 ::: -DSP の場合は、入札のために UID2 Advertising Token を復号化して UID2 を返すインターフェースを呼び出します。ユーザーのオプトアウトを処理する入札ロジックの詳細は [DSP Integration Guide](../guides/dsp-guide.md) を参照してください。 +DSP の場合は、入札のために UID2 Advertising Token を復号化して UID2 を返すインターフェースを呼び出します。ユーザーのオプトアウトを処理する入札ロジックの詳細は [DSP integration guide](../guides/dsp-guide.md) を参照してください。 以下は、C++ での decrypt メソッド呼び出しです: @@ -82,17 +82,17 @@ client->Refresh(); //Note that Refresh() should be called once after create(), a const auto result = client->Decrypt(adToken); ``` -### Response Content +### Response content SDK から返される利用可能な情報の概要を次の表に示します。 | Function | Description | | :--- | :--- | -| `GetStatus()` | 復号結果のステータス。指定可能な値の一覧と定義は、[Response Statuses](#response-statuses) を参照してください。 | +| `GetStatus()` | 復号結果のステータス。指定可能な値の一覧と定義は、[Response statuses](#response-statuses) を参照してください。 | | `GetUid()` | UID2 Advertising Token に対応する raw UID2。 | | `GetEstablished()` | ユーザーがパブリッシャーと最初に UID2 を確立した時を示すタイムスタンプ。 | -### Response Statuses +### Response statuses | Value | Description | | :--- | :--- | @@ -104,14 +104,14 @@ SDK から返される利用可能な情報の概要を次の表に示します | `KeysNotSynced` | クライアントは UID2 Service からの鍵の同期に失敗しました。| | `VersionNotSupported` | クライアントライブラリが暗号化トークンのバージョンをサポートしていません。| -## Usage for UID2 Sharers +## Usage for UID2 sharers UID2 Sharing Participant は、送信者または受信者として共有に参加し、他の参加者と UID2 を共有する企業です。 -広告主やデータプロバイダは、この SDK を使用して他の認証された UID2 共有参加者と UID2 を共有できます (Tokenized Sharing)。彼らは [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) を UID2 tokens に暗号化し、それを他の参加者に送信して共有できます (詳細は [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。データをピクセルで送信していない場合でも、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md) で示されている要件に従えば、UID2 共有に参加できます。 +広告主やデータプロバイダは、この SDK を使用して他の認証された UID2 共有参加者と UID2 を共有できます (Tokenized Sharing)。彼らは [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) を UID2 tokens に暗号化し、それを他の参加者に送信して共有できます (詳細は [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。データをピクセルで送信していない場合でも、[Security requirements for UID2 sharing](../sharing/sharing-security.md) で示されている要件に従えば、UID2 共有に参加できます。 :::important -このプロセスで生成される UID2 Token は共有専用です—ビッドストリームでは使用できません。ビッドストリーム用のトークン生成には別のワークフローがあります: [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 +このプロセスで生成される UID2 Token は共有専用です—ビッドストリームでは使用できません。ビッドストリーム用のトークン生成には別のワークフローがあります: [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 ::: 使用例は [com.uid2.client.test.IntegrationExamples](https://github.com/IABTechLab/uid2-client-java/blob/master/src/test/java/com/uid2/client/test/IntegrationExamples.java) (`runSharingExample` メソッド) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-csharp-dotnet.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-csharp-dotnet.md index 02883cc12..22e9530d1 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-csharp-dotnet.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-csharp-dotnet.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for C# / .NET Reference Guide +# SDK for C# / .NET reference guide Server-Side では、C# / .NET SDK を使用して、raw UID2 を暗号化して UID2 Token を生成し、UID2 Token を復号して raw UID2 にアクセスすることができます。 @@ -24,17 +24,17 @@ Server-Side では、C# / .NET SDK を使用して、raw UID2 を暗号化して | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | — | — | — | — | -## UID2 Account Setup +## UID2 account setup -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -## API Permissions +## API permissions -アカウントの初期設定が完了すると、パブリッシャー、広告主、またはデータプロバイダーの場合、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: +アカウントの初期設定が完了すると、パブリッシャー、広告主、またはデータプロバイダーの場合、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: - アカウント用の [credentials](../getting-started/gs-credentials.md) を生成します。 - オプションとして、チームメンバーに関する情報を設定するなど、他の値を設定します。 -SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。SDK には使用権限がない機能がある可能性があることに注意してください。詳細は、[API Permissions](../getting-started/gs-permissions.md) を参照してください。 +SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。SDK には使用権限がない機能がある可能性があることに注意してください。詳細は、[API permissions](../getting-started/gs-permissions.md) を参照してください。 DSP の場合は、資格情報を送信します。 @@ -42,7 +42,7 @@ DSP の場合は、資格情報を送信します。 このライブラリは、.NET Standard 2.1. のユニットテストを使用しています。サンプルアプリは .NET 5.0 を使用しています。 -## GitHub Repository/Binary +## Github repository/binary この SDK は以下のオープンソースの GitHub リポジトリにあります: @@ -61,14 +61,14 @@ SDK が UID2 Service で認証するために必要な値を提供する必要 | Parameter | Description | | :--- | :--- | | `endpoint` | UID2 Service のエンドポイント。[Environments](../getting-started/gs-environments) を参照してください。 | -| `authKey` | API Key。[UID2 Credentials](../getting-started/gs-credentials) を参照してください | -| `secretKey` | Client Secret 。[UID2 Credentials](../getting-started/gs-credentials) を参照してください。 | +| `authKey` | API Key。[UID2 credentials](../getting-started/gs-credentials) を参照してください | +| `secretKey` | Client Secret 。[UID2 credentials](../getting-started/gs-credentials) を参照してください。 | ## Interface `BidstreamClient` クラスを使用すると、UID2 Token を raw UID2 に復号することができます。 -ユーザーのオプトアウトを処理する入札ロジックの詳細は [DSP Integration Guide](../guides/dsp-guide.md) を参照してください。 +ユーザーのオプトアウトを処理する入札ロジックの詳細は [DSP integration guide](../guides/dsp-guide.md) を参照してください。 `SharingClient` クラスを使うと、raw UID2 を暗号化して UID2 Token に変換したり、UID2 Token を復号してraw UID2 に変換したりすることができます。 @@ -76,16 +76,16 @@ SDK が UID2 Service で認証するために必要な値を提供する必要 SDK を使用する場合、復号鍵を保存したり管理したりする必要はありません。 ::: -### Encryption Response Content +### Encryption response content `SharingClient`で暗号化する場合、SDKは以下の情報を返します： | Property | Description | | :--- | :--- | -| `Status` | 暗号化結果のステータス。取り得る値のリストと定義は [Encryption Response Statuses](#encryption-response-statuses) を参照してください。 | +| `Status` | 暗号化結果のステータス。取り得る値のリストと定義は [Encryption response statuses](#encryption-response-statuses) を参照してください。 | | `EncryptedData` | 暗号化された UID2 Token。 | -### Encryption Response Statuses +### Encryption response statuses | Value | Description | | :--- | :--- | @@ -98,17 +98,17 @@ SDK を使用する場合、復号鍵を保存したり管理したりする必 | `EncryptionFailure` | 一般的な暗号化に失敗しました。 | -### Decryption Response Content +### Decryption response content `BidstreamClient`、`SharingClient` いずれでも、SDK は以下の情報を返します: | Property | Description | | :--- | :--- | -| `Status` | 復号結果のステータス。取り得る値のリストと定義は [Decryption Response Statuses](#decryption-response-statuses) を参照してください。 | +| `Status` | 復号結果のステータス。取り得る値のリストと定義は [Decryption response statuses](#decryption-response-statuses) を参照してください。 | | `Uid` | UID2 Token に対応する raw UID2。 | | `Established` | ユーザーがパブリッシャーと最初に UID2 を確立した時のタイムスタンプ。 | -### Decryption Response Statuses +### Decryption response statuses | Value | Description | | :--- | :--- | @@ -157,14 +157,14 @@ else 完全な例は、[SampleApp/Program.cs](https://github.com/IABTechLab/uid2-client-net/blob/main/src/SampleApp/Program.cs) の `ExampleBidStreamClient` メソッドを参照してください。 -## Usage for UID2 Sharers +## Usage for UID2 sharers UID2 Sharing Participant は、送信者または受信者として共有に参加し、他の参加者と UID2 を共有する企業です。 -広告主やデータプロバイダは、この SDK を使用して他の認証された UID2 共有参加者と UID2 を共有できます (Tokenized Sharing)。彼らは [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) を UID2 tokens に暗号化し、それを他の参加者に送信して共有できます (詳細は [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。データをピクセルで送信していない場合でも、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md) で示されている要件に従えば、UID2 共有に参加できます。 +広告主やデータプロバイダは、この SDK を使用して他の認証された UID2 共有参加者と UID2 を共有できます (Tokenized Sharing)。彼らは [raw UID2s](../ref-info/glossary-uid#gl-raw-uid2) を UID2 tokens に暗号化し、それを他の参加者に送信して共有できます (詳細は [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。データをピクセルで送信していない場合でも、[Security requirements for UID2 sharing](../sharing/sharing-security.md) で示されている要件に従えば、UID2 共有に参加できます。 :::important -このプロセスで生成される UID2 Token は共有専用です—ビッドストリームでは使用できません。ビッドストリーム用のトークン生成には別のワークフローがあります: [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 +このプロセスで生成される UID2 Token は共有専用です—ビッドストリームでは使用できません。ビッドストリーム用のトークン生成には別のワークフローがあります: [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 ::: 以下は、SDK for C# / .NET を使用して、送信側または受信側として共有を実装する方法の例です。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-ios.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-ios.md index ae2196790..9ea7e8c66 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-ios.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-ios.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for iOS Reference Guide +# SDK for iOS reference guide iOS SDK を使用すると、UID2 を使用したクライアント ID の生成または確立、bidstream 用の Advertising Token の取得、および UID2 Token の自動リフレッシュを容易に行うことができます。 @@ -16,11 +16,11 @@ iOS SDK を使用すると、UID2 を使用したクライアント ID の生成 | Purpose | Product/Documentation | | :--- | :--- | -| Google Mobile Ads (GMA) SDK を使用して iOS/tvOS アプリから広告リクエストで [secure signals](https://support.google.com/admob/answer/11556288) として UID2 Token を送信する | [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios.md) | -| Google Interactive Media Ads SDK for iOS を使用して iOS/tvOS アプリから広告リクエストで [secure signals](https://support.google.com/admob/answer/11556288) として UID2 Token を送信する | [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios.md) | +| Google Mobile Ads (GMA) SDK を使用して iOS/tvOS アプリから広告リクエストで [secure signals](https://support.google.com/admob/answer/11556288) として UID2 Token を送信する | [UID2 GMA plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | +| Google Interactive Media Ads SDK for iOS を使用して iOS/tvOS アプリから広告リクエストで [secure signals](https://support.google.com/admob/answer/11556288) として UID2 Token を送信する | [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | ## tvOS Support -このページは iOS 用 SDK について説明していますが、この SDK は tvOS もサポートしています。必要な tvOS バージョンについては、[Minimum Requirements](#minimum-requirements) を参照してください。 +このページは iOS 用 SDK について説明していますが、この SDK は tvOS もサポートしています。必要な tvOS バージョンについては、[Minimum requirements](#minimum-requirements) を参照してください。 ## Functionality @@ -34,22 +34,22 @@ SDK for iOS は、iOS アプリケーションに代わって UID2 ID を生成 デフォルトでは、SDK は有効期限に基づいて UID2 ID を自動的にリフレッシュします。ただし、これを無効にして、アプリが UID2 IDのライフサイクルを手動で管理できるように実装することもできます。 -## UID2 Account Setup +## UID2 account setup -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -## API Permissions +## API permissions -初期アカウント設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: +初期アカウント設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: - アカウント用の [credentials](../getting-started/gs-credentials.md) を生成します。 - オプション: Client-Side の実装の場合、ドメイン名やモバイルアプリ ID などの設定値を設定します。 - オプションとして、チームメンバーに関する情報を設定するなど、他の値を設定します。 -UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。モバイルインテグレーションのオプションの概要は、[Client-Side, Client-Server, or Server-Side Integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 +UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、Server-Side のいずれであるかによって異なります。モバイルインテグレーションのオプションの概要は、[Client-side, client-server, or server-side integration?](../guides/integration-mobile-overview#client-side-client-server-or-server-side-integration) を参照してください。 -## SDK Version +## SDK version @@ -57,13 +57,13 @@ UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、S リリースノートの情報は、[https://github.com/IABTechLab/uid2-ios-sdk/releases](https://github.com/IABTechLab/uid2-ios-sdk/releases) を参照してください。 -## GitHub Open-Source Repository +## Github open-source repository この SDK は以下のオープンソースの GitHub リポジトリにあります: - [https://github.com/IABTechLab/uid2-ios-sdk](https://github.com/IABTechLab/uid2-ios-sdk) -## Minimum Requirements +## Minimum requirements この SDK の最小要件は以下の通りです: @@ -80,11 +80,11 @@ UID2 Portal で実行する手順は、実装が Client-Side、Client-Server、S Swift Package Manager (SPM) を使って iOS SDK をインストールします。2つのインストールオプションがあります: -- [Package.swift](#installing-with-packageswift) +- [Package.Swift](#installing-with-packageswift) - [Xcode](#installing-with-xcode) -- [CocoaPods](#installing-with-cocoapods) +- [Cocoapods](#installing-with-cocoapods) -### Installing with Package.swift +### Installing with package.Swift Package.swift に次の依存関係を追加します: @@ -94,7 +94,7 @@ dependencies: [ ] ``` -### Installing with Xcode +### Installing with xcode アプリの Package Dependencies に次のエントリを追加します: @@ -102,7 +102,7 @@ dependencies: [ | :--- | :--- | :--- | | 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 +### Installing with cocoapods `Podfile` に次のエントリを追加します: @@ -110,7 +110,7 @@ dependencies: [ pod 'UID2', '~> 2.0' ``` -## Usage Guidelines +## Usage guidelines **UID2Manager** シングルトンは、SDK for iOS の主要な開発者 API です。UID2 Token を含む UID2 Identity の保存、リフレッシュ、取得を行います。 @@ -118,18 +118,18 @@ iOS の場合、`UID2Manager` は初めてアクセスされたときに自動 UID2 Identity を確立する方法は2つあります: -1. DII を使用して UID2 ID を生成します—メール (ハッシュ化または非ハッシュ化) または電話番号 (ハッシュ化または非ハッシュ化) を使用します。インテグレーション手順は、[Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md) を参照してください。 +1. DII を使用して UID2 ID を生成します—メール (ハッシュ化または非ハッシュ化) または電話番号 (ハッシュ化または非ハッシュ化) を使用します。インテグレーション手順は、[Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) を参照してください。 -2. Server-Side で UID2 ID を生成し、それを UID2 SDK に渡します。インテグレーション手順は、[Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md) を参照してください。 +2. Server-Side で UID2 ID を生成し、それを UID2 SDK に渡します。インテグレーション手順は、[Client-server integration guide for mobile](../guides/integration-mobile-client-server.md) を参照してください。 UID2 Mobile SDK は、UID2 identifier が確立された後に UID2 identities をリフレッシュできます。これは、リフレッシュ機能が UID2 Identity の一部である Refresh Token に依存しているためです。 -## Code Samples +## Code samples 以下のコードサンプルは、iOS SDK を使用して UID2 を管理する特定のアクティビティを実行する例を示します。 -初期の UID2 Identity を生成します (手順は、[Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side#configure-the-uid2-mobile-sdk) を参照): +初期の UID2 Identity を生成します (手順は、[Client-side integration guide for mobile](../guides/integration-mobile-client-side#configure-the-uid2-mobile-sdk) を参照): ```js UID2Manager.shared.generateIdentity( @@ -139,7 +139,7 @@ UID2Manager.shared.generateIdentity( appName: String? = nil ) ``` -初期 UID2 Identity を設定します (手順は、[Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server#configure-the-uid2-mobile-sdk) を参照): +初期 UID2 Identity を設定します (手順は、[Client-server integration guide for mobile](../guides/integration-mobile-client-server#configure-the-uid2-mobile-sdk) を参照): ``` javascript UID2Manager.shared.setIdentity(_ identity: UID2Identity) @@ -151,7 +151,7 @@ Advertising SDK (広告リクエストまたはビッドストリーム使用) UID2Manager.shared.getAdvertisingToken() ``` -## UID2Manager API +## Uid2manager API このセクションには、UID2Manager APIの一部である関数と変数が含まれています。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-java.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-java.md index d7c31b84f..d19f2da45 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-java.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-java.md @@ -9,7 +9,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; import SnptPOSTIdentityMapImprovements from '../snippets/_snpt-post-identity-map-improvements-v3.mdx'; -# SDK for Java Reference Guide +# SDK for Java reference guide Server-Side で Java SDK を使用すると、UID2 を使用してクライアント ID を生成または確立し、ビッドストリームで使用する Advertising Token を取得し、UID2 Token を自動的にリフレッシュするプロセスを簡素化できます。適用可能な権限がある場合、共有のために暗号化および復号化し、DII を raw UID2 にマップすることもできます。 @@ -21,17 +21,17 @@ Server-Side で Java SDK を使用すると、UID2 を使用してクライア | :--- | :--- | :--- | :--- | :--- | :--- | | ✅ | ✅ | ✅ | ✅ | ✅ | — | -## UID2 Account Setup +## UID2 account setup -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、最初に [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、最初に [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -## API Permissions +## API permissions -アカウントの初期設定が完了すると、パブリッシャー、広告主、またはデータプロバイダーの場合、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: +アカウントの初期設定が完了すると、パブリッシャー、広告主、またはデータプロバイダーの場合、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: - アカウント用の [credentials](../getting-started/gs-credentials.md) を生成します。 - オプションとして、チームメンバーに関する情報を設定するなど、他の値を設定します。 -SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。SDK には使用権限がない機能がある可能性があることに注意してください。詳細は、[API Permissions](../getting-started/gs-permissions.md) を参照してください。 +SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。SDK には使用権限がない機能がある可能性があることに注意してください。詳細は、[API permissions](../getting-started/gs-permissions.md) を参照してください。 DSP の場合は、資格情報を送信します。 @@ -39,7 +39,7 @@ DSP の場合は、資格情報を送信します。 この SDK には Java version 1.8 以降が必要です。 -## GitHub Repository/Binary +## Github repository/binary この SDK は以下のオープンソースの GitHub リポジトリにあります: @@ -55,24 +55,24 @@ DSP の場合は、資格情報を送信します。 | Role | Create Instance of Class | Link to Instructions | | :--- | :--- | :--- | -| Publisher | `PublisherUid2Client` | [Usage for Publishers](#usage-for-publishers) | -| Advertiser/Data Provider | `IdentityMapClient` | [Usage for Advertisers/Data Providers](#usage-for-advertisersdata-providers) | +| Publisher | `PublisherUid2Client` | [Usage for publishers](#usage-for-publishers) | +| Advertiser/Data Provider | `IdentityMapClient` | [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) | +| Sharer | `SharingClient` | [Usage for UID2 sharers](#usage-for-uid2-sharers) | SDK が UID2 Service で認証するために必要な値を提供する必要があります。 | Parameter | Description | | :--- | :--- | | `baseUrl/uid2BaseUrl` | The endpoint for the UID2 service. See [Environments](../getting-started/gs-environments). | -| `clientApiKey` | The API key. See [UID2 Credentials](../getting-started/gs-credentials). | -| `base64SecretKey` | The client secret. See [UID2 Credentials](../getting-started/gs-credentials). | +| `clientApiKey` | The API key. See [UID2 credentials](../getting-started/gs-credentials). | +| `base64SecretKey` | The client secret. See [UID2 credentials](../getting-started/gs-credentials). | ### Interface `BidstreamClient` クラスを利用すると UID2 Token を raw UID2 に復号化できます。 -ユーザーのオプトアウトを処理する入札ロジックの詳細は [DSP Integration Guide](../guides/dsp-guide.md) を参照してください。 +ユーザーのオプトアウトを処理する入札ロジックの詳細は [DSP integration guide](../guides/dsp-guide.md) を参照してください。 `SharingClient` クラスを利用すると、raw UID2 を UID2 Token に暗号化し、UID2 Token を raw UID2 に復号化することができます。 @@ -80,16 +80,16 @@ SDK が UID2 Service で認証するために必要な値を提供する必要 SDK を使用する際に、復号鍵を保存したり管理したりする必要はありません。 ::: -### Encryption Response Content +### Encryption response content `SharingClient` クラスで暗号化する場合、SDK は次の表に示す情報を返します。 | Method | Description | | :--- | :--- | -| `getStatus()` | 暗号化結果のステータス。取り得る値のリストと定義は、[Encryption Response Statuses](#encryption-response-statuses) を参照してください。 | +| `getStatus()` | 暗号化結果のステータス。取り得る値のリストと定義は、[Encryption response statuses](#encryption-response-statuses) を参照してください。 | | `getEncryptedData()` | 暗号化された UID2 token。 | -### Encryption Response Statuses +### Encryption response statuses 暗号化レスポンスコードとその意味は次の表の通りです。 @@ -102,17 +102,17 @@ SDK を使用する際に、復号鍵を保存したり管理したりする必 | `KEYS_NOT_SYNCED` | クライアントが UID2 Service との鍵の同期に失敗しました。 | | `ENCRYPTION_FAILURE` | 一般的な暗号化に失敗しました。 | -### Decryption Response Content +### Decryption response content `BidstreamClient` クラスと `SharingClient` クラスのどちらで復号化しても、SDK は次の表に示す情報を返します。 | Methods | Description | | :--- | :--- | -| `getStatus()` | 復号結果のステータス。取り得る値のリストと定義は、[Decryption Response Statuses](#decryption-response-statuses) を参照してください。 | +| `getStatus()` | 復号結果のステータス。取り得る値のリストと定義は、[Decryption response statuses](#decryption-response-statuses) を参照してください。 | | `getUid()` | UID2 Token に対応する raw UID2 | | `getEstablished()` | ユーザーがパブリッシャーと最初に UID2 を確立した時のタイムスタンプ。 | -### Decryption Response Statuses +### Decryption response statuses 復号化レスポンスコードとその意味は次の表の通りです。 @@ -127,15 +127,15 @@ SDK を使用する際に、復号鍵を保存したり管理したりする必 | `VERSION_NOT_SUPPORTED` | クライアントライブラリが暗号化トークンのバージョンをサポートしていません。 | | `INVALID_TOKEN_LIFETIME` | トークンのタイムスタンプが無効です。 | -## Usage for Publishers +## Usage for publishers パブリッシャーとして、SDK for Java を使用するには 2 つの方法があります: -1. [**Basic Usage**](#basic-usage) は、この SDK の HTTP 実装 (synchronous [OkHttp](https://square.github.io/okhttp/)) を使いたいパブリッシャー向けです。 -2. [**Advanced Usage**](#advanced-usage) は、独自の HTTP ライブラリを使用したいパブリッシャー向けです。 +1. [**basic usage**](#basic-usage) は、この SDK の HTTP 実装 (synchronous [OkHttp](https://square.github.io/okhttp/)) を使いたいパブリッシャー向けです。 +2. [**advanced usage**](#advanced-usage) は、独自の HTTP ライブラリを使用したいパブリッシャー向けです。 Basic と Advanced 両方の使い方を示すサンプルアプリケーションは、[Java UID2 Integration Example](https://github.com/UnifiedID2/uid2-examples/tree/main/publisher/uid2-java-test-site#readme) を参照してください。 -### Basic Usage +### Basic usage SDK の HTTP 実装を使用している場合は、以下の手順に従ってください。 @@ -152,9 +152,9 @@ SDK の HTTP 実装を使用している場合は、以下の手順に従って -#### Basic Usage, Client-Server Integration +#### Basic usage, client-server integration -Standard Integration (Client and Server) を使用している場合([Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照)、このステップに従ってください： +Standard Integration (Client and Server) を使用している場合([Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) を参照)、このステップに従ってください： * この ID を JSON 文字列としてクライアントに送り返します ([identity field](../sdks/sdk-ref-javascript.md#initopts-object-void) で使用するため): @@ -166,9 +166,9 @@ Standard Integration (Client and Server) を使用している場合([Client-Ser ユーザーがオプトアウトした場合、このメソッドは `null` を返しますので、必ず処理してください。 ::: -#### Basic Usage, Server-Side Integration +#### Basic usage, server-side integration -Server-Side Integration ([Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md) を参照) を使用している場合は、以下の手順に従ってください: +Server-Side Integration ([Publisher integration guide, server-side](../guides/integration-publisher-server-side.md) を参照) を使用している場合は、以下の手順に従ってください: 1. `tokenGenerateResponse.getIdentityJsonString()` 関数を使用して、この ID をユーザーのセッションに JSON 文字列として格納します。 @@ -208,7 +208,7 @@ Server-Side Integration ([Publisher Integration Guide, Server-Side](../guides/in ユーザーがオプトアウトした場合、このメソッドは `null` を返し、ユーザーの ID をセッションから削除する必要があることを示します。オプトアウトを確認するには、`tokenRefreshResponse.isOptout()` 関数を使用します。 -### Advanced Usage +### Advanced usage 1. インスタンス変数として `PublisherUid2Helper` のインスタンスを作成します: @@ -229,15 +229,15 @@ Server-Side Integration ([Publisher Integration Guide, Server-Side](../guides/in -4. HTTP レスポンスステータスコードが 200 でない場合は、[Response Status Codes](../endpoints/post-token-generate.md#response-status-codes) を参照して次のステップを決定します。そうでない場合は、UID2 ID レスポンスの内容を `TokenGenerateResponse` オブジェクトに変換します: +4. HTTP レスポンスステータスコードが 200 でない場合は、[Response status codes](../endpoints/post-token-generate.md#response-status-codes) を参照して次のステップを決定します。そうでない場合は、UID2 ID レスポンスの内容を `TokenGenerateResponse` オブジェクトに変換します: ```java TokenGenerateResponse tokenGenerateResponse = publisherUid2Helper.createTokenGenerateResponse({response body}, envelope); ``` -#### Advanced Usage, Client-Server Integration +#### Advanced usage, client-server integration -Standard Integration (client and server) を使用している場合 ([Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照)、以下の手順に従ってください: +Standard Integration (client and server) を使用している場合 ([Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) を参照)、以下の手順に従ってください: * この ID を JSON 文字列としてクライアントに送り返します ([identity field](../sdks/sdk-ref-javascript.md#initopts-object-void) で使用するため): @@ -249,9 +249,9 @@ Standard Integration (client and server) を使用している場合 ([Client-Se ユーザーがオプトアウトした場合、このメソッドは `null` を返しますので、必ず処理してください。 ::: -#### Advanced Usage, Server-Side Integration +#### Advanced usage, server-side integration -Server-Side Integration ([Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md) を参照) を使用している場合は、以下の手順に従ってください: +Server-Side Integration ([Publisher integration guide, server-side](../guides/integration-publisher-server-side.md) を参照) を使用している場合は、以下の手順に従ってください: 1. `tokenGenerateResponse.getIdentityJsonString()` を使用して、この ID をユーザーのセッションに JSON 文字列として保存します。 @@ -296,11 +296,11 @@ Server-Side Integration ([Publisher Integration Guide, Server-Side](../guides/in ユーザーがオプトアウトした場合、このメソッドは `null` を返し、ユーザーの ID をセッションから削除する必要があることを示します。オプトアウトを確認するには、`tokenRefreshResponse.isOptout()` 関数を使用します。 -## Usage for Advertisers/Data Providers +## Usage for advertisers/data providers 以下の手順は、最新バージョンの `POST /identity/map` エンドポイントを使用して DII を raw UID2 にマップする方法の例です。 -以前のバージョンを使用する場合は、[Previous SDK Version (using POST /identity/map v2)](#previous-sdk-version-using-post-identitymap-v2) を参照してください。最新バージョンへの移行手順については、[Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map) を参照してください。 +以前のバージョンを使用する場合は、[Previous SDK version (using POST /identity/map v2)](#previous-sdk-version-using-post-identitymap-v2) を参照してください。最新バージョンへの移行手順については、[Migration from version using v2 identity map](#migration-from-version-using-v2-identity-map) を参照してください。 1. IdentityMapClient のインスタンスをインスタンス変数として作成します: ```java @@ -353,7 +353,7 @@ Server-Side Integration ([Publisher Integration Guide, Server-Side](../guides/in raw UID2 は、リフレッシュタイムスタンプの前では変化しません。リフレッシュタイムスタンプの後、DII を再マッピングすると新しいリフレッシュタイムスタンプが返されますが、raw UID2 は変化する場合もあれば変化しない場合もあります。raw UID2 が複数のリフレッシュ間隔にわたって変化しない可能性もあります。 ::: -### Usage Example +### Usage example ```java IdentityMapV3Client client = new IdentityMapV3Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY); @@ -386,19 +386,19 @@ IdentityMapV3Input mixedInput = new IdentityMapV3Input() IdentityMapV3Response mixedResponse = client.generateIdentityMap(mixedInput); ``` -## Migration From Version Using v2 Identity Map +## Migration from version using v2 identity map 以下のセクションでは、この SDK の最新バージョンへの移行に関する一般的な情報とガイダンスを提供します。最新バージョンは `POST /identity/map` バージョン 3 を参照しています: -- [Version 3 Improvements](#version-3-improvements) -- [Required Changes](#required-changes) -- [Recommended Changes](#recommended-changes) +- [Version 3 improvements](#version-3-improvements) +- [Required changes](#required-changes) +- [Recommended changes](#recommended-changes) -### Version 3 Improvements +### Version 3 improvements -### Required Changes +### Required changes アップグレードするには、以下の手順に従ってください: @@ -406,7 +406,7 @@ IdentityMapV3Response mixedResponse = client.generateIdentityMap(mixedInput); 2. [Change client class](#2-change-client-class) 3. [Update import statements](#3-update-import-statements) -#### 1. Update dependency version +#### 1. update dependency version コード内で参照されている依存関係のバージョンを、次の例のように更新します。 @@ -418,7 +418,7 @@ IdentityMapV3Response mixedResponse = client.generateIdentityMap(mixedInput); ``` -#### 2. Change client class +#### 2. change client class コード内で参照されているクライアントクラスを更新します。以下の例を参照してください。 @@ -430,7 +430,7 @@ IdentityMapClient identityMapClient = new IdentityMapClient(UID2_BASE_URL, UID2_ IdentityMapV3Client identityMapClient = new IdentityMapV3Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY); ``` -#### 3. Update import statements +#### 3. update import statements 以下の例のように、インポートステートメントを更新します。 @@ -441,7 +441,7 @@ import com.uid2.client.IdentityMapV3Response; import com.uid2.client.UnmappedIdentityReason; ``` -### Recommended Changes +### Recommended changes 以下の変更は**オプション**ですが、新しい v3 機能を活用できます。[必須の変更](#required-changes) で基本的な機能は十分ですが、これらの推奨される変更により、機能が向上します。 @@ -487,11 +487,11 @@ import com.uid2.client.UnmappedIdentityReason; String rawReason = unmapped.getRawReason(); ``` -## Previous SDK Version (using POST /identity/map v2) +## Previous SDK version (using POST /identity/map v2) :::note 下位互換性のために、`POST /identity/map` v2 エンドポイントを参照する SDK for Java の以前のバージョンも利用可能です。パフォーマンスの向上、複数の ID タイプのサポート、UID ローテーション管理の改善のために、現在の SDK に移行してください。新しいインテグレーションではこのバージョンを使用しないでください。 -詳細は [Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map) を参照してください。 +詳細は [Migration from version using v2 identity map](#migration-from-version-using-v2-identity-map) を参照してください。 ::: 以前のバージョンを使用するには、以下の手順に従ってください。 @@ -561,14 +561,14 @@ else 詳細な例は、[test/IntegrationExamples.java](https://github.com/IABTechLab/uid2-client-java/blob/main/src/test/java/com/uid2/client/test/IntegrationExamples.java) を参照してください。 -## Usage for UID2 Sharers +## Usage for UID2 sharers UID2 共有参加者は、送信者または受信者として共有に参加し、他の参加者と UID2 を共有する企業です。 -広告主およびデータプロバイダーは、この SDK を使用して、他の承認された UID2 共有参加者と UID2 を共有できます (Tokenized Sharing)。彼らは [raw UID2](../ref-info/glossary-uid#gl-raw-uid2) を UID2 Token に暗号化し、それを共有のために別の参加者に送信できます (詳細は [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。ピクセルでデータを送信しない場合は、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md)に記載されている要件に従う限り、UID2 共有に参加できます。 +広告主およびデータプロバイダーは、この SDK を使用して、他の承認された UID2 共有参加者と UID2 を共有できます (Tokenized Sharing)。彼らは [raw UID2](../ref-info/glossary-uid#gl-raw-uid2) を UID2 Token に暗号化し、それを共有のために別の参加者に送信できます (詳細は [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。ピクセルでデータを送信しない場合は、[Security requirements for UID2 sharing](../sharing/sharing-security.md)に記載されている要件に従う限り、UID2 共有に参加できます。 :::important -このプロセスで生成される UID2 Token は共有専用であり、ビッドストリームでは使用できません。ビッドストリーム用のトークンを生成するための別のワークフローがあります: [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md)を参照してください。 +このプロセスで生成される UID2 Token は共有専用であり、ビッドストリームでは使用できません。ビッドストリーム用のトークンを生成するための別のワークフローがあります: [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md)を参照してください。 ::: 以下の手順は、SDK for Java を使用して、送信者または受信者として共有を実装する方法の例を示しています。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v2.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v2.md index e27942ae0..b68f85a21 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v2.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v2.md @@ -10,15 +10,15 @@ import Link from '@docusaurus/Link'; import SnptExampleUid2Cookie from '../snippets/_snpt-example-uid2-cookie.mdx'; import SnptExampleJavaScriptV2Init from '../snippets/_snpt-example-javascript-v2-init.mdx'; -# SDK for JavaScript Reference Guide (v2.x and earlier) +# SDK for JavaScript reference guide (v2.x and earlier) :::important -このドキュメントは、SDK for JavaScript の旧バージョン用です。以前のバージョンを使用している場合は、アップグレードすることを推奨します。移行ガイドを含む [SDK for JavaScript Reference Guide](sdk-ref-javascript.md) を参照してください。 +このドキュメントは、SDK for JavaScript の旧バージョン用です。以前のバージョンを使用している場合は、アップグレードすることを推奨します。移行ガイドを含む [SDK for JavaScript reference guide](sdk-ref-javascript.md) を参照してください。 ::: この SDK を使用して、UID2 を使用してクライアントの ID を確立し、広告トークンを取得するプロセスを容易にします。以下のセクションでは、UID2 を確立するための [workflow](#workflow-overview) について説明し、SDK の [API reference](#api-reference) を提供し、[UID2 cookie format](#uid2-cookie-format) について説明します。 -コンテンツパブリッシャー向けのインテグレーション手順は、[Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照してください。 +コンテンツパブリッシャー向けのインテグレーション手順は、[Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) を参照してください。 ## Functionality @@ -28,19 +28,19 @@ import SnptExampleJavaScriptV2Init from '../snippets/_snpt-example-javascript-v2 | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | — | ✅ | — | — | -## API Permissions +## API permissions -この SDK を使用するには、[Account Setup](../getting-started/gs-account-setup.md) ページの手順に従って、UID2 アカウントの設定を完了する必要があります。 +この SDK を使用するには、[Account setup](../getting-started/gs-account-setup.md) ページの手順に従って、UID2 アカウントの設定を完了する必要があります。 SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。 -詳細は [API Permissions](../getting-started/gs-permissions.md) を参照してください。 +詳細は [API permissions](../getting-started/gs-permissions.md) を参照してください。 -## SDK Version +## SDK version このドキュメントは SDK for JavaScript version 2 用です。 -## GitHub Repository +## Github repository この SDK のソースは、以下のオープンソースの GitHub リポジトリにあります: @@ -52,7 +52,7 @@ SDK が提供する特定の機能を使用する権限が与えられ、その - **ID** とは、[POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントによって返される、UID2 Token、Refresh Token、および Timestamp などの関連値を含む値のパッケージを指します。 - **Advertising Token** は UID2 Token を指します。 -## Include the SDK Script +## Include the SDK script UID2 をターゲティング広告に使用したいすべてのページに、以下の SDK スクリプトを含めます: @@ -60,7 +60,7 @@ UID2 をターゲティング広告に使用したいすべてのページに、 ``` -## Workflow Overview +## Workflow overview SDK を使用して UID2 ID を確立するための Client-Side ワークフローは、以下の Step で構成されます: @@ -70,14 +70,14 @@ SDK を使用して UID2 ID を確立するための Client-Side ワークフロ - ID が利用できない場合、利用できない理由はコールバック関数に渡されるオブジェクトに指定されます。 3. SDK: アイデンティティ [state](#workflow-states-and-transitions) に基づき、SDK は以下の処理を行います: - 有効な ID が利用可能な場合、SDK はその ID が[ファーストパーティクッキー](#uid2-cookie-format) で利用可能であることを保証します。 - - ID が使用できない場合、SDK は ID が更新可能かどうかに基づいて適切なアクションを実行します。詳細は [Workflow States and Transitions](#workflow-states-and-transitions) を参照してください。 + - ID が使用できない場合、SDK は ID が更新可能かどうかに基づいて適切なアクションを実行します。詳細は [Workflow states and transitions](#workflow-states-and-transitions) を参照してください。 4. Publisher: ID の状態に基づいて ID を処理します: - Advertising Token が使用可能な場合は、それを使用してターゲティング広告の要求を開始します。 - Advertising Token が利用可能でない場合は、ターゲティング広告を使用しないか、同意フォームでユーザーを データキャプチャにリダイレクトします。 -Web インテグレーションの詳細は [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照してください。 +Web インテグレーションの詳細は [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) を参照してください。 -### Workflow States and Transitions +### Workflow states and transitions 次の表は、[getAdvertisingToken()](#getadvertisingtoken-string) と [isLoginRequired()](#isloginrequired-boolean) という 2 つの主要な関数が返す値の組み合わせに基づいて、SDK が取り得る 4 つの主要な状態の概要を示し、それぞれの状態において開発者として取ることができる適切なアクションを示しています。 @@ -90,9 +90,9 @@ Web インテグレーションの詳細は [Client-Server Integration Guide for 次の図は、対応する ID の [status values](#identity-status-values) を含む 4 つの状態と、それらの間で可能な遷移を示しています。SDK は各遷移で [callback function](#callback-function) を呼び出します。 -![Client-Side JavaScript SDK Workflow](images/uid2-js-sdk-workflow.png) +![Client-side JavaScript SDK workflow](images/uid2-js-sdk-workflow.png) -### Background Token Auto-Refresh +### Background token auto-refresh SDKの [initialization](#initopts-object-void) の一部として、ID の Token Auto-refresh が設定され、ID の Timestamp または断続的なエラーによるリフレッシュの失敗によってバックグラウンドでトリガーされます。 @@ -106,7 +106,7 @@ Token の Auto-refresh について知っておくべきことは以下のとお - たとえば、ユーザーがオプトアウトした場合などです。
NOTE: ID が一時的に利用できず、自動更新が失敗し続ける場合、コールバックは呼び出されません。この場合、SDK は既存の Advertising Token を使用し続けます。 - [disconnect()](#disconnect-void) 呼び出しはアクティブなタイマーをキャンセルします。 -## API Reference +## API reference Client-Side JavaScript SDK とのやり取りはすべて `UID2` クラスのインスタンスであるグローバルな `__uid2` オブジェクトを介して行われます。以下の JavaScript 関数はすべて `UID2` クラスのメンバです。 @@ -169,7 +169,7 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 | Property | Data Type | Attribute | Description | Default Value | | :--- | :--- | :--- | :--- | :--- | -| `callback` | `function(object): void` | 必須 | 渡された ID を検証した後に SDK が呼び出す関数です。[Callback Function](#callback-function) を参照してください。 | N/A | +| `callback` | `function(object): void` | 必須 | 渡された ID を検証した後に SDK が呼び出す関数です。[Callback function](#callback-function) を参照してください。 | N/A | | `identity` | object | オプション | [POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) 呼び出しが成功したときの `body` プロパティ値です。
[ファーストパーティクッキー](#uid2-cookie-format) からの ID を使用するには、このプロパティを空にしておきます。 | N/A | | `baseUrl` | string | オプション | [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントを呼び出す際に使用する UID2 Operator のカスタム Base URLです。
たとえば: `https://my.operator.com`. | `https://prod.uidapi.com`. | | `refreshRetryPeriod` | number | オプション | 断続的なエラーが発生した場合に、トークンのリフレッシュを再試行する秒数です。 | 5 | @@ -186,21 +186,21 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 | `TypeError` | 以下のいずれかの問題が発生しました:
- 関数がすでに呼び出されています。
- `opts` の値がオブジェクトではありません。
- コールバック関数が指定されていません。
- `callback` の値が関数ではありません。 | | `RangeError` | リフレッシュの再試行期間が 1 未満です。 | -#### Callback Function +#### Callback function `function(object): void` コールバック関数は、初期化が完了したことを示します。これ以降、SDK は確立された ID のリフレッシュに成功した時にコールバックを呼び出します。 -コールバック関数がよばれるタイミングについての詳細は [Background Token Auto-Refresh](#background-token-auto-refresh) を参照してください。 +コールバック関数がよばれるタイミングについての詳細は [Background token auto-refresh](#background-token-auto-refresh) を参照してください。 `object` パラメータは以下のプロパティを含みます。 | Property | Data Type | Description | | :--- | :--- | :--- | | `advertisingToken` | string | ターゲティング広告のために SSP に渡す Token です。トークン/ID が無効または使用できない場合、値は `undefined` になります。 | -| `status` | `UID2.IdentityStatus` enum | ID のステータスを示す数値です。詳細は [Identity Status Values](#identity-status-values) を参照してください。 | +| `status` | `UID2.IdentityStatus` enum | ID のステータスを示す数値です。詳細は [Identity status values](#identity-status-values) を参照してください。 | | `statusText` | string | ID ステータスに関する追加情報です。 | -#### Identity Status Values +#### Identity status values [callback function](#callback-function) は `UID2.IdentityStatus` enum から `status` フィールドの値を数値として返します。`UID2.IdentityStatus[state.status]` を呼び出すことで、対応する文字列に変換することができます。次の表に `status` enum の文字列を示します。 @@ -269,7 +269,7 @@ ID が利用できない場合は、[isLoginRequired()](#isloginrequired-boolean UID2 [POST /token/generate](../endpoints/post-token-generate.md) 呼び出しが必要かどうかを指定します。 -この関数は、[Workflow States and Transitions](#workflow-states-and-transitions) で示したように、ID が見つからない場合の処理に追加のコンテキストを提供することもできます。 +この関数は、[Workflow states and transitions](#workflow-states-and-transitions) で示したように、ID が見つからない場合の処理に追加のコンテキストを提供することもできます。 ```html ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -306,7 +306,7 @@ UID2 [POST /token/generate](../endpoints/post-token-generate.md) 呼び出 この関数は、既存の UID2 オブジェクトを新しいインスタンスで置き換えるような高度なシナリオで使用することを想定しています。たとえば、シングルページのアプリケーションでこれを使用すると、[POST /token/generate](../endpoints/post-token-generate.md) レスポンスでサーバーから新しい ID を受け取った後に、現在の UID2 オブジェクトをクリアして新しいオブジェクトを作成したり初期化したりすることができます。 -## UID2 Cookie Format +## UID2 cookie format SDK はファーストパーティクッキーを使用してユーザーの ID を保存します。 @@ -321,7 +321,7 @@ SDK はファーストパーティクッキーを使用してユーザーの ID | `Path` | `/` | 別の値を使用したい場合は、SDK の初期化時に `cookiePath` [init() parameter](#parameters) を使用して設定することができます。 | | `Domain` | `undefined` | 別の値を使用したい場合は、SDK の初期化時に `cookieDomain` [init() parameter](#parameters) を使用して設定することができます。 | -### Contents Structure +### Contents structure UID2 Cookie の内容は、[POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) レスポンスの `body` プロパティと同じ構造を持つ JSON オブジェクトを、`private` オブジェクトを除いてURI エンコードした文字列表現です。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v3.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v3.md index d8657d21e..f671ec624 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v3.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript-v3.md @@ -24,7 +24,7 @@ export const Deprecated3100 = () => ( Deprecated in version 3.10.0 ); -# SDK for JavaScript Reference Guide (v3) +# SDK for JavaScript reference guide (v3) :::important このドキュメントは、SDK for JavaScript のバージョン 3 用で最新バージョンではありません。このバージョンを使用している場合は、アップグレードを推奨します。移行ガイドが含まれている [SDK for JavaScript リファレンスガイド](sdk-ref-javascript.md) を参照してください。 @@ -35,14 +35,14 @@ export const Deprecated3100 = () => ( 以下のセクションでは、UID2 ID の確立のための高レベルな [ワークフロー](#workflow-overview)、SDK [API リファレンス](#api-reference)、および UID2 [ストレージフォーマット](#uid2-storage-format) を説明します。 :::tip -UID2 Identify Module、または UID2 サポートのある他の製品と Prebid.js を使用している場合、SDK を使用する必要はありません。Prebid.js モジュールがすべてを管理します。詳細は、[UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) を参照してください。 +UID2 Identify Module、または UID2 サポートのある他の製品と Prebid.js を使用している場合、SDK を使用する必要はありません。Prebid.js モジュールがすべてを管理します。詳細は、[UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) を参照してください。 ::: このページでは、SDK のバージョン 3 について説明します。以前のバージョンを使用している場合は、[移行ガイド](#migration-guide) を使用してインテグレーションをアップグレードすることを推奨します。必要に応じて、[SDK の以前のバージョン](./sdk-ref-javascript-v2.md) のドキュメントも利用できます。 コンテンツパブリッシャー向けのインテグレーション手順は、以下のガイドを参照してください: - - [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) - - [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) + - [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) + - [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) ## Functionality @@ -52,30 +52,30 @@ UID2 Identify Module、または UID2 サポートのある他の製品と Prebi | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | ✅ | ✅ | — | — | -## UID2 Account Setup +## UID2 account setup -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページに記載されている手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページに記載されている手順に従ってください。 -## API Permissions +## API permissions -アカウントの初期設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが提供されます。以下の操作を行うことができます: +アカウントの初期設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが提供されます。以下の操作を行うことができます: - アカウントの [credentials](../getting-started/gs-credentials.md) を生成します。 - オプション: Client-Side の実装では、ドメイン名などの設定値を設定します。 - オプションで、チームメンバーに関する情報の設定など、他の値を設定します。 SDK が提供する特定の機能の使用権限が付与され、そのアクセスに必要な資格情報が提供されます。 -## SDK Version +## SDK version このドキュメントは SDK for JavaScript version 3 用です。 -## GitHub Repository +## Github repository この SDK のソースは、以下のオープンソースの GitHub リポジトリにあります: - [https://github.com/iabtechlab/uid2-web-integrations](https://github.com/iabtechlab/uid2-web-integrations) -## SDK Distribution +## SDK distribution この SDK は、以下のロケーションに公開されています: @@ -98,10 +98,10 @@ SDK が提供する特定の機能の使用権限が付与され、そのアク このドキュメントでは、以下の用語が使われます: - **ID** とは、[POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントによって返される、UID2 Token、Refresh Token、および Timestamp などの関連値を含む値のパッケージを指します。 - **Advertising Token** は UID2 Token を指します。 -- **Callback function**は、本 SDK の現在のバージョン用に構築され、[Array Push Pattern](#array-push-pattern) を使用して登録されたコールバック関数を指します。 +- **Callback function**は、本 SDK の現在のバージョン用に構築され、[Array push pattern](#array-push-pattern) を使用して登録されたコールバック関数を指します。 - **Legacy callback function** は、この SDK のバージョン 1.x または 2.x 用に構築され、`init` の呼び出しで登録されたコールバック関数を指します。 -## Include the SDK Script +## Include the SDK script UID2 をターゲティング広告に使用したいすべてのページに、以下の SDK スクリプトを含めます: @@ -109,7 +109,7 @@ UID2 をターゲティング広告に使用したいすべてのページに、 ``` -### Async or Defer Loading the SDK Script +### Async or defer loading the SDK script Version 3 以降の SDK は、`async` または `defer` スクリプトローディングとともに使用することができます。 @@ -126,11 +126,11 @@ Version 3 以降の SDK は、`async` または `defer` スクリプトローデ ``` -## Workflow Overview +## Workflow overview SDK を使用して UID2 ID を確立するための Client-Side ワークフローは、以下の Step で構成されます: -1. [Array Push Pattern](#array-push-pattern) を使ってコールバック関数を登録します。 +1. [Array push pattern](#array-push-pattern) を使ってコールバック関数を登録します。 2. コールバックが `SdkLoaded` イベントを受信したら、[init](#initopts-object-void) 関数を使用して SDK を初期化します。 3. イベントリスナーが `InitCompleted` イベントを受信するのを待ちます。イベントデータは ID が利用可能かどうかを示します: - ID が利用可能な場合、その ID がイベントペイロードに返されます。SDK は [background token auto-refresh](#background-token-auto-refresh) を設定します。 @@ -142,9 +142,9 @@ SDK を使用して UID2 ID を確立するための Client-Side ワークフロ - Advertising Token が利用可能な場合、それを使用してターゲティング広告のリクエストを開始します。 - Advertising Token が利用可能でない場合は、ターゲティング広告を使用しないか、同意フォームでユーザーをデータキャプチャにリダイレクトします。 -より詳細な Web インテグレーションの手順は、[Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照してください。 +より詳細な Web インテグレーションの手順は、[Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) を参照してください。 -### Background Token Auto-Refresh +### Background token auto-refresh SDKの [initialization](#initopts-object-void) の一部として、ID の Token Auto-refresh が設定され、ID の Timestamp または断続的なエラーによるリフレッシュの失敗によってバックグラウンドでトリガーされます。 @@ -157,9 +157,9 @@ Token の Auto-refresh について知っておくべきことは以下のとお - ユーザがオプトアウトした場合など、IDが無効になった場合。
NOTE: ID が一時的に使用できなくなり、自動リフレッシュに失敗し続けた場合、コールバックは呼び出されません。この場合、SDK は有効期限が切れていない限り、既存の Advertising Token を使用し続けます。 - [disconnect()](#disconnect-void) 呼び出しはアクティブなタイマーをキャンセルします。 -### Callback Function +### Callback function -[Array Push Pattern](#array-push-pattern) を使用して、UID2 SDK からイベントを受信する関数を登録できます。現在利用可能なイベントはいくつかあります: +[Array push pattern](#array-push-pattern) を使用して、UID2 SDK からイベントを受信する関数を登録できます。現在利用可能なイベントはいくつかあります: - `SdkLoaded` は SDK がパースされ、グローバルな `__uid2` オブジェクトが構築された後に発生します。これは `init()` を呼び出す際に便利で、特にスクリプトのロード順序が保証されていない場合に便利です (例えば、スクリプトのロードに `async` や `defer` を使用している場合など)。 - `init()` が終了し、SDK を使用できる状態になると `InitCompleted` が発生します。`init` 呼び出しで ID が提供された場合、または SDK が以前に提供された ID をロードできた場合、その ID がペイロードに含まれます。 - `IdentityUpdated` は、新しいIDが利用可能になるか、既存の ID が利用できなくなるたびに発生します。 @@ -168,7 +168,7 @@ Token の Auto-refresh について知っておくべきことは以下のとお コールバック関数はいくつでも用意でき、どこからでも登録できます。これにより、サイトにとって意味のある方法でコードを分割することができます。 ::: -#### Callback Function Signature +#### Callback function signature コールバック関数は、イベントタイプとペイロードの2つのパラメータを受け取る必要があります。ペイロードのタイプはイベントのタイプにより異なります。 @@ -213,7 +213,7 @@ Token の Auto-refresh について知っておくべきことは以下のとお -#### Event Types and Payload Details +#### Event types and payload details
@@ -227,7 +227,7 @@ Token の Auto-refresh について知っておくべきことは以下のとお `Identity` 型は `init()` を呼び出す時に指定できる ID と同じ型です。 -#### Array Push Pattern +#### Array push pattern 順番にロードされることが保証されていないスクリプトタグ (例えば、`async` や `defer` スクリプトタグを使用している場合など) を最適にサポートするために、コールバックを登録するには以下のパターンを使用します: @@ -242,27 +242,27 @@ window.__uid2.callbacks.push(callbackFunction); - あなたのコードより先に SDK が実行された場合、`__uid2` オブジェクトや `callbacks` 配列は上書きされません。 - このパターンを使用して複数のコールバックが登録された場合、それらは互いに上書きされません。 -### Provide an Identity to the SDK +### Provide an identity to the SDK SDK がローカルストレージまたはクッキーから以前に保存された ID をロードできる場合を除き、SDK に ID を提供する必要があります。これにはいくつかの方法があります: -- [Provide an Identity by Setting a First-Party Cookie](#provide-an-identity-by-setting-a-first-party-cookie) -- [Provide an Identity in the Call to `init`](#provide-an-identity-in-the-call-to-init) -- [Provide an Identity by Calling `setIdentity`](#provide-an-identity-by-calling-setidentity) +- [Provide an identity by setting a first-party cookie](#provide-an-identity-by-setting-a-first-party-cookie) +- [Provide an identity in the call to `init`](#provide-an-identity-in-the-call-to-init) +- [Provide an identity by calling `setidentity`](#provide-an-identity-by-calling-setidentity) -#### Provide an Identity by Setting a First-Party Cookie +#### Provide an identity by setting a first-party cookie [storage format section](#uid2-storage-format) で説明されているように、ファーストパーティクッキーを保存していて、その値がローカルストレージで利用可能な値よりも新しい場合、SDK はその値をクッキーからロードします。もし `useCookie` init オプションを `true` に設定した場合、SDK は常にこの値をロードし、ローカルストレージをチェックしません。[init parameters](#init-parameters) を使用して、クッキーに関することを制御できます。 -#### Provide an Identity in the Call to `init` +#### Provide an identity in the call to `init` [`init`](#initopts-object-void) を呼び出す時に、新しい ID を指定できます。 -#### Provide an Identity by Calling `setIdentity` +#### Provide an identity by calling `setidentity` -`init` が完了したら、いつでも [`setIdentity`](#setidentityidentity-identity-void) を呼び出して、SDK に新しい ID を渡すことができます。 +`init` が完了したら、いつでも [`setidentity`](#setidentityidentity-identity-void) を呼び出して、SDK に新しい ID を渡すことができます。 -## API Reference +## API reference SDK for JavaScript とのすべてのインストラクションは、グローバルな `__uid2` オブジェクトを介して行われます。このオブジェクトは `UID2` クラスのインスタンスであり、以下の JavaScript 関数はすべて `UID2` クラスのメンバーです: @@ -293,11 +293,11 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 この関数について知っておくべきことは以下のとおりです: -- `init()` は SDK がロードされた後であれば、いつでも呼び出すことができます。これを行うには、[Array Push Pattern](#array-push-pattern) を使用して `SdkLoaded` イベントを処理するコールバック関数を登録することを推奨します。このパターンを使うことで、スクリプトのロード順序に関係なくコードが動作し、スクリプトタグで `async` や `defer` を使っても UID2 SDK のエラーが発生しないようにすることができます。 +- `init()` は SDK がロードされた後であれば、いつでも呼び出すことができます。これを行うには、[Array push pattern](#array-push-pattern) を使用して `SdkLoaded` イベントを処理するコールバック関数を登録することを推奨します。このパターンを使うことで、スクリプトのロード順序に関係なくコードが動作し、スクリプトタグで `async` や `defer` を使っても UID2 SDK のエラーが発生しないようにすることができます。 - `init()` 呼び出しの `identity` プロパティは、[POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) 呼び出しが成功したときに返されるレスポンス JSON オブジェクトの `body` プロパティを参照します。Server-side のインテグレーションで常に現在のトークンを使用できるようにしていて、JavaScript を使用して ID を提供するほうが便利な場合は、この方法を使用するとよいでしょう。 - `init()` 呼び出しの `identity` プロパティが不正な場合、SDK はローカルストレージまたはクッキーから ID をロードしようとします。 - `init()` が完了すると、すべてのコールバックは `InitCompleted` イベントを受信します。このイベントのペイロードの `identity` プロパティが null の場合、ID をロードできなかったことになるので、[provide an identity to the SDK](#provide-an-identity-to-the-sdk) する必要があります。これは、Server-side のインテグレーションによって常に現在の ID が利用可能であることが保証されておらず、必要な場合にのみサーバーから ID を要求する必要がある場合に推奨される ID の提供方法です。 - - 渡された UID2 情報をセッションに保存するためにファーストパーティクッキー ([UID2 Storage Format](#uid2-storage-format) を参照) を使用している場合、異なるドメインのページから `init()` を呼び出すと、そのクッキーにアクセスできないことがあります。`cookieDomain` オプションと `cookiePath` オプションで、クッキーに使用する設定を調整することができます。 + - 渡された UID2 情報をセッションに保存するためにファーストパーティクッキー ([UID2 storage format](#uid2-storage-format) を参照) を使用している場合、異なるドメインのページから `init()` を呼び出すと、そのクッキーにアクセスできないことがあります。`cookieDomain` オプションと `cookiePath` オプションで、クッキーに使用する設定を調整することができます。 - 特定の動作を調整するために、初期化呼び出しにはオプションの設定 [init prarmeters](#init-parameters) を含めることができます。 以下は、Server-side で生成された ID を含むコールバックを使った `init()` 呼び出しの例です。 @@ -318,7 +318,7 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 ``` -#### Init Parameters +#### Init parameters `opts` オブジェクトは、以下のプロパティをサポートしています。 @@ -332,24 +332,24 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 | `useCookie` | `boolean` | オプション | この値を `true` に設定すると、SDK はローカルストレージではなくクッキーに ID を保存します。この値がfalseであるか、提供されていない場合でも、ファーストパーティクッキーを使用して ID を提供することができます。 | | `callback` | `function(object): void` | 非推奨 | 渡された ID を検証した後に SDK が呼び出す関数です。新しいインテグレーションには使用しないでください。 | N/A | -#### Multiple Init Calls +#### Multiple init calls `init()` 関数は何度でも呼び出すことができます。ほとんどの場合、特定の [init parameter](#init-parameters) の最新の値を受け入れます。例えば、`baseUrl` が 2 回呼び出され、それぞれ異なる `baseUrl` が渡された場合、`baseUrl` 変数は 2 回目の呼び出しからの値に更新されます。 この機能には 2 つの例外があります: 1. 新しい identity が提供され、新しい identity が現在の identity よりも早く失効する場合、新しい identity は現在の identity を置き換えません。 -2. 移行、渡されたコールバック関数のすべてに対し、[Array Push Pattern](#array-push-pattern) を使用して既存のコールバック配列に関数が追加されます。 +2. 移行、渡されたコールバック関数のすべてに対し、[Array push pattern](#array-push-pattern) を使用して既存のコールバック配列に関数が追加されます。 :::note `useCookie` が更新されると、identity の場所が変わります。例えば、値が `true` から `false` に更新されると、ファーストパーティクッキーが削除され、identity がローカルストレージに追加されます。 ::: -### Init Config +### Init config `init()` を呼び出すと、初期設定がファーストパーティクッキーまたはローカルストレージに保存されます。この設定には、`baseUrl`、`useCookie`、`refreshRetryPeriod`、`cookiePath`、`cookieDomain` が含まれる場合があります。この設定は [bootstrap init](#self-bootstrap) に使用され、その後のページロードでの読み込み時間を短縮します。`init()` に対する後続の呼び出しは、最新のパラメータで設定を更新します。 -### Self Bootstrap +### Self bootstrap コンストラクタが完了し、SDK が window オブジェクトに配置されると、コードはローカルストレージとクッキーストレージをチェックして、保存された [init config](#init-config) を取得します。Condig が存在する場合、`init()` は自動的にその config のパラメータで呼び出され、その結果、`init()` が必要な関数を使用できるようになります。 @@ -362,11 +362,11 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 | `TypeError` | 次のいずれかの問題が発生しました:
  • `opts` の値がオブジェクトではありません。
  • レガシーコールバックが提供されているが、関数ではありません。
  • `refreshRetryPeriod` が提供されているが、数値ではありません。
| | `RangeError` | リフレッシュの再試行期間が 1000 未満である。 | -#### Legacy Callback Function +#### Legacy callback function -これは後方互換性のためだけに提供されています。新しいインテグレーションでは、新しいスタイルの [callback function](#callback-function) を使う必要があります。レガシーコールバックは [Array Push Pattern](#array-push-pattern) を使って登録することができません。また、新スタイルのコールバックは `init` に渡すことができません。 +これは後方互換性のためだけに提供されています。新しいインテグレーションでは、新しいスタイルの [callback function](#callback-function) を使う必要があります。レガシーコールバックは [Array push pattern](#array-push-pattern) を使って登録することができません。また、新スタイルのコールバックは `init` に渡すことができません。 -詳細は、以前のバージョンの SDK のドキュメントの[Legacy Callback Function](./sdk-ref-javascript-v2#callback-function) を参照してください。 +詳細は、以前のバージョンの SDK のドキュメントの[Legacy callback function](./sdk-ref-javascript-v2#callback-function) を参照してください。 すでにレガシーコールバック関数を使用してインテグレーションを構築している場合は、現在のバージョンの SDK で変更なく使用できます。ただし、この機能は SDK の将来のバージョンで削除される予定です。新しいスタイルの [callback function](#callback-function) を使用するようにインテグレーションを更新することを強く推奨します。 @@ -427,7 +427,7 @@ UID2 ログイン [POST /token/generate](../endpoints/post-token-generate. ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -447,7 +447,7 @@ Identity が利用可能かどうかを判断します。たとえば、ロー __uid2.isIdentityAvailable(); ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -484,7 +484,7 @@ SDK が正しいクッキーにアクセスするために `cookieDomain` また ### callbacks -これは、登録されたコールバックをすべて格納する配列です。[Array Push Pattern](#array-push-pattern) を使ってのみ、この配列とやりとりする必要があります。 +これは、登録されたコールバックをすべて格納する配列です。[Array push pattern](#array-push-pattern) を使ってのみ、この配列とやりとりする必要があります。 ### setIdentity(identity: Identity): void @@ -510,13 +510,13 @@ UID2 SDK に新しい ID を提供するには、この関数を使用します `init()` が一度も呼び出されたことがない場合、false を返します。 -## UID2 Storage Format +## UID2 storage format SDK はユーザーの ID を保存するのに、ローカルストレージかファーストパーティクッキーのどちらかを使用します。デフォルトではローカルストレージを使用しますが、[init parameter](#init-parameters) を使用して変更できます。 ローカルストレージを使用する場合でも、SDK はファーストパーティクッキーに利用可能な新しい ID があるかどうかを確認します。これにより、SDK はローカルストレージを利用しながら、ファーストパーティクッキーを設定することでIDを提供することができます。 -### UID2 Cookie Properties +### UID2 cookie properties クッキーが使用されている場合、クッキーは次の表のプロパティを使用します。 @@ -527,7 +527,7 @@ SDK はユーザーの ID を保存するのに、ローカルストレージか | `Path` | `/` | 別の値を使用したい場合は、SDK の初期化時に `cookiePath` [init() parameter](#init-parameters) を使用して設定することができます。 | | `Domain` | `undefined` | 別の値を使用したい場合は、SDK の初期化時に `cookieDomain` [init() parameter](#init-parameters) を使用して設定することができます。 | -### Contents Structure +### Contents structure UID2 Cookie の内容は、[POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) レスポンスの `body` プロパティと同じ構造を持つ JSON オブジェクトを、`private` オブジェクトを除いてURI エンコードした文字列表現です。 @@ -539,16 +539,16 @@ UID2 Cookie の内容は、[POST /token/generate](../endpoints/post-token-g `private` オブジェクトの内容は明示的に指定されておらず、SDK が解釈するようになっています。このオブジェクトの構造、セマンティクス、互換性について、いかなる仮定もしないでください。クッキーの更新はその構造を保持しなければなりません。 ::: -## Migration Guide +## Migration guide このセクションには、以前のバージョンの SDK for JavaScript から現在のバージョンである v3 にアップグレードするために必要な情報がすべて含まれています: -- [Benefits of Migrating](#benefits-of-migrating) -- [Required Changes](#required-changes) -- [Recommended Changes](#recommended-changes) -- [Optional Changes](#optional-changes) +- [Benefits of migrating](#benefits-of-migrating) +- [Required changes](#required-changes) +- [Recommended changes](#recommended-changes) +- [Optional changes](#optional-changes) -### Benefits of Migrating +### Benefits of migrating 既存のインテグレーションが SDK の version 1.x または 2.x を使用している場合、version 3 は完全に下位互換性があります。新しい URL を参照するようにスクリプトタグを変更するだけで、SDK を version 3 に更新できます。こうすることで、次のような利点があります: @@ -572,33 +572,33 @@ Version 1.x と 2.x の機能の一部は非推奨となっており、将来の これにより、SDK はシングルページのアプリシナリオで使いやすくなりました。 -### Required Changes +### Required changes #### Update your script URL -[Version 3 CDN URL](#include-the-sdk-script) から SDK をロードするようにスクリプトタグを更新します。 +[Version 3 cdn URL](#include-the-sdk-script) から SDK をロードするようにスクリプトタグを更新します。 -### Recommended Changes +### Recommended changes SDK の version 3 の利点を得るために、以下の変更を実施することを強く推奨します: -- [Migrate to the Version 3 Callback System](#migrate-to-the-version-3-callback-system) -- [Take advantage of `setIdentity` and other new features](#take-advantage-of-setidentity-and-other-new-features) +- [Migrate to the version 3 callback system](#migrate-to-the-version-3-callback-system) +- [Take advantage of `setidentity` and other new features](#take-advantage-of-setidentity-and-other-new-features) - [Change how you call init](#change-how-you-call-init) -#### Migrate to the Version 3 Callback System +#### Migrate to the version 3 callback system -以前のバージョンでは、コールバックは `advertisingToken`、`status`、`statusText` プロパティを持つ単一のオブジェクトをパラメータとして受け取っていました。Version 3 では、この関数を新しい [Callback Function Signature](#callback-function-signature) を使用するように変更してください。 +以前のバージョンでは、コールバックは `advertisingToken`、`status`、`statusText` プロパティを持つ単一のオブジェクトをパラメータとして受け取っていました。Version 3 では、この関数を新しい [Callback function signature](#callback-function-signature) を使用するように変更してください。 元のコールバックには、おそらく `status` の異なる値を処理するためのロジックがあると思われます。以前のシステムでは、`EXPIRED`、`REFRESHED`、`NO_IDENTITY` などのさまざまなステータス値を扱うことができました。その代わり、新しいシステムには 3 つのイベントタイプしかありません: `SdkLoaded`、`InitCompleted`、`IdentityUpdated` です。 -[Callback Function](#callback-function) のセクションを確認し、新しいシステムを使用してあなたの要求を実装するための最良の方法を検討する必要があります。しかし、参考になる一般的なガイドラインがいくつかあります: +[Callback function](#callback-function) のセクションを確認し、新しいシステムを使用してあなたの要求を実装するための最良の方法を検討する必要があります。しかし、参考になる一般的なガイドラインがいくつかあります: - `event` パラメータをチェックしてください。値が `SdkLoaded` の場合は、すぐにリターンします。 - そうでなければ、`payload` パラメータに `identity` プロパティがあるかどうかを確認します。 - `identity` プロパティにオブジェクトがない場合、UID2 ID は利用できません。同じような状況では、前のコールバックが行った処理を呼び出す必要があります。 - そうでない場合、`identity` プロパティは `advertising_token` という名前の `string` プロパティを持つオブジェクトとなります。これは、以前のコールバックと同じように使用する必要があります。 -古いコールバックを `init` 呼び出しから削除し、更新したコールバック関数を [Array Push Pattern](#array-push-pattern) を使用して SDK に提供します: +古いコールバックを `init` 呼び出しから削除し、更新したコールバック関数を [Array push pattern](#array-push-pattern) を使用して SDK に提供します: ``` window.__uid2 = window.__uid2 || {}; @@ -606,13 +606,13 @@ window.__uid2.callbacks = window.__uid2.callbacks || []; window.__uid2.callbacks.push(callbackFunction); ``` -#### Take advantage of `setIdentity` and other new features +#### Take advantage of `setidentity` and other new features 以前のバージョンの SDK では新しい ID を提供する方法は一つしかありませんでした: `init` の呼び出しです。このため、パブリッシャーによっては、ページのライフサイクルの後半で新しい ID を提供するために、さまざまな回避策を利用しなければなりませんでした。これらの回避策を取り除き、`init` が呼ばれた後に SDK に新しい ID を渡したい場合は `setIdentity` を呼び出すだけで、インテグレーションを簡素化できるかもしれません。 #### Change how you call init -`init` を呼び出すには、[Array Push Pattern](#array-push-pattern) を使用することを推奨します。既存の `init` 呼び出しは、次の例に示すように、`SdkLoaded` イベントのみを処理するコールバックハンドラ内に移動する必要があります: +`init` を呼び出すには、[Array push pattern](#array-push-pattern) を使用することを推奨します。既存の `init` 呼び出しは、次の例に示すように、`SdkLoaded` イベントのみを処理するコールバックハンドラ内に移動する必要があります: ``` window.__uid2 = window.__uid2 || {}; @@ -627,7 +627,7 @@ window.__uid2.callbacks.push((eventType) => { }); ``` -### Optional Changes +### Optional changes #### Add `async` or `defer` to your script tag diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md index 671e29d1c..b2d01c566 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md @@ -12,28 +12,28 @@ import TabItem from '@theme/TabItem'; import SnptExampleUid2Cookie from '../snippets/_snpt-example-uid2-cookie.mdx'; import SnptExampleJavaScriptInit from '../snippets/_snpt-example-javascript-init.mdx'; -# SDK for JavaScript Reference Guide +# SDK for JavaScript reference guide この SDK を使用して、UID2 を使用したクライアント ID の生成または確立、ターゲティング広告用の Advertising Token の取得、および UID2 Token の自動リフレッシュを容易に行うことができます。 以下のセクションでは、UID2 ID の確立のための高レベルな [ワークフロー](#workflow-overview)、SDK [API リファレンス](#api-reference)、および UID2 [ストレージフォーマット](#uid2-storage-format) を説明します。 :::tip -UID2 Identify Module、または UID2 サポートのある他の製品と Prebid.js を使用している場合、SDK を使用する必要はありません。Prebid.js モジュールがすべてを管理します。詳細は、[UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) を参照してください。 +UID2 Identify Module、または UID2 サポートのある他の製品と Prebid.js を使用している場合、SDK を使用する必要はありません。Prebid.js モジュールがすべてを管理します。詳細は、[UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) を参照してください。 ::: コンテンツパブリッシャー向けのインテグレーション手順は、以下のガイドを参照してください: - - [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) - - [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) + - [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) + - [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) -## SDK Version +## SDK version -このページは、最新の UID2 SDK for JavaScript バージョン 4 を説明しています。以前のバージョンを使用している場合は、[Migration Guide](#migration-guide) を使用してインテグレーションをアップグレードすることを推奨します。必要に応じて、以下の以前のバージョンのドキュメントも利用できます: +このページは、最新の UID2 SDK for JavaScript バージョン 4 を説明しています。以前のバージョンを使用している場合は、[Migration guide](#migration-guide) を使用してインテグレーションをアップグレードすることを推奨します。必要に応じて、以下の以前のバージョンのドキュメントも利用できます: - [Version 3](./sdk-ref-javascript-v3.md) - [Version 2.x and earlier](./sdk-ref-javascript-v2.md) -## Changes in Version 4 +## Changes in version 4 Version 4 には、Version 3 からの主な変更が含まれています: @@ -51,7 +51,7 @@ Version 4 には、Version 3 からの主な変更が含まれています: | :--- | :--- | :--- | :--- | :--- | :--- | | — | — | ✅ | ✅ | — | — | -## Sample Implementations +## Sample implementations サンプルアプリケーションと関連するドキュメントは以下を参照してください: - JavaScript SDK を使用した Client-Side インテグレーション: @@ -61,30 +61,30 @@ Version 4 には、Version 3 からの主な変更が含まれています: - [Code](https://github.com/IABTechLab/uid2-examples/tree/main/web-integrations/javascript-sdk/client-server) - Running site: [Client-Server UID2 Integration Example](https://js-client-server.samples.uidapi.com/) -## UID2 Account Setup +## UID2 account setup -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -## API Permissions +## API permissions -初期アカウント設定が完了すると、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作を行うことができます: +初期アカウント設定が完了すると、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作を行うことができます: - アカウント用の [credentials](../getting-started/gs-credentials.md) を生成します。 - オプション: Client-Side の実装の場合、ドメイン名やモバイルアプリ ID などの設定値を設定します。 - オプションとして、チームメンバーに関する情報を設定するなど、他の値を設定します。 SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。 -## SDK Version +## SDK version このドキュメントは SDK for JavaScript version 4 用です。 -## GitHub Repository +## Github repository この SDK のソースは、以下のオープンソースの GitHub リポジトリにあります: - [https://github.com/iabtechlab/uid2-web-integrations](https://github.com/iabtechlab/uid2-web-integrations) -## SDK Distribution +## SDK distribution この SDK は、以下のロケーションに公開されています: @@ -107,10 +107,10 @@ SDK が提供する特定の機能を使用する権限が与えられ、その このドキュメントでは、以下の用語が使われます: - **ID** とは、[POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントによって返される、UID2 Token、Refresh Token、および Timestamp などの関連値を含む値のパッケージを指します。 - **Advertising Token** は UID2 Token を指します。 -- **Callback function**は、本 SDK の現在のバージョン用に構築され、[Array Push Pattern](#array-push-pattern) を使用して登録されたコールバック関数を指します。 +- **Callback function**は、本 SDK の現在のバージョン用に構築され、[Array push pattern](#array-push-pattern) を使用して登録されたコールバック関数を指します。 - **Legacy callback function** は、この SDK のバージョン 1.x または 2.x 用に構築され、`init` の呼び出しで登録されたコールバック関数を指します。 -## Include the SDK Script +## Include the SDK script UID2 をターゲティング広告に使用したいすべてのページに、以下の SDK スクリプトを含めます: @@ -118,7 +118,7 @@ UID2 をターゲティング広告に使用したいすべてのページに、 ``` -### Async or Defer Loading the SDK Script +### Async or defer loading the SDK script Version 3 以降の SDK は、`async` または `defer` スクリプトローディングとともに使用することができます。 @@ -135,11 +135,11 @@ Version 3 以降の SDK は、`async` または `defer` スクリプトローデ ``` -## Workflow Overview +## Workflow overview SDK を使用して UID2 ID を確立するための Client-Side ワークフローは、以下の Step で構成されます: -1. [Array Push Pattern](#array-push-pattern) を使ってコールバック関数を登録します。 +1. [Array push pattern](#array-push-pattern) を使ってコールバック関数を登録します。 2. コールバックが `SdkLoaded` イベントを受信したら、[init](#initopts-object-void) 関数を使用して SDK を初期化します。 3. イベントリスナーが `InitCompleted` イベントを受信するのを待ちます。イベントデータは ID が利用可能かどうかを示します: - ID が利用可能な場合、その ID がイベントペイロードに返されます。SDK は [background token auto-refresh](#background-token-auto-refresh) を設定します。 @@ -151,9 +151,9 @@ SDK を使用して UID2 ID を確立するための Client-Side ワークフロ - Advertising Token が利用可能な場合、それを使用してターゲティング広告のリクエストを開始します。 - Advertising Token が利用可能でない場合は、ターゲティング広告を使用しないか、同意フォームでユーザーをデータキャプチャにリダイレクトします。 -より詳細な Web インテグレーションの手順は、[Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照してください。 +より詳細な Web インテグレーションの手順は、[Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) を参照してください。 -### Background Token Auto-Refresh +### Background token auto-refresh SDKの [initialization](#initopts-object-void) の一部として、ID の Token Auto-refresh が設定され、ID の Timestamp または断続的なエラーによるリフレッシュの失敗によってバックグラウンドでトリガーされます。 @@ -166,9 +166,9 @@ Token の Auto-refresh について知っておくべきことは以下のとお - ユーザがオプトアウトした場合など、IDが無効になった場合。
NOTE: ID が一時的に使用できなくなり、自動リフレッシュに失敗し続けた場合、コールバックは呼び出されません。この場合、SDK は有効期限が切れていない限り、既存の Advertising Token を使用し続けます。 - [disconnect()](#disconnect-void) 呼び出しはアクティブなタイマーをキャンセルします。 -### Callback Function +### Callback function -[Array Push Pattern](#array-push-pattern) を使用して、UID2 SDK からイベントを受信する関数を登録できます。現在利用可能なイベントはいくつかあります: +[Array push pattern](#array-push-pattern) を使用して、UID2 SDK からイベントを受信する関数を登録できます。現在利用可能なイベントはいくつかあります: - `SdkLoaded` は SDK がパースされ、グローバルな `__uid2` オブジェクトが構築された後に発生します。これは `init()` を呼び出す際に便利で、特にスクリプトのロード順序が保証されていない場合に便利です (たとえば、スクリプトのロードに `async` や `defer` を使用している場合など)。 - `init()` が終了し、SDK を使用できる状態になると `InitCompleted` が発生します。`init` 呼び出しで ID が提供された場合、または SDK が以前に提供された ID をロードできた場合、その ID がペイロードに含まれます。 - `IdentityUpdated` は、新しいIDが利用可能になるか、既存の ID が利用できなくなるたびに発生します。 @@ -177,7 +177,7 @@ Token の Auto-refresh について知っておくべきことは以下のとお コールバック関数はいくつでも用意でき、どこからでも登録できます。これにより、サイトにとって意味のある方法でコードを分割することができます。 ::: -#### Callback Function Signature +#### Callback function signature コールバック関数は、イベントタイプとペイロードの2つのパラメータを受け取る必要があります。ペイロードのタイプはイベントのタイプにより異なります。 @@ -222,7 +222,7 @@ Token の Auto-refresh について知っておくべきことは以下のとお -#### Array Push Pattern +#### Array push pattern 順番にロードされることが保証されていないスクリプトタグ (たとえば、`async` や `defer` スクリプトタグを使用している場合など) を最適にサポートするために、コールバックを登録するには以下のパターンを使用します: @@ -237,27 +237,27 @@ window.__uid2.callbacks.push(callbackFunction); - あなたのコードより先に SDK が実行された場合、`__uid2` オブジェクトや `callbacks` 配列は上書きされません。 - このパターンを使用して複数のコールバックが登録された場合、それらは互いに上書きされません。 -### Provide an Identity to the SDK +### Provide an identity to the SDK SDK がローカルストレージまたはクッキーから以前に保存された ID をロードできる場合を除き、SDK に ID を提供する必要があります。これにはいくつかの方法があります: -- [Provide an Identity by Setting a First-Party Cookie](#provide-an-identity-by-setting-a-first-party-cookie) -- [Provide an Identity in the Call to `init`](#provide-an-identity-in-the-call-to-init) -- [Provide an Identity by Calling `setIdentity`](#provide-an-identity-by-calling-setidentity) +- [Provide an identity by setting a first-party cookie](#provide-an-identity-by-setting-a-first-party-cookie) +- [Provide an identity in the call to `init`](#provide-an-identity-in-the-call-to-init) +- [Provide an identity by calling `setidentity`](#provide-an-identity-by-calling-setidentity) -#### Provide an Identity by Setting a First-Party Cookie +#### Provide an identity by setting a first-party cookie [storage format section](#uid2-storage-format) で説明されているように、ファーストパーティクッキーを保存していて、その値がローカルストレージで利用可能な値よりも新しい場合、SDK はその値をクッキーからロードします。もし `useCookie` init オプションを `true` に設定した場合、SDK は常にこの値をロードし、ローカルストレージをチェックしません。[init parameters](#init-parameters) を使用して、クッキーに関することを制御できます。 -#### Provide an Identity in the Call to `init` +#### Provide an identity in the call to `init` [`init`](#initopts-object-void) を呼び出す時に、新しい ID を指定できます。 -#### Provide an Identity by Calling `setIdentity` +#### Provide an identity by calling `setidentity` -`init` が完了したら、いつでも [`setIdentity`](#setidentityidentity-identity-void) を呼び出して、SDK に新しい ID を渡すことができます。 +`init` が完了したら、いつでも [`setidentity`](#setidentityidentity-identity-void) を呼び出して、SDK に新しい ID を渡すことができます。 -## API Reference +## API reference SDK for JavaScript とのすべてのインストラクションは、グローバルな `__uid2` オブジェクトを介して行われます。このオブジェクトは `UID2` クラスのインスタンスであり、以下の JavaScript 関数はすべて `UID2` クラスのメンバーです: @@ -287,11 +287,11 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 この関数について知っておくべきことは以下のとおりです: -- `init()` は SDK がロードされた後であれば、いつでも呼び出すことができます。これを行うには、[Array Push Pattern](#array-push-pattern) を使用して `SdkLoaded` イベントを処理するコールバック関数を登録することを推奨します。このパターンを使うことで、スクリプトのロード順序に関係なくコードが動作し、スクリプトタグで `async` や `defer` を使っても UID2 SDK のエラーが発生しないようにすることができます。 +- `init()` は SDK がロードされた後であれば、いつでも呼び出すことができます。これを行うには、[Array push pattern](#array-push-pattern) を使用して `SdkLoaded` イベントを処理するコールバック関数を登録することを推奨します。このパターンを使うことで、スクリプトのロード順序に関係なくコードが動作し、スクリプトタグで `async` や `defer` を使っても UID2 SDK のエラーが発生しないようにすることができます。 - `init()` 呼び出しの `identity` プロパティは、[POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) 呼び出しが成功したときに返されるレスポンス JSON オブジェクトの `body` プロパティを参照します。Server-side のインテグレーションで常に現在のトークンを使用できるようにしていて、JavaScript を使用して ID を提供するほうが便利な場合は、この方法を使用するとよいでしょう。 - `init()` 呼び出しの `identity` プロパティが不正な場合、SDK はローカルストレージまたはクッキーから ID をロードしようとします。 - `init()` が完了すると、すべてのコールバックは `InitCompleted` イベントを受信します。このイベントのペイロードの `identity` プロパティが null の場合、ID をロードできなかったことになるので、[provide an identity to the SDK](#provide-an-identity-to-the-sdk) する必要があります。これは、Server-side のインテグレーションによって常に現在の ID が利用可能であることが保証されておらず、必要な場合にのみサーバーから ID を要求する必要がある場合に推奨される ID の提供方法です。 - - 渡された UID2 情報をセッションに保存するためにファーストパーティクッキー ([UID2 Storage Format](#uid2-storage-format) を参照) を使用している場合、異なるドメインのページから `init()` を呼び出すと、そのクッキーにアクセスできないことがあります。`cookieDomain` オプションと `cookiePath` オプションで、クッキーに使用する設定を調整することができます。 + - 渡された UID2 情報をセッションに保存するためにファーストパーティクッキー ([UID2 storage format](#uid2-storage-format) を参照) を使用している場合、異なるドメインのページから `init()` を呼び出すと、そのクッキーにアクセスできないことがあります。`cookieDomain` オプションと `cookiePath` オプションで、クッキーに使用する設定を調整することができます。 - 特定の動作を調整するために、初期化呼び出しにはオプションの設定 [init prarmeters](#init-parameters) を含めることができます。 以下は、Server-side で生成された ID を含むコールバックを使った `init()` 呼び出しの例です。 @@ -312,7 +312,7 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 ``` -#### Init Parameters +#### Init parameters `opts` オブジェクトは、以下のプロパティをサポートしています。 @@ -325,24 +325,24 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 | `cookiePath` | string | オプション | [UID2 cookie](sdk-ref-javascript-v2.md#uid2-cookie-format) に適用する Path 文字列です。 | `/` | | `useCookie` | `boolean` | オプション | この値を `true` に設定すると、SDK はローカルストレージではなくクッキーに ID を保存します。この値がfalseであるか、提供されていない場合でも、ファーストパーティクッキーを使用して ID を提供することができます。 | -#### Multiple Init Calls +#### Multiple init calls `init()` 関数は何度でも呼び出すことができます。ほとんどの場合、特定の [init parameter](#init-parameters) の最新の値を受け入れます。たとえば、`baseUrl` が 2 回呼び出され、それぞれ異なる `baseUrl` が渡された場合、`baseUrl` 変数は 2 回目の呼び出しからの値に更新されます。 この機能には 2 つの例外があります: 1. 新しい identity が提供され、新しい identity が現在の identity よりも早く失効する場合、新しい identity は現在の identity を置き換えません。 -2. 移行、渡されたコールバック関数のすべてに対し、[Array Push Pattern](#array-push-pattern) を使用して既存のコールバック配列に関数が追加されます。 +2. 移行、渡されたコールバック関数のすべてに対し、[Array push pattern](#array-push-pattern) を使用して既存のコールバック配列に関数が追加されます。 :::note `useCookie` が更新されると、identity の場所が変わります。たとえば、値が `true` から `false` に更新されると、ファーストパーティクッキーが削除され、identity がローカルストレージに追加されます。 ::: -### Init Config +### Init config `init()` を呼び出すと、初期設定がファーストパーティクッキーまたはローカルストレージに保存されます。この設定には、`baseUrl`、`useCookie`、`refreshRetryPeriod`、`cookiePath`、`cookieDomain` が含まれる場合があります。この設定は [bootstrap init](#self-bootstrap) に使用され、その後のページロードでの読み込み時間を短縮します。`init()` に対する後続の呼び出しは、最新のパラメータで設定を更新します。 -### Self Bootstrap +### Self bootstrap コンストラクタが完了し、SDK が window オブジェクトに配置されると、コードはローカルストレージとクッキーストレージをチェックして、保存された [init config](#init-config) を取得します。Condig が存在する場合、`init()` は自動的にその config のパラメータで呼び出され、その結果、`init()` が必要な関数を使用できるようになります。 @@ -355,11 +355,11 @@ SDK を初期化し、ターゲティング広告用のユーザー ID を確立 | `TypeError` | 次のいずれかの問題が発生しました:
  • `opts` の値がオブジェクトではありません。
  • レガシーコールバックが提供されているが、関数ではありません。
  • `refreshRetryPeriod` が提供されているが、数値ではありません。
| | `RangeError` | リフレッシュの再試行期間が 1000 未満である。 | -#### Legacy Callback Function +#### Legacy callback function -これは後方互換性のためだけに提供されています。新しいインテグレーションでは、新しい [callback function](#callback-function) を使う必要があります。レガシーコールバックは [Array Push Pattern](#array-push-pattern) を使って登録することができません。また、新しいコールバックは `init` に渡すことができません。 +これは後方互換性のためだけに提供されています。新しいインテグレーションでは、新しい [callback function](#callback-function) を使う必要があります。レガシーコールバックは [Array push pattern](#array-push-pattern) を使って登録することができません。また、新しいコールバックは `init` に渡すことができません。 -詳細は、以前のバージョンの SDK のドキュメントの[Legacy Callback Function](./sdk-ref-javascript-v2#callback-function) を参照してください。 +詳細は、以前のバージョンの SDK のドキュメントの[Legacy callback function](./sdk-ref-javascript-v2#callback-function) を参照してください。 すでにレガシーコールバック関数を使用してインテグレーションを構築している場合は、現在のバージョンの SDK で変更なく使用できます。ただし、この機能は SDK の将来のバージョンで削除される予定です。新しいスタイルの [callback function](#callback-function) を使用するようにインテグレーションを更新することを強く推奨します。 @@ -420,7 +420,7 @@ UID2 ログイン [POST /token/generate](../endpoints/post-token-generate. ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -438,7 +438,7 @@ Identity が利用可能かどうかを判断します。たとえば、ロー __uid2.isIdentityAvailable(); ``` -#### Return Values +#### Return values | Value | Description | | :--- | :--- | @@ -465,7 +465,7 @@ SDK が正しいクッキーにアクセスするために `cookieDomain` また ### callbacks -これは、登録されたコールバックをすべて格納する配列です。[Array Push Pattern](#array-push-pattern) を使ってのみ、この配列とやりとりする必要があります。 +これは、登録されたコールバックをすべて格納する配列です。[Array push pattern](#array-push-pattern) を使ってのみ、この配列とやりとりする必要があります。 ### setIdentity(identity: Identity): void @@ -491,13 +491,13 @@ UID2 SDK に新しい ID を提供するには、この関数を使用します `init()` が一度も呼び出されたことがない場合、false を返します。 -## UID2 Storage Format +## UID2 storage format SDK はユーザーの ID を保存するのに、ローカルストレージかファーストパーティクッキーのどちらかを使用します。デフォルトではローカルストレージを使用しますが、[init parameter](#init-parameters) を使用して変更できます。 ローカルストレージを使用する場合でも、SDK はファーストパーティクッキーに利用可能な新しい ID があるかどうかを確認します。これにより、SDK はローカルストレージを利用しながら、ファーストパーティクッキーを設定することでIDを提供することができます。 -### UID2 Cookie Properties +### UID2 cookie properties クッキーが使用されている場合、クッキーは次の表のプロパティを使用します。 @@ -508,7 +508,7 @@ SDK はユーザーの ID を保存するのに、ローカルストレージか | `Path` | `/` | 別の値を使用したい場合は、SDK の初期化時に `cookiePath` [init() parameter](#init-parameters) を使用して設定することができます。 | | `Domain` | `undefined` | 別の値を使用したい場合は、SDK の初期化時に `cookieDomain` [init() parameter](#init-parameters) を使用して設定することができます。 | -### Contents Structure +### Contents structure UID2 Cookie の内容は、[POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) レスポンスの `body` プロパティと同じ構造を持つ JSON オブジェクトを、`private` オブジェクトを除いてURI エンコードした文字列表現です。 @@ -520,27 +520,27 @@ UID2 Cookie の内容は、[POST /token/generate](../endpoints/post-token-g `private` オブジェクトの内容は明示的に指定されておらず、SDK が解釈するようになっています。このオブジェクトの構造、セマンティクス、互換性について、いかなる仮定もしないでください。クッキーの更新はその構造を保持しなければなりません。 ::: -## Migration Guide +## Migration guide このセクションには、以前のバージョンの SDK for JavaScript から現在のバージョンである v3 にアップグレードするために必要な情報がすべて含まれています: -- [Benefits of Migrating](#benefits-of-migrating) -- [Required Changes](#required-changes) -- [Recommended Changes](#recommended-changes) -- [Optional Changes](#optional-changes) +- [Benefits of migrating](#benefits-of-migrating) +- [Required changes](#required-changes) +- [Recommended changes](#recommended-changes) +- [Optional changes](#optional-changes) -### Benefits of Migrating +### Benefits of migrating Version 4 に移行することで、以下の Version 3 および 4 で導入された利点を得ることができます: -- [Benefits in Version 3](#benefits-in-version-3) -- [Benefits in Version 4](#benefits-in-version-4) +- [Benefits in version 3](#benefits-in-version-3) +- [Benefits in version 4](#benefits-in-version-4) :::important -SDK Version 3 は、以前のバージョンと完全に互換性がありますが、Version 4 で削除された非推奨の要素が含まれています。Version 4 に移行するには、スクリプトタグを新しい URL に変更する必要があります。さらに、[Changes in Version 4](#changes-in-version-4) にリストされている項目のいずれかを参照している場合、更新されていない場合は、Version 4 にアップグレードする際にこれらの更新を行う必要があります。たとえば、Version 4 で削除された `abort()` 関数を使用しないようにコードを更新してください。 +SDK Version 3 は、以前のバージョンと完全に互換性がありますが、Version 4 で削除された非推奨の要素が含まれています。Version 4 に移行するには、スクリプトタグを新しい URL に変更する必要があります。さらに、[Changes in version 4](#changes-in-version-4) にリストされている項目のいずれかを参照している場合、更新されていない場合は、Version 4 にアップグレードする際にこれらの更新を行う必要があります。たとえば、Version 4 で削除された `abort()` 関数を使用しないようにコードを更新してください。 ::: -#### Benefits in Version 3 +#### Benefits in version 3 Version 3 では: @@ -552,7 +552,7 @@ Version 3 では: - 新しい ID を提供するために first-party cookie の設定を依存している場合、この変更による利点はありません。 - `init` に ID を渡すだけで ID を提供する場合、SDK はもはやクッキーに書き込みません。 -Version 2 以前の機能の一部は Version 3 で非推奨とされ、Version 3 にアップグレードする際にいくつかのコードの更新を行うことを推奨しました。この機能は Version 4 で削除されました。[Changes in Version 4](#changes-in-version-4) にリストされている項目のいずれかを参照している場合、更新されていない場合は、Version 4 にアップグレードする際にこれらの更新を行う必要があります。 +Version 2 以前の機能の一部は Version 3 で非推奨とされ、Version 3 にアップグレードする際にいくつかのコードの更新を行うことを推奨しました。この機能は Version 4 で削除されました。[Changes in version 4](#changes-in-version-4) にリストされている項目のいずれかを参照している場合、更新されていない場合は、Version 4 にアップグレードする際にこれらの更新を行う必要があります。 Version 3 では、レガシーコールバックシステムが非推奨とされ、将来のバージョンで削除される予定です。 @@ -565,48 +565,48 @@ Version 3 では、レガシーコールバックシステムが非推奨とさ これにより、SDK はシングルページアプリケーションのシナリオでの使用がはるかに簡単になります。 -#### Benefits in Version 4 +#### Benefits in version 4 -Version 4 は、以前のバージョンよりも堅牢です。利点の概要は、[Changes in Version 4](#changes-in-version-4) を参照してください。 +Version 4 は、以前のバージョンよりも堅牢です。利点の概要は、[Changes in version 4](#changes-in-version-4) を参照してください。 -### Required Changes +### Required changes Version 4 に移行するためには、現在の実装がどのように構成されているかによって手順が異なります: -- **Migration from version 3, with no elements from earlier versions**: 必要な作業は、スクリプトタグを更新して、バージョン 4.0.1 CDN URL から SDK をロードすることだけです。[Include the SDK Script](#include-the-sdk-script) を参照してください。 +- **Migration from version 3, with no elements from earlier versions**: 必要な作業は、スクリプトタグを更新して、バージョン 4.0.1 CDN URL から SDK をロードすることだけです。[Include the SDK script](#include-the-sdk-script) を参照してください。 -- **Migration from version 3, and you previously migrated from version 2 without completing the steps to update your implementation**: スクリプトタグを更新し、また、Version 4 で削除された要素を参照しないようにコードを更新してください。詳細は、[Changes in Version 4](#changes-in-version-4) を参照してください。 +- **Migration from version 3, and you previously migrated from version 2 without completing the steps to update your implementation**: スクリプトタグを更新し、また、Version 4 で削除された要素を参照しないようにコードを更新してください。詳細は、[Changes in version 4](#changes-in-version-4) を参照してください。 -- **Migration from version 2 or earlier**: スクリプトタグを更新し、また、Version 4 で削除された要素を参照しないようにコードを更新してください。詳細は、[Changes in Version 4](#changes-in-version-4) を参照してください。 +- **Migration from version 2 or earlier**: スクリプトタグを更新し、また、Version 4 で削除された要素を参照しないようにコードを更新してください。詳細は、[Changes in version 4](#changes-in-version-4) を参照してください。 -### Additional Changes: Migration from v2 or Earlier +### Additional changes: Migration from v2 or earlier v3 より前のバージョンから移行する場合、または以前のバージョンから Version 3 に移行したが、コードを更新していない場合は、UID2 JavaScript SDK の実装を改善するための以下の推奨およびオプションの変更を検討してください: -- [Recommended Changes](#recommended-changes) -- [Optional Changes](#optional-changes) +- [Recommended changes](#recommended-changes) +- [Optional changes](#optional-changes) -#### Recommended Changes +#### Recommended changes SDK の version 3 の利点を得るために、以下の変更を実施することを強く推奨します: -- [Migrate to the Newer Callback System Introduced in Version 3](#migrate-to-the-newer-callback-system-introduced-in-version-3) -- [Take advantage of `setIdentity` and other features introduced in version 3](#take-advantage-of-setidentity-and-other-features-introduced-in-version-3) +- [Migrate to the newer callback system introduced in version 3](#migrate-to-the-newer-callback-system-introduced-in-version-3) +- [Take advantage of `setidentity` and other features introduced in version 3](#take-advantage-of-setidentity-and-other-features-introduced-in-version-3) - [Change how you call init](#change-how-you-call-init) ##### Migrate to the Newer Callback System Introduced in Version 3 -以前のバージョンでは、コールバックは `advertisingToken`、`status`、`statusText` プロパティを持つ単一のオブジェクトをパラメータとして受け取っていました。Version 3 では、この関数を新しい [Callback Function Signature](#callback-function-signature) を使用するように変更してください。 +以前のバージョンでは、コールバックは `advertisingToken`、`status`、`statusText` プロパティを持つ単一のオブジェクトをパラメータとして受け取っていました。Version 3 では、この関数を新しい [Callback function signature](#callback-function-signature) を使用するように変更してください。 元のコールバックには、おそらく `status` の異なる値を処理するためのロジックがあると思われます。以前のシステムでは、`EXPIRED`、`REFRESHED`、`NO_IDENTITY` などのさまざまなステータス値を扱うことができました。その代わり、新しいシステムには 3 つのイベントタイプしかありません: `SdkLoaded`、`InitCompleted`、`IdentityUpdated` です。 -[Callback Function](#callback-function) のセクションを確認し、新しいシステムを使用してあなたの要求を実装するための最良の方法を検討する必要があります。しかし、参考になる一般的なガイドラインがいくつかあります: +[Callback function](#callback-function) のセクションを確認し、新しいシステムを使用してあなたの要求を実装するための最良の方法を検討する必要があります。しかし、参考になる一般的なガイドラインがいくつかあります: - `event` パラメータをチェックしてください。値が `SdkLoaded` の場合は、すぐにリターンします。 - そうでなければ、`payload` パラメータに `identity` プロパティがあるかどうかを確認します。 - `identity` プロパティにオブジェクトがない場合、UID2 ID は利用できません。同じような状況では、前のコールバックが行った処理を呼び出す必要があります。 - そうでない場合、`identity` プロパティは `advertising_token` という名前の `string` プロパティを持つオブジェクトとなります。これは、以前のコールバックと同じように使用する必要があります。 -古いコールバックを `init` 呼び出しから削除し、更新したコールバック関数を [Array Push Pattern](#array-push-pattern) を使用して SDK に提供します: +古いコールバックを `init` 呼び出しから削除し、更新したコールバック関数を [Array push pattern](#array-push-pattern) を使用して SDK に提供します: ``` window.__uid2 = window.__uid2 || {}; @@ -620,7 +620,7 @@ window.__uid2.callbacks.push(callbackFunction); ##### Change how you call init -`init` を呼び出すには、[Array Push Pattern](#array-push-pattern) を使用することを推奨します。既存の `init` 呼び出しは、次の例に示すように、`SdkLoaded` イベントのみを処理するコールバックハンドラ内に移動する必要があります: +`init` を呼び出すには、[Array push pattern](#array-push-pattern) を使用することを推奨します。既存の `init` 呼び出しは、次の例に示すように、`SdkLoaded` イベントのみを処理するコールバックハンドラ内に移動する必要があります: ``` window.__uid2 = window.__uid2 || {}; @@ -635,7 +635,7 @@ window.__uid2.callbacks.push((eventType) => { }); ``` -#### Optional Changes +#### Optional changes v3 以前のバージョンからアップグレードする場合は、次のオプションの変更を検討してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-python.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-python.md index 61c26e182..a73cd776a 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-python.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-python.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# SDK for Python Reference Guide +# SDK for Python reference guide Server-Side で UID2 を使用してクライアント ID の生成や確立、Advertiser ID の取得、UID2 Token の自動リフレッシュを行うために、Python SDK を使用できます。適用可能な権限がある場合は、共有のための暗号化と復号化、DII の raw UID2s へのマッピングも行えます。 @@ -22,17 +22,17 @@ Server-Side で UID2 を使用してクライアント ID の生成や確立、A *この設定は、SDK のバージョンが `POST /identity/map` エンドポイントのバージョン 3 より前のバージョンを参照している場合にのみ適用されます。 -## UID2 Account Setup +## UID2 account setup -UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account Setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 +UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントを作成していない場合は、まず [Account setup](../getting-started/gs-account-setup.md) ページの手順に従ってください。 -## API Permissions +## API permissions -アカウントの初期設定が完了すると、パブリッシャー、広告主、またはデータプロバイダーの場合、[UID2 Portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: +アカウントの初期設定が完了すると、パブリッシャー、広告主、またはデータプロバイダーの場合、[UID2 portal](../portal/portal-overview.md) にアクセスするための手順とリンクが送信されます。以下の操作が可能です: - アカウント用の [credentials](../getting-started/gs-credentials.md) を生成します。 - オプションとして、チームメンバーに関する情報を設定するなど、他の値を設定します。 -SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。SDK には使用権限がない機能がある可能性があることに注意してください。詳細は、[API Permissions](../getting-started/gs-permissions.md) を参照してください。 +SDK が提供する特定の機能を使用する権限が与えられ、そのアクセスのための資格情報が提供されます。SDK には使用権限がない機能がある可能性があることに注意してください。詳細は、[API permissions](../getting-started/gs-permissions.md) を参照してください。 DSP の場合は、資格情報を送信します。 @@ -45,7 +45,7 @@ version: - **v2.6.0**: Python 3.8 or higher - **v2.5.0 and below**: Python 3.6 or higher -## GitHub Repository/Package +## Github repository/package この SDK は以下のオープンソースの GitHub リポジトリにあります: @@ -55,7 +55,7 @@ version: - [https://pypi.org/project/uid2-client/](https://pypi.org/project/uid2-client/) -## Release Notes +## Release notes 各リリースの変更点、バグ修正、新機能の詳細については、[release notes on GitHub](https://github.com/IABTechLab/uid2-client-python/releases) を参照してください。 @@ -73,10 +73,10 @@ pip install uid2-client | 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) | +| Publisher | `Uid2PublisherClient` | [Usage for publishers](#usage-for-publishers) | +| 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) | +| Sharer | `SharingClient` | [Usage for sharers](#usage-for-uid2-sharers) | @@ -85,14 +85,14 @@ SDK が　UID2 Service と通信するために必要な値を提供する必要 | Parameter | Description | | :--- | :--- | | `base_url` | UID2 Service のエンドポイント。[Environments](../getting-started/gs-environments) を参照してください。 | -| `auth_key` | API Key。[UID2 Credentials](../getting-started/gs-credentials) を参照してください。 | -| `secret_key` | Client Secret。[UID2 Credentials](../getting-started/gs-credentials) を参照してください。 | +| `auth_key` | API Key。[UID2 credentials](../getting-started/gs-credentials) を参照してください。 | +| `secret_key` | Client Secret。[UID2 credentials](../getting-started/gs-credentials) を参照してください。 | ## Interface `BidstreamClient` クラスを利用すると UID2 Token を raw UID2 に復号化できます。 -ユーザーのオプトアウトを処理する入札ロジックの詳細は [DSP Integration Guide](../guides/dsp-guide.md) を参照してください。 +ユーザーのオプトアウトを処理する入札ロジックの詳細は [DSP integration guide](../guides/dsp-guide.md) を参照してください。 `SharingClient` クラスを利用すると、raw UID2 を UID2 Token に暗号化し、UID2 Token を raw UID2 に復号化することができます。 @@ -101,16 +101,16 @@ SDK が　UID2 Service と通信するために必要な値を提供する必要 SDK を使用すると、復号化キーを保存または管理する必要がありません。 ::: -### Encryption Response Content +### Encryption response content `SharingClient` を使用して暗号化すると、SDK が次の表に示す情報を返します。 | Property | Description | | :--- | :--- | -| `status` | 暗号化結果のステータス。取り得る値のリストと定義は、[Encryption Response Statuses](#encryption-response-statuses) を参照してください。 | +| `status` | 暗号化結果のステータス。取り得る値のリストと定義は、[Encryption response statuses](#encryption-response-statuses) を参照してください。 | | `encrypted_data` | 暗号化された UID2 Token。 | -### Encryption Response Statuses +### Encryption response statuses 暗号化のレスポンスコードとその意味は、次の表に示します。 @@ -123,17 +123,17 @@ SDK を使用すると、復号化キーを保存または管理する必要が | `KEYS_NOT_SYNCED` | クライアントが UID2 Service からの鍵の同期に失敗しました。 | | `ENCRYPTION_FAILURE` | 一般的な暗号化に失敗しました。 | -### Decryption Response Content +### Decryption response content `BidstreamClient` または `SharingClient` を使用して復号化すると、SDK が次の表に示す情報を返します。 | Property | Description | | :--- | :--- | -| `status` | 復号結果のステータス。取り得る値のリストと定義につては、[Decryption Response Statuses](#decryption-response-statuses) を参照してください。 | +| `status` | 復号結果のステータス。取り得る値のリストと定義につては、[Decryption response statuses](#decryption-response-statuses) を参照してください。 | | `uid` | UID2 Token に対応する raw UID2。 | | `established` | ユーザーがパブリッシャーと最初に UID2 を確立した時のタイムスタンプ。 | -### Decryption Response Statuses +### Decryption response statuses 復号化のレスポンスコードとその意味を次の表に示します。 @@ -149,7 +149,7 @@ SDK を使用すると、復号化キーを保存または管理する必要が | `DOMAIN_NAME_CHECK_FAILED` | ドメイン名が暗号化されたトークンのドメインと一致しません。 | | `INVALID_TOKEN_LIFETIME` | トークンのタイムスタンプが無効です。 | -## Usage for Publishers +## Usage for publishers 1. `Uid2PublisherClient` のインスタンスを作成します: ```py @@ -163,9 +163,9 @@ SDK を使用すると、復号化キーを保存または管理する必要が -### Client-Server Integration +### Client-server integration -Client-Server インテグレーションを使用している場合 (詳細は [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照): +Client-Server インテグレーションを使用している場合 (詳細は [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) を参照): * Identity を JSON 文字列としてクライアントに返します (Client-Side で使用するための [identity field](../sdks/sdk-ref-javascript.md#initopts-object-void) で使用) するには、次の手順に従います: @@ -177,9 +177,9 @@ Client-Server インテグレーションを使用している場合 (詳細は ユーザーがオプトアウトしている場合、このメソッドは None を返します。その場合は、適切に処理してください。 ::: -### Server-Side Integration +### Server-side integration -Server-Side インテグレーションを使用している場合 (詳細は [Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md) を参照): +Server-Side インテグレーションを使用している場合 (詳細は [Publisher integration guide, server-side](../guides/integration-publisher-server-side.md) を参照): 1. `token_generate_response.get_identity_json_string()` 関数を使用して、ユーザーのセッションに JSON 文字列としてこの Identity を保存します。 @@ -221,13 +221,13 @@ Server-Side インテグレーションを使用している場合 (詳細は [P ユーザーがオプトアウトしている場合、このメソッドは `None` を返します。ユーザーがオプトアウトしていることを確認するには、`token_refresh_response.is_optout()` 関数を使用できます。 -## Usage for Advertisers/Data Providers +## Usage for advertisers/data providers 以下の手順は、最新バージョンの `POST /identity/map` エンドポイントを使用して、DII を raw UID2 にマッピングする方法の例を示しています。 -以前のバージョンについては、[Previous Version (v2 Identity Map)](#previous-version-v2-identity-map) を参照してください。最新バージョンへの移行手順は、[Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map) を参照してください。 +以前のバージョンについては、[Previous version (v2 identity map)](#previous-version-v2-identity-map) を参照してください。最新バージョンへの移行手順は、[Migration from version using v2 identity map](#migration-from-version-using-v2-identity-map) を参照してください。 -### Map DII to Raw UID2s +### Map DII to raw UID2s DII を raw UID2s にマッピングするには、次の手順に従います: @@ -280,7 +280,7 @@ DII を raw UID2s にマッピングするには、次の手順に従います: raw UID2 は、リフレッシュタイムスタンプの前では変化しません。リフレッシュタイムスタンプの後、DII を再マッピングすると新しいリフレッシュタイムスタンプが返されますが、raw UID2 は変化する場合もあれば変化しない場合もあります。raw UID2 が複数のリフレッシュ間隔にわたって変化しない可能性もあります。 ::: -#### Usage Example +#### Usage example ```py client = IdentityMapV3Client(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY) @@ -309,15 +309,15 @@ mixed_input = IdentityMapV3Input() mixed_response = client.generate_identity_map(mixed_input) ``` -## Migration From Version Using v2 Identity Map +## Migration from version using v2 identity map 以下は、`POST /identity/map` バージョン 3 を参照する最新バージョンの SDK への移行に関する一般的な情報とガイダンスです: -- [Version 3 Improvements](#version-3-improvements) -- [Upgrading Client Version](#upgrading-client-version) -- [Updating DII Mapping](#updating-dii-mapping) +- [Version 3 improvements](#version-3-improvements) +- [Upgrading client version](#upgrading-client-version) +- [Updating DII mapping](#updating-dii-mapping) -### Version 3 Improvements +### Version 3 improvements `POST /v3/identity/map` は v2 に比べて以下の改善点を提供します: @@ -327,7 +327,7 @@ mixed_response = client.generate_identity_map(mixed_input) - **Multiple Identity Types in One Request**: メールアドレスと電話番号の両方を単一のリクエストで処理できます。 - **Improved Performance**: 更新されたバージョンは、同じ量の DII を処理するために必要な帯域幅を大幅に削減します。 -### Upgrading Client Version +### Upgrading client version クライアントを最新バージョン (version 3) にアップグレードするには、以下の手順に従ってください: @@ -350,7 +350,7 @@ mixed_response = client.generate_identity_map(mixed_input) from uid2_client import IdentityMapV3Client, IdentityMapV3Input, IdentityMapV3Response, UnmappedIdentityReason ``` -### Updating DII Mapping +### Updating DII mapping `POST /identity/map` エンドポイントの version 2 から version 3 への DII マッピングの更新手順は以下の通りです: @@ -397,14 +397,14 @@ mixed_response = client.generate_identity_map(mixed_input) raw_reason = unmapped.raw_reason ``` -### Previous Version (v2 Identity Map) +### Previous version (v2 identity map) :::note v2 の Identity Map SDK は、後方互換性のために維持されている以前のバージョンです。パフォーマンスの向上、複数のアイデンティティタイプのサポート、および UID2 ローテーション管理の改善のために、現在の SDK に移行してください。 新しいインテグレーションはこのバージョンを使用しないでください。 -手順は、[Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map) を参照してください。 +手順は、[Migration from version using v2 identity map](#migration-from-version-using-v2-identity-map) を参照してください。 ::: メールアドレス、電話番号、またはそれらのハッシュを raw UID2s およびソルトバケット ID にマッピングするには、`POST /identity/map` version 2 を使用している以前の SDK バージョンを使用している場合は、以下の手順に従ってください。 @@ -440,11 +440,11 @@ v2 の Identity Map SDK は、後方互換性のために維持されている reason = unmapped_identity.get_reason() ``` -#### Monitor Rotated Salt Buckets +#### Monitor rotated salt buckets ソルトバケットを監視するには、以下の手順に従ってください。 -1. `IdentityMapClient` のインスタンスをインスタンス変数として作成、または [Map DII to Raw UID2s](#map-dii-to-raw-uid2s) から再利用します: +1. `IdentityMapClient` のインスタンスをインスタンス変数として作成、または [Map DII to raw UID2s](#map-dii-to-raw-uid2s) から再利用します: ```py client = IdentityMapClient(base_url, api_key, client_secret) @@ -504,14 +504,14 @@ else: 詳細な例は、[examples/sample_bidstream_client.py](https://github.com/IABTechLab/uid2-client-python/blob/main/examples/sample_bidstream_client.py) の `sample_bidstream_client.py` を参照してください。 -## Usage for UID2 Sharers +## Usage for UID2 sharers UID2 sharing participant は、送信者または受信者として共有に参加し、他の参加者と UID2 を共有する組織です。 -広告主とデータプロバイダーは、この SDK を使用して、他の許可された UID2 共有参加者 (tokenized sharing) と UID2 を共有できます。彼らは [raw UID2](../ref-info/glossary-uid#gl-raw-uid2) を UID2 Tokens に暗号化し、それを共有のために別の参加者に送信することができます (詳細は [Tokenized Sharing in Pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。ピクセルでデータを送信しない場合でも、[Security Requirements for UID2 Sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、UID2 共有に参加できます。 +広告主とデータプロバイダーは、この SDK を使用して、他の許可された UID2 共有参加者 (tokenized sharing) と UID2 を共有できます。彼らは [raw UID2](../ref-info/glossary-uid#gl-raw-uid2) を UID2 Tokens に暗号化し、それを共有のために別の参加者に送信することができます (詳細は [Tokenized sharing in pixels](../sharing/sharing-tokenized-from-data-pixel.md) を参照)。ピクセルでデータを送信しない場合でも、[Security requirements for UID2 sharing](../sharing/sharing-security.md) に記載されている要件に従う限り、UID2 共有に参加できます。 :::important -このプロセスで生成される UID2 Token は共有専用です。—ビッドストリームで使用することはできません。ビッドストリーム用のトークンを生成するための異なるワークフローがあります: [Tokenized Sharing in the Bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 +このプロセスで生成される UID2 Token は共有専用です。—ビッドストリームで使用することはできません。ビッドストリーム用のトークンを生成するための異なるワークフローがあります: [Tokenized sharing in the bidstream](../sharing/sharing-tokenized-from-data-bid-stream.md) を参照してください。 ::: 以下の手順は、SDK for Python を使用して、送信者または受信者として共有を実装する方法の例を示しています。 @@ -555,10 +555,10 @@ else: 以下の手順は、開発時に役立つかもしれません: -- [Example Usage](#example-usage) +- [Example usage](#example-usage) - [Running tests](#running-tests) -### Example Usage +### Example usage [examples](https://github.com/IABTechLab/uid2-client-python/blob/main/examples) ディレクトリにある例を実行できます。 ```py diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/summary-sdks.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/summary-sdks.md index c4461e549..32462fb9d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/summary-sdks.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/summary-sdks.md @@ -14,7 +14,7 @@ import Link from '@docusaurus/Link'; SDK の機能を確認して使用する SDK を決定し、SDK の表をクリックして参照ドキュメントを確認してください。 -## SDK Functionality +## SDK functionality 以下の表は、各 SDK で利用可能な機能をまとめたものです。 @@ -121,21 +121,21 @@ SDK の機能を確認して使用する SDK を決定し、SDK の表をクリ -*DII から raw UID2 を生成する必要がある広告主およびデータプロバイダは Snowflake ([Snowflake Integration Guide](../guides/integration-snowflake.md) を参照) または [POST /identity/map (v2)](../endpoints/post-identity-map-v2.md) エンドポイントを使用することができます。 +*DII から raw UID2 を生成する必要がある広告主およびデータプロバイダは Snowflake ([Snowflake integration guide](../guides/integration-snowflake.md) を参照) または [POST /identity/map (v2)](../endpoints/post-identity-map-v2.md) エンドポイントを使用することができます。 ** 最新バージョンの [POST /identity/map](../endpoints/post-identity-map.md) エンドポイントを使用している実装では、ソルトバケットの監視は必要ありません。 -## SDK Documentation +## SDK documentation UID2 インテグレーションは、以下の SDK ドキュメントを参照してください。ドキュメンテーションのリンクは最初の欄にあります。 | SDK/Link to Guide | Description | Audience | :--- | :--- | :--- | | [SDK for JavaScript](sdk-ref-javascript.md) | UID2 を使用したクライアント ID の確立と、パブリッシャー向けの UID2 Token の取得プロセスを容易にする、Client-Side JavaScript SDK。 | Publishers | -| [SDK for Java](sdk-ref-java.md) | Java Server-Side を使用するオーディエンスのための SDK:
  • パブリッシャーが DII から UID2 Token を生成したりリフレッシュしたりするのを支援します。([POST /token/generate](../endpoints/post-token-generate))
  • UID2 Sharer が UID2 Token を暗号化・復号化するのを支援します。([Usage for UID2 Sharers](sdk-ref-java.md#usage-for-uid2-sharers))
  • ビッドリクエストから UID2 Token を復号する DSP を支援します。([Decrypt UID2 Tokens for RTB Use](guides/dsp-guide.md#decrypt-uid2-tokens-for-rtb-use))
| Publishers
DSPs
Advertisers
Data Providers | -| [SDK for Python](sdk-ref-python.md) | Python Server-Side を使用するオーディエンスのための SDK:
  • パブリッシャーが DII から UID2 Token を生成したりリフレッシュしたりするのを支援します。([POST /token/generate](../endpoints/post-token-generate))
  • UID2 Sharer が UID2 Token を暗号化・復号化するのを支援します。([Usage for UID2 Sharers](sdk-ref-java.md#usage-for-uid2-sharers))
  • ビッドリクエストから UID2 Token を復号する DSP を支援します。([Decrypt UID2 Tokens for RTB Use](guides/dsp-guide.md#decrypt-uid2-tokens-for-rtb-use))
| Publishers
DSPs
Advertisers
Data Providers | +| [SDK for Java](sdk-ref-java.md) | Java Server-Side を使用するオーディエンスのための SDK:
  • パブリッシャーが DII から UID2 Token を生成したりリフレッシュしたりするのを支援します。([POST /token/generate](../endpoints/post-token-generate))
  • UID2 Sharer が UID2 Token を暗号化・復号化するのを支援します。([Usage for UID2 sharers](sdk-ref-java.md#usage-for-uid2-sharers))
  • ビッドリクエストから UID2 Token を復号する DSP を支援します。([Decrypt UID2 tokens for RTB use](guides/dsp-guide.md#decrypt-uid2-tokens-for-rtb-use))
| Publishers
DSPs
Advertisers
Data Providers | +| [SDK for Python](sdk-ref-python.md) | Python Server-Side を使用するオーディエンスのための SDK:
  • パブリッシャーが DII から UID2 Token を生成したりリフレッシュしたりするのを支援します。([POST /token/generate](../endpoints/post-token-generate))
  • UID2 Sharer が UID2 Token を暗号化・復号化するのを支援します。([Usage for UID2 sharers](sdk-ref-java.md#usage-for-uid2-sharers))
  • ビッドリクエストから UID2 Token を復号する DSP を支援します。([Decrypt UID2 tokens for RTB use](guides/dsp-guide.md#decrypt-uid2-tokens-for-rtb-use))
| Publishers
DSPs
Advertisers
Data Providers | | [SDK for C# / .NET](sdk-ref-csharp-dotnet.md) | .NET Server-Side を使用するオーディエンスのための SDK:
  • DSP がビッドリクエストから UID2 Token を復号化するのを支援します。
  • UID2 Sharer が UID2 Token を暗号化または復号化するのを支援します。
| DSPs
Advertisers
Data Providers | | [SDK for C++](sdk-ref-cplusplus.md) | C++ Server-Side を使用するオーディエンスのための SDK:
  • DSP がビッドリクエストから UID2 Token を復号化するのを支援します。
  • UID2 Sharer が UID2 Token を暗号化または復号化するのを支援します。
| DSPs
Advertisers
Data Providers | | [SDK for Android](sdk-ref-android.md) | Android アプリをサポートする必要があるパブリッシャー向けに、UID2 を使用してクライアント ID の生成または確立し、UID2 Token の取得プロセスを容易にする SDK。 | Publishers | diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-best-practices.md b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-best-practices.md index b07509e08..552afdc3c 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-best-practices.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-best-practices.md @@ -8,20 +8,20 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Sharing: Best Practices +# UID2 sharing: Best practices raw UID2 や UID2 Token を、UID2 の許可を受けた他のユーザーと安全に共有できるようになったことで、UID2 をビジネスでさまざまに活用できるようになりました。 しかし、UID2 参加者は皆、UID2 エコシステムのセキュリティを維持する責任を負っています。ここでは、UID2 の共有を円滑かつ安全に行うためのベストプラクティスをいくつか紹介します。 -## Best Practices for Managing Raw UID2s and UID2 Tokens +## Best practices for managing raw UID2s and UID2 tokens 以下のガイドラインに従ってください: - プラットフォーム上の UID2 は、UID2 Token としてではなく、raw UID2 として使用・保管してください。UID2 Token を受け取ったら、できるだけ早く復号化してください。 UID2 Token は短命なので、この点は重要です。UID2 Token の作成に使われた鍵の有効期限が切れると、トークンを復号化できなくなります。 -- raw UID2 は、非参加者に**渡してはなりません**。詳細は [UID2 Token Pass-Through](sharing-tokenized-overview.md#uid2-token-pass-through) を参照してください。 +- raw UID2 は、非参加者に**渡してはなりません**。詳細は [UID2 token pass-through](sharing-tokenized-overview.md#uid2-token-pass-through) を参照してください。 - コードでは、将来の拡張性を考慮して、以下を許容してください： @@ -31,7 +31,7 @@ raw UID2 や UID2 Token を、UID2 の許可を受けた他のユーザーと安 - raw UID2 を他の承認された共有参加者と共有する前に、[POST /optout/status](../endpoints/post-optout-status.md) エンドポイントを使用して、raw UID2 のオプトアウトステータスを確認してください。オプトアウトされた raw UID2 を共有しないでください。 -## Decryption Key Refresh Cadence for Sharing +## Decryption key refresh cadence for sharing SDK を使用している場合、共有キーの更新スケジュールを設定することはセットアップの一部です。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-overview.md b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-overview.md index a33c33e9e..4b7c3ea05 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-overview.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-overview.md @@ -8,54 +8,54 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 Sharing: Overview  +# UID2 sharing: Overview  UID2 では、Sharing とは、UID2 参加者間で [raw UID2](../ref-info/glossary-uid.md#gl-raw-uid2) または [UID2 tokens](../ref-info/glossary-uid.md#gl-uid2-token) を配布するプロセスです。 -raw UID2 または UID2 Token が他の参加者と共有される場合はすべて、Sharing の定義に該当します。raw UID2 を送信するすべての共有参加者は、標準セキュリティプラクティスで指定されているセキュリティ要件に従わなければなりません。詳細は [Security Requirements for UID2 Sharing](sharing-security.md) を参照してください。UID2 Token を共有するすべての参加者は、以下の手順に従うことを推奨します。 +raw UID2 または UID2 Token が他の参加者と共有される場合はすべて、Sharing の定義に該当します。raw UID2 を送信するすべての共有参加者は、標準セキュリティプラクティスで指定されているセキュリティ要件に従わなければなりません。詳細は [Security requirements for UID2 sharing](sharing-security.md) を参照してください。UID2 Token を共有するすべての参加者は、以下の手順に従うことを推奨します。 -## Sharing Participants +## Sharing participants UID2 では、Sharing Participant とは、ある UID2 参加者から別の UID2 参加者への raw UID2 または UID2 Token の配布に参加する企業のことです。 共有参加者は、パブリッシャー、広告主、DSP、データプロバイダーである場合もあれば、これらの役割を複数持つ場合もあります。 -## Approved Sharing Scenarios +## Approved sharing scenarios いくつかの主な共有シナリオは次の表にまとめられています。 -例は、[Sharing UID2s: Use Cases](sharing-use-cases.md) を参照してください。 +例は、[Sharing UID2s: Use cases](sharing-use-cases.md) を参照してください。 | Sharing Scenario | Sender | Receiver | Sharing Approach | Sharing Route | Link for Details | :--- | :--- | :--- | :--- | :--- | :--- | -| ビッドストリームでの共有 | パブリッシャー | DSP | UID2 Token の共有 (tokenized sharing) | パブリッシャーが UID2 Token を生成し、ビッドストリームに送信します。 | [Tokenized Sharing in the Bidstream](sharing-tokenized-from-data-bid-stream.md) | -| ピクセルによる共有 | 承認された任意の[参加者](../ref-info/glossary-uid.md#gl-sharing-participant) | 承認された任意の[参加者](../ref-info/glossary-uid.md#gl-sharing-participant) | UID2 Token の共有 (tokenized sharing) | トラッキングピクセルやクリエイティブピクセルなど、あらゆるピクセルを介した共有。 | [Tokenized Sharing in Pixels](sharing-tokenized-from-data-pixel.md) | -| 他の UID2 Sharing 参加者とビッドストリームまたはピクセル以外で共有 | 承認された任意の[参加者](../ref-info/glossary-uid.md#gl-sharing-participant) | 承認された任意の[参加者](../ref-info/glossary-uid.md#gl-sharing-participant) | raw UID2 の共有
または
UID2 Token の共有 (tokenized sharing) | API や Amazon S3 ドロップなど安全なチャネルによる共有。 | [Raw UID2 Sharing](sharing-raw.md)
or
[Tokenized Sharing from Raw UID2s](sharing-tokenized-from-raw.md) | +| ビッドストリームでの共有 | パブリッシャー | DSP | UID2 Token の共有 (tokenized sharing) | パブリッシャーが UID2 Token を生成し、ビッドストリームに送信します。 | [Tokenized sharing in the bidstream](sharing-tokenized-from-data-bid-stream.md) | +| ピクセルによる共有 | 承認された任意の[参加者](../ref-info/glossary-uid.md#gl-sharing-participant) | 承認された任意の[参加者](../ref-info/glossary-uid.md#gl-sharing-participant) | UID2 Token の共有 (tokenized sharing) | トラッキングピクセルやクリエイティブピクセルなど、あらゆるピクセルを介した共有。 | [Tokenized sharing in pixels](sharing-tokenized-from-data-pixel.md) | +| 他の UID2 Sharing 参加者とビッドストリームまたはピクセル以外で共有 | 承認された任意の[参加者](../ref-info/glossary-uid.md#gl-sharing-participant) | 承認された任意の[参加者](../ref-info/glossary-uid.md#gl-sharing-participant) | raw UID2 の共有
または
UID2 Token の共有 (tokenized sharing) | API や Amazon S3 ドロップなど安全なチャネルによる共有。 | [Raw UID2 sharing](sharing-raw.md)
or
[Tokenized sharing from raw UID2s](sharing-tokenized-from-raw.md) | -## UID2 Sharing Approaches +## UID2 sharing approaches 共有参加者が UID2 を他の許可された共有参加者と共有したい場合、2つの経路があります: -- [Sharing UID2 Tokens](#sharing-uid2-tokens) -- [Sharing Raw UID2s](#sharing-raw-uid2s) +- [Sharing UID2 tokens](#sharing-uid2-tokens) +- [Sharing raw UID2s](#sharing-raw-uid2s) -### Sharing UID2 Tokens +### Sharing UID2 tokens 以下は、UID2 Token を共有 ([tokenized sharing](../ref-info/glossary-uid.md#gl-tokenized-sharing)) するための手順です: 1. 送信者は UID2 Portal で共有権限を設定します。 :::note - 共有を使用するには、API Key ([API Keys](../portal/api-keys.md) を参照) または client-side key pair ([Client-Side Integration](../portal/client-side-integration.md) を参照) が必要です。UID2 Portal では、共有権限を設定する前に、これらの値を設定してください。 + 共有を使用するには、API Key ([API keys](../portal/api-keys.md) を参照) または client-side key pair ([Client-side integration](../portal/client-side-integration.md) を参照) が必要です。UID2 Portal では、共有権限を設定する前に、これらの値を設定してください。 ::: 2. 送信者は以下のいずれかを行います: - DII から UID2 Token を生成します。 - raw UID2 を UID2 Token に暗号化します。 - 3. 受信者は、共有シナリオに適用される指示に従って、UID2 Token を raw UID2 に復号します ([Approved Sharing Scenarios](#approved-sharing-scenarios) を参照)。 + 3. 受信者は、共有シナリオに適用される指示に従って、UID2 Token を raw UID2 に復号します ([Approved sharing scenarios](#approved-sharing-scenarios) を参照)。 -UID2 Token を共有するためのオプションの詳細と説明へのリンクは、[Tokenized Sharing Overview](sharing-tokenized-overview.md) を参照してください。 +UID2 Token を共有するためのオプションの詳細と説明へのリンクは、[Tokenized sharing overview](sharing-tokenized-overview.md) を参照してください。 -### Sharing Raw UID2s +### Sharing raw UID2s -raw UID2 を共有するには、送り手と受け手の両方が、raw UID2 が漏洩しないことを保証するためのリソース、プロセス、設備を備え、[Security Requirements for UID2 Sharing](sharing-security.md) で定義されている標準的なセキュリティ慣行に従う [共有参加者](ref-info/glossary-uid.md#gl-sharing-participant) であることを期待します。 +raw UID2 を共有するには、送り手と受け手の両方が、raw UID2 が漏洩しないことを保証するためのリソース、プロセス、設備を備え、[Security requirements for UID2 sharing](sharing-security.md) で定義されている標準的なセキュリティ慣行に従う [共有参加者](ref-info/glossary-uid.md#gl-sharing-participant) であることを期待します。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-raw.md b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-raw.md index a9c361975..ed6296aa1 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-raw.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-raw.md @@ -8,9 +8,9 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Raw UID2 Sharing +# Raw UID2 sharing -[raw UID2](../ref-info/glossary-uid.md#gl-raw-uid2) を他の認可された共有参加者と共有したい [共有参加者](ref-info/glossary-uid.md#gl-sharing-participant) は、[Security Requirements for UID2 Sharing](sharing-security.md) で規定されているように、認証、認可、アカウンティング、安全なトランスポートの責任を守らなければなりません。すべての点が厳密に守られていることを確認してください。 +[raw UID2](../ref-info/glossary-uid.md#gl-raw-uid2) を他の認可された共有参加者と共有したい [共有参加者](ref-info/glossary-uid.md#gl-sharing-participant) は、[Security requirements for UID2 sharing](sharing-security.md) で規定されているように、認証、認可、アカウンティング、安全なトランスポートの責任を守らなければなりません。すべての点が厳密に守られていることを確認してください。 :::note ユーザーのオプトアウトを受け入れることは重要です。raw UID2 を他の承認された共有参加者と共有する前に、[POST /optout/status](../endpoints/post-optout-status.md) エンドポイントを使用して、raw UID2 のオプトアウトステータスを確認してください。オプトアウトされた raw UID2 を共有しないでください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-security.md b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-security.md index 3eb8e95d2..17660304c 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-security.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-security.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Security Requirements for UID2 Sharing +# Security requirements for UID2 sharing すべての UID2 参加者は、UID2 エコシステムの安全を確保する中核的な責任を負っています。以下は、すべての UID2 参加者のための標準的なセキュリティ慣行です。承認された [共有参加者](../ref-info/glossary-uid.md#gl-sharing-participant) 間で raw UID2 を共有する場合、これらは必須であり、すべて一貫して満たす必要があります。UID2 Token を共有する場合は推奨されます。 @@ -17,8 +17,8 @@ import Link from '@docusaurus/Link'; - [Authentication](#authentication) - [Authorization](#authorization) - [Accounting](#accounting) -- [Secure Transport](#secure-transport) -- [Example Workflow](#example-workflow) +- [Secure transport](#secure-transport) +- [Example workflow](#example-workflow) ## Authentication @@ -59,14 +59,14 @@ Accounting とは、取引の記録があり、必要に応じてその活動を ネットワークログ、アプリケーションログ、クラウド監査ログなどの追加ログも、送信元と送信先の IP アドレスやクラウドプラットフォームのアカウント ID などの追加情報を提供することで役立ちます。 -## Secure Transport +## Secure transport セキュアトランスポートは、送信者から受信者、エンドからエンドへのデータの移行中に、傍受者が raw UID2 にアクセスしたり、変更したりできないように保護するのに役立ちます。セキュアトランスポートの例: - HTTPS or TLS - Message-based encryption -## Example Workflow +## Example workflow 以下は、契約検証のための人による確認ステップを含む、オンライン AAA (Authentication, Authorization, and Accounting) フローのワークフロー例です。 1. Pre-Authentication: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-data-bid-stream.md b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-data-bid-stream.md index 378c7d30c..68ba9e748 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-data-bid-stream.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-data-bid-stream.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Tokenized Sharing in the Bidstream +# Tokenized sharing in the bidstream ビッドストリームに共有される UID2 データは、[directly identifying information (DII)](../ref-info/glossary-uid.md#gl-dii) (メールアドレスまたは電話番号) を直接 UID2 Token に暗号化して生成された UID2 Token の形式でなければなりません。 @@ -21,49 +21,49 @@ import Link from '@docusaurus/Link'; ::: パブリッシャー向けの追加情報は以下のページにあります: -- [UID2 Overview for Publishers](../overviews/overview-publishers.md) -- [UID2 Portal: Overview](../portal/portal-overview.md) +- [UID2 overview for publishers](../overviews/overview-publishers.md) +- [UID2 portal: Overview](../portal/portal-overview.md) ### Audience ビッドストリームにおける Tokenized Sharing は、以下のオーディエンスに適用されます: - **Sender**: パブリッシャー。UID2 Portal でのアカウント設定は任意です。 -- **Receiver**: DSP. [Information for Sharing Receivers](#information-for-sharing-receivers) を参照してください。 +- **Receiver**: DSP. [Information for sharing receivers](#information-for-sharing-receivers) を参照してください。 -### Implementation Options for Senders +### Implementation options for senders DII を直接 UID2 Token に暗号化してビッドストリームに送信するには、以下の方法があります。 | Integration Option | Token Generated Client-Side or Server-Side? | Integration Guide | | :--- | :--- | :--- | -| Prebid.js | Client-Side | [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) | -| Prebid.js | Server-Side | [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) | -| JavaScript SDK | Client-Side | [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) | -| JavaScript SDK | Server-Side | [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) | -| Java SDK | Server-Side | [SDK for Java Reference Guide](../sdks/sdk-ref-java.md) | -| Python SDK | Server-Side | [SDK for Python Reference Guide](../sdks/sdk-ref-python.md) | -| UID2 API (token generate and refresh) | Server-Side | [UID2 Endpoints Summary: UID2 Tokens](../endpoints/summary-endpoints.md#uid2-tokens) | +| Prebid.js | Client-Side | [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) | +| Prebid.js | Server-Side | [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) | +| JavaScript SDK | Client-Side | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | +| JavaScript SDK | Server-Side | [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) | +| Java SDK | Server-Side | [SDK for Java reference guide](../sdks/sdk-ref-java.md) | +| Python SDK | Server-Side | [SDK for Python reference guide](../sdks/sdk-ref-python.md) | +| UID2 API (token generate and refresh) | Server-Side | [UID2 endpoints summary: UID2 tokens](../endpoints/summary-endpoints.md#uid2-tokens) | これらのオプションは、メールアドレスまたは電話番号から UID2 Token を生成し、トークンを定期的に更新することをサポートしています。他の SDK は、現時点ではトークン生成とトークン更新をサポートしていません。 :::tip -SDK に関する詳細は、[SDK Functionality](../sdks/summary-sdks.md#sdk-functionality) を参照してください。パブリッシャー向けのインテグレーションアプローチの詳細は、[Publisher Integrations](../guides/summary-guides.md#publisher-integrations) を参照してください。 +SDK に関する詳細は、[SDK functionality](../sdks/summary-sdks.md#sdk-functionality) を参照してください。パブリッシャー向けのインテグレーションアプローチの詳細は、[Publisher integrations](../guides/summary-guides.md#publisher-integrations) を参照してください。 ::: -### Decryption Options for Receivers +### Decryption options for receivers UID2 Token の復号化には以下の方法があります。 | 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) | - | Tokenized sharing in the bidstream from DII | [DSP Integration Guide](../guides/dsp-guide.md) | - | Tokenized sharing in tracking pixels from DII | [Workflow: Tokenized Sharing in Tracking Pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-tracking-pixels) | - | Tokenized sharing in creative pixels from raw UID2s | [Workflow: Tokenized Sharing in Creative Pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-creative-pixels) | + | 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) | + | Tokenized sharing in the bidstream from DII | [DSP integration guide](../guides/dsp-guide.md) | + | Tokenized sharing in tracking pixels from DII | [Workflow: Tokenized sharing in tracking pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-tracking-pixels) | + | Tokenized sharing in creative pixels from raw UID2s | [Workflow: Tokenized sharing in creative pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-creative-pixels) | -### Account Setup in the UID2 Portal +### Account setup in the UID2 portal ビッドストリームで共有する場合、送信者は UID2 Portal アカウントを必要としません。どのパブリッシャーも、すべての DSP と共有できるように自動的に設定されます。ただし、パブリッシャーで共有範囲を限定したい場合は、UID2 Portal アカウントをリクエストし、共有権限を設定することができます。たとえば、セキュリティ上の理由やその他の理由で、1社または複数の共有パートナーに限定して共有したい場合などです。 @@ -71,18 +71,18 @@ UID2 Token の復号化には以下の方法があります。 送信者は、受信者または参加者のタイプごとに共有許可を1回だけ設定する必要があります。ただし、新しい共有権限を追加したり、既存の共有権限を変更したりする場合は、再度設定し直す必要があります。 -詳細は [UID2 Portal: Overview](../portal/portal-overview.md) を参照し、各タスクのリンクをたどってください。 +詳細は [UID2 portal: Overview](../portal/portal-overview.md) を参照し、各タスクのリンクをたどってください。 -### Workflow: Tokenized Sharing in the Bidstream +### Workflow: Tokenized sharing in the bidstream API または指定された Server-Side SDK を介して、DII から UID2 Token を生成するワークフローは、以下の手順で構成されます: 1. UID2 とのインテグレーションをセットアップします: - - パブリッシャー: [Implementation Options for Senders](#implementation-options-for-senders) に記載されているいずれかの方法を使用します。 + - パブリッシャー: [Implementation options for senders](#implementation-options-for-senders) に記載されているいずれかの方法を使用します。 - オプションで、UID2 Token を復号化できる DSP を制限できます: UID2 Portal で共有権限を設定します。[Account Setup in the UID2 Portal](#account-setup-in-the-uid2-portal) を参照してください。 - - DSP: [Decryption Options for Receivers](#decryption-options-for-receivers) に記載されているインテグレーションオプションのいずれかを使用します。 + オプションで、UID2 Token を復号化できる DSP を制限できます: UID2 Portal で共有権限を設定します。[Account setup in the UID2 portal](#account-setup-in-the-uid2-portal) を参照してください。 + - DSP: [Decryption options for receivers](#decryption-options-for-receivers) に記載されているインテグレーションオプションのいずれかを使用します。 1. パブリッシャーは以下の手順で UID2 Token を作成し、送信します: @@ -93,13 +93,13 @@ API または指定された Server-Side SDK を介して、DII から UID2 Toke 1. UID2 Token を受け取ります。 1. UID2 Token を raw UID2 に復号します。 - 1. UID2 がオプトアウトされていないことを確認します。詳細は [Honor User Opt-Outs](../guides/dsp-guide.md#honor-user-opt-outs) を参照してください。オプトアウトされていない場合は、raw UID2 を入札に使用します。 + 1. UID2 がオプトアウトされていないことを確認します。詳細は [Honor user opt-outs](../guides/dsp-guide.md#honor-user-opt-outs) を参照してください。オプトアウトされていない場合は、raw UID2 を入札に使用します。 以下の図は、パブリッシャーのための UID2 共有ワークフローです。 -![UID2 Sharing Permission Integration Workflow for publishers](images/UID2_Sharing_Diagram_Integrate_SDK_Bid_Stream.png) +![UID2 sharing permission integration workflow for publishers](images/UID2_Sharing_Diagram_Integrate_SDK_Bid_Stream.png) -### Token Example for Publishers in the Bidstream +### Token example for publishers in the bidstream パブリッシャーは、次の例に示すように、入力されたメールアドレスまたは電話番号を直接 UID2 Token に変換し、ビッドストリームで使用します。 @@ -134,17 +134,17 @@ API または指定された Server-Side SDK を介して、DII から UID2 Toke -## Information for Sharing Receivers +## Information for sharing receivers UID2 Token を raw UID2 に復号するには、承認された共有参加者であり、送信者の暗号鍵を持っている必要があります。 デフォルトでは、パブリッシャーが UID2 Token をビッドストリームに送信する場合、パブリッシャーの暗号キーはすべての承認済み DSP と共有されます。ただし、パブリッシャーが特定の共有関係を設定している場合は、パブリッシャーが共有関係を作成している場合にのみ、そのパブリッシャーの暗号キーを受け取ることができます。 -詳細は [Receiving UID2 Tokens from Another Sharing Participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant) を参照してください。 +詳細は [Receiving UID2 tokens from another sharing participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant) を参照してください。 暗号鍵の更新を定期的に行い、UID2 Token を速やかに復号化することが重要です。 詳細は、*UID2 Sharing: Best Practices*の以下のセクションを参照してください: -- [Decryption Key Refresh Cadence for Sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) -- [Best Practices for Managing Raw UID2s and UID2 Tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) +- [Decryption key refresh cadence for sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) +- [Best practices for managing raw UID2s and UID2 tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-data-pixel.md b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-data-pixel.md index ecaaf3def..329947da5 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-data-pixel.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-data-pixel.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Tokenized Sharing in Pixels +# Tokenized sharing in pixels ピクセルで共有される UID2 データは、以下の2つの方法のいずれかで生成された UID2 Token でなければなりません: @@ -26,9 +26,9 @@ import Link from '@docusaurus/Link'; ピクセルでの Tokenized sharing は、以下の対象者に適用されます: - **Sender**: 最も一般的なのは広告主またはデータプロバイダーですが、承認された共有参加者であれば誰でもかまいません。 -- **Receiver**: 承認された共有参加者であれば誰でも構いません。[Information for Sharing Receivers](#information-for-sharing-receivers) を参照してください。 +- **Receiver**: 承認された共有参加者であれば誰でも構いません。[Information for sharing receivers](#information-for-sharing-receivers) を参照してください。 -## Sharing UID2 Tokens in Pixels +## Sharing UID2 tokens in pixels 参加者によって、ピクセルの使用方法は異なります。次の表は、広告技術のエコシステムにおけるピクセルの2つの一般的な使用例を示しています。 @@ -41,26 +41,26 @@ import Link from '@docusaurus/Link'; 2つのシナリオがあります: -- [Tokenized Sharing in Tracking Pixels](#workflow-tokenized-sharing-in-tracking-pixels) -- [Tokenized Sharing in Creative Pixels](#workflow-tokenized-sharing-in-creative-pixels) +- [Tokenized sharing in tracking pixels](#workflow-tokenized-sharing-in-tracking-pixels) +- [Tokenized sharing in creative pixels](#workflow-tokenized-sharing-in-creative-pixels) -## Account Setup in the UID2 Portal +## Account setup in the UID2 portal UID2 Portal では、送信者と受信者がアカウントを設定し、送信者が共有許可を行う必要があります。 送信者は、受信者または参加者タイプごとに共有許可を1回だけ設定するだけで済みます。ただし、新しい共有許可を追加したり、既存の設定を変更したい場合は、設定を調整する必要があります。 -詳細は [UID2 Portal: Overview](../portal/portal-overview.md) を参照し、各タスクのリンクをたどってください。 +詳細は [UID2 portal: Overview](../portal/portal-overview.md) を参照し、各タスクのリンクをたどってください。 -## Workflow: Tokenized Sharing in Tracking Pixels +## Workflow: Tokenized sharing in tracking pixels :::tip -トラッキングピクセル用のトークンを生成する場合、raw UID2 ではなく、DII から直接 UID2 Token を生成することを推奨します。これはいくつかの方法で行うことができますが、UID2 Token をクライアントサイドで生成することを推奨します。手順は、[Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) を参照してください。 +トラッキングピクセル用のトークンを生成する場合、raw UID2 ではなく、DII から直接 UID2 Token を生成することを推奨します。これはいくつかの方法で行うことができますが、UID2 Token をクライアントサイドで生成することを推奨します。手順は、[Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) を参照してください。 ::: ウェブサイトで製品の購入などのアクションが完了したときにトリガーされるトラッキングピクセルを使用している場合、おそらく DII から始めて、UID2 Token に変換して共有します。 -UID2 送信者は、UID2 Token を復号化できる受信者を指定します。これは、UID2 Portal で権限を設定することで行います(詳細は [Sharing Permissions](../portal/sharing-permissions.md) を参照)。送信者が UID2 Sharing の権限を受信者に付与すると、送信者の暗号キーが UID2 SDK または Snowflake を介して受信者と共有されます。共有の一環として、UID2 SDK と API は暗号化と復号化を処理します。 +UID2 送信者は、UID2 Token を復号化できる受信者を指定します。これは、UID2 Portal で権限を設定することで行います(詳細は [Sharing permissions](../portal/sharing-permissions.md) を参照)。送信者が UID2 Sharing の権限を受信者に付与すると、送信者の暗号キーが UID2 SDK または Snowflake を介して受信者と共有されます。共有の一環として、UID2 SDK と API は暗号化と復号化を処理します。 たとえば、広告主(送信者)が UID2 Token を UID2 DSP と共有することを望んでいるとします。これは、トラッキングピクセルを介したコンバージョントラッキングのためです。共有を使用するには、次のシーケンスになります: @@ -70,31 +70,31 @@ UID2 送信者は、UID2 Token を復号化できる受信者を指定します 2. ユーザーから提供された DII から UID2 Token を直接生成します。これは、[POST /token/generate](../endpoints/post-token-generate.md) エンドポイントまたは UID2 Token を生成する SDK のいずれかを使用して行います。 - オプションの概要は、[SDK Functionality](../sdks/summary-sdks.md#sdk-functionality) を参照してください。JavaScript を使用して UID2 Token を生成する方法は、[Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) を推奨します。 + オプションの概要は、[SDK functionality](../sdks/summary-sdks.md#sdk-functionality) を参照してください。JavaScript を使用して UID2 Token を生成する方法は、[Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) を推奨します。 3. UID2 Token を DSP に安全に送信します。 2. DSPは、受信者であり、共有に参加しています。DSPは、UID2 Portal の共有権限設定を通じて広告主の暗号鍵にアクセスできるため、UID2 Token をセグメント作成のための raw UID2 に復号化できます。 -UID2 送信者と受信者の両方が、UID2 Portal アカウントを作成する必要があります(詳細は [Account Setup in the UID2 Portal](#account-setup-in-the-uid2-portal) を参照)。アカウントがない場合、UID2 参加者は UID2 Portal の共有参加者リストに表示されず、送信者の暗号キーを受信して復号化することができません。 +UID2 送信者と受信者の両方が、UID2 Portal アカウントを作成する必要があります(詳細は [Account setup in the UID2 portal](#account-setup-in-the-uid2-portal) を参照)。アカウントがない場合、UID2 参加者は UID2 Portal の共有参加者リストに表示されず、送信者の暗号キーを受信して復号化することができません。 -## Workflow: Tokenized Sharing in Creative Pixels +## Workflow: Tokenized sharing in creative pixels クリエイティブピクセルを使用している場合、DSP は raw UID2 を UID2 Token に変換してクリエイティブピクセルに追加します。トークンはインプレッション時に発火されるクリエイティブピクセルに追加されます。 すべての実装ステップは、[raw UID2 からの Tokenized sharing](sharing-tokenized-from-raw.md) と同じです。 -Snowflake を使用してピクセルで Tokenized Sharing を実装する方法の例は、[Snowflake Integration Guide: Usage for UID2 Sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) を参照してください。 +Snowflake を使用してピクセルで Tokenized Sharing を実装する方法の例は、[Snowflake integration guide: Usage for UID2 sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) を参照してください。 -## Information for Sharing Receivers +## Information for sharing receivers UID2 Token を raw UID2 に復号化するには、UID2 Portal アカウントが必要であり、送信者があなたとの共有関係を作成する必要があります。 -詳細は [Receiving UID2 Tokens from Another Sharing Participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant) を参照してください。 +詳細は [Receiving UID2 tokens from another sharing participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant) を参照してください。 暗号鍵の更新を定期的に行い、UID2 Token をすみやかに復号化することが重要です。 詳細は、*UID2 Sharing: Best Practices* の次のセクションを参照してください: -- [Decryption Key Refresh Cadence for Sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) -- [Best Practices for Managing Raw UID2s and UID2 Tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) +- [Decryption key refresh cadence for sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) +- [Best practices for managing raw UID2s and UID2 tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-raw.md b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-raw.md index 3ea2bd5bc..a601ca824 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-raw.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-from-raw.md @@ -8,7 +8,7 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Tokenized Sharing from Raw UID2s +# Tokenized sharing from raw UID2s いくつかのケースでは、共有参加者が raw UID2 を他の共有参加者に送信する前に、それらを暗号化したい場合があります。広告主がクリエイティブピクセルで UID2 を共有する場合がその一例です。 @@ -22,31 +22,31 @@ raw UID2 からの Tokenized sharing は、ユースケースによっては、 共有受信者は、UID2 Portal アカウントを作成して共有を実装し、送信者と共有関係を持つ必要があります。 -## Account Setup in the UID2 Portal +## Account setup in the UID2 portal UID2 Portal では、送信者と受信者はアカウントを設定し、送信者は共有権限を設定する必要があります。 送信者は、受信者または参加者のタイプごとに共有許可を1回だけ設定する必要があります。ただし、新しい共有権限を追加したり、既存の共有権限を変更したりする場合は、再度設定し直す必要があります。 -詳細は [UID2 Portal: Overview](../portal/portal-overview.md) を参照し、各タスクのリンクをたどってください。 +詳細は [UID2 portal: Overview](../portal/portal-overview.md) を参照し、各タスクのリンクをたどってください。 -## Tokenized Sharing Steps: Summary +## Tokenized sharing steps: Summary raw UID2 から UID2 Token を生成して共有する手順を以下に説明します: -1. すべてのユーザーはアカウントを設定し、共有オプションを構成する必要があります。[Account Setup in the UID2 Portal](#account-setup-in-the-uid2-portal) を参照してください。 +1. すべてのユーザーはアカウントを設定し、共有オプションを構成する必要があります。[Account setup in the UID2 portal](#account-setup-in-the-uid2-portal) を参照してください。 2. コードに共有を実装するには、以下から選択してください。選択肢は、使用しているインテグレーションオプションによって異なります: - - [Implementing Sharing Encryption/Decryption with an SDK](#implementing-sharing-encryptiondecryption-with-an-sdk) - - [Implementing Sharing Encryption/Decryption Using Snowflake](#implementing-sharing-encryptiondecryption-using-snowflake) + - [Implementing sharing encryption/decryption with an SDK](#implementing-sharing-encryptiondecryption-with-an-sdk) + - [Implementing sharing encryption/decryption using Snowflake](#implementing-sharing-encryptiondecryption-using-snowflake) -## Workflow: Tokenized Sharing from Raw UID2 +## Workflow: Tokenized sharing from raw UID2 raw UID2 から UID2 Token を生成して、Tokenized Sharing を行うワークフローは、以下の手順で構成されています。 :::note -送信者と受信者の両方が UID2 Portal アカウントを持っている必要があります。[Request an Account](../portal/portal-getting-started.md#request-an-account) を参照してください。 +送信者と受信者の両方が UID2 Portal アカウントを持っている必要があります。[Request an account](../portal/portal-getting-started.md#request-an-account) を参照してください。 ::: 1. 送信者と受信者: [UID2 SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) または [Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake) を使用して UID2 Sharing をインテグレーションします。 @@ -54,7 +54,7 @@ raw UID2 から UID2 Token を生成して、Tokenized Sharing を行うワー 1. 送信者: UID2 Portal で共有権限を承認します: 1. UID2 Token を復号することを許可する共有参加者を定義します。 - 1. UID2 Portal にログインし、[Sharing Permissions](../portal/sharing-permissions.md) ページに移動し、共有したい参加者を指定します。必要に応じて、特定の共有参加者を検索するために検索機能を使用します。 + 1. UID2 Portal にログインし、[Sharing permissions](../portal/sharing-permissions.md) ページに移動し、共有したい参加者を指定します。必要に応じて、特定の共有参加者を検索するために検索機能を使用します。 1. 共有選択肢を保存します。 1. 送信者: UID2 Token に変換するために raw UID2 を暗号化します。これには、[UID2 SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) または [Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake) を使用します。 @@ -64,13 +64,13 @@ raw UID2 から UID2 Token を生成して、Tokenized Sharing を行うワー 1. 受信者: UID2 Token を復号化するために以下の手順を完了します: 1. UID2 Token を安全に受信します。 - 1. UID2 Token を raw UID2 に復号化します: [Implementing Sharing Encryption/Decryption with an SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) または [Implementing Sharing Encryption/Decryption Using Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake) を参照してください。 + 1. UID2 Token を raw UID2 に復号化します: [Implementing sharing encryption/decryption with an SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) または [Implementing sharing encryption/decryption using Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake) を参照してください。 次の図は、UID2 Sharing Permission SDK インテグレーションワークフローを示しています: -![UID2 Sharing Permission SDK Integration Workflow](images/UID2_Sharing_Diagram_Integrate_SDK_Sharing_Token.png) +![UID2 sharing permission SDK integration workflow](images/UID2_Sharing_Diagram_Integrate_SDK_Sharing_Token.png) -## Implementing Sharing Encryption/Decryption with an SDK +## Implementing sharing encryption/decryption with an SDK 以下の手順は、SDK を使用して raw UID2 を UID2 Token に暗号化するか、UID2 Token を raw UID2 に復号化するすべての共有参加者に適用されます。—送信者と受信者。 @@ -78,35 +78,35 @@ raw UID2 から UID2 Token を生成して、Tokenized Sharing を行うワー | 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) | - | Java | [SDK for Java: Usage for UID2 Sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) | - | Python | [SDK for Python: Usage for UID2 Sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) | + | 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) | + | Java | [SDK for Java: Usage for UID2 sharers](../sdks/sdk-ref-java.md#usage-for-uid2-sharers) | + | Python | [SDK for Python: Usage for UID2 sharers](../sdks/sdk-ref-python.md#usage-for-uid2-sharers) | 2. 以下の手順に従って、SDK をコードに組み込み、送信者または受信者の役割に応じて各ステップを実装します。使用している言語のコード例を確認するには、以下の表のリンクを参照してください。 1. 送信者と受信者: UID2 Client を定義します。 2. 送信者と受信者: 暗号鍵の更新スケジュールを定義します。 - 推奨される更新間隔は1時間です。例は、[Decryption Key Refresh Cadence for Sharing (SDK Only)](#decryption-key-refresh-cadence-for-sharing-sdk-only) を参照してください。 + 推奨される更新間隔は1時間です。例は、[Decryption key refresh cadence for sharing (SDK only)](#decryption-key-refresh-cadence-for-sharing-sdk-only) を参照してください。 3. 送信者: 暗号化を設定します。 4. 受信者: 復号化を設定します。 -### Decryption Key Refresh Cadence for Sharing (SDK Only) +### Decryption key refresh cadence for sharing (SDK only) SDK を使用している場合、共有キーの更新スケジュールを定義することもStep 2の一部です。 長時間/継続的に実行されるプロセスでは、1時間に1回 `uid2client.refresh()` 関数を呼び出すことを推奨します。 -詳細は *UID2 Sharing: Best Practices* の [Decryption Key Refresh Cadence for Sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) を参照してください。 +詳細は *UID2 Sharing: Best Practices* の [Decryption key refresh cadence for sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) を参照してください。 :::note Snowflake を使用している場合は、この手順を実行する必要はありません。Snowflake UID2 インテグレーションがキーのリフレッシュを行います。 ::: -### Decryption Key Refresh Example +### Decryption key refresh example この例は、`uid2client.refresh()` 関数が新しい共有許可を有効にする方法を示しています。この例では、広告主 ABC がデータプロバイダ XYZ にデータを送信したいとします。 @@ -116,26 +116,26 @@ Snowflake を使用している場合は、この手順を実行する必要は | 12:30 pm | 広告主 ABC が UID2 Portal にログインし、データプロバイダ XYZ との共有許可を作成します。 | | 1:00 pm | データプロバイダ XYZ は、1時間ごとに `uid2client.refresh()` を再度呼び出します。新しい共有許可があるため、広告主 ABC の鍵がレスポンスに返されます。
データプロバイダ XYZ は、広告主 ABC から受け取った UID2 Token を復号化して raw UID2 に変換できます。 | -## Implementing Sharing Encryption/Decryption Using Snowflake +## Implementing sharing encryption/decryption using Snowflake Snowflake を使用している UID2 参加者は、送信者または受信者として UID2 Sharing に参加することができます。 -1. [Snowflake Integration Guide: Usage for UID2 Sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) の例を確認して、共有コードがどのように見えるかを確認します。 +1. [Snowflake integration guide: Usage for UID2 sharers](../guides/integration-snowflake.md#usage-for-uid2-sharers) の例を確認して、共有コードがどのように見えるかを確認します。 -2. 送信者または受信者の役割に応じて、コードに Snowflake を組み込みます。以下のドキュメントにあるコード例を使用してください: [UID2 Sharing Example](../guides/integration-snowflake.md#uid2-sharing-example): +2. 送信者または受信者の役割に応じて、コードに Snowflake を組み込みます。以下のドキュメントにあるコード例を使用してください: [UID2 sharing example](../guides/integration-snowflake.md#uid2-sharing-example): - 送信者: 暗号化を設定します。 - 受信者: 復号化を設定します。 -## Information for Sharing Receivers +## Information for sharing receivers UID2 Token を raw UID2 に復号化するには、UID2 Portal アカウントが必要であり、送信者があなたとの共有関係を作成する必要があります。 -詳細は [Receiving UID2 Tokens from Another Sharing Participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant) を参照してください。 +詳細は [Receiving UID2 tokens from another sharing participant](sharing-tokenized-overview.md#receiving-uid2-tokens-from-another-sharing-participant) を参照してください。 暗号鍵を定期的に更新し、UID2 Token をすみやかに復号化することが重要です。 詳細は、*UID2 Sharing: Best Practices* の次のセクションを参照してください: -- [Decryption Key Refresh Cadence for Sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) -- [Best Practices for Managing Raw UID2s and UID2 Tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) +- [Decryption key refresh cadence for sharing](sharing-best-practices.md#decryption-key-refresh-cadence-for-sharing) +- [Best practices for managing raw UID2s and UID2 tokens](sharing-best-practices.md#best-practices-for-managing-raw-uid2s-and-uid2-tokens) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-overview.md b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-overview.md index ee919ddfc..0c09f3a66 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-overview.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sharing/sharing-tokenized-overview.md @@ -8,27 +8,27 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# Tokenized Sharing Overview +# Tokenized sharing overview UID2 では、Tokenized Sharing は、DII または raw UID2s を UID2 tokens に暗号化し、トークンを承認された [共有参加者](ref-info/glossary-uid.md#gl-sharing-participant) と共有することを意味します。UID2 Token を使用することで、データが未認可の関係者を通過する場合も含め、データの送信者と受信者の間でエンドツーエンドで raw UID2 を保護することができます。Tokenized sharing は、ビッドストリームまたはピクセル経由での共有に必要ですが、どのような共有ユースケースでも使用できます。 トークンは、次のいずれかの方法で生成されます: -- raw UID2 を UID2 Token に暗号化する: [Tokenized Sharing: Starting with a Raw UID2](#tokenized-sharing-starting-with-a-raw-uid2) を参照してください。 -- DII から直接 UID2 Token を生成する: [Tokenized Sharing: Starting with DII](#tokenized-sharing-starting-with-dii) を参照してください。 +- raw UID2 を UID2 Token に暗号化する: [Tokenized sharing: Starting with a raw UID2](#tokenized-sharing-starting-with-a-raw-uid2) を参照してください。 +- DII から直接 UID2 Token を生成する: [Tokenized sharing: Starting with DII](#tokenized-sharing-starting-with-dii) を参照してください。 -## Tokenized Sharing Scenarios +## Tokenized sharing scenarios 多くのシナリオでは、UID2 データは UID2 token の形で共有されます。主なユースケースは次の表に示されています。 | Scenario | Sender | Receiver | Sharing Approach | | :--- | :--- | :--- | :--- | -| ビッドストリームで UID2 を送信する | パブリッシャー | DSP | [Tokenized Sharing in the Bidstream](sharing-tokenized-from-data-bid-stream.md) を参照してください | -| トラッキングピクセルで UID2 を送信する | どの共有参加者でも | どの共有参加者でも | [Tokenized Sharing in Pixels](sharing-tokenized-from-data-pixel.md) を参照してください | -| 他の共有参加者に UID2 Token を送信する | どの共有参加者でも、[Security Requirements for UID2 Sharing](sharing-security.md) が満たされない場合、またはその他の理由がある場合 | どの共有参加者でも | [Tokenized Sharing from Raw UID2s](sharing-tokenized-from-raw.md) を参照してください | +| ビッドストリームで UID2 を送信する | パブリッシャー | DSP | [Tokenized sharing in the bidstream](sharing-tokenized-from-data-bid-stream.md) を参照してください | +| トラッキングピクセルで UID2 を送信する | どの共有参加者でも | どの共有参加者でも | [Tokenized sharing in pixels](sharing-tokenized-from-data-pixel.md) を参照してください | +| 他の共有参加者に UID2 Token を送信する | どの共有参加者でも、[Security requirements for UID2 sharing](sharing-security.md) が満たされない場合、またはその他の理由がある場合 | どの共有参加者でも | [Tokenized sharing from raw UID2s](sharing-tokenized-from-raw.md) を参照してください | -その他の例は、[Sharing UID2s: Use Cases](sharing-use-cases.md) を参照してください。 +その他の例は、[Sharing UID2s: Use cases](sharing-use-cases.md) を参照してください。 -## Sending UID2 Tokens to Another Sharing Participant +## Sending UID2 tokens to another sharing participant UID2 Token を介して別の共有参加者と UID2 を共有することは、どのような共有シナリオでもオプションですが、ビッドストリーム内またはピクセル内では必須です。次の表に示すように、プロセスは開始点によって少し異なります。 @@ -36,41 +36,41 @@ UID2 では、Tokenized Sharing は、ビッドストリーム経由で DSP (受信者) に送信します。([Tokenized Sharing in the Bidstream](sharing-tokenized-from-data-bid-stream.md) を参照) - - 広告主 (送信者) がトラッキングピクセルを通じて UID2 Token をデータプロバイダー (受信者) に送信します。([Tokenized Sharing in Pixels](sharing-tokenized-from-data-pixel.md) を参照) + - パブリッシャー (送信者) は、UID2 Token をビッドストリーム経由で DSP (受信者) に送信します。([Tokenized sharing in the bidstream](sharing-tokenized-from-data-bid-stream.md) を参照) + - 広告主 (送信者) がトラッキングピクセルを通じて UID2 Token をデータプロバイダー (受信者) に送信します。([Tokenized sharing in pixels](sharing-tokenized-from-data-pixel.md) を参照) - Raw UID2 共有 (sharing a raw UID2) の例: - - 測定パートナー (送信者) は、Amazon Simple Storage Service (S3) を介して、raw UID2 を広告主 (受信者) に送信します。([Raw UID2 Sharing](sharing-raw.md) を参照) - - DSP (送信者) は、raw UID2 をレポート経由で広告主 (受信者) に送信します。([Raw UID2 Sharing](sharing-raw.md) を参照) + - 測定パートナー (送信者) は、Amazon Simple Storage Service (S3) を介して、raw UID2 を広告主 (受信者) に送信します。([Raw UID2 sharing](sharing-raw.md) を参照) + - DSP (送信者) は、raw UID2 をレポート経由で広告主 (受信者) に送信します。([Raw UID2 sharing](sharing-raw.md) を参照) これらのシナリオと、その他のシナリオを以下の図に示します。 -![Illustration of Sharing Use Cases](images/SharingSlide-Examples.png) +![Illustration of sharing use cases](images/SharingSlide-Examples.png) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-integrating-with-sso.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-integrating-with-sso.mdx index d4c3fc8b2..925569778 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-integrating-with-sso.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-integrating-with-sso.mdx @@ -1,3 +1,3 @@ SSO ログインを提供するために1つ以上の SSO プロバイダーとインテグレーションしている場合、SSO プロバイダーからログインユーザーのメールアドレスを取得して UID2 Token を生成できる可能性があります。 -詳細は、[Publisher Integration with SSO Providers](../ref-info/ref-integration-sso-providers.md) を参照してください。 +詳細は、[Publisher integration with SSO providers](../ref-info/ref-integration-sso-providers.md) を参照してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile-docs-error-response-states.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile-docs-error-response-states.mdx index cfafe49af..170dc5830 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile-docs-error-response-states.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile-docs-error-response-states.mdx @@ -3,15 +3,15 @@ 特定の条件下では、モバイル SDK は次のいずれかのエラーレスポンス状態を返す可能性があります: - [Expired](#response-state-of-expired) -- [RefreshExpired](#response-state-of-refreshexpired) +- [Refreshexpired](#response-state-of-refreshexpired) - [Invalid](#response-state-of-expired) -- [NoIdentity](#response-state-of-expired) +- [Noidentity](#response-state-of-expired) :::note レスポンスステータスは、Android と iOS の両方で同じです。 ::: -### Response State of Expired +### Response state of expired `Expired` のレスポンスステータスは、UID2 Token が有効期限切れであることを示しますが、リフレッシュトークンは有効期限切れではないため、UID2 Token をリフレッシュできます。 @@ -23,7 +23,7 @@ **Manual refresh**: トークンの自動リフレッシュを無効にしている場合、`Expired` のレスポンスステータスが返された場合、`refreshIdentity()` メソッドを呼び出してリフレッシュを手動でリクエストできます。 -### Response State of RefreshExpired +### Response state of refreshexpired `RefreshExpired` のレスポンスステータスは、UID2 Token と Refresh Token の両方が有効期限切れであることを示します。そのため、UID2 Token をリフレッシュできません。 @@ -31,7 +31,7 @@ この場合、Identity を再生成する必要があります。 -### Response State of Invalid +### Response state of invalid `Invalid` のレスポンスステータスは、ディスクからロードされたか、API 経由でリクエストされた ID に、必要なすべてのトークンが含まれていないことを示します。これは起こるべきではありませんが、予期しない状況で発生する可能性があります。 @@ -39,7 +39,7 @@ SDK がこのエラーを検出すると、以前の ID は使用できないと この場合、Identity を再生成する必要があります。また、問題を UID2 の連絡先に報告することが望ましいです。 -### Response State of NoIdentity +### Response state of noidentity `NoIdentity` のレスポンスステータスは、SDK は初期化されていますが、現在の identity がまだ生成されていないことを示します。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx index 0eb8b4a19..f329a1aa3 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx @@ -3,10 +3,10 @@ import TabItem from '@theme/TabItem'; UID2 Token を生成して [Google GMA SDK](https://developers.google.com/ad-manager/mobile-ads-sdk) または [Google IMA SDK](https://developers.google.com/interactive-media-ads/) に送信する場合、このガイドに従っていると仮定して、モバイルアプリに UID2 GMA/IMA プラグインを追加する必要があります。手順は、該当するプラグインガイドを参照してください。 -- [UID2 GMA Plugin for Android Integration Guide](../guides/mobile-plugin-gma-android) -- [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios) -- [UID2 IMA Plugin for Android Integration Guide](../guides/mobile-plugin-ima-android) -- [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios) +- [UID2 GMA plugin for Android integration guide](../guides/mobile-plugin-gma-android) +- [UID2 GMA plugin for iOS integration guide](../guides/mobile-plugin-gma-ios) +- [UID2 IMA plugin for Android integration guide](../guides/mobile-plugin-ima-android) +- [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios) Advertising Token を取得して Google GMA/IMA SDK に手動で渡すために、明示的に `getAdvertisingToken()` メソッドを呼び出す必要はありません。UID2 GMA/IMA プラグインが自動的に処理します。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile_docs_prebid-mobile.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile_docs_prebid-mobile.mdx index ae651e400..34b56ad84 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile_docs_prebid-mobile.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-mobile_docs_prebid-mobile.mdx @@ -15,7 +15,7 @@ UID2 Prebid for Mobile インテグレーションを設定するには、次の 1. [Prebid SDK Integration for Android](https://docs.prebid.org/prebid-mobile/pbm-api/android/code-integration-android.html) または [Prebid SDK Integration for iOS](https://docs.prebid.org/prebid-mobile/pbm-api/ios/code-integration-ios.html) の手順に従って、Prebid の Mobile SDK を設定します。 -2. [Add the UID2 Mobile SDK to Your Mobile App](#add-the-uid2-mobile-sdk-to-your-mobile-app) の手順に従って、UID2 Mobile SDK をアプリに追加します。 +2. [Add the UID2 Mobile SDK to your mobile app](#add-the-uid2-mobile-sdk-to-your-mobile-app) の手順に従って、UID2 Mobile SDK をアプリに追加します。 3. UID2 Prebid インテグレーションは別のモジュールとして配布されているため、プロジェクトの依存関係として追加する必要があります。以下のオプションのいずれかに適用されるインストール手順に従います: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-preparing-emails-and-phone-numbers.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-preparing-emails-and-phone-numbers.mdx index 64b4e1db5..4d8f6f89a 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-preparing-emails-and-phone-numbers.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-preparing-emails-and-phone-numbers.mdx @@ -1,7 +1,7 @@ import Link from "@docusaurus/Link"; -UID2 に変換する入力データが許容可能な形式であることは非常に重要です。そうでない場合、期待される結果は得られません。たとえば、[Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) で説明されているように、電話番号には国コードを含めるように正規化する必要があります。 +UID2 に変換する入力データが許容可能な形式であることは非常に重要です。そうでない場合、期待される結果は得られません。たとえば、[Phone number normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization) で説明されているように、電話番号には国コードを含めるように正規化する必要があります。 -詳細は、[Preparing Emails and Phone Numbers for Processing](../ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md) を参照してください。 +詳細は、[Preparing emails and phone numbers for processing](../ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md) を参照してください。 フルトークン生成パイプラインをエンドツーエンドで検証し、正規化・ハッシュ化・エンコードされた値から生成されたトークンが正確であることを確認するためには、［UID2 Token Validator］（../ref-info/ref-token-validator.md）を使用してください。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-private-operator-option.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-private-operator-option.mdx index 7ccb7f400..4a9b7f9b7 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-private-operator-option.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-private-operator-option.mdx @@ -5,7 +5,7 @@ import Link from '@docusaurus/Link'; その他の情報は、次のリソースを確認してください: - [The UID2 Operator](../ref-info/ref-operators-public-private.md) -- [UID2 Private Operator Integration Overview](../guides/integration-options-private-operator.md) +- [UID2 Private Operator integration overview](../guides/integration-options-private-operator.md) :::note UID2 Private Operator ソリューションは、UID2 Token の Client-Side 生成をサポートしていません。Client-Side インテグレーションを希望する場合は、Public Operator ソリューションを使用する必要があります。 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-publisher-implementation-resources.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-publisher-implementation-resources.mdx index 732b13db2..f75602161 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-publisher-implementation-resources.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/snippets/_snpt-publisher-implementation-resources.mdx @@ -2,71 +2,71 @@ import Link from '@docusaurus/Link'; パブリッシャーが UID2 を実装するために利用できるリソースは以下の通りです: -- [Web Integrations](#web-integrations) -- [Mobile Integrations](#mobile-integrations) -- [CTV Integrations](#ctv-integrations) -- [Prebid Integrations](#prebid-integrations) -- [Google Ad Manager Integrations](#google-ad-manager-integrations) +- [Web integrations](#web-integrations) +- [Mobile integrations](#mobile-integrations) +- [CTV integrations](#ctv-integrations) +- [Prebid integrations](#prebid-integrations) +- [Google Ad Manager integrations](#google-ad-manager-integrations) -### Web Integrations +### Web integrations 以下のリソースは、パブリッシャーの Web インテグレーションに利用できます。 :::tip -Web インテグレーションオプションの詳細は [Publisher Web Integration Overview](../guides/integration-options-publisher-web.md) を参照してください。 +Web インテグレーションオプションの詳細は [Publisher web integration overview](../guides/integration-options-publisher-web.md) を参照してください。 ::: | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| Prebid (Overview) | [UID2 Integration Overview for Prebid](../guides/integration-prebid.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js または Prebid Mobile SDK から渡される UID2 Token (Advertising Token) を生成したいパブリッシャー向けのインテグレーションオプションの概要です。 | -| Prebid.js Client-Side Integration | [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) | 最も簡単な実装方法であるClient-Side で UID2 Token をリクエストし、Prebid.js に以下を管理させることを選択したいパブリッシャー向けのガイドです:
  • トークンの生成と Token Refresh。
  • トークンを RTB ビッドストリームに渡す。
| -| Prebid.js Client-Server Integration | [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js から渡される UID2 Token を生成したいが、トークンを Server-Side で生成したいパブリッシャー向けのガイドです: たとえば、Private Operator を利用しているパブリッシャーなど。 | -| JavaScript (Overview) | [UID2 Integration Overview for JavaScript](../guides/integration-javascript.md) | JavaScript SDK を使って UID2 とインテグレーションしたいパブリッシャー向けのオプションの概要です。 | -| JavaScript Client-Side Integration | [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) | Client-Side の JavaScript の変更だけで UID2 とインテグレーションしたいパブリッシャー向けのガイドで、最も簡単な実装方法です。
SDK for JavaScript は、トークン生成とトークンリフレッシュを自動的に管理します。 | -| JavaScript Client-Server Integration | [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) | SDK for JavaScript を使用し、トークンを Server-Side で生成してパブリッシャーのウェブページに渡す必要がある、標準的なWeb インテグレーションシナリオを網羅したパブリッシャーガイドです。 | -| Server-Side Integration | [Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md) | [SDK for JavaScript](../sdks/sdk-ref-javascript.md) を使用しないパブリッシャー向けのガイドです。 | -| Publisher/SSP Integration with GAM | [Google Ad Manager Secure Signals Integration Guide](../guides/integration-google-ss.md) | パブリッシャーが UID2 を Google Ad Manager のセキュアシグナル機能(旧称: Encrypted Signals for Publishers、ESP) で使用する際に必要な追加手順について説明したガイドです。 | +| Prebid (Overview) | [UID2 integration overview for Prebid](../guides/integration-prebid.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js または Prebid Mobile SDK から渡される UID2 Token (Advertising Token) を生成したいパブリッシャー向けのインテグレーションオプションの概要です。 | +| Prebid.js Client-Side Integration | [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) | 最も簡単な実装方法であるClient-Side で UID2 Token をリクエストし、Prebid.js に以下を管理させることを選択したいパブリッシャー向けのガイドです:
  • トークンの生成と Token Refresh。
  • トークンを RTB ビッドストリームに渡す。
| +| Prebid.js Client-Server Integration | [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js から渡される UID2 Token を生成したいが、トークンを Server-Side で生成したいパブリッシャー向けのガイドです: たとえば、Private Operator を利用しているパブリッシャーなど。 | +| JavaScript (Overview) | [UID2 integration overview for JavaScript](../guides/integration-javascript.md) | JavaScript SDK を使って UID2 とインテグレーションしたいパブリッシャー向けのオプションの概要です。 | +| JavaScript Client-Side Integration | [Client-side integration guide for JavaScript](../guides/integration-javascript-client-side.md) | Client-Side の JavaScript の変更だけで UID2 とインテグレーションしたいパブリッシャー向けのガイドで、最も簡単な実装方法です。
SDK for JavaScript は、トークン生成とトークンリフレッシュを自動的に管理します。 | +| JavaScript Client-Server Integration | [Client-server integration guide for JavaScript](../guides/integration-javascript-client-server.md) | SDK for JavaScript を使用し、トークンを Server-Side で生成してパブリッシャーのウェブページに渡す必要がある、標準的なWeb インテグレーションシナリオを網羅したパブリッシャーガイドです。 | +| Server-Side Integration | [Publisher integration guide, server-side](../guides/integration-publisher-server-side.md) | [SDK for JavaScript](../sdks/sdk-ref-javascript.md) を使用しないパブリッシャー向けのガイドです。 | +| Publisher/SSP Integration with GAM | [Google Ad Manager Secure Signals integration guide](../guides/integration-google-ss.md) | パブリッシャーが UID2 を Google Ad Manager のセキュアシグナル機能(旧称: Encrypted Signals for Publishers、ESP) で使用する際に必要な追加手順について説明したガイドです。 | -### Mobile Integrations +### Mobile integrations 以下のリソースは、Android または iOS デバイスをサポートするパブリッシャーのインテグレーションに利用できます。 | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| Android/iOS (Overview) | [Mobile Integration Overview for Android and iOS](../guides/integration-mobile-overview.md) | SDK for Android または SDK for iOS を使用して UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けのオプションの概要です。 | -| Android/iOS, Client-Side Integration | [Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md) | モバイルアプリ内のみの変更で UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けのインテグレーションガイドです（Server-Side の変更はありません）。 | -| Android/iOS, Client-Server Integration | [Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md) | UID2 とインテグレーションしたいモバイルアプリのパブリッシャー向けのインテグレーションガイドです:
  1. UID2 Token を Server-Side で生成するには、PublicまたはPrivate Operatorを使用します。
  2. その結果、identities をモバイルアプリに渡し、ビッドストリームに渡します。
| -| Android/iOS, Server-Side Integration | [Server-Side Integration Guide for Mobile](../guides/integration-mobile-server-side.md) | UID2 Token を完全に Server-Side で管理したいモバイルアプリパブリッシャー向けのインテグレーションガイドです。 | -| Android | [SDK for Android Reference Guide](../sdks/sdk-ref-android.md) | Android アプリをサポートする必要があるパブリッシャー向けに、UID2 を使用してクライアント ID を生成または確立し、UID2 Token を取得するプロセスを促進する SDK。 | -| iOS | [SDK for iOS Reference Guide](../sdks/sdk-ref-ios.md) | iOS アプリをサポートする必要があるパブリッシャー向けに、UID2 を使用してクライアント ID を生成または確立し、UID2 Token を取得するプロセスを促進する SDK。 | +| Android/iOS (Overview) | [Mobile integration overview for Android and iOS](../guides/integration-mobile-overview.md) | SDK for Android または SDK for iOS を使用して UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けのオプションの概要です。 | +| Android/iOS, Client-Side Integration | [Client-side integration guide for mobile](../guides/integration-mobile-client-side.md) | モバイルアプリ内のみの変更で UID2 とインテグレーションしたいモバイルアプリパブリッシャー向けのインテグレーションガイドです（Server-Side の変更はありません）。 | +| Android/iOS, Client-Server Integration | [Client-server integration guide for mobile](../guides/integration-mobile-client-server.md) | UID2 とインテグレーションしたいモバイルアプリのパブリッシャー向けのインテグレーションガイドです:
  1. UID2 Token を Server-Side で生成するには、PublicまたはPrivate Operatorを使用します。
  2. その結果、identities をモバイルアプリに渡し、ビッドストリームに渡します。
| +| Android/iOS, Server-Side Integration | [Server-side integration guide for mobile](../guides/integration-mobile-server-side.md) | UID2 Token を完全に Server-Side で管理したいモバイルアプリパブリッシャー向けのインテグレーションガイドです。 | +| Android | [SDK for Android reference guide](../sdks/sdk-ref-android.md) | Android アプリをサポートする必要があるパブリッシャー向けに、UID2 を使用してクライアント ID を生成または確立し、UID2 Token を取得するプロセスを促進する SDK。 | +| iOS | [SDK for iOS reference guide](../sdks/sdk-ref-ios.md) | iOS アプリをサポートする必要があるパブリッシャー向けに、UID2 を使用してクライアント ID を生成または確立し、UID2 Token を取得するプロセスを促進する SDK。 | -### CTV Integrations +### CTV integrations CTV をサポートするパブリッシャーのインテグレーションに利用できるリソースは以下の通りです。 | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| CTV | [CTV Integration Guide](../guides/integration-ctv-guide.md) | CTV インテグレーションオプションの概要と、追加情報および手順へのリンク。 | +| CTV | [CTV integration guide](../guides/integration-ctv-guide.md) | CTV インテグレーションオプションの概要と、追加情報および手順へのリンク。 | -### Prebid Integrations +### Prebid integrations Prebid とインテグレーションするパブリッシャーには、以下のリソースがあります。 | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| Prebid (Overview) | [UID2 Integration Overview for Prebid](../guides/integration-prebid.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js または Prebid Mobile SDK から渡される UID2 Token (Advertising Token) を生成したいパブリッシャー向けのインテグレーションオプションの概要。 | -| Prebid.js Client-Side Integration | [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) | 最も簡単な実装方法である Client-Side で UID2 Token をリクエストし、Prebid.js に以下を管理させることを選択したいパブリッシャー向けのガイドです:
  • トークン生成とトークンリフレッシュ。
  • トークンを RTB ビッドストリームに渡す。
| -| Prebid.js Client-Server Integration | [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js から渡される UID2 Token を生成したいが、トークンを Server-Side で生成したいパブリッシャー向けのガイドです: たとえば、Private Operatorを使用しているパブリッシャーなどです。 | -| Prebid.js on Mobile | [UID2 Mobile Integration for Prebid.js](../guides/integration-prebid-mobile-summary.md) | モバイルデバイス上の Prebid.js と UID2 のインテグレーションに関する情報リソースのまとめです。 | +| Prebid (Overview) | [UID2 integration overview for Prebid](../guides/integration-prebid.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js または Prebid Mobile SDK から渡される UID2 Token (Advertising Token) を生成したいパブリッシャー向けのインテグレーションオプションの概要。 | +| Prebid.js Client-Side Integration | [UID2 client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md) | 最も簡単な実装方法である Client-Side で UID2 Token をリクエストし、Prebid.js に以下を管理させることを選択したいパブリッシャー向けのガイドです:
  • トークン生成とトークンリフレッシュ。
  • トークンを RTB ビッドストリームに渡す。
| +| Prebid.js Client-Server Integration | [UID2 client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md) | UID2 とインテグレーションし、RTB ビッドストリームで Prebid.js から渡される UID2 Token を生成したいが、トークンを Server-Side で生成したいパブリッシャー向けのガイドです: たとえば、Private Operatorを使用しているパブリッシャーなどです。 | +| Prebid.js on Mobile | [UID2 mobile integration for Prebid.js](../guides/integration-prebid-mobile-summary.md) | モバイルデバイス上の Prebid.js と UID2 のインテグレーションに関する情報リソースのまとめです。 | -### Google Ad Manager Integrations +### Google Ad Manager integrations 以下のリソースは、パブリッシャーの Google Ad Manager とのインテグレーションに利用できます。 | Integration Type| Documentation | Content Description | | :--- | :--- | :--- | -| Publisher/SSP Integration with GAM | [Google Ad Manager Secure Signals Integration Guide](../guides/integration-google-ss.md) | パブリッシャーが UID2 を Google Ad Manager のセキュアシグナル機能(旧称: Encrypted Signals for Publishers、ESP) で使用する際に必要な追加手順について説明したガイドです。 | -| GMA for Android | [UID2 GMA Plugin for Android Integration Guide](../guides/mobile-plugin-gma-android.md) | Google Mobile Ads(GMA)SDK を使用するパブリッシャーが、Android アプリからの広告リクエストに UID2 Token を使うためのガイドです。 | -| GMA for iOS | [UID2 GMA Plugin for iOS Integration Guide](../guides/mobile-plugin-gma-ios.md) | Google Mobile Ads (GMA) SDK を使用するパブリッシャーが、iOS アプリからの広告リクエストに UID2 Token を使うためのガイドです。 | -| IMA for Android | [UID2 IMA Plugin for Android Integration Guide](../guides/mobile-plugin-ima-android.md) | Google Interactive Media Ads (IMA) SDK を使用するパブリッシャーが、Android アプリからの広告リクエストに UID2 Token を使うためのガイドです。 | Publishers | -| IMA for iOS | [UID2 IMA Plugin for iOS Integration Guide](../guides/mobile-plugin-ima-ios.md) | Google Interactive Media Ads (IMA) SDK を使用するパブリッシャーが、iOS アプリからの広告リクエストに UID2 Token を使うためのガイドです。 | \ No newline at end of file +| Publisher/SSP Integration with GAM | [Google Ad Manager Secure Signals integration guide](../guides/integration-google-ss.md) | パブリッシャーが UID2 を Google Ad Manager のセキュアシグナル機能(旧称: Encrypted Signals for Publishers、ESP) で使用する際に必要な追加手順について説明したガイドです。 | +| GMA for Android | [UID2 GMA plugin for Android integration guide](../guides/mobile-plugin-gma-android.md) | Google Mobile Ads(GMA)SDK を使用するパブリッシャーが、Android アプリからの広告リクエストに UID2 Token を使うためのガイドです。 | +| GMA for iOS | [UID2 GMA plugin for iOS integration guide](../guides/mobile-plugin-gma-ios.md) | Google Mobile Ads (GMA) SDK を使用するパブリッシャーが、iOS アプリからの広告リクエストに UID2 Token を使うためのガイドです。 | +| IMA for Android | [UID2 IMA plugin for Android integration guide](../guides/mobile-plugin-ima-android.md) | Google Interactive Media Ads (IMA) SDK を使用するパブリッシャーが、Android アプリからの広告リクエストに UID2 Token を使うためのガイドです。 | Publishers | +| IMA for iOS | [UID2 IMA plugin for iOS integration guide](../guides/mobile-plugin-ima-ios.md) | Google Interactive Media Ads (IMA) SDK を使用するパブリッシャーが、iOS アプリからの広告リクエストに UID2 Token を使うためのガイドです。 | \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/summary-doc-v2.md b/i18n/ja/docusaurus-plugin-content-docs/current/summary-doc-v2.md index 94d5881ac..ffe90134d 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/summary-doc-v2.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/summary-doc-v2.md @@ -8,15 +8,15 @@ displayed_sidebar: docs import Link from '@docusaurus/Link'; -# UID2 API v2 Documentation +# UID2 API v2 documentation -UID2 の定義、ID タイプ、指針となる原則、コンポーネント、およびその他の概念的な詳細については、[Unified ID 2.0 Overview](intro.md) を参照してください。連絡先やライセンス情報、および正規化やハッシュエンコードのルールについては、[Getting Started](getting-started/gs-account-setup.md) を参照してください。 +UID2 の定義、ID タイプ、指針となる原則、コンポーネント、およびその他の概念的な詳細については、[Unified ID 2.0 overview](intro.md) を参照してください。連絡先やライセンス情報、および正規化やハッシュエンコードのルールについては、[Getting started](getting-started/gs-account-setup.md) を参照してください。 API の使用法の詳細については、以下のページを参照してください。 | Documentation | Content Description | | :--- | :--- | -| [Encrypting Requests and Decrypting Responses](getting-started/gs-encryption-decryption.md) | UID2 API のリクエスト - レスポンスのワークフロー、リクエストの暗号化とレスポンスの復号化の要件、および異なるプログラミング言語でのそれぞれのスクリプト例。 | +| [Encrypting requests and decrypting responses](getting-started/gs-encryption-decryption.md) | UID2 API のリクエスト - レスポンスのワークフロー、リクエストの暗号化とレスポンスの復号化の要件、および異なるプログラミング言語でのそれぞれのスクリプト例。 | | [Endpoints](endpoints/summary-endpoints.md) | ID トークンを管理し、メールアドレス、電話番号、またはハッシュを UID2 にマッピングし、UID2 の生成に使用されるソルトバケット ID を管理するための API リファレンス。
NOTE: インテグレーション環境と本番環境では、異なる [API keys](ref-info/glossary-uid.md#gl-api-key) が必要です。 | -| [Integration Guides](guides/summary-guides.md) | パブリッシャー、DSP、広告主、データプロバイダーなどの UID2 参加者、および Microsoft Azure、AWS、Snowflake、Databricks などの Operator Enterprise Partners 向けの UID2 インテグレーションワークフロー。 | +| [Integration guides](guides/summary-guides.md) | パブリッシャー、DSP、広告主、データプロバイダーなどの UID2 参加者、および Microsoft Azure、AWS、Snowflake、Databricks などの Operator Enterprise Partners 向けの UID2 インテグレーションワークフロー。 | | [SDKs](sdks/summary-sdks.md) | UID2 SDK を使用するためのドキュメントへのリンク。 | diff --git a/sidebars.js b/sidebars.js index 326f5a087..4d2ba83fb 100644 --- a/sidebars.js +++ b/sidebars.js @@ -54,7 +54,7 @@ const fullSidebar = [ { type: 'category', - label: 'Getting Started', + label: 'Getting started', link: { type: 'generated-index', }, @@ -90,7 +90,7 @@ const fullSidebar = [ { type: 'category', - label: 'Integration Guides', + label: 'Integration guides', link: { type: 'doc', id: 'guides/summary-guides', @@ -100,7 +100,7 @@ const fullSidebar = [ items: [ { type: 'category', - label: 'Publisher Integrations', + label: 'Publisher integrations', link: { type: 'doc', id: 'guides/integration-options-publisher-all', @@ -206,7 +206,7 @@ const fullSidebar = [ { type: 'category', - label: 'Advertiser/Data Provider Integrations', + label: 'Advertiser/data provider integrations', link: { type: 'generated-index', }, @@ -235,7 +235,7 @@ const fullSidebar = [ { type: 'category', - label: 'DSP Integrations', + label: 'DSP integrations', link: { type: 'generated-index', }, @@ -248,7 +248,7 @@ const fullSidebar = [ { type: 'category', - label: 'Private Operator Integrations', + label: 'Private Operator integrations', link: { type: 'doc', id: 'guides/integration-options-private-operator', @@ -338,7 +338,7 @@ const fullSidebar = [ 'sharing/sharing-use-cases', { type: 'category', - label: 'Tokenized Sharing', + label: 'Tokenized sharing', link: { type: 'generated-index', }, @@ -357,7 +357,7 @@ const fullSidebar = [ { type: 'category', - label: 'Reference Information', + label: 'Reference information', link: { type: 'generated-index', }, @@ -386,7 +386,6 @@ const fullSidebar = [ 'ref-info/updates-doc', ]; - const sidebars = { docs: fullSidebar, @@ -394,14 +393,14 @@ const sidebars = { 'overviews/overview-advertisers', 'overviews/overview-dsps', 'overviews/overview-data-providers', - 'Advertiser/Data Provider Integrations', + 'Advertiser/data provider integrations', 'guides/integration-advertiser-dataprovider-overview', 'guides/integration-snowflake', 'guides/integration-snowflake-previous', 'guides/integration-databricks', 'guides/integration-aws-entity-resolution', 'guides/advertiser-dataprovider-endpoints', - 'DSP Integrations', + 'DSP integrations', 'guides/dsp-guide', 'endpoints/post-identity-buckets', 'endpoints/post-identity-map', @@ -413,7 +412,7 @@ const sidebars = { 'overviews/overview-publishers', 'overviews/overview-dsps', 'overviews/overview-data-providers', - 'Publisher Integrations', + 'Publisher integrations', 'Web', 'guides/integration-options-publisher-all', 'guides/integration-options-publisher-web', @@ -424,7 +423,7 @@ const sidebars = { 'JavaScript', 'guides/integration-javascript', 'guides/integration-javascript-client-server', - 'Server-Only', + 'Server-only', 'guides/integration-publisher-server-side', 'GAM Secure Signals', 'guides/integration-google-ss', @@ -441,20 +440,19 @@ const sidebars = { 'guides/mobile-plugin-gma-ios', 'guides/mobile-plugin-ima-android', 'guides/mobile-plugin-ima-ios', - 'DSP Integrations', + 'DSP integrations', 'guides/dsp-guide', 'endpoints/post-token-generate', 'endpoints/post-token-validate', 'endpoints/post-token-refresh', - 'sharing/sharing-bid-stream', - 'ref-info/ref-token-validator' - ), + 'sharing/sharing-bid-stream' + ), - sidebarDSPs: removeItems(fullSidebar, + sidebarDSPs: removeItems(fullSidebar, 'overviews/overview-publishers', 'overviews/overview-advertisers', 'overviews/overview-data-providers', - 'Publisher Integrations', + 'Publisher integrations', 'Web', 'guides/integration-options-publisher-all', 'guides/integration-options-publisher-web', @@ -466,7 +464,7 @@ const sidebars = { 'guides/integration-javascript', 'guides/integration-javascript-client-side', 'guides/integration-javascript-client-server', - 'Server-Only', + 'Server-only', 'guides/integration-publisher-server-side', 'GAM Secure Signals', 'guides/integration-google-ss', @@ -483,7 +481,7 @@ const sidebars = { 'guides/mobile-plugin-gma-ios', 'guides/mobile-plugin-ima-android', 'guides/mobile-plugin-ima-ios', - 'Advertiser/Data Provider Integrations', + 'Advertiser/data provider integrations', 'guides/integration-advertiser-dataprovider-overview', 'guides/integration-snowflake', 'guides/integration-snowflake-previous', @@ -494,11 +492,11 @@ const sidebars = { 'ref-info/ref-token-validator' ), - sidebarDataProviders: removeItems(fullSidebar, + sidebarDataProviders: removeItems(fullSidebar, 'overviews/overview-publishers', 'overviews/overview-advertisers', 'overviews/overview-dsps', - 'Publisher Integrations', + 'Publisher integrations', 'Web', 'guides/integration-options-publisher-all', 'guides/integration-options-publisher-web', @@ -509,7 +507,7 @@ const sidebars = { 'JavaScript', 'guides/integration-javascript', 'guides/integration-javascript-client-server', - 'Server-Only', + 'Server-only', 'guides/integration-publisher-server-side', 'GAM Secure Signals', 'guides/integration-google-ss', @@ -526,7 +524,7 @@ const sidebars = { 'guides/mobile-plugin-gma-ios', 'guides/mobile-plugin-ima-android', 'guides/mobile-plugin-ima-ios', - 'DSP Integrations', + 'DSP integrations', 'guides/dsp-guide', 'endpoints/post-token-generate', 'endpoints/post-token-validate', diff --git a/test/python/README.md b/test/python/README.md index 24d8671f2..de3a88a99 100644 --- a/test/python/README.md +++ b/test/python/README.md @@ -1,10 +1,10 @@ -# UID2 Documentation Python Tests +# UID2 documentation Python tests This directory contains Python tests for the code samples in the [POST /identity/map v3 documentation](../../docs/endpoints/post-identity-map.md). The tests verify that the Python code examples in the documentation work correctly and demonstrate proper usage patterns. The intention is not to test the UID2 features or clients - we assume those work based on other tests. -## Quick Start +## Quick start ### Prerequisites @@ -13,13 +13,13 @@ The intention is not to test the UID2 features or clients - we assume those work pip install uv ``` -## Environment Configuration +## Environment configuration Fill the following environment variables into the `.env` file. The file is gitignored. - `UID2_BASE_URL` - Integration environment endpoint - `UID2_API_KEY` - Test API key - `UID2_SECRET_KEY` - Test secret key -### Run Tests +### Run tests ```bash cd test/python uv run pytest