Skip to content

Commit edb6690

Browse files
authored
Merge pull request #336 from IABTechLab/gwh-APIDOCS-1607-cstg-prebid-from-MC-02-jp
Japanese updates for prebid plus fix one broken link
2 parents 87a3e98 + d86e8f3 commit edb6690

File tree

3 files changed

+321
-74
lines changed

3 files changed

+321
-74
lines changed
Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
title: Prebid Integration
3+
description: UID2 実装のため、Prebid とのインテグレーションに関する情報。
4+
hide_table_of_contents: false
5+
sidebar_position: 04
6+
---
7+
8+
# Prebid Integration Guide
9+
10+
<!-- This guide includes the following information:
11+
12+
- [Prebid Overview](#prebid-overview)
13+
- [UID2 Prebid Module Page](#uid2-prebid-module-page)
14+
- [UID2 User ID Submodule](#uid2-user-id-submodule)
15+
- [Client Refresh Mode](#client-refresh-mode)
16+
- [Client Refresh Cookie Example](#client-refresh-cookie-example)
17+
- [Client Refresh uid2Token Example](#client-refresh-uid2token-example)
18+
- [Storage of Internal Values](#storage-of-internal-values)
19+
- [Sample Token](#sample-token)
20+
- [Prebid Implementation Notes and Tips](#prebid-implementation-notes-and-tips)
21+
- [Configuration Parameters for `usersync`](#usersync-configuration-parameters) -->
22+
23+
このガイドは、UID2 と直接インテグレーションし、RTB ビッドストリームで Prebid から渡される ID トークン を生成したいパブリッシャー向けのものです。
24+
UID2 との直接インテグレーションを行い、ヘッダービディングに Prebid を使用する場合に考慮すべき基本的なステップの概要を説明します。
25+
26+
## Introduction
27+
28+
ヘッダービディングに Prebid を使用しているパブリッシャーの場合、Prebid ヘッダービディング実装が UID2 もサポートできるように、いくつかの追加ステップがあります。
29+
30+
まだ UID2 account を持っていない場合は、UID2 account をセットアップする必要があります: [Account Setup](../getting-started/gs-account-setup.md) を参照してください。
31+
32+
## UID2 Prebid Module Page
33+
34+
Prebid と UID2 のインテグレーション方法の詳細については、Prebid サイトの [Unified ID 2.0 Prebid User ID module](https://docs.prebid.org/dev-docs/modules/userid-submodules/unified2.html) を参照してください。必ずすべての手順に従ってください。
35+
36+
## UID2 User ID Submodule
37+
38+
UID2 では、サーバーサイドで初期トークンを生成する必要があります。UID2 モジュールは、トークンの保存、提供、およびオプションのリフレッシュを処理します。このモジュールは Client Refresh モードで動作します。
39+
40+
>**Important:** UID2 は GDPR が適用される場所で使用できないように設計されています。このモジュールは渡された同意データをチェックし、`gdprApplies` フラグが `true` に設定されている場合は動作しません。
41+
42+
## Client Refresh Mode
43+
44+
Client Refresh モードでは、UID2 [POST /token/generate](../endpoints/post-token-generate.md) または [POST /token/refresh](../endpoints/post-token-refresh.md) エンドポイントからの完全なレスポンスボディをモジュールに提供する必要があります。Refresh Token が有効である限り、モジュールは必要に応じて UID2 Token (Advertising Token) をリフレッシュします。
45+
46+
Client Refresh モードを使用するようにモジュールを設定するには、以下の **どちらか** を実行する必要があります:
47+
- `params.uid2Cookie` に、レスポンスボディを JSON 文字列として含むクッキーの名前を設定します。[Client Refresh Cookie Example](#client-refresh-cookie-example) を参照してください。
48+
49+
- レスポンス本文に `params.uid2Token` を JavaScript オブジェクトとして設定します。[Client Refresh uid2Token Example](#client-refresh-uid2token-example) を参照してください。
50+
51+
### Client Refresh Cookie Example
52+
53+
この例では、Cookie は `uid2_pub_cookie` です。
54+
55+
#### Cookie
56+
```
57+
uid2_pub_cookie={"advertising_token":"...advertising token...","refresh_token":"...refresh token...","identity_expires":1684741472161,"refresh_from":1684741425653,"refresh_expires":1684784643668,"refresh_response_key":"...response key..."}
58+
```
59+
60+
#### Configuration
61+
62+
```javascript
63+
pbjs.setConfig({
64+
userSync: {
65+
userIds: [{
66+
name: 'uid2',
67+
params: {
68+
uid2Cookie: 'uid2_pub_cookie'
69+
}
70+
}]
71+
}
72+
});
73+
```
74+
75+
### Client Refresh uid2Token Example
76+
77+
次の例は、コンフィギュレーションのサンプルを示しています。トークンの内容については、[Sample Token](#sample-token) を参照してください。
78+
79+
```javascript
80+
pbjs.setConfig({
81+
userSync: {
82+
userIds: [{
83+
name: 'uid2',
84+
params: {
85+
uid2Token: {
86+
'advertising_token': '...advertising token...',
87+
'refresh_token': '...refresh token...',
88+
// etc. - see the sample token for contents of this object
89+
}
90+
}
91+
}]
92+
}
93+
});
94+
```
95+
96+
## Storage of Internal Values
97+
98+
UID2 Prebid モジュールは、いくつかの内部値を保存します。デフォルトでは、すべての値は HTML5 のローカルストレージに保存されます。必要に応じて、`params.storage``cookie` に設定することで、Cookie ストレージに切り替えることができます。Cookie のサイズが大きくなる可能性があるため、この解決策は推奨しませんが、ローカルストレージが選択できない場合には可能な解決策です。
99+
100+
## Sample Token
101+
102+
以下のサンプルは架空のものですが、トークンレスポンスオブジェクトがどのように見えるかを示しています:
103+
104+
```javascript
105+
{
106+
"advertising_token": "...",
107+
"refresh_token": "...",
108+
"identity_expires": 1633643601000,
109+
"refresh_from": 1633643001000,
110+
"refresh_expires": 1636322000000,
111+
"refresh_response_key": "wR5t6HKMfJ2r4J7fEGX9Gw=="
112+
}
113+
```
114+
115+
## Prebid Implementation Notes and Tips
116+
117+
Prebid の実装を計画する際には、以下を考慮してください:
118+
119+
- Cookie のサイズを制限しようとしている場合、コンフィギュレーションで Token を指定し、ローカルストレージのデフォルトオプションを使用します。
120+
121+
- 期限切れの Identity を提供し、モジュールが提供した Identity からリフレッシュされた有効な Identity を持っている場合、モジュールはリフレッシュされた Identity を使用します。モジュールはトークンのリフレッシュに使用した元のトークンを保存し、元のトークンが提供したトークンと一致する限り、リフレッシュされたトークンを使用します。
122+
123+
- リフレッシュされたトークンを生成するために使用された元のトークンと一致しない新しいトークンを提供した場合、保存されたトークンはすべて破棄され、代わりに新しいトークンが使用されます (必要に応じてリフレッシュされます)。
124+
125+
- インテグレーションテストの際には、`params.uid2ApiBase``"https://operator-integ.uidapi.com"` に設定することができます。トークンの生成に使用する環境と同じ環境 (本番環境またはテスト環境) を使用しなければならないことに注意してください。
126+
127+
## Configuration Parameters for `usersync`
128+
129+
以下のパラメータは、UID2 Prebid User ID Module インテグレーションにのみ適用されます。
130+
131+
| Param under userSync.userIds[] | Scope | Type | Description | Example |
132+
| --- | --- | --- | --- | --- |
133+
| name | 必須 | String | UID2 モジュールの ID 値 - `"uid2"` | `"uid2"` |
134+
| value | オプション, server only | Object | Advertising Token の値を含むオブジェクト。 | [Sample Token](#sample-token) を参照してください。 |
135+
| params.uid2Token | オプション, client refresh | Object | 初期 UID2 Token。これは `/token/generate` または `/token/refresh` エンドポイントをコールした際に復号されたレスポンスの `body` 要素でなければなりません。 | [Sample Token](#sample-token) を参照してください。 |
136+
| params.uid2Cookie | オプション, client refresh | String | サーバが設定した UID2 Token を保持する Cookie の名前。この Cookie は uid2Token パラメータと同じ形式の JSON 出なければなりません。**uid2Token を指定した場合、このパラメータは無視されます。** | [Sample Token](#sample-token) を参照してください。 |
137+
| params.uid2ApiBase | オプション, client refresh | String | デフォルトの UID2 API エンドポイントをオーバーライドします。 | `"https://prod.uidapi.com"` (デフォルト) |
138+
| params.storage | オプション, client refresh | String | モジュール内部の保存方法を指定します: `cookie` または `localStorage`。このパラメータは指定しないことを推奨します。代わりに、モジュールがデフォルトを使用するようにします。 | `localStorage` (デフォルト) |
139+
140+
<!-- eng_jp -->

0 commit comments

Comments
 (0)