Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ DII が正常にマッピングされた場合、マッピングされたオブ
| :------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `u` | string | リクエストで提供されたメールアドレスまたは電話番号に対応する raw UID2。 |
| `p` | string | 以下のいずれか:<ul><li>現在の raw UID2 が過去 90 日以内にローテーションされた場合: 以前の raw UID2。</li><li>それ以外の場合: `null`。</li></ul> |
| `r` | number | Unix タイムスタンプ(ミリ秒単位)で、raw UID2 がリフレッシュされる可能性のある時刻を示します。このタイムスタンプまで、raw UID2 は有効であることが保証されています。 |
| `r` | number | raw UID2 を更新する可能性がある時刻を示す Unix タイムスタンプ(ミリ秒)。raw UID2 はこのタイムスタンプまで有効です。 |

:::note
raw UID2 はリフレッシュタイムスタンプの前では変化しません。リフレッシュタイムスタンプの後、DII を再マッピングすると新しいリフレッシュタイムスタンプが返されますが、raw UID2 は変化する場合もあれば変化しない場合もあります。raw UID2 が複数のリフレッシュ間隔にわたって変化しない可能性もあります。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,7 @@ import SnptIdentityGenerateResponse from '../snippets/_snpt-example-identity-gen

Used by: このエンドポイントは、主にパブリッシャーが使用します。

:::important
`optout_check` パラメータは値 `1` が必須で、ユーザーがオプトアウトしたかどうかをチェックします。
:::

<!-- uid2_euid_diff re legal basis for admonition above -->
<!-- uid2_euid_diff: admonition re legal basis (in EUID not in UID2)-->

このエンドポイントを直接呼び出すのではなく、UID2 SDK を使って管理することもできます。オプションの概要は、[SDKs: Summary](../sdks/summary-sdks.md) を参照してください。

Expand All @@ -41,12 +37,12 @@ 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 Key</Link> が必要です。</li><li>トークンの有効期限は変更される可能性がありますが、`integ` 環境では常に `prod` 環境よりも大幅に短くなります。</li></ul> |
| `{environment}` | string | 必須 | テスト (インテグレーション) 環境: `https://operator-integ.uidapi.com`<br/>本番環境: ユーザーの所在地に応じて最適な URL が異なります。ユースケースに最適な URL の選択方法および有効なベース URL の全リストは、[Environments](../getting-started/gs-environments.md) を参照してください。<br/>Notes:<ul><li>`integ` 環境と `prod` 環境では、異なる <Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link> が必要です。</li><li>トークンの有効期限は変更される可能性がありますが、`integ` 環境では常に `prod` 環境よりも大幅に短くなります。</li></ul> |

### Unencrypted JSON Body Parameters

:::important
リクエストを暗号化するときには、以下の 4 つの条件付きパラメータのうち **1 つ** と、必須パラメータである `optout_check` の値 `1` のみをJSON ボディのキーと値のペアとして含める必要があります。
リクエストを暗号化するときには、以下の 4 つの条件付きパラメータのうち **1 つ** のみを JSON ボディのキーと値のペアとして含める必要があります。
:::

| Body Parameter | Data Type | Attribute | Description |
Expand All @@ -55,7 +51,6 @@ Used by: このエンドポイントは、主にパブリッシャーが使用
| `email_hash` | string | 条件付きで必須 | [SHA-256 ハッシュし、Base64 エンコード](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) した [正規化](../getting-started/gs-normalization-encoding.md#email-address-normalization) 済みメールアドレスです。 |
| `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) 済み電話番号です。 |
| `optout_check` | number | 必須 | ユーザーがオプトアウトしたかどうかをチェックします。このパラメータは `1` とします。 |

### Request Examples

Expand All @@ -67,33 +62,29 @@ Used by: このエンドポイントは、主にパブリッシャーが使用

```json
{
"email": "username@example.com",
"optout_check": 1
"email": "username@example.com"
}
```
```json
{
"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=",
"optout_check": 1
"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
}
```
```json
{
"phone": "+12345678901",
"optout_check": 1
"phone": "+12345678901"
}
```
```json
{
"phone_hash": "wdN1alhrbw1Bmz49GzKGdPvGxLhCNn7n3teAOQ/FSK4=",
"optout_check": 1
"phone_hash": "wdN1alhrbw1Bmz49GzKGdPvGxLhCNn7n3teAOQ/FSK4="
}
```

以下は、メールアドレスハッシュの暗号化トークン生成リクエストの例です:

```sh
echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=","optout_check":1}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/generate [Your-Client-API-Key] [Your-Client-Secret]
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) を参照してください。

