@@ -33,27 +33,31 @@ Used by: このエンドポイントは、主に広告主やデータプロバ
3333| :-------------- | :-------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3434| ` {environment} ` | string | 必須 | テスト環境: ` https://operator-integ.uidapi.com ` <br />本番環境: ` https://prod.uidapi.com ` <br />リージョンごとのオペレーターを含む全リストは [ Environments] ( ../summary-doc-v2.md#environments ) を参照してください。 |
3535
36- NOTE: インテグレーション環境と本番環境では、異なる[ APIキー] ( ../ref-info/glossary-uid.md#gl-api-key ) が必要です。
36+ NOTE: インテグレーション環境と本番環境では、異なる [ APIキー] ( ../ref-info/glossary-uid.md#gl-api-key ) が必要です。
3737
3838### Unencrypted JSON Body Parameters
3939
40- > IMPORTANT: リクエストを暗号化する際、JSON ボディに Key-Value ペアとして以下のパラメータのうち 1 つだけを含める必要があります 。
40+ > IMPORTANT: リクエストを暗号化するときには、以下の4つの条件付きパラメータのうち ** 1つ ** と、必須パラメータである ` policy ` の値 ` 1 ` のみを、JSON ボディのキーと値のペアとして含める必要があります 。
4141
4242| Body Parameter | Data Type | Attribute | Description |
4343| :------------- | :----------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4444| ` email ` | string array | 条件付きで必要 | マッピングするメールアドレスのリストです。 |
45- | ` email_hash ` | string array | 条件付きで必要 | [ 正規化 ] ( ../getting-started/gs-normalization-encoding#email-address-hash-encoding ) したメールアドレスを [ SHA-256 ハッシュし、Base64 エンコード ] ( ../getting-started/gs-normalization-encoding#email-address-normalization ) したリストです 。 |
46- | ` phone ` | string array | 条件付きで必要 | マッピングする [ 正規化] ( ../getting-started/gs-normalization-encoding#phone-number-normalization ) 済み電話番号のリストです。 |
47- | ` phone_hash ` | string array | 条件付きで必要 | [ SHA-256 ハッシュし、Base64 エンコード] ( ../getting-started/gs-normalization-encoding#phone-number-hash-encoding ) した [ 正規化] ( ../getting-started/gs-normalization-encoding#phone-number-normalization ) 済み電話番号のリストです。 |
48- | ` optout_check ` | number | オプション | ユーザー識別子がオプトアウトされたときの ID マップの動作をカスタマイズします。詳しくは、 [ Identity Map Policy ] ( #identity-map-policy ) を参照してください 。 |
45+ | ` email_hash ` | string array | 条件付きで必要 | マッピングする [ SHA-256 ハッシュし、Base64 エンコード ] ( ../getting-started/gs-normalization-encoding.md #email-address-normalization ) した [ 正規化 ] ( ../getting-started/gs-normalization-encoding.md #email-address-hash-encoding ) 済みメールアドレスのリストです 。 |
46+ | ` phone ` | string array | 条件付きで必要 | マッピングする [ 正規化] ( ../getting-started/gs-normalization-encoding.md #phone-number-normalization ) 済み電話番号のリストです。 |
47+ | ` 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 ) 済み電話番号のリストです。 |
48+ | ` policy ` | number | 必須 | トークン生成ポリシー ID は、ユーザーがオプトアウトしたかどうかをチェックします。このパラメータは ` 1 ` とします 。 |
4949
5050### Request Examples
5151
5252以下は、各パラメータの暗号化されていない JSON リクエストボディの例で、このうちの 1 つを ID マッピングリクエストに含める必要があります:
5353
5454``` json
5555{
56- "email" : [" user@example.com" , " user2@example.com" ]
56+ "email" : [
57+ " user@example.com" ,
58+ " user2@example.com"
59+ ],
60+ "policy" :1
5761}
5862```
5963
@@ -62,13 +66,18 @@ NOTE: インテグレーション環境と本番環境では、異なる[APIキ
6266 "email_hash" : [
6367 " eVvLS/Vg+YZ6+z3i0NOpSXYyQAfEXqCZ7BTpAjFUBUc=" ,
6468 " tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
65- ]
69+ ],
70+ "policy" :1
6671}
6772```
6873
6974``` json
7075{
71- "phone" : [" +1111111111" , " +2222222222" ]
76+ "phone" : [
77+ " +1111111111" ,
78+ " +2222222222"
79+ ],
80+ "policy" :1
7281}
7382```
7483
@@ -77,14 +86,15 @@ NOTE: インテグレーション環境と本番環境では、異なる[APIキ
7786 "phone_hash" : [
7887 " eVvLS/Vg+YZ6+z3i0NOpSXYyQAfEXqCZ7BTpAjFUBUc=" ,
7988 " tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
80- ]
89+ ],
90+ "policy" :1
8191}
8292```
8393
8494以下は、メールアドレスハッシュに対する暗号化された ID マッピングリクエストの例です:
8595
8696``` sh
87- echo ' {"phone": ["+1111111111", "+2222222222"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk= DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow=
97+ echo ' {"phone": ["+1111111111", "+2222222222"], "policy":1 }' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk= DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow=
8898```
8999
90100詳細と Python スクリプトの例は、[ リクエストの暗号化とレスポンスの復号化] ( ../getting-started/gs-encryption-decryption.md ) を参照してください。
@@ -138,7 +148,7 @@ echo '{"phone": ["+1111111111", "+2222222222"]}' | python3 uid2_request.py https
138148}
139149```
140150
141- リクエストにパラメータ/値 ` optout_check=1 ` が含まれ、 一部の識別子が UID2 エコシステムからオプトアウトしている場合、オプトアウトした識別子は、見つかった無効な識別子とともに"unmapped"リストに移動されます。この場合でも、応答ステータスは "success" です。
151+ 一部の識別子が UID2 エコシステムからオプトアウトしている場合、オプトアウトした識別子は、見つかった無効な識別子とともに "unmapped" リストに移動されます。この場合でも、応答ステータスは "success" です。
142152
143153``` json
144154{
@@ -177,15 +187,7 @@ echo '{"phone": ["+1111111111", "+2222222222"]}' | python3 uid2_request.py https
177187| :------------- | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
178188| ` success ` | 200 | リクエストは成功しました。レスポンスは暗号化されています。 |
179189| ` client_error ` | 400 | リクエストに不足している、または無効なパラメータがありました。 |
180- | ` unauthorized ` | 401 | クエストにベアラートークンが含まれていない、無効なベアラートークンが含まれている、またはリクエストされた操作を実行するのに許可されていないベアラートークンが含まれていました 。 |
190+ | ` unauthorized ` | 401 | クエストにベアラートークンが含まれていない、無効なベアラートークンが含まれている、またはリクエストされた操作を実行するのに許可されていないベアラートークンが含まれていた 。 |
181191
182- ` status ` の値が ` success ` 以外の場合 、 ` message ` フィールドにその問題に関する追加情報が表示されます。
192+ ` status ` の値が ` success ` 以外であれば 、 ` message ` フィールドにその問題に関する追加情報が表示されます。
183193
184- ### Identity Map Policy
185-
186- ID マップポリシーは、トークンを生成するタイミングを呼び出し元が決定できるようにします。これは、リクエストボディに整数値の ID として渡されます (キー 'policy' を使用)。このパラメータが省略された場合、デフォルト値である optout_check = 0 が適用されます。
187-
188- | ID | Description |
189- | :-- | :----------------------------------------------------- |
190- | 0 | 常にユーザー ID を UID2 にマッピングします。 |
191- | 1 | オプトアウトしたユーザーは、マッピングに含まれません。 |
0 commit comments