push()

El método push() agrega elementos a la capa de datos del cliente de Adobe (ACDL). Es el único método al que se puede llamar antes de que se cargue la biblioteca, por lo que es la forma principal en que el código del sitio interactúa con la capa de datos.

adobeDataLayer.push(...items: (object | Function)[]): number | undefined

Antes de cargar ACDL, push() es el método estándar Array.prototype.push() y los elementos esperan en la matriz hasta que se cargue la biblioteca. Después de cargar ACDL, su versión de push() procesa cada elemento inmediatamente. Ver Cola e historial.

Cree siempre la matriz antes de insertar:

window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({ page: { title: "Home" } });

Tipos de elementos item-types

Puede insertar tres tipos de elementos:

Elemento
Qué hace ACDL
Objeto de datos
Combina el objeto en el estado calculado y déclencheur adobeDataLayer:change.
Objeto de evento
Déclencheur el evento con nombre y adobeDataLayer:event. Combina cualquier dato del objeto en el estado calculado.
Función
Llama a la función y pasa la capa de datos a ella.

Objeto de datos data

Objeto sin formato sin clave event. ACDL lo combina en estado calculado:

window.adobeDataLayer.push({
  page: { title: "Products", language: "en" },
  user: { loggedIn: true }
});

Para eliminar una clave, inserte null como su valor. Ver Eliminar datos.

Objeto de evento event

Objeto sin formato con una clave event que contiene una cadena que no está vacía. El objeto también puede incluir una clave eventInfo y datos para combinarlos en el estado calculado:

window.adobeDataLayer.push({
  event: "cart add",
  eventInfo: { sku: "a-100" },
  cart: { itemCount: 3 }
});

ACDL combina los datos cart de este ejemplo en el estado calculado y, a continuación, llama a los oyentes del evento. Ver Eventos.

Función function

Una función a la que ACDL llama cuando la biblioteca está lista. Utilícelo para llamar a otros métodos ACDL de forma segura, incluso si la biblioteca aún no se ha cargado:

window.adobeDataLayer.push(function(dl) {
  dl.addEventListener("cart add", function(event) {
    console.log("Added to cart:", event.eventInfo.sku);
  });
});

ACDL llama a la función con la capa de datos como argumento y como this. No mantiene la función en la matriz. Si la función genera un error, el error se propaga al código que llamó a push(). Antes de que se cargue la biblioteca, un error también impide que ACDL procese el resto de la cola. Ver Ejecutar código cuando ACDL esté listo.

Valor devuelto return

Después de cargar ACDL, push() devuelve la nueva longitud de la matriz cuando agrega un elemento al historial. Devuelve undefined cuando no agrega un elemento, como cuando solo inserta una función o un elemento no válido.

Insertar un elemento por llamada one-item

Puede pasar varios elementos a una llamada de push() y ACDL los procesará en orden. Sin embargo, cuando una llamada combina distintos tipos de elementos, el historial puede llegar a ser incoherente. Por ejemplo, si el primer elemento es una función, ACDL procesa los objetos de datos que le siguen, pero no los agrega al historial. Insertar cada elemento en una llamada independiente.

Elementos no válidos invalid

ACDL solo acepta objetos y funciones simples. Si inserta cualquier otro valor, como una cadena, un número, un booleano o una matriz, ACDL no lo procesa y registra el siguiente error en la consola del explorador:

The following item cannot be handled by the data layer because it does not have a valid format: "example"

Insertar null o undefined genera un TypeError.

NOTE
Los objetos con claves on y handler, o con una clave off, no son datos. ACDL los ignora y no los agrega al historial. Para agregar o quitar agentes de escucha, use addEventListener() y removeEventListener().
recommendation-more-help
experience-platform-help-collection