イベント
イベントは、ページビュー、クリック、フォーム送信など、ページ上で何かが起こったことを他のスクリプトに伝えます。 Adobe Client Data Layer (ACDL)に、event キーを持つオブジェクトとしてイベントをプッシュします。 そのイベント名に イベントリスナーを登録したスクリプトが呼び出されます。
イベントオブジェクト event-objects
イベントオブジェクトには、次のキーがあります。
eventcart addとCart addは異なるイベントです。eventInfoeventInfoをリスナーに渡しますが、計算状態に保存しません。window.adobeDataLayer = window.adobeDataLayer || [];
// An event with no data
window.adobeDataLayer.push({ event: "page loaded" });
// An event with extra information for listeners
window.adobeDataLayer.push({
event: "click",
eventInfo: { reference: "component.hero-1" }
});
// An event that also updates the computed state
window.adobeDataLayer.push({
event: "cart add",
eventInfo: { sku: "a-100" },
cart: { itemCount: 3 }
});
これらのプッシュの後、計算状態は{ cart: { itemCount: 3 } }です。 eventとeventInfo キーは計算状態の一部ではありませんが、イベントオブジェクトは履歴としてデータレイヤー配列に残ります。
event キーが見つからないか、空であるか、文字列でない場合、ACDLはオブジェクトをデータプッシュとして扱います。 イベントリスナーは呼び出されず、計算状態にはeventまたはeventInfo キーが含まれていません。
noun verb (cart add、form submit)またはobject.action (cart.add、form.submit)などのイベントの命名規則を選択し、どこでも使用してください。 名前では大文字と小文字が区別されるため、一貫性のない名前は、リスナーが実行されない一般的な理由です。組み込みイベント built-in-events
名前付きイベントに加えて、ACDLは2つのビルトインイベントをトリガーします。
adobeDataLayer:change: プッシュが計算状態を変更したときにトリガーされます。 データをトリガーするデータプッシュとイベントプッシュ。adobeDataLayer:event: イベントのプッシュごとにトリガーされます(名前は問いません)。
次の表に、各プッシュトリガーの種類を示します。
adobeDataLayer:eventadobeDataLayer:change{ page: { title: "Home" } }など){ event: "click" })eventInfo ({ event: "click", eventInfo: {...} }など){ event: "cart add", cart: {...} }など)1つのプッシュトリガーが複数のイベントを呼び出すと、ACDLはリスナーを次の順序で呼び出します:adobeDataLayer:event、次にadobeDataLayer:change、次に名前付きイベント。
リスナーが受け取る内容 listener-arguments
ACDLは、各リスナーを1つの引数(event、eventInfo、および任意のデータを含む、プッシュされた完全なオブジェクトのコピー)で呼び出します。
window.adobeDataLayer.push(function(dl) {
dl.addEventListener("cart add", function(event) {
console.log(event.eventInfo.sku); // "a-100"
console.log(event.cart.itemCount); // 3
console.log(dl.getState("cart")); // { itemCount: 3 }
});
});
次の詳細は、すべてのリスナーに適用されます。
- 計算状態は既に更新されています。 リスナーが実行されると、計算状態には、それをトリガーしたプッシュからのデータが既に含まれています。
- 引数はコピーです。 変更しても、データレイヤーやプッシュされたオブジェクトは変更されません。
thisはデータ レイヤーです。 リスナー関数の内部では、thisはadobeDataLayer配列を参照します。- リスナーは同期して実行されます。 ACDLは、
push()が返す前に各リスナーを呼び出します。 リスナーは短く、時間のかかる作業は避けましょう。
過去や未来の出来事を聴く scope
デフォルトでは、新しいリスナーは、既にデータレイヤー配列にある一致するイベントと、後でプッシュされる一致するイベントに対して実行されます。 この動作により、スクリプトは、タグライブラリが読み込まれる前にプッシュされたページビューなど、以前に発生したイベントを見逃すことなく、いつでもリスナーを追加できます。
この動作をscope オプションで変更して、過去のイベントのみをリッスンするか、将来のイベントのみをリッスンできます。 ACDLが過去のイベントを保持する方法については、 キューと履歴を参照してください。
無限ループの回避 loops
リスナーはデータレイヤーにプッシュできます。 リスナーが返す直前にプッシュするACDL プロセス。 リスナーが同じリスナーを再びトリガーするものをプッシュした場合、ブラウザーがRangeError: Maximum call stack size exceededなどのスタックオーバーフローエラーをスローするまで、呼び出しは終了しません。 例えば、データトリガー自体をプッシュするadobeDataLayer:change リスナーです。
新しいプッシュが同じリスナーをトリガーできない場合にのみ、リスナーからプッシュします。