CTV integration guide
Connected TV (CTV) パブリッシャーであれば、UID2 とインテグレーションして、CTV アプリのコンテキストで RTB ビッドストリームに渡す ID トークンを生成およびリフレッシュする方法がいくつかあります。
Key integration steps
UID2 とインテグレーションするには、次の 3 つの主要なステップを実装します:
-
UID2 Token を生成します。
-
UID2 Token を頻繁に更新または再生成し、トークンが最新の状態を維持するようにしてください。
詳細については、Keeping the token current と Recommended token refresh frequency を参照してください。
-
UID2 Token をビッドストリームに渡します。
これらのステップをどのように実装するかを決定するには、CTV integration options から選択してください。
Integrating with single sign-on (SSO)
SSO ログインを提供するために1つ以上の SSO プロバイダーとインテグレーションしている場合、SSO プロバイダーからログインユーザーのメールアドレスを取得して UID2 Token を生成できる可能性があります。
詳細は、Publisher integration with SSO providers を参照してください。
Preparing DII for processing
UID2 に変換する入力データが許容可能な形式であることは非常に重要です。そうでない場合、期待される結果は得られません。たとえば、Phone number normalization で説明されているように、電話番号には国コードを含めるように正規化する必要があります。
詳細は、Preparing emails and phone numbers for processing を参照してください。
フルトークン生成パイプラインをエンドツーエンドで検証し、正規化・ハッシュ化・エンコードされた値から生成されたトークンが正確であることを確認するためには、[UID2 Token Validator](../ref-info/ref-token-validator.md)を使用してください。
Private Operator option
パブリッシャーで、ファーストパーティデータを企業ネットワーク内に保持したい場合は、Private Operator を展開することを選択できます。このシナリオでは、自身のためだけのプライベートインスタンスをホストします。
その他の情報は、次のリソースを確認してください:
UID2 Private Operator ソリューションは、UID2 Token の Client-Side 生成をサポートしていません。Client-Side インテグレーションを希望する場合は、Public Operator ソリューションを使用する必要があります。
Complete UID2 account setup and configure account
UID2 とインテグレーションするには、UID2 のアカウントが必要です。まだアカウントを作成していない場合は、最初に Account setup ページの手順に従ってください。
アカウントの初期設定が完了すると、本番環境用の credentials を作成し、必要に応じて追加の値を設定できる UID2 Portal にアクセスするための手順とリンクが送信されます。詳細は、UID2 Portal での開始 を参照して ください。
設定する具体的な値は、CTV integration options で選択したオプションによって異なります:
- Client-Server または Server-Side の実装の場合、UID2 Portal の API keys ページで次の値を設定する必要があります:
-
API Key、Client Key とも呼ばれます。
-
Client Secret、参加者と UID2 Service のみが知る値です。
importantこれらの値を安全に保管することは非常に重要です。詳細は、Security of API key and client secret を参照してください。
-
- Client-Side の実装には、UID2 Portal の Client-side integration ページで次の値を設定する必要があります:
- Subscription ID と Public Key: Adding and managing key pairs を参照してください。
- この SDK を使用するすべてのサイトの domain names のリスト: Adding and managing root-level domains を参照してください。
- モバイルアプリ ID (適用される場合): モバイルアプリ ID の追加と管理 を参照してください。
CTV integration options
UID2 Token の生成とリフレッシュをどこで行うかに基づいて、最適なインテグレーションオプションを選択できます。以下の表に示すように、3 つのオプションがあります:
| Option | Details |
|---|---|
| Client-side integration | トークンは Client-Side で生成され、リフレッシュされます。 |
| Server-side integration | トークンは Server-Side で生成され、リフレッシュされます。 |
| Client-server integration | トークンは Server-Side で生成され、Client-Side でリフレッシュされます。 |
Client-side integration for CTV apps
Client-Side オプションは、UID2 Token を完全に Client-Side で管理したいパブリッシャー向けです:
- トークンは CTV アプリ内で Client-Side で生成されます。
- トークンは CTV アプリ内から必要に応じてリフレッシュされます。
このセットアップでは、すべてのコード変更が CTV アプリ内で行う必要があります。
この方法で実装するには、Client-side integration guide for mobile の手順に従ってください。
次の表は、対応するオペレーティングシステムと、関連するドキュメントリソースへのリンクを示しています。
| Operating System | Integration Guide | Link to SDK Guide |
|---|---|---|
| Apple tvOS | Client-side integration guide for mobile | SDK for iOS reference guide |
| Android TV | Client-side integration guide for mobile | SDK for Android reference guide |
Server-side integration for CTV apps
Server-Side オプションは、UID2 Token を完全に Server-Side で管理したいパブリッシャー向けです:
- トークンは Server-Side で生成されます。
- 必要に応じてトークンは Server-Side でリフレッシュされます。
このセットアップでは、ほとんどのコード変更が Server-Side で行われ、CTV アプリ内での変更は最小限に抑えられます。
この方法の利点の 1 つは、複数のプラットフォーム (Web / CTV / モバイル) に対処する場合、すべてを Server-Side で行うことで、プラットフォーム固有の作業を減らすことができることです。
この方法で実装するには、Publisher integration guide, server-side の手順に従ってください。
Server-Side コードが Java または Python である場合、UID2 SDK のいずれかを使用して、UID2 への HTTP リクエストを行うことができます。自分でソースコードを書く代わりに、次のいずれかの SDK ガイドを参照してください:
- SDK for Java reference guide: Usage for publishers
- SDK for Python reference guide: Usage for publishers
Client-server integration for CTV apps
このオプションは UID2 Token を Client-Server で管理したいパブリッシャー向けです:
- トークンは Server-Side で生成されます。
- トークンは CTV アプリ内から必要に応じて Client-Side でリフレッシュされます。
この方法で実装するには、Client-server integration guide for mobile の手順に従ってください。
次の表は、対応するオペレーティングシステムと、関連するドキュメントリソースへのリンクを示しています。
| Operating System | Integration Guide | Link to SDK Guide |
|---|---|---|
| Apple tvOS | Client-server integration guide for mobile | SDK for iOS reference guide |
| Android TV | Client-server integration guide for mobile | SDK for Android reference guide |
Best practices
CTV インテグレーションのベストプラクティスは次のとおりです:
-
トークンを事前にローテーションさせる
CTV 広告は広告ブレイク中のトラフィックスパイクに関連付けられています。これらの時間帯に UID2 Token を生成またはリフレッシュすることは理想的ではありません。忙しい時間帯の前にトークンを生成またはリフレッシュすることを推奨します。
トークンが有効期限前にリフレッシュされた場合、古いトークンが有効期限切れになるまで、新しいトークンまたは古いトークンのいずれかを使用できます。TTL (time to live) タイムスタンプは、トークンが生成またはリフレッシュされたときに UID2 Operator から返されるレスポンスボディの一部です。
-
トークンは必要な場合のみローテーションさせる
UID2 Token はユーザーの HEM (Household Email Address) または電話番号に紐付けられており、視聴セッションやアプリセッションには紐付けられていません。ユーザーに有効な UID2 Token がある限り、新しい視聴セッションやアプリセッションごとに新しいトークンを生成する必要はありません。たとえば、ユーザーがアプリを離れ、再度開いた場合、既存のトークンがまだ有効であれば、新しい UID2 Token を生成する必要はありません。
-
ポッド内の複数の広告スロットで同じトークン を使用する
UID2 Token がポッドの期間中に有効である限り、ポッド内の任意の広告スロットで使用できます。
理想的には、これらのガイドラインに従うと、広告ブレイク中に新しい UID2 Token を生成する必要はありません。