Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jpn translation update 202308 #335

Merged
merged 33 commits into from
Nov 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
37c06fb
New translation files added
miyaichi Sep 7, 2023
aff82b3
Translation improvements
miyaichi Oct 16, 2023
a02bb0e
Snowflake doc, clarification re example scenario
miyaichi Oct 16, 2023
0838c74
add links from publisher guides to new FAQ
miyaichi Oct 16, 2023
d25be1d
mods re case sensitivity of tokens
miyaichi Oct 16, 2023
97bb1e0
Guides folder, mods to sidebar wording (add YAML values)
miyaichi Oct 16, 2023
b17effc
Update links in IMA docs plus add links to IMA docs from other docs.
miyaichi Oct 16, 2023
b244cc3
In publisher overview, heading update re GMA/IMA
miyaichi Oct 16, 2023
522298e
Mods for manual left navbar + groups in Integration Guides folder + c…
miyaichi Oct 22, 2023
a4bd12e
state in doc that policy parameter with value 1 is required + update …
miyaichi Oct 22, 2023
60e382c
minor copy edits to FAQ doc
miyaichi Oct 22, 2023
493354b
Minor edits to UID2 docs based on porting various endpoint updates to…
miyaichi Oct 22, 2023
3899de5
opt in/optout clarification per comments from JN
miyaichi Oct 22, 2023
07731e7
Light edit on advertiser/data provider guide from 7/17 + minor update…
miyaichi Oct 23, 2023
42e5679
opt in/optout copy clarifications re policy parameter required.
miyaichi Oct 23, 2023
ddd64fe
Secure Signals doc, add links to sample applications
miyaichi Oct 23, 2023
9e85fe0
edit publisher integration guide
miyaichi Oct 23, 2023
f6fcee6
DSP integration Guide: Preliminary edits with queries marked.
miyaichi Oct 23, 2023
994b2db
minor copy edits to Snowflake sharing doc based on edits to AT Snowfl…
miyaichi Oct 24, 2023
f700bf0
new doc for GCP confidential space.
miyaichi Oct 24, 2023
167b36e
DSP guide, mods for opt-out no timestamp
miyaichi Oct 24, 2023
12f48c9
update header on DSP overview page
miyaichi Oct 24, 2023
2fd082e
update DII heading to remove acronym
miyaichi Oct 24, 2023
292da2f
optout diagram updates (new image + svg, remove old, update file) NOT…
miyaichi Oct 24, 2023
e9a3344
add note re sharing token not in bid stream, 5 docs
miyaichi Oct 24, 2023
17e15a1
Snowflake doc, fix broken link
miyaichi Oct 24, 2023
ec56733
mod to one DSP FAQ plus minor copy edits re FAQ titles and links.
miyaichi Oct 24, 2023
5446568
edits from KK re publisher doc summaries
miyaichi Oct 27, 2023
e9ee7ff
fix broken link
miyaichi Oct 27, 2023
1f19463
edit from KK: Integration Guides summary page
miyaichi Oct 27, 2023
f11933c
Update opt-out diagram
miyaichi Nov 1, 2023
cf2192e
Proofreading
miyaichi Nov 1, 2023
0f187e1
Merge branch 'main' into jpn-translation-update-202308
genwhittTTD Nov 2, 2023
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 @@ -23,7 +23,7 @@ Used by: このエンドポイントは、主に広告主とデータプロバ
| :-------------- | :-------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `{environment}` | string | Required | テスト環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../summary-doc-v2.md#environments) を参照してください。 |

