エッジ拡張機能のデータ要素のタイプ

データ要素型ライブラリモジュールには、データの取得という 1 つの目標があります。このデータをどのように取得するかはユーザー次第です。例えば、データ要素型を使用して、Adobe Experience Platform Launch ユーザーがローカルストレージ、cookie、または DOM 要素からデータを取得できるようにすることができます。

重要

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

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

ユーザーが productName という名前のローカルストレージ項目からデータを取得できるようにするとします。モジュールは次のようになります。

module.exports = function(settings) {
  return localStorage.getItem('productName');
}

Platform Launch ユーザーがローカルストレージ項目名を設定できるようにする場合は、ユーザーが名前を入力し、その名前を settings オブジェクトに保存できるようにします。オブジェクトは次のようになります。

{
  itemName: "campaignId"
}

ユーザー定義のローカルストレージ項目名を操作するには、モジュールを次のように変更する必要があります。

module.exports = function(settings) {
  return localStorage.getItem(settings.itemName);
}

デフォルト値のサポート

ユーザーは、データ要素のデフォルト値を設定できることに注意してください。データ要素ライブラリモジュールが undefined または null の値を返す場合、ユーザーがデータ要素に設定したデフォルト値へと自動的に置き換えられます。

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

トリガーされたルールの結果としてデータ要素が取得される場合(例えば、ルールの条件やアクションでデータ要素が使用される場合)、ルールを発動したイベントに関するコンテキスト情報を含む 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 オブジェクトに追加できます。

このページ