getState()

getState()方法返回Adobe Client Data Layer (ACDL) 计算状态的副本:合并到目前为止推送的所有数据的结果。

adobeDataLayer.getState(path?: string | string[]): any

此方法仅存在于ACDL加载之后。 如果您的代码可能在此之前运行,请从您推送的函数中调用它。 查看安全调用方法。

获取整个计算状态 entire-state

调用getState()不带参数:

window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({ page: { title: "Getting started" } });
window.adobeDataLayer.push({ component: { "hero-1": { title: "Learn more", link: "learn-more.html" } } });

window.adobeDataLayer.push(function(dl) {
  console.log(dl.getState());
});

控制台显示以下对象:

{
  "page": {
    "title": "Getting started"
  },
  "component": {
    "hero-1": {
      "title": "Learn more",
      "link": "learn-more.html"
    }
  }
}

如果未推送任何内容,getState()将返回空对象({})。

在路径处获取值 paths

传递路径以从计算状态中获取一个值。 用点分隔路径中的键:

window.adobeDataLayer.push(function(dl) {
  dl.getState("component.hero-1");        // { title: "Learn more", link: "learn-more.html" }
  dl.getState("component.hero-1.title");  // "Learn more"
});

以下规则适用于路径:

  • 数组项:将该项的索引用作键,如cart.items.0.sku。 ACDL 3.x不支持括号表示法,如cart.items[0].sku。
  • 包含点的键:将路径作为键的数组而不是字符串传递,如["component", "hero.1", "title"]。
  • 缺少值:如果路径中不存在任何键,getState()将返回undefined。 它不会引发错误。
  • 返回类型:路径上的值可以是任何类型,例如对象、数组、字符串、数字或布尔值。

返回的值为副本 copies

getState()返回计算状态的副本,而不是计算状态本身。 更改返回的对象不会更改数据层:

const state = adobeDataLayer.getState();
state.page.title = "Changed";
adobeDataLayer.getState("page.title");  // Still "Getting started"

要更改计算状态,请使用push()推送更改。

每次调用都会复制整个计算状态,即使您传递了路径也是如此。 在具有较大数据层的页面上,避免在经常运行的代码(如滚动处理程序)中调用getState()。 读取一次值并重复使用。

读取事件侦听器中的状态 in-listener

当事件侦听器运行时,计算状态已包含来自触发它的推送的数据:

window.adobeDataLayer.push(function(dl) {
  dl.addEventListener("adobeDataLayer:change", function(event) {
    console.log("New page title:", dl.getState("page.title"));
  }, { path: "page.title" });
});
recommendation-more-help
experience-platform-help-collection