Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ UID2 のオプトアウトワークフローとユーザーがオプトアウト

## Version

このドキュメントは、このエンドポイントのバージョン 2 のものであり、最新バージョンではありません。最新バージョン v3 の詳細は、[POST /v3/identity/map](post-identity-map.md) を参照してください。
このドキュメントは、このエンドポイントのバージョン 2 のものです。最新バージョン v3 の詳細は、[POST /v3/identity/map](post-identity-map.md) を参照してください。

:::note
以前のバージョンを使用している場合は、改善点を活用するためにできるだけ早くアップグレードすることを推奨します。移行ガイダンスは、[Migration from POST /v2/identity/map](post-identity-map.md#migration-from-post-v2identitymap) を参照してください。廃止に関する情報は、[Deprecation schedule: Endpoint versions](../ref-info/deprecation-schedule.md#endpoint-versions) を参照してください。
:::important
このエンドポイントのこのバージョンは廃止予定です。バージョン 2 を使用している場合は、できるだけ早くアップグレードしてください。移行ガイダンスは、[Migration from POST /v2/identity/map](post-identity-map.md#migration-from-post-v2identitymap) を参照してください。廃止に関する情報は、[Deprecation schedule: Endpoint versions](../ref-info/deprecation-schedule.md#endpoint-versions) を参照してください。
:::

## Batch size and request parallelization requirements
Expand Down Expand Up @@ -72,7 +72,7 @@ UID2 のオプトアウトワークフローとユーザーがオプトアウト

### Request examples

以下は、各パラメータの暗号化されていない JSON リクエストボディの例です。このうちの 1 つを、`POST /identity/map` エンドポイントへのリクエストに含める必要があります:
以下は、各パラメータの暗号化されていない JSON リクエストボディの例です。このうちの 1 つを、`POST /v2/identity/map` エンドポイントへのリクエストに含める必要があります:

```json
{
Expand Down Expand Up @@ -107,7 +107,7 @@ UID2 のオプトアウトワークフローとユーザーがオプトアウト
}
```

以下は、電話番号に対する `POST /identity/map` エンドポイントへの暗号化リクエストの例です:
以下は、電話番号に対する `POST /v2/identity/map` エンドポイントへの暗号化リクエストの例です:

```sh
echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map [Your-Client-API-Key] [Your-Client-Secret]
Expand Down Expand Up @@ -208,6 +208,6 @@ echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py ht
| `success` | 200 | リクエストは成功しました。レスポンスは暗号化されています。 |
| `client_error` | 400 | リクエストに不足している、または無効なパラメータがありました。 |
| `unauthorized` | 401 | リクエストにベアラートークンが含まれていない、無効なベアラートークンが含まれている、またはリクエストされた操作を実行するのに許可されていないベアラートークンが含まれていました。 |
| N/A | 429 | このエンドポイントへのリクエストが多すぎます。待ってからexponential backoffを使用して再試行してください。 |
| N/A | 429 | このエンドポイントへのリクエストが多すぎます。待ってから exponential backoff を使用して再試行してください。 |

`status` の値が `success` 以外であれば、`message` フィールドにその問題に関する追加情報が表示されます。Note: 429 のレスポンスには、JSON 形式のレスポンス本文が含まれていません。
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ raw UID2 はリフレッシュタイムスタンプの前では変化しませ
| `success` | 200 | リクエストは成功しました。レスポンスは暗号化されます。 |
| `client_error` | 400 | リクエストに欠落または無効なパラメーターが含まれていました。 |
| `unauthorized` | 401 | リクエストにベアラートークンが含まれていない、無効なベアラートークンが含まれている、またはリクエストされた操作を実行する権限のないベアラートークンが含まれていました。 |
| N/A | 429 | このエンドポイントへのリクエストが多すぎます。待ってからexponential backoffを使用して再試行してください。 |
| N/A | 429 | このエンドポイントへのリクエストが多すぎます。待ってから exponential backoff を使用して再試行してください。 |

`status` の値が `success` 以外であれば、`message` フィールドにその問題に関する追加情報が表示されます。Note: 429 のレスポンスには、JSON 形式のレスポンス本文が含まれていません。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ displayed_sidebar: docs

import Link from '@docusaurus/Link';

# UID2 endpoints: Summary
# Endpoints: Summary

すべての UID2 エンドポイントでは、API リクエストの暗号化([POST /token/refresh](post-token-refresh.md) を除く) とレスポンスの復号化に Client Secret が必要です。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting requests and decrypting responses](../getting-started/gs-encryption-decryption.md) を参照してください。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Client-Server または Server-Side の実装を使用している場合([Client
- インテグレーション環境と本番環境の両方を使用する場合、環境ごとに個別の 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

Expand All @@ -118,7 +118,7 @@ UID2 アカウントのセットアップの一環として、1つ以上の API
- これらの値が保存され使用されているすべての場所を追跡しておき、キーをローテーションする必要がある場合にすぐに実行できるようにしておいてください。
- 既存のキーとシークレットが漏洩した場合、新しいキーとシークレットに置き換えるプロセスを確立してください。

API Key と Client Secret は、認証情報が漏洩するリスクを減らすために、定期的に(たとえば1年ごとに)更新することを推奨します。
API Key と Client Secret は、認証情報が漏洩するリスクを減らすために、定期的に(たとえば 1 年ごとに)更新することを推奨します。

## Refreshing credentials

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ UID2 フレームワークを使用するパブリッシャーからのよくあ
#### Where should I make token generation calls—from the server side or the client side?
トークン生成の呼び出しは、Server-Side と Client-Side のどちらで行うべきですか?

UID2 Token は、Client-Side、Server-Sideのどちらでも生成できます。詳細は、以下を参照してください:
UID2 Token は、Client-Side、Server-Side のどちらでも生成できます。詳細は、以下を参照してください:
- Prebid.js を使用して Client-Side からトークンを生成します: [Client-side integration guide for Prebid.js](../guides/integration-prebid-client-side.md).
- Prebid.js を使用して Server-Side からトークンを生成します: [Client-server integration guide for Prebid.js](../guides/integration-prebid-client-server.md).
- その他の Server-Side オプション: [Publisher integrations](../guides/summary-guides.md#publisher-integrations).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ UID2 <Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service<

## Email address hash encoding

メールアドレスのハッシュは、正規化されたメールアドレスの Base64 エンコードされた <Link href="../ref-info/glossary-uid#gl-sha-256">SHA-256</Link> ハッシュです。メールアドレスは最初に正規化され、次に SHA-256 ハッシュアルゴリズムを使用してハッシュ化され、最後にハッシュ値のバイトを Base64 エンコードします。Base64 エンコードは、ハッシュ値のバイトに適用され、16進数でエンコードされた文字列表現ではないことに注意してください
メールアドレスのハッシュは、正規化されたメールアドレスの Base64 エンコードされた <Link href="../ref-info/glossary-uid#gl-sha-256">SHA-256</Link> ハッシュです。メールアドレスは最初に正規化され、次に SHA-256 ハッシュアルゴリズムを使用してハッシュ化され、最後にハッシュ値のバイトを Base64 エンコードします。Base64 エンコードは、ハッシュ値のバイトに適用され、16 進数でエンコードされた文字列表現ではないことに注意してください

以下の表は、シンプルな入力メールアドレスと、各手順を適用して安全で不透明な値に到達する結果を示しています。

Expand All @@ -70,8 +70,8 @@ Base64 エンコーディングを適用する際は、ハッシュの生のバ
| :--- | :--- | :--- |
| 元のメールアドレス | `USER@example.com` | N/A |
| 正規化されたメールアドレス | `user@example.com` | 正規化は常に最初のステップです。 |
| 正規化されたメールアドレスの SHA-256 ハッシュ| `b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514` | これは、32 バイトの SHA-256 の16進数エンコードされた表現です。 |
| SHA-256 ハッシュの16進数から Base64 へのエンコード | `tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=` | この 44 文字の文字列は、32 バイトの SHA-256 の Base64 エンコードされた表現です。<br/>SHA-256 ハッシュの文字列は、ハッシュ値の 16 進数エンコードされた表現であることに注意してください。ハッシュの生のバイトを Base64 エンコードするか、16 進数エンコードされた値を入力として受け取る Base64 エンコーダーを使用する必要があります。<br/>このエンコードをリクエストボディで送信される `email_hash` 値に使用します。 |
| 正規化されたメールアドレスの SHA-256 ハッシュ| `b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514` | これは、32 バイトの SHA-256 の 16 進数エンコードされた表現です。 |
| SHA-256 ハッシュの 16 進数から Base64 へのエンコード | `tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=` | この 44 文字の文字列は、32 バイトの SHA-256 の Base64 エンコードされた表現です。<br/>SHA-256 ハッシュの文字列は、ハッシュ値の 16 進数エンコードされた表現であることに注意してください。ハッシュの生のバイトを Base64 エンコードするか、16 進数エンコードされた値を入力として受け取る Base64 エンコーダーを使用する必要があります。<br/>このエンコードをリクエストボディで送信される `email_hash` 値に使用します。 |

その他の例は、[Normalization examples for email](#normalization-examples-for-email) を参照してください。

Expand Down Expand Up @@ -143,22 +143,22 @@ UID2 Operator Service へのリクエストで電話番号を送信する前に

## Phone number hash encoding

電話番号のハッシュは、正規化された電話番号の Base64 エンコードされた SHA-256 ハッシュです。電話番号は最初に正規化し、次に SHA-256 ハッシュアルゴリズムを使用してハッシュ化し、最後にハッシュ値のバイトを Base64 エンコードします。Base64 エンコードは、ハッシュ値のバイトに適用され、16進数でエンコードされた文字列表現ではないことに注意してください
電話番号のハッシュは、正規化された電話番号の Base64 エンコードされた SHA-256 ハッシュです。電話番号は最初に正規化し、次に SHA-256 ハッシュアルゴリズムを使用してハッシュ化し、最後にハッシュ値のバイトを Base64 エンコードします。Base64 エンコードは、ハッシュ値のバイトに適用され、16 進数でエンコードされた文字列表現ではないことに注意してください

以下の表は、単純な入力電話番号の例と、各ステップを適用して安全で不透明な URL-safe な値にする結果を示しています。

最終値、すなわち SHA-256 ハッシュの 16進数から Base64 エンコードされた表現は、UID2 Operator endpoint に提供する値となります。
最終値、すなわち SHA-256 ハッシュの 16 進数から Base64 エンコードされた表現は、UID2 Operator endpoint に提供する値となります。

:::warning
Base64 エンコーディングを適用する際は、ハッシュの生のバイト列を Base64 エンコードするか、16進数エンコードされた値を入力として受け取る Base64 エンコーダーを使用してください。テキストを入力として受け取る関数を使用すると、結果として得られる文字列が長くなり、UID2 の目的では無効となります。
Base64 エンコーディングを適用する際は、ハッシュの生のバイト列を Base64 エンコードするか、16 進数エンコードされた値を入力として受け取る Base64 エンコーダーを使用してください。テキストを入力として受け取る関数を使用すると、結果として得られる文字列が長くなり、UID2 の目的では無効となります。
:::

| Type | Example | Comments and Usage |
| :--- | :--- | :--- |
| 元の電話番号 | `1 (234) 567-8901` | N/A |
| 正規化された電話番号 | `+12345678901` | 正規化は常に最初のステップです。 |
| 正規化された電話番号の SHA-256 ハッシュ | `10e6f0b47054a83359477dcb35231db6de5c69fb1816e1a6b98e192de9e5b9ee` | この 64 文字の文字列は、32 バイト SHA-256 の16進数エンコードされた表現です。 |
| SHA-256 ハッシュの 16進数から Base64 へのエンコード | `EObwtHBUqDNZR33LNSMdtt5cafsYFuGmuY4ZLenlue4=` | この 44 文字の文字列は、32 バイト SHA-256 の Base64 エンコードされた表現です。<br/>注: SHA-256 ハッシュは16進数の値です。16進数の値を入力として受け取る Base64 エンコーダーを使用する必要があります。このエンコードは、リクエストボディに送信される `phone_hash` 値に使用します。 |
| 正規化された電話番号の SHA-256 ハッシュ | `10e6f0b47054a83359477dcb35231db6de5c69fb1816e1a6b98e192de9e5b9ee` | この 64 文字の文字列は、32 バイト SHA-256 の 16 進数エンコードされた表現です。 |
| SHA-256 ハッシュの 16 進数から Base64 へのエンコード | `EObwtHBUqDNZR33LNSMdtt5cafsYFuGmuY4ZLenlue4=` | この 44 文字の文字列は、32 バイト SHA-256 の Base64 エンコードされた表現です。<br/>注: SHA-256 ハッシュは 16 進数の値です。16 進数の値を入力として受け取る Base64 エンコーダーを使用する必要があります。このエンコードは、リクエストボディに送信される `phone_hash` 値に使用します。 |

## Example code

Expand Down Expand Up @@ -214,4 +214,4 @@ Email または Phone Number を選択し、値を入力または貼り付けて

- **Use the Base64-encoded value**: このプロセスには、ハッシュ値のバイト列を正規化、ハッシュ化、Base64 エンコードする手順が含まれます。UID2 を生成する際の入力は、この Base64 エンコードされた値です。必ずこの 44 文字の文字列値を使用してください。

- 以下のエラーメッセージが表示される場合があります:「The hashing value must be 44 characters. (ハッシュ値は44文字でなければなりません)」。この場合、使用しているハッシュ関数に問題があります。SHA-256 ハッシュの 16 進数から Base64 へのエンコードを使用してください。詳細は[Email address hash encoding](#email-address-hash-encoding)または[Phone number hash encoding](#phone-number-hash-encoding)を参照してください。確認のため、[UID2 hashing tool](https://hashing-tool.samples.uidapi.com/) でテストしてください。
- 以下のエラーメッセージが表示される場合があります:「The hashing value must be 44 characters. (ハッシュ値は 44 文字でなければなりません)」。この場合、使用しているハッシュ関数に問題があります。SHA-256 ハッシュの 16 進数から Base64 へのエンコードを使用してください。詳細は[Email address hash encoding](#email-address-hash-encoding)または[Phone number hash encoding](#phone-number-hash-encoding)を参照してください。確認のため、[UID2 hashing tool](https://hashing-tool.samples.uidapi.com/) でテストしてください。
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ UID2 エコシステムには、2 種類のオプトアウトがあります:
以下の手順は、メールアドレスまたは電話番号から UID2 が作成されたユーザーを対象としたオプトアウトワークフローの概要です。

1. ユーザーは [Transparency and Control Portal](https://www.transparentadvertising.com/) にアクセスし、UID2 全体からオプトアウトすることができます。
2. Transparency and Control Portalは、オプトアウト要求を UID2 <Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> に送信します。
2. Transparency and Control Portal は、オプトアウト要求を UID2 <Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> に送信します。
3. ユーザーがオプトアウトした場合、UID2 Operator Service はオプトアウト情報を UID2 参加者に以下のように配布します:

| Participant | Distribution Method |
Expand Down
Loading