Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
e444996
LiveRamp integration tips. (new doc page)
miyaichi Dec 11, 2024
5b06904
Copy updates re recommended period for token refresh.
miyaichi Dec 12, 2024
e729293
Minor edits to mobile docs. (mods to 2 files)
miyaichi Dec 12, 2024
92f0732
Minor edits. (mods to 16 files)
miyaichi Dec 12, 2024
d6dc1d2
minor copy mods, mostly Prebid doc title change. (mods to 13 files)
miyaichi Dec 12, 2024
c0063b4
participant switcher, audit trail, doc mods
miyaichi Dec 12, 2024
ac2e19b
Announcement re LiveRamp doc
miyaichi Dec 12, 2024
6abc66a
Minor mods arising from parity checks (except guides). Minor copy edi…
miyaichi Dec 12, 2024
6955408
UID2 minor back-edits from parity check on Guides docs (17 files)
miyaichi Dec 12, 2024
ca7c93b
UID2 minor docs mods resulting from queries (mods to 6 files)
miyaichi Dec 17, 2024
54b0068
AWS doc edit from TM, other minor typographical edits (2 files)
miyaichi Dec 17, 2024
0120b11
add info re system-required password change (3 files)
miyaichi Dec 17, 2024
bdd1365
In Portal doc, add link to Request Access to UID2 page
miyaichi Dec 17, 2024
b34d643
Minor edits from follow-up compare of Endpoint docs, couple of other …
miyaichi Dec 17, 2024
4f97935
Checks for translation omissions
miyaichi Dec 17, 2024
e6e510c
Merge branch 'main' into jpn-translation-update-726-and-750-766
miyaichi Dec 17, 2024
e82dea2
Checks for translation omissions
miyaichi Dec 17, 2024
2dd29f1
fix: brocken link
miyaichi Dec 17, 2024
b136855
Minor mod
miyaichi Dec 17, 2024
1ae0af1
Merge branch 'main' into jpn-translation-update-726-and-750-766
miyaichi Dec 17, 2024
58c3891
resolve merge conflicts
genwhittTTD Dec 17, 2024
0e11c2a
fix link issue in an English file
genwhittTTD Dec 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting-started/gs-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Notes:
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 <Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> 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]
- 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Used by: このエンドポイントは、主に広告主とデータプロバ

`POST '{environment}/v2/identity/buckets'`

認証の詳細については、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。

:::important
すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[リクエストの暗号化とレスポンスの復号化](../getting-started/gs-encryption-decryption.md) を参照してください。
:::
Expand All @@ -25,7 +27,7 @@ Used by: このエンドポイントは、主に広告主とデータプロバ

| Path Parameter | Data Type | Attribute | Description |
| :--- | :--- | :--- | :--- |
| `{environment}` | string | 必須 | インテグレーション環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 |
| `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 |

:::note
インテグレーション環境と本番環境では、異なる <Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link> が必要です。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import Link from '@docusaurus/Link';

Used by: このエンドポイントは、主に広告主やデータプロバイダーが使用します。詳細は [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md) を参照してください。

UID2 の Opt-Out ワークフローとユーザーが Opt-Out する方法の詳細については、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。

## Batch Size and Request Parallelization Requirements

知っておくべきことは以下のとおりです:
Expand All @@ -26,6 +28,8 @@ Used by: このエンドポイントは、主に広告主やデータプロバ

`POST '{environment}/v2/identity/map'`

認証の詳細については、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。

:::important
すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[リクエストの暗号化とレスポンスの復号化](../getting-started/gs-encryption-decryption.md) を参照してください。
:::
Expand All @@ -34,7 +38,7 @@ Used by: このエンドポイントは、主に広告主やデータプロバ

| Path Parameter | Data Type | Attribute | Description |
| :--- | :--- | :--- | :--- |
| `{environment}` | string | 必須 | インテグレーション環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 |
| `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 |

:::note
インテグレーション環境と本番環境では、異なる <Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link> が必要です。
Expand Down Expand Up @@ -93,7 +97,7 @@ Used by: このエンドポイントは、主に広告主やデータプロバ
以下は、メールアドレスハッシュに対する暗号化された ID マッピングリクエストの例です:

```sh
echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk= DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow=
echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map [Your-Client-API-Key] [Your-Client-Secret]
```