NOTE: インテグレーション環境と本番環境では、異なる[APIキー](../ref-info/glossary-uid.md#gl-api-key)が必要です。
NOTE: インテグレーション環境と本番環境では、異なる [APIキー](../ref-info/glossary-uid.md#gl-api-key) が必要です。

### Unencrypted JSON Body Parameters

Expand Down Expand Up @@ -94,4 +94,4 @@ echo '{"since_timestamp": "2023-04-19T13:00:00"}' | python3 uid2_request.py http
| `client_error` | 400 | リクエストに不足している、または無効なパラメータがありました。 |
| `unauthorized` | 401 | クエストにベアラートークンが含まれていない、無効なベアラートークンが含まれている、またはリクエストされた操作を実行するのに許可されていないベアラートークンが含まれていました。 |

`status` の値が `success` 以外の場合、 `message` フィールドにその問題に関する追加情報が表示されます。
`status` の値が `success` 以外であれば、 `message` フィールドにその問題に関する追加情報が表示されます。
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,31 @@ Used by: このエンドポイントは、主に広告主やデータプロバ
| :-------------- | :-------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `{environment}` | string | 必須 | テスト環境: `https://operator-integ.uidapi.com`<br/>本番環境: `https://prod.uidapi.com`<br/>リージョンごとのオペレーターを含む全リストは [Environments](../summary-doc-v2.md#environments) を参照してください。 |

NOTE: インテグレーション環境と本番環境では、異なる[APIキー](../ref-info/glossary-uid.md#gl-api-key)が必要です。
NOTE: インテグレーション環境と本番環境では、異なる [APIキー](../ref-info/glossary-uid.md#gl-api-key) が必要です。

### Unencrypted JSON Body Parameters

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

| Body Parameter | Data Type | Attribute | Description |
| :------------- | :----------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `email` | string array | 条件付きで必要 | マッピングするメールアドレスのリストです。 |
| `email_hash` | string array | 条件付きで必要 | [正規化](../getting-started/gs-normalization-encoding#email-address-hash-encoding) したメールアドレスを [SHA-256 ハッシュし、Base64 エンコード](../getting-started/gs-normalization-encoding#email-address-normalization) したリストです。 |
| `phone` | string array | 条件付きで必要 | マッピングする [正規化](../getting-started/gs-normalization-encoding#phone-number-normalization) 済み電話番号のリストです。 |
| `phone_hash` | string array | 条件付きで必要 | [SHA-256 ハッシュし、Base64 エンコード](../getting-started/gs-normalization-encoding#phone-number-hash-encoding) した [正規化](../getting-started/gs-normalization-encoding#phone-number-normalization) 済み電話番号のリストです。 |
| `optout_check` | number | オプション | ユーザー識別子がオプトアウトされたときの ID マップの動作をカスタマイズします。詳しくは、[Identity Map Policy](#identity-map-policy) を参照してください。 |
| `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) 済みメールアドレスのリストです。 |
| `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) 済み電話番号のリストです。 |
| `policy` | number | 必須 | トークン生成ポリシー ID は、ユーザーがオプトアウトしたかどうかをチェックします。このパラメータは `1` とします。 |

### Request Examples

以下は、各パラメータの暗号化されていない JSON リクエストボディの例で、このうちの 1 つを ID マッピングリクエストに含める必要があります:

```json
{
"email": ["[email protected]", "[email protected]"]
"email": [
"[email protected]",
"[email protected]"
],
"policy":1
}
```

Expand All @@ -62,13 +66,18 @@ NOTE: インテグレーション環境と本番環境では、異なる[APIキ
"email_hash": [
"eVvLS/Vg+YZ6+z3i0NOpSXYyQAfEXqCZ7BTpAjFUBUc=",
"tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
]
],
"policy":1
}
```

```json
{
"phone": ["+1111111111", "+2222222222"]
"phone": [
"+1111111111",
"+2222222222"
],
"policy":1
}
```

Expand All @@ -77,14 +86,15 @@ NOTE: インテグレーション環境と本番環境では、異なる[APIキ
"phone_hash": [
"eVvLS/Vg+YZ6+z3i0NOpSXYyQAfEXqCZ7BTpAjFUBUc=",
"tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
]
],
"policy":1
}
```

以下は、メールアドレスハッシュに対する暗号化された ID マッピングリクエストの例です:

```sh
echo '{"phone": ["+1111111111", "+2222222222"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk= DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow=
echo '{"phone": ["+1111111111", "+2222222222"], "policy":1}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk= DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow=
```

詳細と Python スクリプトの例は、[リクエストの暗号化とレスポンスの復号化](../getting-started/gs-encryption-decryption.md) を参照してください。
Expand Down Expand Up @@ -138,7 +148,7 @@ echo '{"phone": ["+1111111111", "+2222222222"]}' | python3 uid2_request.py https
}
```

リクエストにパラメータ/値 `optout_check=1` が含まれ、一部の識別子が UID2 エコシステムからオプトアウトしている場合、オプトアウトした識別子は、見つかった無効な識別子とともに"unmapped"リストに移動されます。この場合でも、応答ステータスは "success" です。
一部の識別子が UID2 エコシステムからオプトアウトしている場合、オプトアウトした識別子は、見つかった無効な識別子とともに "unmapped" リストに移動されます。この場合でも、応答ステータスは "success" です。

```json
{
Expand Down Expand Up @@ -177,15 +187,7 @@ echo '{"phone": ["+1111111111", "+2222222222"]}' | python3 uid2_request.py https
| :------------- | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `success` | 200 | リクエストは成功しました。レスポンスは暗号化されています。 |
| `client_error` | 400 | リクエストに不足している、または無効なパラメータがありました。 |
| `unauthorized` | 401 | クエストにベアラートークンが含まれていない、無効なベアラートークンが含まれている、またはリクエストされた操作を実行するのに許可されていないベアラートークンが含まれていました。 |
| `unauthorized` | 401 | クエストにベアラートークンが含まれていない、無効なベアラートークンが含まれている、またはリクエストされた操作を実行するのに許可されていないベアラートークンが含まれていた。 |

`status` の値が `success` 以外の場合、 `message` フィールドにその問題に関する追加情報が表示されます。
`status` の値が `success` 以外であれば、 `message` フィールドにその問題に関する追加情報が表示されます。

### Identity Map Policy

ID マップポリシーは、トークンを生成するタイミングを呼び出し元が決定できるようにします。これは、リクエストボディに整数値の ID として渡されます (キー 'policy' を使用)。このパラメータが省略された場合、デフォルト値である optout_check = 0 が適用されます。

| ID | Description |
| :-- | :----------------------------------------------------- |
| 0 | 常にユーザー ID を UID2 にマッピングします。 |
| 1 | オプトアウトしたユーザーは、マッピングに含まれません。 |
Loading