getState()

O método getState() retorna uma cópia do estado computado da ACDL (Camada de Dados de Clientes Adobe): o resultado da mesclagem de todos os dados enviados até agora.

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

Esse método existe somente após carregamentos de ACDL. Se o código puder ser executado antes disso, chame-o de uma função que você envia. Consulte Chamar métodos com segurança.

Obter todo o estado calculado entire-state

Chamada getState() sem argumentos:

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());
});

O console mostra o seguinte objeto:

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

Se nada tiver sido enviado por push, getState() retornará um objeto vazio ({}).

Obter um valor em um caminho paths

Transmita um caminho para obter um valor do estado calculado. Separe as chaves no caminho com pontos:

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"
});

As seguintes regras se aplicam aos caminhos:

  • Itens da matriz: use o índice do item como uma chave, como cart.items.0.sku. ACDL 3.x não suporta notação de colchetes, como cart.items[0].sku.
  • Chaves que contêm pontos: transmitem o caminho como uma matriz de chaves em vez de uma cadeia de caracteres, como ["component", "hero.1", "title"].
  • Valores ausentes: se alguma chave no caminho não existir, getState() retornará undefined. Isso não gera um erro.
  • Tipo de retorno: o valor no caminho pode ser de qualquer tipo, como um objeto, uma matriz, uma cadeia de caracteres, um número ou um booleano.

Os valores retornados são cópias copies

getState() retorna uma cópia do estado computado, não o próprio estado computado. A alteração do objeto retornado não altera a camada de dados:

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

Para alterar o estado calculado, envie a alteração com push().

Cada chamada copia todo o estado calculado, mesmo quando você passa um caminho. Em páginas com uma grande camada de dados, evite chamar getState() em código executado com frequência, como um manipulador de rolagem. Leia o valor uma vez e reutilize-o.

Ler o estado em um ouvinte de eventos in-listener

Quando um ouvinte de eventos é executado, o estado calculado já inclui os dados do push que o acionou:

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