Adobe客户端数据层概述

Adobe Client Data Layer (ACDL)是一个小型的开源JavaScript库,它为您的网站提供了一种向页面上的任何脚本公开数据和事件的标准方式。 您的网站代码将数据和事件推送到名为adobeDataLayer的JavaScript数组。 无论何时加载ACDL脚本,标记规则、Web SDK和其他脚本都会读取这些数据并监听这些事件。

本指南记录了ACDL库。 要在数据收集UI中使用ACDL,请参阅Adobe Client Data Layer标记扩展。

为何使用数据层 why

如果没有数据层,标记通常会从页面中刮取值,例如DOM中的文本或URL中的参数。 这些实施在页面设计更改时中断,并且它们只能收集页面显示的内容。 数据层将两个职责分开:

  • 您的网站代码​描述了页面上发生的情况,如页面名称、访客查看的产品或他们提交的表单。
  • 您的标记和其他脚本​将决定如何处理这些信息,例如要将哪些数据发送到Adobe以及何时发送。

ACDL在此模式中添加了以下功能:

  • 异步加载。 站点代码可以在ACDL脚本加载之前推送数据。 ACDL在加载时按顺序处理所有内容,因此您可以使用async或defer加载它,而不会丢失数据。
  • 事件和侦听器。 脚本可以侦听命名事件或数据更改,包括在添加侦听器之前发生的事件。
  • 计算状态。 ACDL将每次数据推送到任何脚本都可以随时读取的单个对象中。
  • 历史记录。 该数组会保留已推送的数据和事件的记录,这有助于您调试实施。

工作原理 how-it-works

ACDL构建在一个简单的JavaScript阵列之上:

  1. 您的页面将创建window.adobeDataLayer数组(如果该数组不存在)。
  2. 您的站点代码将项目添加到具有push()的数组。 项目可以是数据对象、事件对象或函数。 在ACDL加载之前,这些项目在数组中像队列一样等待。
  3. 加载ACDL脚本时,它会向数组添加方法,如getState()和addEventListener(),并将push()替换为其自己的版本。 然后,它按推送的顺序处理每个排队的项目。
  4. 从那时起,ACDL会在推送每个新项目后立即对其进行处理。 它将数据合并到计算状态,调用匹配事件侦听器,并将数组中的数据和事件对象保留为历史记录。
// Site code: describe what happened on the page
window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({
  page: { title: "Home", language: "en" }
});
window.adobeDataLayer.push({ event: "page view" });

// Another script: react to what happened
window.adobeDataLayer.push(function(dl) {
  dl.addEventListener("page view", function(event) {
    console.log("Page title:", dl.getState("page.title"));
  });
});

由于侦听器使用默认all 作用域,因此它将为page view事件运行,即使该事件是先推送的。

ACDL在页面内存储和分发数据。 它不会将数据发送到任何位置。 要将数据发送到Adobe,请使用标记或Web SDK从数据层读取。 请参阅使用Web SDK发送Adobe客户端数据层数据。

ACDL如何与其他Adobe工具配合使用 adobe-tools

工具
与ACDL的关系
标记
ACDL标记扩展可以加载库、在推送数据或事件时触发规则、读取数据元素中的计算状态以及推送数据或清除规则操作中的历史记录。
Web SDK
Web SDK将数据发送到Edge Network。 您的代码或标记规则从ACDL读取数据并将其传递到Web SDK。 请参阅使用Web SDK发送Adobe客户端数据层数据。
Adobe Experience Manager
核心组件2.9.0及更高版本包括ACDL,并且可以将组件数据和事件自动推送到其中。 请参阅将Adobe Client Data Layer与核心组件一起使用。

数据格式 data-format

ACDL不需要特定的数据结构。 您可以推送任何纯对象,然后ACDL将其合并到计算状态。 由于许多脚本和团队依赖于相同数据,因此请考虑以下实践:

  • 在写入数据层之前就结构达成一致,并为推送或读取数据的每个人记录该结构。
  • 使用与JSON兼容的值,如字符串、数字、布尔值、纯对象和数组。 其他值(如Date对象和函数)在合并后将无法继续使用。 查看值类型。
  • 考虑您的目标。 如果将数据发送到Adobe Experience Platform,则可以将它构建为类似于您的XDM架构,以便轻松映射,也可以保留自己的结构,并通过用于数据收集的数据准备将其映射到数据流中。

浏览器要求 browser-requirements

ACDL 3.x使用浏览器的structuredClone()函数和现代JavaScript语法。 它需要以下浏览器之一或更高版本:

  • Chrome 98
  • Edge 98
  • Firefox 94
  • Safari 15.4

ACDL 2.x对浏览器的要求较低。 有关版本之间的差异,请参阅从2.x升级到3.x。

版本和源代码 source

ACDL是Apache许可证2.0下的开放源代码。

要检查页面上运行的版本,请阅读浏览器控制台中的version属性:

adobeDataLayer.version

后续步骤 next-steps

recommendation-more-help
experience-platform-help-collection