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

パスを渡して、計算状態から1つの値を取得します。 パス内のキーをドットで区切ります。

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