Google Ad Manager Secure Signals Integration Guide
このガイドでは、UID2 を Google Ad Manager のセキュアシグナル機能 (旧称: Encrypted Signals for Publishers、ESP) で使用するパブリッシャー向けのインテグレーション手順について説明します。
UID2 Google Ad Manager セキュアシグナルインテグレーションを使用するには、SDK を使用している場合、UID2 インテグレーションがすでに設定されている必要があります。サーバーのみのインテグレーションを使用している場合は、この限りではありません。使用可能なすべてのインテグレーションオプションの概要は、UID2 Integration Guides: Summary を参照してください。
Overview
Google secure signals は、パブリッシャーが Google Ad Manager と Google Ad Manager Ad Exchange (AdX) を通じて、Google が承認したビッダーに対して「暗号化」したユーザー ID を渡すための方法です。このフレームワークは、パブリッ シャーが一般的に使用する Google Publisher Tag (GPT)ライブラリのオプションパーツとして提供されています。
このフレームワークでは、次のようなステップを踏みます:
- パブリッシャーは、ユーザー ID シグナル (Advertising Token) をセキュアシグナル機能にプッシュします。
- セキュアシグナル機能は、Client-Side でそれらをキャッシュし、Google Ad Manager に透過的に渡します。
- Google Ad Manager は UID2 Token を使ってビッドリクエストを行い、パブリッシャーの設定に基づき Google AdX 内の承認済み入札者にトークンを転送します。
Complete UID2 Account Setup and Configure Account
UID2 とインテグレーションするには、UID2 アカウントが必要です。アカウントをまだ作成していない場合は、まず Account Setup ページの手順に従ってください。
アカウントの初期設定が完了すると、UID2 Portal にアクセスするための手順とリンクが送信されます。ここで、本番環境用の credentials を作成し、提供する必要がある追加の値を設定できます。詳細は、Getting Started with the UID2 Portal を参照してください。
設定 する値は、選択した Publisher 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 (適用される場合): Adding and Managing Mobile App IDs を参照してください。
Allow Secure Signals Sharing
Google Ad Manager アカウントで暗号化 UID2 Token を受け取るには、暗号化されたシグナルが Google Ad Manager アカウントで第三者の入札者と適切に共有されていることを確認する必要があります。
詳細は、Google ドキュメントの Share encrypted signals with bidders を確認し、Use a third-party signal provider の手順に従って、シグナルプロバイダーとして UID2 をオンに設定してください。
手順に従う際、Select allowed secure signals の Web Signal Deploy Option で Google Deploy を選択してください。Prebid.js を使用している場合は、Optional: Enable Secure Signals in Prebid.js を参照してください。
Optional: Enable Secure Signals in Prebid.js
Prebid.js で Secure Signals を使用する場合は、UID2 が正しく処理されるように、次の追加手順を完了する必要があります:
-
Google Ad Manager で、暗号化されたシグナルがサードパーティの入札者と適切に共有されていることを確認する際: Prebid User ID Module を選択し、Use your Prebid configuration to automatically configure your Secure signals settings も選択します。設定を保存する前に、正しいオプションを選択したことを再確認してください。
-
Prebid.js のセットアップ: 次のコードに示すように、Prebid 構成内の
encryptedSignalSources
セクションを更新します。"encryptedSignalSources": {
"sources":[
{
"source":[
"uidapi.com"
],
"encrypt":false
}
]
}For details, see ESP Configurations in the Prebid documentation.
Integrating with Single Sign-On (SSO)
シングルサインオン(SSO)プロバイダーとのインテグレーションに関する情報は、Publisher Integration with SSO Providers を参照してください。
Publisher Integration
暗号化されたシグナルがキャッシュされると、セキュアシグナル機能は、新しいシグナルを生成するためのハンドラを実行しません。このため、データキャプチャの前後にキャッシュをクリアする必要があります。
セキュアシグナル機能は特定の ID を削除したり無効にしたりする方法を提供しないので、パブリッシャーはデータキャプチャのワークフローの一部として、window.googletag.secureSignalProviders.clearAllCache()
関数を呼び出して、共有された暗号化シグナルすべてをクリアしなければなりません。
以下は window.googletag.secureSignalProviders.clearAllCache()
関数の呼び出しの例です:
window.googletag = window.googletag || { cmd: [] };
window.googletag.cmd.push(function () {
window.googletag.secureSignalProviders =
window.googletag.secureSignalProviders || [];
window.googletag.secureSignalProviders.clearAllCache();
});
Publisher Integration Options
Google Secure Signals パブリッシャーインテグレーションには、UID2 との 3 つのインテグレーションオプションがあります:
- Server-Side Integration
- SDK for JavaScript Client-Server Integration
- SDK for JavaScript Client-Side Integration
Server-Side Integration
暗号化されたシグナルを共有できるように、ホストされ、自動ロードされたセキュアシグナルスクリプトは window.getUid2AdvertisingToken
関数を非同期に呼び出し、そのレスポンスとして advertising_token
を文字列として受け取れるようにしなければなりません。
ID トークンがフレッシュであることを確認することが重要です。Server-Sideのインテグレーションでは、POST /token/refresh というエンドポイントを呼び出し、JSON レスポンスから新しい Advertising Token を取得することが推奨されます。
次のコードは、その例です。
window.getUid2AdvertisingToken = async () => {
// Make a call to get a fresh identity token which could last for at least 12 hours.
const identity = await getFreshIdentity()
return JSON.parse(decodeURIComponent(identity)).advertising_token
}
詳細は、Server-Only UID2 Integration Guide を参照してください。
Server Only インテグレーションのためのサンプルアプリケーションも用意されています。Sample Implementations を参照してください。
SDK for JavaScript Client-Server Integration
Javascript SDK Version 3.0.0 以降を使用している場合、UID2 セキュアシグナルスクリプトは、SDK で提供されている getAdvertisingTokenAsync
関数を使用して新しい Advertising Token を取得し、そのトークンを Google Ad Manager にプッシュします。
このスクリプトは CDN でホストされており、GPT はセキュアシグナル機能で自動的にロードします。
詳細は、Client-Server Integration Guide for JavaScript を参照してください。
JavaScript SDK を使用したインテグレーションのためのサンプルアプリケーションも用意されています。Sample Implementations を参照してください。
SDK for JavaScript Client-Side Integration
SDK for JavaScript バージョン 3.0.0 以降を使用している場合、UID2 セキュアシグナルスクリプトは、SDKで提供されている getAdvertisingTokenAsync
関数を使用して新しい Advertising Token を取得し、そのトークンを Google Ad Manager にプッシュします。
このスクリプトは CDN でホストされており、GPT はセキュアシグナル機能で自動的にロードします。
詳しくは Client-Side Integration Guide for JavaScript を参照してください。
Sample Implementations
Google Ad Manager のセキュアシグナル機能との連携方法については、以下のサンプルアプリケーションを参照してください:
- UID2 JavaScript SDK と Google secure signals を使用した Server-Side インテグレーションのサンプル:
- UID2 JavaScript SDK と Google secure signals を使用した Client-Server インテグレーションのサンプル:
- UID2 JavaScript SDK と Google secure signals を使用した Client-Side インテグレーションのサンプル:
- Client-side integration example using React, the UID2 JavaScript SDK, and Google secure signals:
各サンプル実装には、それぞれのの手順があります。
Troubleshooting
UID2 インテグレーションで Google Secure Signals を使用する際に役立つトラブルシューティング情報です:
I enabled Secure Signals within Google Ad Manager, but UID2s are not being passed through Google
Google Ad Manager で Secure Signals を有効にした後、Google を介して正常な UID2 が渡されない場合があります。これは、参加者が誤った Web Signal Deployment Method 構成を持っている場合があります。
UID2 が Google を介して渡されない場合は、セットアップ時に正しい Web Signal Deployment Method を選択したことを確認してください。
詳細は、Allow Secure Signals Sharing の Important ノートを参照してください。