Expand Down Expand Up @@ -133,7 +124,7 @@ echo '{"email_hash": "tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=","optout_chec
| `advertising_token` | string | ユーザーの暗号化された Advertising Token (UID2) です。 |
| `refresh_token` | string | UID2 Service と最新の identity トークンのセットを交換できる暗号化されたトークンです。 |
| `identity_expires` | number | Advertising Token の有効期限を示す <a href="../ref-info/glossary-uid#gl-unix-time">Unix</a> タイムスタンプ (ミリ秒単位) です。 |
| `refresh_from` | number | SDK for JavaScript ([SDK for JavaScript Reference Guide](../sdks/sdk-ref-javascript.md) を参照) が UID2 Token のリフレッシュを開始するタイミングを示す Unix タイムスタンプ (ミリ秒単位)。<br/>TIP: SDK を使用していない場合は、このタイムスタンプから UID2 Token もリフレッシュすることを検討してください。 |
| `refresh_from` | number | UID2 Token のリフレッシュを検討するタイミングを示す Unix タイムスタンプ (ミリ秒単位) です。 |
| `refresh_expires` | number | Refresh Token の有効期限を示す Unix タイムスタンプ (ミリ秒単位) です。 |
| `refresh_response_key` | string | [POST&nbsp;/token/refresh](post-token-refresh.md) リクエストでレスポンス復号化のために使用される鍵です。 |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,4 @@ API Key と Client Secret は、認証情報が漏洩するリスクを減らす
<!--
For no-portal:
To request new credentials at any time, ask your UID2 contact.
-->
-->
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ UID2 API のリクエストレスポンスワークフローは、以下のス
[POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) エンドポイントでは、[POST&nbsp;/token/generate](../endpoints/post-token-generate.md) または [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) へのコールで事前に取得した `refresh_token` と `refresh_response_key` の値を使用します。

:::note
Windows の場合、PowerShell の代わりに Windows コマンドプロンプトを使用している場合は、JSON を囲むシングルクォートも削除する必要があります。たとえば、`echo {"email": "test@example.com", "optout_check": 1}` とします。
Windows の場合、PowerShell の代わりに Windows コマンドプロンプトを使用している場合は、JSON を囲むシングルクォートも削除する必要があります。たとえば、`echo {"email": "test@example.com"}` とします。
:::

### Prerequisites and Notes
Expand Down Expand Up @@ -228,8 +228,8 @@ Usage:
echo '<json>' | python3 uid2_request.py <url> <api_key> <client_secret>

Example:
echo '{"email": "test@example.com", "optout_check": 1}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/generate PRODGwJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=
echo '{"email": "test@example.com"}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/generate PRODGwJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=


