| title | Publisher integration guide, server-side |
|---|---|
| sidebar_label | Server-side |
| pagination_label | Publisher integration guide, server-side |
| description | UID2 対応シングルサインオンや ID プロバイダーではなく、UID2 と直接インテグレーションを行いながら、RTB ビッドストリーム用に UID2 を使用して ID トークンを生成する方法。 |
| hide_table_of_contents | false |
| sidebar_position | 3 |
| displayed_sidebar | docs |
import Link from '@docusaurus/Link'; import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx'; import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
このガイドは、UID2 Token (Advertising Token) を RTB ビッドストリーム 用に生成するために、UID2 と直接インテグレーションを行いながら、UID2 対応シングルサインオンや ID プロバイダーではなく、すべてのインテグレーションを Server-Side で行うパブリッシャー向けのガイドです。
パブリッシャーが UID2 と Server-Side でインテグレーションするには、以下のオプションが利用可能です:
- SDK for Java (see Usage for publishers section).
- SDK for Python (see Usage for publishers section).
- Custom server code to generate and refresh the UID2 token by calling the POST /token/generate and POST /token/refresh endpoints.
ワークフローをデモするサンプルアプリケーションもあります。Sample implementation を参照してください。
パブリッシャーインテグレーションオプションの完全な概要は、Publisher integrations を参照してください。
:::tip UID2 と UID2 Token を使用してクライアントのアイデンティティを確立し、UID2 Token を取得するプロセスを容易にするために、SDK for JavaScript を使用することを検討してください。詳細は Client-server integration guide for JavaScript を参照してください。 :::
このガイドでは、Client-Side または Server-Side SDK を使用せずインテグレーションを行う場合に考慮する必要がある basic steps について説明します。たとえば、以下のようなことを決定する必要があります:
- メールアドレスまたは電話番号を取得する機会を実装する: たとえば、プロモーションの交換、サインアップとサブスクリプション、またはマーケティングフォームの記入。
- UID2 ID 情報を管理し、ターゲティング広告に使用する
- UID2 Token をリフレッシュする
- ID が欠落している場合の処理
- ユーザーオプトアウトを管理する
FAQs も参照してください。
UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず Account setup ページの手順に従ってください。
アカウントの初期設定が完了すると、UID2 Portal にアクセスするための手順とリンクが送信されます。UID2 Portal では、本番環境のための credentials を作成し、提供する必要がある追加の値を設定できます。詳細は、Getting started with the UID2 Portal を参照してください。
Server-Side インテグレーションの場合、UID2 Portal の API keys ページで以下の値を設定する必要があります:
- API Key、Client Key とも呼ばれます。
- Client Secret、参加者と UID2 Service のみが知る値。
:::important これらの値を安全に保管することが非常に重要です。詳細は、Security of API key and client secret を参照してください。 :::
以下の図は、ユーザーがパブリッシャーと UID2 Token を確立するために必要なステップと、UID2 Token が RTB ビッドストリームとどのようにインテグレーションされるかを概説したものです。
Server-Side SDK を使用している場合、SDK はエンドポイントに関連するすべてのステップを処理します。たとえば、Step 1-d では、発行者はユーザーの DII をトークン生成サービスに送信します。
次のセクションでは、図中の各ステップについて詳細を説明します:
- Establish identity: capture user data
- Bid using a UID2 token
- Refresh a UID2 token
- Clear identity: user logout
Step 1-c で認証が行われ、パブリッシャーがユーザーのメールアドレスや電話番号を検証した後、パブリッシャーは Server-Side で UID2 Token を生成するリクエストを送信することができます。次の表は、トークン生成ステップの詳細です。
:::tip このエンドポイントを直接呼び出す代わりに、SDK のいずれかを使用して管理することもできます。オプションの概要は、SDKs: Summary を参照してください。 :::
| Step | Endpoint | Description |
|---|---|---|
| 1-d | POST /token/generate | パブリッシャーが UID2 を使用してアイデンティティを確立するには、2 つの方法があります: - UID2 対応のシングルサインオンプロバイダーとインテグレーションします。 - POST /token/generate エンドポイントを使って、ユーザーの正規化したメールアドレスまたは電話番号から UID2 Token を生成します。 |
| 1-e | POST /token/generate | ユーザーのメールアドレス、電話番号、またはそれぞれのハッシュからと、Refresh Token などの関連値から生成された UID2 Token を返します。 |
| 1-f | N/A | 返された advertising_token と refresh_token は、ユーザーに紐づくストレージに保存します。ファーストパーティクッキーのような Client-Side のストレージや、Server-Side のストレージを検討するとよいでしょう。 |
UID2 ID 情報をどのように管理し、ターゲティング広告に使用したいかを検討する必要があります。たとえば、返された UID2 Token を SSP に渡す等。
| Step | Endpoint | Description |
|---|---|---|
| 2-a | N/A | Step 1-e の advertising_token を入札のために SSP に送信します。そのままの値を送信します。 |
:::note UID2 Token が SSP から DSP に送信されるとき、ビッドストリーム内でどのように見えるかの例は、ビッドストリームで UID2 token はどのように見えますか？ を参照してください。 :::
POST /token/refresh エンドポイントを使用して、常に有効で最新の UID2 Token を持つようにします。UID2 ローテーションと同期させるには、UID2 Token をリフレッシュする必要があります。さらに、トークンリフレッシュプロセスではユーザーのオプトアウトステータスをチェックし、ユーザーがオプトアウトしている場合は新しいトークンを送信しません。これによりトークンリフレッシュチェーンが終了します。その UID2 Token を二度と使用してはなりません。
UID2 のオプトアウトワークフローとユーザーがオプトアウトする方法の詳細は、User opt-out を参照してください。
| Step | Endpoint | Description |
|---|---|---|
| 3-a | N/A | ユーザーがアセットに戻り、再びアクティブになったとき、UID2 Token をリフレッシュしてから、SSP に送信します。 |
| 3-b | POST /token/refresh | Step 1-e で取得した refresh_token をクエリパラメータとして送信します。 |
| 3-c | POST /token/refresh | UID2 Service は、オプトアウトしていないユーザーに対して新しい ID トークンを発行します。 |
| 3-d | N/A | POST /token/refresh エンドポイントから返される値、advertising_token と refresh_token を、ユーザーにリンクされるように配置します。ファーストパーティのクッキーのような Client-Side のストレージか、Server-Side のストレージを検討するとよいでしょう。 |
:::tip
POST /token/generate または POST /token/refresh エンドポイントによって返された ID の refresh_from タイムスタンプからトークンのリフレッシュを始めてください。
:::
ユーザーがログアウトした場合は、UID2 Token を使用しないでください。
| Step | Endpoint | Description |
|---|---|---|
| 4-a | N/A | ユーザーがパブリッシャーアセットからログアウトしました。 |
| 4-b | N/A | そのユーザー用に保存してある UID2 Token を削除します。UID2 Service とのやりとりは必要ありません。 |
Server-only のインテグレーションのためのサンプルアプリケーションがあります。以下を参照してください:
パブリッシャー向けのよくある質問は、FAQs for publishers を参照してください。