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