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

メモ

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

アクションタイプライブラリモジュールは、事前に定義されたアクションを実行することを目的としています。 このアクションで何をおこなうかは、ユーザーが決定します。ビーコンの送信、オファーの表示、訪問者に対する感謝、Cookie の保存、サポートチャットの開始などをおこなえます。

重要

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

このドキュメントは、ライブラリモジュールと、それらがタグ拡張に統合される仕組みについても精通していることを前提としています。 説明が必要な場合は、このガイドに戻る前に、ライブラリモジュールの形式の概要を参照してください。

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 オブジェクトに追加できます。

このページ