安装Adobe客户端数据层

安装Adobe Client Data Layer (ACDL)包括两部分:

  1. 在推送到它的每个脚本中创建数据层数组,以便您的代码可以使用ACDL是否已加载。
  2. 使用安装方法之一,每页加载ACDL库​一次。

创建数据层阵列 initialize

在推送到数据层的任何代码之前添加以下行:

window.adobeDataLayer = window.adobeDataLayer || [];

如果数组不存在,则此行将创建该数组,如果存在,则保留该数组。 将它包含在推送到数据层的每个脚本中,而不仅仅是第一个脚本。 脚本可以按任意顺序加载,而行可确保每个脚本都推送到同一数组而不覆盖它。

在此行之后,使用push()推送数据、事件和函数:

window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({ page: { title: "Home" } });

在ACDL加载之前,push()是标准的JavaScript数组方法,数组作为队列工作。 加载ACDL时,它将按顺序处理排队的项目。 请参阅队列和历史记录。

IMPORTANT
ACDL始终使用全局名称adobeDataLayer。 库不支持其他名称。 标记扩展可以使第二个名称引用同一数据层。

选择安装方法 methods

使用以下方法之一在每个页面上加载ACDL:

方法
使用时机
标记扩展
您可以使用Adobe Experience Platform中的标记。 扩展可以为您加载ACDL。
脚本标记
您希望自行托管库文件,并将其添加到页面模板。
npm
使用捆绑包构建网站的JavaScript。
Adobe Experience Manager
您的网站使用的是AEM核心组件2.9.0或更高版本。

标记扩展 tags

加载标记库时,Adobe客户端数据层标记扩展将加载ACDL,除非页面已加载它。 您无需将库添加到页面模板。 您的网站代码仍需要创建数据层数组并推送数据。 请参阅配置Adobe客户端数据层扩展。

脚本标记 script

从网站上的npm (请参阅npm)和主机adobe-client-data-layer.min.js下载库。 然后将其加载到每个页面的<head>中,其中具有async和defer属性:

<script src="/js/adobe-client-data-layer.min.js" async defer></script>

支持async的浏览器在下载脚本后立即运行该脚本,而不会阻止页面。 由于ACDL会处理在加载之前排队的所有内容,因此即使其他脚本先将数据层推送,您的数据也是安全的。

以下示例显示了一个页面,其中内联脚本和外部脚本都在ACDL加载之前推送到数据层:

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>My page</title>
    <script src="/js/myscripts.js" defer></script>
    <script>
      window.adobeDataLayer = window.adobeDataLayer || [];
      window.adobeDataLayer.push({ page: { title: "My page" } });
    </script>
    <script src="/js/adobe-client-data-layer.min.js" async defer></script>
  </head>
  <body>
    <h1>My page</h1>
  </body>
</html>

外部脚本/js/myscripts.js也会在推送之前创建数组:

window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({ user: { loggedIn: false } });

公共npm CDN(如unpkg和jsDelivr)也提供库文件。 如果您从第三方CDN加载它,请在URL中固定一个确切版本,以便在您不知情的情况下文件不会更改。

npm npm

安装包:

npm install @adobe/adobe-client-data-layer

该包包含位于dist/adobe-client-data-layer.min.js的浏览器脚本。 将该文件复制到您的网站中,然后使用脚本标记加载该文件,或者将该文件导入捆绑的JavaScript中:

import "@adobe/adobe-client-data-layer/dist/adobe-client-data-layer.min.js";

该脚本不会导出任何内容。 当它运行时,它会设置window.adobeDataLayer。

NOTE
在ACDL 3.x中,导入上述文件路径。 3.x包未定义入口点,因此import "@adobe/adobe-client-data-layer"失败。

Adobe Experience Manager aem

AEM核心组件2.9.0及更高版本包括作为客户端库的ACDL,以及核心组件推送数据和每个组件的事件。 请参阅将Adobe Client Data Layer与核心组件一起使用。

如果您的AEM网站也使用ACDL标记扩展,请关闭该扩展的​ 加载Adobe客户端数据层库(如果不存在) ​选项,以便仅AEM加载库。 请参阅配置Adobe客户端数据层扩展。

仅加载库一次 load-once

每页加载ACDL一次。 如果加载第二个副本,它会将以下警告记录到浏览器控制台,并且不会更改数据层:

Adobe Client Data Layer v3.0.1 has already been imported/initialized on this page. You may be erroneously loading it a second time.

第一个副本将一直运行,因此您的数据和侦听器仍然有效。 删除重复项以避免额外下载。 在页面模板和标记扩展加载库时,重复项很常见。

验证安装 verify

在加载ACDL的页面上打开浏览器的开发人员控制台,并运行以下命令:

adobeDataLayer.version     // For example, "3.0.1"
adobeDataLayer.getState()  // The computed state of everything pushed so far

如果adobeDataLayer.version是undefined,则尚未在页面上加载ACDL。 请参阅疑难解答。

从2.x升级到3.x upgrade

默认情况下,Adobe Experience Manager核心组件会加载ACDL 2.x,因此许多网站仍运行2.x。 在升级到3.x之前,请查看以下更改。 有关所有版本,请参阅GitHub 🔗上的发行说明。

ACDL 3.0用内置的浏览器功能替换了其内部实用程序库。 文件小得多,但要求和某些合并行为发生了变化:

面积
2.x
3.x
浏览器要求
支持的旧版浏览器
需要structuredClone()和新式JavaScript。 请参阅浏览器要求。
文件大小(缩小)
大约33 KB
大约6 KB
将数组推送到已保存数组的键
按位置合并数组。 正在将["c"]推送到["c", "b"]中的["a", "b"]个结果。
替换数组。 正在将["c"]推送到["c"]中的["a", "b"]个结果。 请参阅数组。
将对象推送到保存字符串、数字或布尔值的键
将该值替换为对象。
不会替换值。 查看更改值的类型。
getState()路径中的括号表示法,如items[0].sku
受支持
不支持。 使用点表示法,如items.0.sku。 请参阅getState()。
npm包入口点
import "@adobe/adobe-client-data-layer"加载库。
导入文件路径。 请参阅npm。

升级后测试您的实施,特别是推送数组或更改值类型的代码。

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