デリゲート記述子 ID

Adobe Experience Platform でタグを使用する場合、サイトにデプロイできるすべての機能が拡張機能によって提供されます。各拡張機能で提供される機能は、拡張機能の開発者が定義します。拡張機能がデプロイされると、様々な機能にバンドルされて、 拡張機能パッケージ の形式で表示されます。開発者が拡張機能パッケージに追加する機能は、そのパッケージの「委任者」と見なされます。

拡張機能パッケージ内の各デリゲートには、一意のデリゲート記述子 ID が割り当てられます。特定のリソースのデリゲート記述子 ID は、リソースの種類と、そのリソースが属する拡張パッケージをシステムに通知します。

構文

デリゲート記述子 ID は、拡張パッケージ名、デリゲートタイプ、デリゲート名を表す 3 つの文字列を、ダブルコロン(::)で結合することで構成されます。これらの文字列は人間が判読できるよう構成され、拡張機能パッケージの取得時に自動的に生成され、割り当てられます。

例えば、example-packageという名前の拡張パッケージにcustom-code という名前のアクションがある場合、そのアクションにはデリゲート記述子 ID example-package::actions::custom-code が含まれます。

適用可能なリソースでのデリゲート記述子 ID の使用

デリゲート記述子 ID は、API でルールコンポーネント(イベント、条件、アクション)とデータ要素を定義する際に理解することが重要です。以下の節では、各リソースでこれらの ID がどのように利用されるかについて説明します。

ルールコンポーネント

ルールコンポーネント は、拡張機能パッケージに属するイベント、条件、またはアクションに関連付ける必要があります。ルールコンポーネントの「タイプ」を表します。これは、ルール全体のロジック(イベント、条件またはアクション)に関連しています。したがって、ルールコンポーネントを作成する際に、ルールコンポーネントに関連付ける必要があるイベント、条件またはアクションを示すために、デリゲート記述子 ID を指定する必要があります。

例えば、拡張パッケージ example-package 内の click イベントに基づくイベントルールコンポーネントを作成する場合、ルールコンポーネントでは delegate_descriptor_idexample-package::events::click を使用します。

詳しくは、 ルールコンポーネントの作成 の節を参照してください。

データ要素

各拡張機能パッケージは、デリゲートデータ要素の互換性のある型と意図された動作を定義するので、 データ要素 は、最初に作成されたときに拡張機能パッケージに関連付ける必要があります。

例えば、拡張パッケージ example-package で定義された cookie タイプを使用するデータ要素を作成する場合、データ要素では次 delegate_descriptor_idexample-package::dataElements::cookie を使用します。

詳しくは、 データ要素の作成 の節を参照してください。

拡張機能

拡張機能 は、最初に作成されたときに自動的に拡張機能パッケージに関連付けられ、拡張機能の relationships オブジェクト内に表されます。拡張機能にカスタム設定が必要な場合は、デリゲート記述子 ID も必要です。

メモ

カスタム設定を必要としない拡張では、デリゲート記述子 ID は必要ありません。

例えば、拡張パッケージ example-package に属する拡張機能にデリゲート記述子 ID を追加するには、拡張機能で delegate_descriptor_idexample-package::extensionConfiguration::config を使用します。

詳しくは、 拡張機能の作成 に関するガイドを参照してください。

このページ