getState()

El método getState() devuelve una copia del estado calculado de la capa de datos del cliente de Adobe (ACDL): el resultado de combinar todos los datos insertados hasta el momento.

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

Este método solo existe después de que se cargue ACDL. Si el código puede ejecutarse antes de, llámelo desde una función que inserte. Ver métodos de llamada seguros.

Obtener todo el estado calculado entire-state

Llamar a getState() sin 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());
});

La consola muestra el siguiente objeto:

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

Si no se ha insertado nada, getState() devuelve un objeto vacío ({}).

Obtener un valor en una ruta paths

Pase una ruta para obtener un valor del estado calculado. Separe las teclas de la ruta con puntos:

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

Las siguientes reglas se aplican a las rutas:

  • Elementos de matriz: use el índice del elemento como clave, como cart.items.0.sku. ACDL 3.x no admite la notación de corchetes, como cart.items[0].sku.
  • Claves que contienen puntos: Pase la ruta como una matriz de claves en lugar de una cadena, como ["component", "hero.1", "title"].
  • Valores que faltan: Si alguna clave de la ruta no existe, getState() devuelve undefined. No arroja un error.
  • Tipo de valor devuelto: el valor de la ruta de acceso puede ser de cualquier tipo, como un objeto, una matriz, una cadena, un número o un valor booleano.

Los valores devueltos son copias copies

getState() devuelve una copia del estado calculado, no el propio estado calculado. Cambiar el objeto devuelto no cambia la capa de datos:

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

Para cambiar el estado calculado, inserte el cambio con push().

Cada llamada copia todo el estado calculado, incluso cuando se pasa una ruta. En páginas con una capa de datos grande, evite llamar a getState() en código que se ejecute con frecuencia, como un controlador de desplazamiento. Lea una vez el valor y vuelva a utilizarlo.

Leer el estado en un detector de eventos in-listener

Cuando se ejecuta un detector de eventos, el estado calculado ya incluye los datos de la notificación push que lo activó:

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