イベントタイプ

ここでは、Adobe Experience Platform Web SDK タグ拡張機能で提供されるAdobe Experience Platform イベントタイプについて説明します。 これらは ​ ルールの作成 ​ に使用されるので、eventType オブジェクトの xdm フィールドと混同しないでください ​。

モニタリングフックのトリガー monitoring-hook-triggered

Adobe Experience Platform Web SDKには、様々なシステムイベントを監視するために使用できるモニタリングフックが含まれています。 これらのツールは、独自のデバッグツールを開発したり、web SDKのログを取得したりするのに役立ちます。

各モニタリングフックイベントに含まれるパラメーターについて詳しくは、Web SDKのモニタリングフックのドキュメント ​ を参照してください。

Web SDK タグ拡張機能は、次のモニタリングフックをサポートしています。

Send event complete

通常、プロパティには、イベントをAdobe Experience Platform Edge Networkに送信するために Send event アクションを使用する 1 つ以上のルールがあります。 イベントがEdge Networkに送信されるたびに、役立つデータが記載されたレスポンスがブラウザーに返されます。 Send event complete イベントタイプがないと、返されたデータへのアクセスはできなくなります。

返されたデータにアクセスするには、別のルールを作成してから、ルールに Send event complete イベントを追加します。 このルールは、Send event のアクションの結果として、サーバーから正常な応答が受信されるたびにトリガーされます。

Send event complete イベントがルールをトリガーすると、特定のタスクの実行に役立つサーバーから返されるデータが提供されます。 通常は、Custom code イベントを含む同じルールに（Core 拡張機能から） Send event complete アクションを追加します。 Custom code アクションでは、カスタムコードは event という名前の変数にアクセスできます。 この event 変数には、サーバーから返されたデータが含まれます。

Edge Networkから返されるデータを処理するルールは、次のようになります。

このルールの Custom code アクションを使用して特定のタスクを実行する方法の例を以下に示します。

パーソナライズされたコンテンツの手動レンダリング

応答データを処理するルールにあるカスタムコードアクションでは、サーバーから返されたパーソナライゼーションの提案にアクセスできます。 それには、次のカスタムコードを入力します。

var propositions = event.propositions;

event.propositions が存在する場合、パーソナライゼーションの提案オブジェクトを含む配列です。 配列に含まれる提案の大部分は、イベントがサーバーにどのように送信されたかによって決定されます。

この最初のシナリオでは、「Render decisions」チェックボックスをオンにしておらず、イベントの送信を担当する decision scopes アクション内に Send event ールを提供していないとします。

この例では、propositions 配列には、自動レンダリングの対象となるイベントに関連する提案のみが含まれています。

propositions の配列は、次の例のようになります。

[
  {
    "id": "AT:eyJhY3Rpdml0eUlkIjoiMTI3MDE5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
    "scope": "__view__",
    "items": [
      {
        "id": "11223344",
        "schema": "https://ns.adobe.com/personalization/dom-action",
        "data": {
          "content": "<h2 style=\"color: yellow\">An HTML proposition.</h2>",
          "selector": "#hero",
          "type": "setHtml"
        },
        "meta": {}
      }
    ],
    "renderAttempted": false
  },
  {
    "id": "AT:PyJhY3Rpdml0eUlkIjoiMTI3MDE5IiwiZXhwZXJpZW5jZUlkIjoiMCJ8",
    "scope": "__view__",
    "items": [
      {
        "id": "11223345",
        "schema": "https://ns.adobe.com/personalization/dom-action",
        "data": {
          "content": "<h2 style=\"color: yellow\">Another HTML proposition.</h2>",
          "selector": "#sidebar",
          "type": "setHtml"
        },
        "meta": {}
      }
    ],
    "renderAttempted": false
  }
]

イベントを送信する際、「Render decisions」チェックボックスがオフになっていたので、SDKはコンテンツの自動レンダリングを試みませんでした。 ただし、SDKは自動レンダリングの対象となるコンテンツを自動的に取得し、必要に応じて手動でレンダリングすることもできます。 各提案オブジェクトの renderAttempted プロパティが false に設定されていることに注意してください。

イベントを送信する際に代わりに「Render decisions」チェックボックスをオンにした場合、SDKは自動レンダリングの対象となる提案をレンダリングしようとしたことになります。 その結果、各提案オブジェクトの renderAttempted プロパティが true に設定されます。 この場合、これらの提案を手動でレンダリングする必要はありません。

これまで、自動レンダリングの対象となるパーソナライゼーションコンテンツ（例えば、Adobe Targetを使用して Visual Experience Composer で作成されたコンテンツ）のみを確認しました。 自動レンダリングの対象となるパーソナライゼーションコンテンツ なし を取得するには、Decision scopes アクションの Send event フィールドを使用して決定範囲を指定してコンテンツをリクエストします。 範囲は、サーバーから取得したい特定の提案を識別する文字列です。

Send event のアクションは次のようになります。

この例では、salutation または discount の範囲に一致する提案がサーバーで見つかった場合、その提案が返され、propositions 配列に含まれます。 自動レンダリングの条件を満たす提案は、propositions アクションの Render decisions フィールドまたは Decision scopes フィールドの設定方法に関係なく、引き続き Send event 配列に含まれます。 この場合、propositions の配列は次の例のようになります。