Refresh Token Usage:
python3 uid2_request.py <url> --refresh-token <refresh_token> <refresh_response_key>
Expand Down Expand Up @@ -356,7 +356,7 @@ public class Uid2Request {
+ "java -jar Uid2Request-jar-with-dependencies.jar <url> <api_key> <client_secret>" + "\n\n"

+ "Example:" + "\n "
+ "echo '{\"email\": \"test@example.com\",\"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\": \"test@example.com\"}' | 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 Expand Up @@ -466,8 +466,8 @@ Usage:
echo '<json>' | .\uid2_request <url> <api_key> <client_secret>

Example:
echo '{"email": "test@example.com", "optout_check": 1}' | .\uid2_request https://prod.uidapi.com/v2/token/generate UID2-C-L-999-fCXrMM.fsR3mDqAXELtWWMS+xG1s7RdgRTMqdOH2qaAo= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=
echo '{"email": "test@example.com"}' | .\uid2_request https://prod.uidapi.com/v2/token/generate UID2-C-L-999-fCXrMM.fsR3mDqAXELtWWMS+xG1s7RdgRTMqdOH2qaAo= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=


Refresh Token Usage:
.\uid2_request <url> --refresh-token <refresh_token> <refresh_response_key>
Expand Down Expand Up @@ -810,8 +810,8 @@ func printUsage() {
echo '<json>' | go run uid2_request.go <url> <api_key> <client_secret>

Example:
echo '{"email": "test@example.com", "optout_check": 1}' | go run uid2_request.go https://prod.uidapi.com/v2/token/generate UID2-C-L-999-fCXrMM.fsR3mDqAXELtWWMS+xG1s7RdgRTMqdOH2qaAo= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=
echo '{"email": "test@example.com"}' | go run uid2_request.go https://prod.uidapi.com/v2/token/generate UID2-C-L-999-fCXrMM.fsR3mDqAXELtWWMS+xG1s7RdgRTMqdOH2qaAo= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=


Refresh Token Usage:
go run uid2_request.go <url> --refresh-token <refresh_token> <refresh_response_key>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ UID2 フレームワークを使用するパブリッシャーからのよくあ
ユーザーのオプトアウトはどのように通知されますか?

ユーザーがオプトアウトした場合、API レスポンスは以下のいずれかのケースで通知します:
- 直接または UID2 SDK のいずれかで [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) エンドポイントを呼び出し、UID2 Token を生成する場合、必須の `optout_check` パラメータに `1` を指定します
- 直接または UID2 SDK のいずれかで [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) エンドポイントを呼び出し、UID2 Token を生成する場合。
- 直接または UID2 SDK のいずれかで [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) エンドポイントを呼び出し、UID2 Token をリフレッシュした場合。

#### Where should I make token generation calls&#8212;from the server side or the client side?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ UID2 Operator Service へのリクエストで電話番号を送信する前に
例:
- US: `1 (234) 567-8901` は `+12345678901` に正規化されます。
- Singapore: `65 1243 5678` は `+6512345678` に正規化されます。
- Sydney, Australia: `(02) 1234 5678` は、先頭のゼロを削除し、国コードを含めるように正規化されます: `+61212345678`。
- Australia: 携帯電話番号 `0491 570 006` は、国番号を追加し、先頭のゼロを削除して正規化されます:`+61491570006`。

:::warning
正規化された電話番号が UTF-8 であることを確認してください。他のエンコーディングシステム(例: UTF-16)ではありません。
Expand Down Expand Up @@ -194,16 +194,16 @@ Email または Phone Number を選択し、値を入力または貼り付けて

## Troubleshooting

いずれの場合も、自身で DII を処理準備するための手順を実行し、その後 [UID2 Hashing Tool](#uid2-hashing-tool) を使用して結果値を確認してください。結果が一致しない場合は、各手順を確認してエラー箇所を特定してください。
いずれの場合も、自身で DII を処理準備するための手順を実行し、その後 [UID2 hashing tool](https://hashing-tool.samples.uidapi.com/) を使用して結果値を確認してください。結果が一致しない場合は、各手順を確認してエラー箇所を特定してください。

問題が発生したりエラーが出たりする場合、あるいは手順を正しく実行できているか確認したい場合にも、以下の点をチェックしてみてください。

- **Phone numbers**: 最初のステップとして、正規化を確実に行うこと&#8212;正しく正規化すること&#8212;が重要です。

このサービスはメールアドレスを正規化しますが、電話番号の正規化はできません。例えば、国コードが欠落している場合の値を判断できません。以下のリソースを利用してください。
- 正規化手順: [Phone Number Normalization](#phone-number-normalization).
- 照合ツール: [UID2 Hashing Tool](#uid2-hashing-tool).
- 照合ツール: [UID2 hashing tool](https://hashing-tool.samples.uidapi.com/).

- **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](#uid2-hashing-tool)でテストしてください。
- 以下のエラーメッセージが表示される場合があります:「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 @@ -48,7 +48,7 @@ UID2 エコシステムには、2 種類のオプトアウトがあります:

| Participant | Distribution Method |
| :--- | :--- |
| パブリッシャー | [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) を必須パラメータ `optout_check` を `1` に設定して呼び出したパブリッシャー、または [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) を呼び出したパブリッシャーは、UID2 Token の代わりにオプトアウトレスポンスを受け取ります。|
| パブリッシャー | [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) または [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) を呼び出したパブリッシャーは、UID2 Token の代わりにオプトアウトレスポンスを受け取ります。|
| DSP | UID2 Operator Service は、DSP に対して、その目的のために提供された Webhook を介して、オプトアウトしたすべてのユーザーの情報を配布します。詳細は [Honor User Opt-Outs](../guides/dsp-guide#honor-user-opt-outs) を参照してください。<br/>DSP は、[POST&nbsp;/optout/status](../endpoints/post-optout-status.md) エンドポイントを使用して、raw UID2 のオプトアウトステータスを確認することもできます。 |
| 広告主とデータプロバイダー | UID2 Operator Service は、[POST&nbsp;/identity/map](../endpoints/post-identity-map.md) エンドポイントを介して、広告主とデータプロバイダーにオプトアウト情報を配布します。別のオプションとして、[POST&nbsp;/optout/status](../endpoints/post-optout-status.md) エンドポイントを使用して、raw UID2 のオプトアウトステータスを確認することもできます。 |
| Sharers | UID2 Sharer は、[POST&nbsp;/optout/status](../endpoints/post-optout-status.md) エンドポイントを使用して、raw UID2 のオプトアウトステータスを確認することができます。 |
Expand Down
Loading
Loading