メインコンテンツまでスキップ

Publisher Integration Guide, Server-Only

このガイドは、UID2 対応のシングルサインオンや ID プロバイダーではなく、UID2 と直接インテグレーションしながら、RTB ビッドストリーム用に UID2 Token (Advertising Token) を生成したいパブリッシャーを対象としています。

Introduction

このガイドでは、Client-Side または Server-Side SDK を使用せずにインテグレーションを行う場合に考慮する必要がある基本的な手順 を概説しています。例えば、以下のような方法を決定する必要があります:

  • ユーザーログインとログアウトの実装方法
  • UID2 アイデンティティ情報を管理し、ターゲティング広告に使用する方法
  • UID2 Token をリフレッシュする方法
  • 紛失した ID の対処方法
  • ユーザーのオプトアウトを管理する方法

FAQ も参照してください。

パブリッシャーが UID2 とインテグレーションするために利用できるオプションは以下のとおりです:

このガイドでは、最後の 2 つのオプションに関する情報を提供します。

ワークフローを示すサンプルアプリケーションもあります。サンプルアプリケーション を参照してください。

TIP: UID2 を使用してクライアントの identity を確立し、UID2 Token を取得するプロセスを容易にするには、UID2 SDK for JavaScript の使用を検討してください。詳細については、Server-Side Integration Guide for JavaScript を参照してください。

Integration Steps

以下の図は、ユーザーがパブリッシャーと UID2 Token を確立するために必要なステップと、UID2 Token が RTB ビッドストリームとどのようにインテグレーションされるかを概説したものです。

Server-Side SDK を使用している場合、SDK はエンドポイントに関連するすべてのステップを処理します。例えば、Step 1-d では、発行者はユーザーの DII をトークン生成サービスに送信します。

次のセクションでは、図中の各ステップについて詳細を説明します:

  1. Establish identity: user login
  2. Bid using a UID2 token
  3. Refresh a UID2 token
  4. Clear Identity: user logout

Establish Identity: User Login

Step 1-c での認証(ユーザーの同意を得ること、パブリッシャーがユーザーのメールアドレスまたは電話番号を検証することを含む) の後、パブリッシャーは Server-Side で UID2 Token を生成するリクエストを送ることがでます。以下の表は、トークン生成ステップの詳細です。

StepEndpointDescription
1-dPOST /token/generateパブリッシャーが UID2 を使用してアイデンティティを確立するには、2 つの方法があります:
- UID2 対応のシングルサインオンプロバイダーとインテグレーションします。
- POST /token/generate エンドポイントを使って、ユーザーの正規化したメールアドレスまたは電話番号から UID2 Token を生成します。
1-ePOST /token/generateユーザーのメールアドレス、電話番号、またはそれぞれのハッシュからと、Refresh Token などの関連値から生成された UID2 Token を返します。
1-fN/A返された advertising_tokenrefresh_token は、ユーザーに紐づくストレージに保存します。ファーストパーティクッキーのようなClient-Side のストレージや、Server-Sideのストレージを検討するとよいでしょう。

Bid Using a UID2 Token

UID2 ID 情報をどのように管理し、ターゲティング広告に使用したいかを検討する必要があります。例えば、返された UID2 token を SSP に渡す等。

StepEndpointDescription
2-aN/AStep 1-eadvertising_token を入札のために SSP に送信します。そのままの値を送信します。

NOTE: UID2 Token が SSP から DSP に送信されるとき、ビッドストリーム内でどのように見えるかの例については、ビッドストリームで UID2 Token はどのように見えますか? を参照してください。

Refresh a UID2 Token

POST /token/refresh エンドポイントを使用して、常に有効で最新の UID2 Token を持つようにします。UID2 ローテーションと同期させるには、UID2 Token をリフレッシュする必要があります。さらに、トークンリフレッシュプロセスではユーザーのオプトアウトステータスをチェックし、ユーザーがオプトアウトしている場合は新しいトークンを送信しません。これによりトークンリフレッシュチェーンが終了します。その UID2 Token を二度と使用してはなりません。

StepEndpointDescription
3-aN/Aユーザーがアセットに戻り、再びアクティブになったとき、UID2 Token をリフレッシュしてから、SSP に送信します。
3-bPOST /token/refreshStep 1-e で取得した refresh_token をクエリパラメータとして送信します。
3-cPOST /token/refreshUID2 Service は、オプトアウトしていないユーザーに対して新しい ID トークンを発行します。
3-dN/APOST /token/refresh エンドポイントから返される値、advertising_tokenrefresh_token を、ユーザーにリンクされるように配置します。ファーストパーティのクッキーのようなClient-Side のストレージか、サーバサイドのストレージを検討するとよいでしょう。

TIP: POST /token/generate または POST /token/refresh エンドポイントによって返された ID の refresh_from タイムスタンプからトークンのリフレッシュを始めてください。

Clear Identity: User Logout

ユーザーがログアウトした場合は、UID2 Token を使用しないでください。

StepEndpointDescription
4-aN/Aユーザーがパブリッシャーアセットからログアウトしました。
4-bN/Aそのユーザー用に保存してある UID2 Token を削除します。UID2 Service とのやりとりは必要ありません。

Sample Application

Server-only のインテグレーションの場合は、サンプルアプリケーションをがあります。参照してください:

FAQs

パブリッシャー向けのよくある質問は、FAQs for Publishers を参照してください。