カスタムCMP統合
この記事では、Tealium iQ Consent Integrationsでカスタム同意管理プラットフォームを構成する方法について説明します。
仕組み
Tealium Consent Integrationsは、以下の二部分から構成されています:
- Tealium iQ用の同意強制フレームワーク(
utcm_framework
テンプレート)。 - Tealium iQの同意強制フレームワークを活用するCMP特有の統合テンプレート。これらの統合テンプレートはできるだけ軽量に設計されています。
私たちの事前構築された統合は、様々な同意管理プラットフォーム(CMP)との統合をサポートしています。しかし、以下のような場合にはカスタム統合が推奨されます:
- 事前に構築された統合がないCMPを使用する場合。
- 同意をキャプチャするための内部ツールを使用する場合。
- 標準の統合を破壊する広範なカスタマイズを伴うサポートされているCMPを使用する場合。
このような場合には、カスタム統合を使用できます。JavaScript関数を使用することで、任意の同意キャプチャツールが強制フレームワークを活用できます。
新しいカスタム統合を追加するには、既存の統合と提供されたテンプレートをガイドとして使用してください。
以下は、カスタム統合を作成するための基本的なワークフローを説明しています:
- Tealium iQ外部(CMPが実装されているウェブサイト)で統合を開発およびデバッグします。
- Tealium iQで新しいカスタム同意統合および目的グループを追加します。詳細については、同意統合と目的グループの管理を参照してください。
- Tealium iQと適切なタグを目的グループ内の目的に割り当てます。
- テンプレートを作成するために、プロファイルを保存します。
- 新しく作成されたテンプレートを編集します。詳細については、テンプレートの管理を参照してください。
- テンプレートを開発またはテスト環境に公開して、すべてが期待通りに動作することを確認し、その後通常のテストおよび公開フローに従います。
カスタム統合の開発、デバッグ、および検証
カスタムCMP統合を作成するには、以下のカスタムテンプレートを編集してCMPの要件に合わせます。カスタムテンプレートのコメントで動作例を参照してください。
公開前の開発とデバッグ
開発中にデバッグするために以下の手順を完了します:
- カスタムテンプレートの最後にあるデバッグブロックのコメントを外します。
- サポートしたいCMPを実行しているウェブサイトのコンソールにテンプレートを貼り付けます。
- デバッグコードブロックが同意決定を出力します。
- 決定をカスタマイズしてテンプレートを再度貼り付け、新しく解釈された同意決定を確認します。
- テンプレートに満足したら、Tealium iQに貼り付けて公開する前に再度デバッグブロックをコメントアウトします。
プロファイルを保存してテンプレートを編集することで、デバッグスニペットも見つけることができます。
公開後の検証
公開後にテンプレートをデバッグおよび検証する方法は二つあります:デバッグモードを使用するか、window.tealiumCmpOutput
オブジェクトを使用するかです。
デバッグモードの使用
デバッグモードを使用するには:
- コンソールで
document.cookie = "utagdb=true"
を構成してutagdb
クッキーをtrue
に構成します。 - 関連する出力のみを表示するようにコンソールフィルタを構成します(デバッグ出力で提案されたフィルタを使用)。
- 期待通りに動作するかどうかを確認するために異なるオプションをテストします。
window.tealiumCmpOutput
オブジェクトの使用
window.tealiumCmpOutput
オブジェクトを使用するには:
- テンプレートの最後にコメントアウトされたデバッグコードブロックをコンソールに貼り付けて、あなたの決定と関連する出力のみを出力します。
- 必要に応じて、テンプレート内の関数を個別に呼び出すか、このオブジェクトの他の便利なプロパティにアクセスすることもできます。
事前構築された統合およびカスタム統合の詳細なデバッグのヒントについては、同意統合の検証とデバッグを参照してください。
統合関数
統合のCMP特有のコンポーネントは、window.tealiumCmpIntegration
オブジェクトを使用して定義されます。
window.tealiumCmpIntegration
オブジェクトは、名前.cmpName
、バージョン.cmpIntegrationVersion
、および以下の関数で構成されています:
動作モードの決定
.cmpCheckIfOptInModel
- 統合がopt-in
モデルまたはopt-out
モデルで動作するかどうかを決定します。ブール値を返します。
決定の取得
.cmpFetchCurrentConsentDecision
- 同意決定の現在の生バージョン(CMPからの生バージョン)を取得します。結果はオブジェクトでなければならず、すべての後続の関数に引数として渡されます。
決定の検証と標準化
-
.cmpCheckForWellFormedDecision
- 同意決定の生バージョンが適切に形成され、理解可能であるかどうかをチェックします。ブール値を返します。 -
.cmpCheckForTiqConsent
- 生の同意決定にTealium iQによるデータ処理の許可が含まれているかどうかを決定します。falseの場合、何も実行されません。ブール値を返します。 -
.cmpCheckForExplicitConsentDecision
- 生の同意決定がexplicit
(明示的)かimplicit
(暗黙的)かを決定します。ブール値を返します。 -
.cmpConvertResponseToGroupList
- 生の決定を下流の強制のために許可された目的キーの単純な配列に変換します。同意された目的キーの配列を返します。
同意更新の監視とトリガー
-
.cmpAddCallbackToTriggerRecheck
- CMPの同意ステータスが変更されるたびに呼び出されるコールバック関数を登録します。これにより、ポーリングに依存せずにTealium iQが最新の同意決定を迅速に更新できるようになります。cmpAddCallbackToTriggerRecheck
は、CMPがコールバックまたは代替実装方法を通じて同意ステータスの変更を通知するたびにtriggerRecheck()
を呼び出すように構成されていることを確認してください。バナーが暗黙の同意のために入れるときやCMPのロード時の類似点でtriggerRecheck()
を呼び出します。詳細については、カスタム統合テンプレートのコメントを参照してください。現在コールバックをサポートしている統合については、サポートされているベンダー統合を参照してください。
カスタム統合テンプレート
以下は、独自のカスタム統合を開始するための空白のテンプレートです。テンプレートには、同意統合をデバッグおよび検証するために使用できるデバッグスニペットがテンプレートの最後に含まれています。
最終更新日 :: 2025年March月14日