[
  {
    "id": "AT:cZJhY3Rpdml0eUlkIjoiMTI3MDE5IiwiZXhwZXJpZW5jZUlkIjoiMCJ2",
    "scope": "salutation",
    "items": [
      {
        "schema": "https://ns.adobe.com/personalization/json-content-item",
        "data": {
          "id": "4433221",
          "content": {
            "salutation": "Welcome, esteemed visitor!"
          }
        },
        "meta": {}
      }
    ],
    "renderAttempted": false
  },
  {
    "id": "AT:FZJhY3Rpdml0eUlkIjoiMTI3MDE5IiwiZXhwZXJpZW5jZUlkIjoiMCJ0",
    "scope": "discount",
    "items": [
      {
        "schema": "https://ns.adobe.com/personalization/html-content-item",
        "data": {
          "id": "4433222",
          "content": "<div>50% off your order!</div>",
          "format": "text/html"
        },
        "meta": {}
      }
    ],
    "renderAttempted": false
  },
  {
    "id": "AT:eyJhY3Rpdml0eUlkIjoiMTI3MDE5IiwiZXhwZXJpZW5jZUlkIjoiMCJ9",
    "scope": "__view__",
    "items": [
      {
        "id": "11223344",
        "schema": "https://ns.adobe.com/personalization/dom-action",
        "data": {
          "content": "<h2 style=\"color: yellow\">An HTML proposition.</h2>",
          "selector": "#hero",
          "type": "setHtml"
        },
        "meta": {}
      }
    ],
    "renderAttempted": false
  },
  {
    "id": "AT:PyJhY3Rpdml0eUlkIjoiMTI3MDE5IiwiZXhwZXJpZW5jZUlkIjoiMCJ8",
    "scope": "__view__",
    "items": [
      {
        "id": "11223345",
        "schema": "https://ns.adobe.com/personalization/dom-action",
        "data": {
          "content": "<h2 style=\"color: yellow\">Another HTML proposition.</h2>",
          "selector": "#sidebar",
          "type": "setHtml"
        },
        "meta": {}
      }
    ],
    "renderAttempted": false
  }
]

この時点で、提案コンテンツを自由にレンダリングできます。 この例では、discount 範囲に一致する提案が、Adobe Targetのフォームベースの Experience Composer を使用して作成されたHTMLの提案です。 ページ上に daily-special という ID を持つ要素があり、discount の提案のコンテンツを daily-special 要素にレンダリングするとします。 次の手順を実行します。

Custom code アクション内のカスタムコードは、次のように表示されます。

var propositions = event.propositions;

var discountProposition;
if (propositions) {
  // Find the discount proposition, if it exists.
  for (var i = 0; i < propositions.length; i++) {
    var proposition = propositions[i];
    if (proposition.scope === "discount") {
      discountProposition = proposition;
      break;
    }
  }
}

var discountHtml;
if (discountProposition) {
  // Find the item from proposition that should be rendered.
  // Rather than assuming there a single item that has HTML
  // content, find the first item whose schema indicates
  // it contains HTML content.
  for (var j = 0; j < discountProposition.items.length; j++) {
    var discountPropositionItem = discountProposition.items[i];
    if (discountPropositionItem.schema === "https://ns.adobe.com/personalization/html-content-item") {
      discountHtml = discountPropositionItem.data.content;
      break;
    }
  }
}

if (discountHtml) {
  // Discount HTML exists. Time to render it.
  var dailySpecialElement = document.getElementById("daily-special");
  dailySpecialElement.innerHTML = discountHtml;
}

Adobe Target応答トークンへのアクセス

Adobe Targetから返されるPersonalization コンテンツには、アクティビティ、オファー、エクスペリエンス、ユーザープロファイル、地域情報などに関する詳細である ​ レスポンストークン ​ が含まれます。 これらの詳細は、サードパーティのツールと共有したり、デバッグに使用したりできます。 レスポンストークンは、Adobe Target ユーザーインターフェイスで設定できます。

応答データを処理するルールにあるカスタムコードアクションでは、サーバーから返されたパーソナライゼーションの提案にアクセスできます。 それには、次のカスタムコードを入力します。

var propositions = event.propositions;

event.propositions が存在する場合、パーソナライゼーションの提案オブジェクトを含む配列です。 コンテン ​ のコンテンツについて詳しくは、 パーソナライズされたコンテンツの手動レンダリング result.propositions を参照してください。

Web SDKによって自動的にレンダリングされたすべての提案からすべてのアクティビティ名を収集し、1 つの配列にプッシュするとします。 その後、単一のアレイをサードパーティに送信できます。 この場合、Custom code のアクション内に次のようなカスタムコードを記述します。

var propositions = event.propositions;
if (propositions) {
  var activityNames = [];
  propositions.forEach(function(proposition) {
    if (proposition.renderAttempted) {
      proposition.items.forEach(function(item) {
        if (item.meta) {
          // item.meta contains the response tokens.
          var activityName = item.meta["activity.name"];
          // Ignore duplicates
          if (activityNames.indexOf(activityName) === -1) {
            activityNames.push(activityName);
          }
        }
      });
    }
  });
  // Now that activity names are in an array,
  // you can send them to a third party or use
  // them in some other way.
}

Subscribe ruleset items subscribe-ruleset-items

Subscribe ruleset items イベントタイプを使用すると、サーフェスのAdobe Journey Optimizer コンテンツカードをサブスクライブできます。 ルールセットが評価されるたびに、このコマンドに提供されるコールバックは、コンテンツカードデータを保持する提案を含む結果オブジェクトを受け取ります。

このイベントタイプは、次の設定可能なプロパティをサポートしています。