詳細といくつかのプログラミング言語でのコードの例は、[リクエストの暗号化とレスポンスの復号化](../getting-started/gs-encryption-decryption.md) を参照してください。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Used by: このエンドポイントは、主に広告主、データプロバ

`POST '{environment}/v2/optout/status'`

認証の詳細については、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。

:::important
すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。
:::
Expand All @@ -38,7 +40,7 @@ Used by: このエンドポイントは、主に広告主、データプロバ

| Path Parameter | Data Type | Attribute | Description |
| :--- | :--- | :--- | :--- |
| `{environment}` | string | 必須 | インテグレーション環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 |
| `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 |

:::note
インテグレーション環境と本番環境では、異なる <Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link> が必要です。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Used by: このエンドポイントは、主にパブリッシャーが使用

## Request Format

認証の詳細については、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。

`POST '{environment}/v2/token/generate'`

このエンドポイントリクエストについて知っておくべきことは、以下のとおりです:
Expand Down Expand Up @@ -53,7 +55,7 @@ Used by: このエンドポイントは、主にパブリッシャーが使用
### Request Examples

:::important
サービスにアクセスするために使用される API Key を確実に秘密にするために、API Key を使用する必要のない [POST&nbsp;/token/refresh](post-token-refresh.md) と異なり、`POST /token/generate` エンドポイントを Server-Side から呼び出す必要があります
サービスへのアクセスに使用する 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 つはトークン生成リクエストに含める必要があります:
Expand Down Expand Up @@ -145,11 +147,11 @@ echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=","optout_chec

## Test Identities

| Type | Identity | Purpose | Next Endpoint |
| :---- | :--------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------- |
| Email | `[email protected]` | キャッシュした `advertising_token` が、指定したメールアドレスの `advertising_token` と一致するかテストします。 | [POST&nbsp;/token/validate](post-token-validate.md) |
| Email | `[email protected]` | このメールアドレスをリクエストに使用すると、常に `optout` レスポンスが生成されます | [POST&nbsp;/token/generate](post-token-generate.md) |
| Email | `[email protected]` | このメールアドレスをリクエストに使用すると、常に `refresh_token` による ID レスポンスが生成され、その結果 `optout` レスポンスが生成されます。 | [POST&nbsp;/token/refresh](post-token-refresh.md) |
| Phone | `+12345678901` | キャッシュした `advertising_token` が、指定した電話番号の `advertising_token` と一致するかテストします。 | [POST&nbsp;/token/validate](post-token-validate.md) |
| Phone | `+00000000002` | この電話番号をリクエストに使用すると、常に `optout` レスポンスが生成されます。 | [POST&nbsp;/token/generate](post-token-generate.md) |
| Phone | `+00000000000` | この電話番号をリクエストに使用すると、常に `refresh_token` による ID レスポンスが生成され、その結果`optout`レスポンスが生成されます。 | [POST&nbsp;/token/refresh](post-token-refresh.md) |
| Type | Identity | Purpose | Next Endpoint |
| :--- | :--- | :--- | :--- |
| Email | `[email protected]` | キャッシュした `advertising_token` が、指定したメールアドレスの `advertising_token` と一致するかテストします。 | [POST&nbsp;/token/validate](post-token-validate.md) |
| Email | `[email protected]` | このメールアドレスをリクエストに使用すると、常に `optout` レスポンスが生成されます | [POST&nbsp;/token/generate](post-token-generate.md) |
| Email | `[email protected]` | このメールアドレスをリクエストに使用すると、常に `refresh_token` による ID レスポンスが生成され、その結果 `optout` レスポンスが生成されます。 | [POST&nbsp;/token/refresh](post-token-refresh.md) |
| Phone | `+12345678901` | キャッシュした `advertising_token` が、指定した電話番号の `advertising_token` と一致するかテストします。 | [POST&nbsp;/token/validate](post-token-validate.md) |
| Phone | `+00000000002` | この電話番号をリクエストに使用すると、常に `optout` レスポンスが生成されます。 | [POST&nbsp;/token/generate](post-token-generate.md) |
| Phone | `+00000000000` | この電話番号をリクエストに使用すると、常に `refresh_token` による ID レスポンスが生成され、その結果`optout`レスポンスが生成されます。 | [POST&nbsp;/token/refresh](post-token-refresh.md) |
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Used by: このエンドポイントは、主にパブリッシャーが使用

| Path Parameter | Data Type | Attribute | Description |
| :--- | :--- | :--- | :--- |
| `{environment}` | string | 必須 | インテグレーション環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは、[Environments](../getting-started/gs-environments.md) を参照してください。<br/>Notes:<ul><li>`integ` 環境と `prod` 環境は異なる <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link> を必要とします。</li><li>トークンの有効期限は変更される可能性がありますが、`integ` 環境では常に `prod` 環境よりも大幅に短くなります。</li></ul> |
| `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは、[Environments](../getting-started/gs-environments.md) を参照してください。<br/>Notes:<ul><li>`integ` 環境と `prod` 環境は異なる <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link> を必要とします。</li><li>トークンの有効期限は変更される可能性がありますが、`integ` 環境では常に `prod` 環境よりも大幅に短くなります。</li></ul> |

