事件
事件告知其他脚本,页面上发生了一些情况,例如页面查看、单击或表单提交。 您将事件作为具有event键的对象推送到Adobe Client Data Layer (ACDL)。 调用了为该事件名称注册事件侦听器的脚本。
事件对象 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键不是计算状态的一部分,但事件对象作为history保留在数据层数组中。
如果event键缺失、为空或不为字符串,ACDL会将该对象视为数据推送。 未调用任何事件侦听器,并且计算状态不包括event或eventInfo键。
noun verb (cart add,form submit)或object.action (cart.add,form.submit),然后随时随地使用它。 由于名称区分大小写,因此名称不一致是监听器不运行的常见原因。内置事件 built-in-events
除了命名事件之外,ACDL还会触发两个内置事件:
adobeDataLayer:change:在推送更改计算状态时触发。 携带数据的数据推送和事件推送会触发该活动。adobeDataLayer:event:每次事件推送都会触发,无论其名称是什么。
下表显示了每种推送触发的事件:
adobeDataLayer:eventadobeDataLayer:change{ page: { title: "Home" } }{ event: "click" }eventInfo,如{ event: "click", eventInfo: {...} }{ event: "cart add", cart: {...} }当一个推送触发多个事件时,ACDL按以下顺序调用侦听器: adobeDataLayer:event,然后adobeDataLayer:change,再调用指定的事件。
听众收到的内容 listener-arguments
ACDL使用一个参数调用每个侦听器:已推送的完整对象的副本,包括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侦听器触发自身。
仅当新推送无法触发同一侦听器时才从侦听器推送。