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

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

重要

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

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

module.exports = function(settings) {
  alert('Thanks for visiting our site!');
};

ここで、Adobe Experience Platform Launch のユーザーがメッセージを設定できるようにする場合を考えてみましょう。 ユーザーがメッセージを入力し、そのメッセージを設定オブジェクトに保存できるようにする場合、オブジェクトは次のようになります。

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

このページ