#### Testing Notes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Used by: このエンドポイントは、主にパブリッシャーが使用

`POST '{environment}/v2/token/validate'`

認証の詳細については、 [Authentication and Authorization](../getting-started/gs-auth.md) を参照してください。

:::important
すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、[リクエストの暗号化とレスポンスの復号化](../getting-started/gs-encryption-decryption.md) を参照してください。
:::
Expand All @@ -29,7 +31,7 @@ Used by: このエンドポイントは、主にパブリッシャーが使用

| Path Parameter | Data Type | Attribute | Description |
| :--- | :--- | :--- | :--- |
| `{environment}` | string | 必須 | インテグレーション環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 |
| `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../getting-started/gs-environments.md) を参照してください。 |

:::note
インテグレーション環境と本番環境では、異なる <Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link> が必要です。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ import Link from '@docusaurus/Link';

以下のエンドポイントは、広告主、サードパーティのデータプロバイダー、DSP、共有者が使用できます。パブリッシャーは、このエンドポイントを使用する必要はありません。

UID2 の Opt-Out ワークフローとユーザーが Opt-Out する方法の詳細については、[User Opt-Out](../getting-started/gs-opt-out.md) を参照してください。

| Endpoint | Description | Request Encryption | Response Decryption |
| :--- | :--- | :--- | :--- |
| [POST&nbsp;/optout/status](post-optout-status.md) | raw UID2 のオプトアウトステータスをチェックします。このエンドポイントは raw UID2 のリストを入力として受け取り、オプトアウトした raw UID2 と、オプトアウトが行われた時刻を返します。 | 必須 | 必須 |
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Notes:
Client-Side または 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 とクライアントシークレットを使用して、<Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> に接続し、API エンドポイントを呼び出すことができます。これらの値は、サービスの参加者を識別します。

以下は API Key とクライアントシークレットに関する情報です:
- これらの値を安全に保管しなければなりません。詳細は、[Security of API Key and Client Secret](#security-of-api-key-and-client-secret) を参照してください。
- UID2 参加者は、複数のキーを持つことができます。
- 各キーには、それを使用できるエンドポイントを決定する [Permissions](gs-permissions.md) のセットがあります。
- 各キーには対応するクライアントシークレットがあります。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import IdentityGenerateResponse from '/docs/snippets/_example-identity-generate-
# Encrypting Requests and Decrypting Responses

:::note
パブリッシャーで、クライアント側に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) を参照してください) などの実装によって自動的に管理されます。
:::

ほとんどすべての UID2 [endpoints](../endpoints/summary-endpoints.md) では、エンドポイントに送られるリクエストは [encrypted](#encrypting-requests) され、エンドポイントからのレスポンスは [decrypted](#decrypting-responses) する必要があります。
Expand Down Expand Up @@ -355,7 +355,7 @@ public class Uid2Request {
+ "java -jar Uid2Request-jar-with-dependencies.jar <url> <api_key> <client_secret>" + "\n\n"

+ "Example:" + "\n "
+ "echo '{\"email\": \"[email protected]\",\"optout_check\": 1}' | java -jar Uid2Request-jar-with-dependencies.jar https://prod.uidapi.com/v2/token/generate PRODGwJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=" + "\n\n\n"
+ "echo '{\"email\": \"[email protected]\",\"optout_check\": 1}' | java -jar Uid2Request-jar-with-dependencies.jar https://prod.uidapi.com/v2/token/generate PRODGwJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=" + "\n\n\n"

+ "Refresh Token Usage:" + "\n "
+ "java -jar Uid2Request-jar-with-dependencies.jar <url> --refresh-token <refresh_token> <refresh_response_key>" + "\n\n"
Expand Down
Loading
Loading