Skip to content

Commit a34f863

Browse files
committed
Merge branch 'main' into gwh-APIDOCS-2943-uid2-snowflake-improvements
2 parents 711acbd + 04aecc0 commit a34f863

26 files changed

+216
-83
lines changed

docs/endpoints/summary-endpoints.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ import Link from '@docusaurus/Link';
1212

1313
All UID2 endpoints require a client secret for encrypting API requests (except [POST /token/refresh](post-token-refresh.md) requests) and decrypting responses. For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md).
1414

15+
## UID2 Endpoints by Audience
16+
17+
The following table shows the UID2 endpoints, with the audience for each. For details, click through to the applicable sections.
18+
19+
| Endpoint | Audience | Details |
20+
| :--- | :--- | :--- |
21+
| [POST /token/generate](post-token-generate.md) | Publishers | [UID2 Tokens](#uid2-tokens) |
22+
| [POST /token/validate](post-token-validate.md) | Publishers | [UID2 Tokens](#uid2-tokens) |
23+
| [POST /token/refresh](post-token-refresh.md) | Publishers | [UID2 Tokens](#uid2-tokens) |
24+
| [POST /identity/map](post-identity-map.md) | Advertisers, data providers | [Identity Map](#identity-map) |
25+
| [POST /optout/status](post-optout-status.md) | Advertisers, data providers, DSPs, sharers | [Opt-Out Status](#opt-out-status)|
26+
1527
## UID2 Tokens
1628

1729
The following endpoints are for retrieving and managing UID2 tokens (identity tokens, advertising tokens), and are used mainly by publishers.

docs/sdks/summary-sdks.md

Lines changed: 100 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,108 @@ Review the SDK functionality to determine which SDK or SDKs you want to use, the
1818

1919
The following table summarizes the functionality available with each SDK.
2020

21-
| UID2 SDK for... | Client-Side or Server-Side | Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s* | Monitor Rotated Salt Buckets** |
21+
<!-- | UID2 SDK for... | Client-Side or Server-Side | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s&ast; | Monitor Rotated Salt Buckets&ast;&ast; | Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 |
2222
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
23-
|JavaScript | Client | &#8212; | &#8212; | &#9989; | &#9989; | &#8212; | &#8212; |
24-
|Java | Server | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#8212; |
23+
|JavaScript | Client | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
24+
|Java | Server | &#9989; | &#9989; | &#9989; | &#8212; | &#9989; | &#9989; |
2525
|Python | Server | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; |
26-
|C# / .NET | Server | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
27-
|C++ | Server | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
28-
|Android | Client&nbsp;(Mobile) | &#8212; | &#8212; | &#9989; | &#9989; | &#8212; | &#8212; |
29-
|iOS | Client (Mobile) | &#8212; | &#8212; | &#9989;| &#9989; |&#8212; | &#8212; |
26+
|C# / .NET | Server | &#8212; | &#8212; | &#8212; | &#8212; | &#9989; | &#9989; |
27+
|C++ | Server | &#8212; | &#8212; | &#8212; | &#8212; | &#9989; | &#9989; |
28+
|Android | Client&nbsp;(Mobile) | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
29+
|iOS | Client (Mobile) | &#9989;| &#9989; |&#8212; | &#8212; | &#8212; | &#8212; | -->
30+
31+
<table>
32+
<thead>
33+
<tr>
34+
<th colspan="2">Audience&nbsp;&nbsp;&gt;&nbsp;&gt;&nbsp;&gt;</th>
35+
<th colspan="2">Publisher</th>
36+
<th colspan="2">Advertiser&nbsp;/ Data Provider</th>
37+
<th colspan="2">DSP</th>
38+
</tr>
39+
<tr>
40+
<th> SDK for...</th>
41+
<th>Client-Side or Server-Side</th>
42+
<th>Generate UID2 Token from DII</th>
43+
<th>Refresh UID2 Token</th>
44+
<th>Map DII to Raw UID2s&ast;</th>
45+
<th>Monitor Rotated Salt Buckets&ast;&ast;</th>
46+
<th>Encrypt Raw UID2 to UID2 Token for Sharing</th>
47+
<th>Decrypt UID2 Token to Raw UID2</th>
48+
</tr>
49+
</thead>
50+
<tbody>
51+
<tr>
52+
<td>JavaScript</td>
53+
<td>Client</td>
54+
<td>&#9989;</td>
55+
<td>&#9989;</td>
56+
<td>&#8212;</td>
57+
<td>&#8212;</td>
58+
<td>&#8212;</td>
59+
<td>&#8212;</td>
60+
</tr>
61+
<tr>
62+
<td>Java</td>
63+
<td>Server</td>
64+
<td>&#9989;</td>
65+
<td>&#9989;</td>
66+
<td>&#9989;</td>
67+
<td>&#8212;</td>
68+
<td>&#9989;</td>
69+
<td>&#9989;</td>
70+
</tr>
71+
<tr>
72+
<td>Python</td>
73+
<td>Server</td>
74+
<td>&#9989;</td>
75+
<td>&#9989;</td>
76+
<td>&#9989;</td>
77+
<td>&#9989;</td>
78+
<td>&#9989;</td>
79+
<td>&#9989;</td>
80+
</tr>
81+
<tr>
82+
<td>C# / .NET</td>
83+
<td>Server</td>
84+
<td>&#8212;</td>
85+
<td>&#8212;</td>
86+
<td>&#8212;</td>
87+
<td>&#8212;</td>
88+
<td>&#9989;</td>
89+
<td>&#9989;</td>
90+
</tr>
91+
<tr>
92+
<td>C++</td>
93+
<td>Server</td>
94+
<td>&#8212;</td>
95+
<td>&#8212;</td>
96+
<td>&#8212;</td>
97+
<td>&#8212;</td>
98+
<td>&#9989;</td>
99+
<td>&#9989;</td>
100+
</tr>
101+
<tr>
102+
<td>Android</td>
103+
<td>Client&nbsp;(Mobile)</td>
104+
<td>&#9989;</td>
105+
<td>&#9989;</td>
106+
<td>&#8212;</td>
107+
<td>&#8212;</td>
108+
<td>&#8212;</td>
109+
<td>&#8212;</td>
110+
</tr>
111+
<tr>
112+
<td>iOS</td>
113+
<td>Client&nbsp;(Mobile)</td>
114+
<td>&#9989;</td>
115+
<td>&#9989;</td>
116+
<td>&#8212;</td>
117+
<td>&#8212;</td>
118+
<td>&#8212;</td>
119+
<td>&#8212;</td>
120+
</tr>
121+
</tbody>
122+
</table>
30123

31124
&ast; Advertisers and Data Providers who need to generate raw UID2s from DII can also do this via Snowflake (see [Snowflake Integration Guide](../guides/integration-snowflake.md)) or by using the [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) endpoint.
32125

i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map-v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ UID2 の Opt-Out ワークフローとユーザーが Opt-Out する方法の詳
2020
このドキュメントは、このエンドポイントのバージョン 2 のものであり、最新バージョンではありません。最新バージョン v3 の詳細は、[POST /identity/map](post-identity-map.md) を参照してください。
2121

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

2626
## Batch Size and Request Parallelization Requirements

i18n/ja/docusaurus-plugin-content-docs/current/endpoints/post-identity-map.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: POST /identity/map
3-
description: Maps DII to raw UID2s.
3+
description: DII raw UID2 にマップします。
44
hide_table_of_contents: false
55
sidebar_position: 08
66
displayed_sidebar: docs
@@ -175,7 +175,7 @@ DII が正常にマッピングされた場合、マッピングされたオブ
175175
| Property | Data Type | Description |
176176
| :--- | :--- | :--- |
177177
| `u` | string | リクエストで提供されたメールアドレスまたは電話番号に対応する raw UID2。 |
178-
| `p` | string | 以下のいずれか:<ul><li>現在の raw UID2 が過去 90 日以内にローテーションされた場合: 前の値。</li><li>現在の raw UID2 が 90 日以上前のものである場合: `null`。</li></ul> |
178+
| `p` | string | 以下のいずれか:<ul><li>現在の raw UID2 が過去 90 日以内にローテーションされた場合: 以前の raw UID2。</li><li>それ以外の場合: `null`。</li></ul> |
179179
| `r` | number | Unix タイムスタンプ(ミリ秒単位)で、raw UID2 がリフレッシュされる可能性のある時刻を示します。このタイムスタンプまで、raw UID2 は有効であることが保証されています。 |
180180

181181
マッピングできなかった入力値に対しては、マッピングされたオブジェクトに以下の表に示すプロパティが含まれます。
@@ -213,7 +213,7 @@ DII が正常にマッピングされた場合、マッピングされたオブ
213213

214214
以下の表は、バージョン間の主な違いを示しています。
215215

216-
| Feature | V2 Implementation | V3 Implementation |
216+
| Feature | v2 Implementation | v3 Implementation |
217217
| :--- | :--- | :--- |
218218
| 必要なエンドポイント | `/v2/identity/map` + `/v2/identity/buckets` | `/v3/identity/map` のみ |
219219
| リクエストごとのアイデンティティタイプ | 単一のアイデンティティタイプのみ | 複数のアイデンティティタイプ |
@@ -225,7 +225,7 @@ DII が正常にマッピングされた場合、マッピングされたオブ
225225
以前のバージョンからバージョン 3 へのアップグレードは、以下の手順に従ってください。
226226

227227
1. [Update Endpoint URL](#1-update-endpoint-url)
228-
2. [Update V3 Response Parsing Logic](#2-update-v3-response-parsing-logic)
228+
2. [Update v3 Response Parsing Logic](#2-update-v3-response-parsing-logic)
229229
3. [Replace Salt Bucket Monitoring with Refresh Timestamp Logic](#3-replace-salt-bucket-monitoring-with-refresh-timestamp-logic)
230230

231231
#### 1. Update Endpoint URL
@@ -244,7 +244,7 @@ url = '/v3/identity/map'
244244

245245
以下の例に従って、レスポンスの解析ロジックを更新してください。
246246

247-
V2 Response Parsing:
247+
v2 Response Parsing:
248248
```python
249249
# v2: Process mapped/unmapped objects with identifier lookup
250250
for item in response['body']['mapped']:
@@ -255,7 +255,7 @@ for item in response['body']['mapped']:
255255
store_mapping(original_identifier, raw_uid, bucket_id)
256256
```
257257

258-
V3 Response Parsing:
258+
v3 Response Parsing:
259259
```python
260260
# v3: Process array-indexed responses
261261
for index, item in enumerate(response['body']['email']):

i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-faqs.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ A raw UID2 for a specific user changes roughly once per year. The latest version
213213

214214
For implementations that reference earlier versions of this endpoint (see [POST&nbsp;/identity/map v2](../endpoints/post-identity-map-v2.md)):
215215

216-
Even though each <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> is updated roughly once a year, individual bucket updates are spread over the year. This means that about 1/365th of all buckets are rotated daily. If fidelity is critical, consider calling the [POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md) endpoint more frequently; for example, hourly.
216+
Even though each <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> is updated roughly once a year, individual bucket updates are spread over the year. This means that about 1/365th of all buckets are rotated daily. If fidelity is critical, consider calling the [POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md) endpoint more frequently: for example, hourly.
217217

218218
#### How should I generate the SHA-256 of DII for mapping?
219219
マッピング用の DII の SHA-256 はどのように生成すればよいですか?
@@ -261,7 +261,7 @@ Even though each <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt bucke
261261
#### How do I know when to refresh the UID2 due to salt bucket rotation?
262262
ソルトバケットのローテーションによって UID2 をリフレッシュするタイミングを知るには?
263263

264-
UID2 生成リクエストで提供されるメタデータには、UID2 の生成に使用される <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> が含まれます。ソルトバケットは持続し、UID2 の生成に使用された基礎となる DII に対応します。指定されたタイムスタンプ以降にローテーションしたソルトバケットを得るには、[POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md) エンドポイントを使用します。返されたローテーションしたソルトバケットは、どの UID2 をリフレッシュすべきかを教えてくれます。
264+
UID2 生成リクエストで提供されるメタデータには、UID2 の生成に使用される <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt bucket</Link> が含まれます。ソルトバケットは持続し、raw UID2 の生成に使用された基礎となる DII に対応します。指定されたタイムスタンプ以降にローテーションしたソルトバケットを得るには、[POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md) エンドポイントを使用します。返されたローテーションしたソルトバケットは、どの UID2 をリフレッシュすべきかを教えてくれます。
265265

266266
:::note
267267
ローテーションがいつ行われるかは、いかなる約束もいたしません。可能な限り最新の状態を保つため、1 時間に 1 回のチェックを推奨します。
@@ -284,8 +284,9 @@ demand-side platform (DSP) に関するよくある質問を紹介します。
284284
- [復号キーはどこで入手できますか?](#where-do-i-get-the-decryption-keys)
285285
- [メモリ上に存在する復号鍵の数は?](#how-many-decryption-keys-may-be-present-in-memory-at-any-point)
286286
- [マップされた raw UID2 を更新するタイミングを知るには?](#how-do-i-know-when-to-refresh-mapped-raw-uid2s)
287+
- [raw UID2 がローテーションしたか、またローテーション時期を確認するには?](#how-do-i-know-ifwhen-the-raw-uid2-has-rotated)
287288
- [DSP はレイテンシーを気にすべきでしょうか?](#should-the-dsp-be-concerned-with-latency)
288-
- [UID2 で DSP はどのように適切なフリクエンシーキャッピング周波数キャッピングを維持すべきでしょうか](#how-should-the-dsp-maintain-proper-frequency-capping-with-uid2)
289+
- [UID2 で DSP はどのように適切なフリクエンシーキャッピングを維持すべきでしょうか](#how-should-the-dsp-maintain-proper-frequency-capping-with-uid2)
289290
- [ユーザーのオプトアウトトラフィックはすべて DSP に送られますか?](#will-all-user-opt-out-traffic-be-sent-to-the-dsp)
290291
- [DSP は、すでに保存している UID2 についてのみオプトアウトシグナルを処理することを期待されているのか?](#is-the-dsp-expected-to-handle-opt-out-signals-only-for-the-uid2s-that-they-already-store)
291292
- [DSP はオプトアウトリストをどれくらいの期間保管すべきですか?](#how-long-should-the-dsp-keep-the-opt-out-list)
@@ -313,7 +314,7 @@ Server-Side SDK のいずれか([SDK](../sdks/summary-sdks.md) を参照) を使
313314
#### How do I know when to refresh mapped raw UID2s?
314315
マップされた raw UID2 を更新するタイミングを知るには?
315316

316-
[Advertisers and Data Providers section](#how-do-i-know-when-to-refresh-a-raw-uid2) を参照して下さい。
317+
See [How do I know when to refresh a raw UID2?](#how-do-i-know-when-to-refresh-a-raw-uid2) in the FAQs for Advertisers and Data Providers.
317318

318319
#### How do I know if/when the raw UID2 has rotated?
319320
raw UID2 がローテーションしたか、またローテーション時期を確認するには?
@@ -326,7 +327,7 @@ DSP はレイテンシーを気にすべきでしょうか?
326327
UID2 Service は、入札プロセスに遅延を生じさせることはありません。発生した遅延は、UID2 Service ではなく、ネットワークに起因すると考えられます
327328

328329
#### How should the DSP maintain proper frequency capping with UID2?
329-
UID2 で DSP はどのように適切なフリクエンシーキャッピング周波数キャッピングを維持すべきでしょうか
330+
UID2 で DSP はどのように適切なフリクエンシーキャッピングを維持すべきでしょうか
330331

331332
UID2 は、クッキーと同じように古くなる可能性があります。したがって、DSP は、クッキーまたは Device ID ベースのフリークエンシーキャッピングに現在使用されているものと同じインフラを UID2 に適応させることができます。詳細は [How do I know when to refresh the UID2 due to salt bucket rotation?](#how-do-i-know-when-to-refresh-the-uid2-due-to-salt-bucket-rotation) を参照してください。
332333

i18n/ja/docusaurus-plugin-content-docs/current/getting-started/gs-permissions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ UID2 エコシステムには、特定のアクティビティを完了するた
2626
| :--- | :--- | :--- |
2727
| Generator | Publishers | Permission to call the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md), [POST&nbsp;/token/validate](../endpoints/post-token-validate.md), and [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) の各エンドポイントを呼び出して、<Link href="../ref-info/glossary-uid#gl-dii">DII</Link> から UID2 Token を生成/リフレッシュする権限:<ul><li>Prebid インテグレーション</li><li>The SDK for JavaScript</li><li>UID2 Token の取得と管理のために、該当する API エンドポイントを直接呼び出すインテグレーション</li></ul> |
2828
| Bidder | DSPs | パブリッシャーからの<Link href="../ref-info/glossary-uid#gl-bidstream">ビッドストリーム</Link>から送られてくる UID2 Token を、入札目的で raw UID2 に復号化する権限。 |
29-
| Sharer | UID2 sharing に参加するすべての参加者タイプ。詳細は [UID2 Sharing: Overview](../sharing/sharing-overview.md) を参照してください。 | 以下両方の権限:<ul><li>UID2 SDK または Snowflake を使用して、raw UID2 を UID2 Token に暗号化し、許可された別の共有参加者と共有します。</li><li>他の許可された共有参加者から受け取った UID2 Token を raw UID2 に復号します。</li></ul> |
30-
| Mapper | Advertisers<br/>Data Providers | 複数のメールアドレス、電話番号、またはそのハッシュを、raw UID2、以前の raw UID2、および リフレッシュタイムスタンプにマッピングするために、以下のエンドポイントを呼び出すパーミッション:<ul><li>[POST&nbsp;/identity/map](../endpoints/post-identity-map.md) (最新バージョン)</li><li>以前の v2 identity mapping エンドポイント: [POST&nbsp;/identity/map (v2)](../endpoints/post-identity-map-v2.md) および [POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md).</li></ul> |
29+
| Sharer | UID2 sharing に参加するすべての参加者タイプ。<br/>詳細は [UID2 Sharing: Overview](../sharing/sharing-overview.md) を参照してください。 | 以下両方の権限:<ul><li>UID2 SDK または Snowflake を使用して、raw UID2 を UID2 Token に暗号化し、許可された別の共有参加者と共有します。</li><li>他の許可された共有参加者から受け取った UID2 Token を raw UID2 に復号します。</li></ul> |
30+
| Mapper | Advertisers<br/>Data Providers | 複数のメールアドレス、電話番号、またはそのハッシュを、raw UID2、以前の raw UID2、および リフレッシュタイムスタンプにマッピングするために、以下のエンドポイントを呼び出すパーミッション:<ul><li>[POST&nbsp;/identity/map](../endpoints/post-identity-map.md) (最新バージョン)</li><li>以前の v2 identity mapping エンドポイント: [POST&nbsp;/identity/map (v2)](../endpoints/post-identity-map-v2.md) および [POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md)</li></ul> |

0 commit comments

Comments
 (0)