Web 拡張機能のアクションの種類

メモ

Adobe Experience Platform Launch は、Adobe Experience Platform のデータ収集テクノロジースイートとしてリブランドされています。 その結果、製品ドキュメント全体でいくつかの用語の変更がロールアウトされました。用語の変更点の一覧については、次のドキュメントを参照してください。

データ収集タグのコンテキストでは、アクションとは、ルールイベントが発生し、すべての条件が評価を渡した後に実行される操作です。

例えば、拡張機能で「show support chat」アクションタイプを提供すると、サポートチャットダイアログを表示して、チェックアウトに苦労しているユーザーを支援できます。

このドキュメントでは、Adobe Experience Platform の Web 拡張機能のアクションタイプを定義する方法について説明します。

重要

このドキュメントでは、Web 拡張機能のアクションの種類について説明します。エッジ拡張機能を開発する場合は、代わりに エッジ拡張機能のアクションタイプ に関するガイドを参照してください。

このドキュメントでは、読者がライブラリモジュールと、ライブラリモジュールが web 拡張機能に統合される仕組みについて理解していることを前提としています。説明が必要な場合は、このガイドに戻る前に、 ライブラリモジュールの形式 の概要を参照してください。

通常、アクションタイプは次の要素で構成されます。

  1. データ収集 UI に表示される ビュー。アクションの設定を変更できます。
  2. タグのランタイムライブラリ内で生成されるライブラリモジュール。設定を解釈し、アクションを実行します。
module.exports = function(settings) {
  alert('Thanks for visiting our site!');
};

例えば、Adobe Experience Platform ユーザーがメッセージを設定できるようにするには、ユーザーがメッセージを入力して設定オブジェクトに保存できるようにします。次のようなオブジェクト。

{
  "message": "Thank you for being one of our VIP members!"
}

ユーザー定義のメッセージを操作するには、モジュールを次のように変更する必要があります。

module.exports = function(settings) {
  alert(settings.message);
}

コンテキストイベントデータ

次に、2 番目の引数を、ルールを起動するイベントに関するコンテキスト情報を含むモジュールに渡す必要があります。これは状況によってはメリットがあり、次のように指定することで実現できます。

module.exports = function(settings, event) {
  // event contains information regarding the event that fired the rule
};

event オブジェクトには次のプロパティが含まれている必要があります。

プロパティ 説明
$type 拡張機能名とイベント名を表す文字列(ピリオドを使用して結合)。例:youtube.play
$rule 現在実行中のルールに関する情報を含むオブジェクト。 オブジェクトには、次のサブプロパティが含まれている必要があります。
  • id:現在実行中のルールの ID。
  • name:現在実行中のルールの名前。

ルールをトリガーしたイベントタイプを提供する拡張機能では、必要に応じて、その他の役に立つ情報をこの event オブジェクトに追加できます。

このページ