Eventos

Los eventos indican a otros scripts que algo ha sucedido en la página, como una vista de página, un clic o un envío de formulario. Un evento se inserta en la capa de datos del cliente de Adobe (ACDL) como un objeto con una clave event. Se llama a los scripts que registraron un detector de eventos para ese nombre de evento.

Objetos de evento event-objects

Un objeto de evento tiene las claves siguientes:

Clave
Requerido
Descripción
event
Sí
Cadena no vacía que asigna un nombre al evento. Los nombres de eventos distinguen entre mayúsculas y minúsculas: cart add y Cart add son eventos diferentes.
eventInfo
No
Cualquier información adicional sobre esta ocurrencia del evento, como una referencia al componente en el que el visitante hizo clic. ACDL pasa eventInfo a los agentes de escucha, pero no lo almacena en el estado calculado.
Cualquier otra clave
No
Datos para combinar en estado calculado, utilizando las mismas reglas que una inserción de datos.
window.adobeDataLayer = window.adobeDataLayer || [];

// An event with no data
window.adobeDataLayer.push({ event: "page loaded" });

// An event with extra information for listeners
window.adobeDataLayer.push({
  event: "click",
  eventInfo: { reference: "component.hero-1" }
});

// An event that also updates the computed state
window.adobeDataLayer.push({
  event: "cart add",
  eventInfo: { sku: "a-100" },
  cart: { itemCount: 3 }
});

Después de estos cambios, el estado calculado es { cart: { itemCount: 3 } }. Las claves event y eventInfo no forman parte del estado calculado, pero los objetos de evento permanecen en la matriz de capa de datos como historial.

Si falta la clave event, está vacía o no es una cadena, ACDL trata el objeto como una inserción de datos. No se llama a ningún agente de escucha de eventos y el estado calculado no incluye las claves event ni eventInfo.

TIP
Elija una convención de nombres para eventos, como noun verb (cart add, form submit) o object.action (cart.add, form.submit), y utilícela en todas partes. Dado que los nombres distinguen entre mayúsculas y minúsculas, los nombres incoherentes son una razón común por la que los oyentes no se ejecutan.

Eventos integrados built-in-events

Además del evento con nombre, ACDL déclencheur dos eventos integrados:

  • adobeDataLayer:change: se activa cuando una notificación push cambia el estado calculado. Inserciones de datos y eventos que llevan el déclencheur de datos.
  • adobeDataLayer:event: se activa para cada inserción de evento, independientemente de su nombre.

La siguiente tabla muestra qué eventos producen cada tipo de déclencheur push:

Push
adobeDataLayer:event
adobeDataLayer:change
Evento con nombre
Solo datos, como { page: { title: "Home" } }
No
Sí
No
Solo evento, como { event: "click" }
Sí
No
Sí
Evento y eventInfo, como { event: "click", eventInfo: {...} }
Sí
No
Sí
Evento y datos, como { event: "cart add", cart: {...} }
Sí
Sí
Sí

Cuando una notificación push déclencheur más de un evento, ACDL llama a los oyentes en el siguiente orden: adobeDataLayer:event, después adobeDataLayer:change y después el evento con nombre.

Qué reciben los oyentes listener-arguments

ACDL llama a cada agente de escucha con un argumento: una copia del objeto completo insertado, incluidos event, eventInfo y cualquier dato.

window.adobeDataLayer.push(function(dl) {
  dl.addEventListener("cart add", function(event) {
    console.log(event.eventInfo.sku);       // "a-100"
    console.log(event.cart.itemCount);      // 3
    console.log(dl.getState("cart"));       // { itemCount: 3 }
  });
});

Los siguientes detalles se aplican a cada oyente:

  • El estado calculado ya se ha actualizado. Cuando se ejecuta un oyente, el estado calculado ya incluye los datos de la notificación push que lo activó.
  • El argumento es una copia. Cambiarla no cambia la capa de datos ni el objeto que se insertó.
  • thises la capa de datos. Dentro de una función de escucha, this hace referencia a la matriz adobeDataLayer.
  • Escuchadores ejecutados sincrónicamente. ACDL llama a cada oyente antes de que push() regrese. Mantenga a los oyentes cortos y no trabaje con lentitud en ellos.

Escuchar eventos pasados y futuros scope

De forma predeterminada, se ejecuta un nuevo oyente para los eventos coincidentes que ya están en la matriz de capas de datos y para los eventos coincidentes que se insertan más adelante. Este comportamiento significa que un script puede añadir su oyente en cualquier momento sin perder los eventos que se produjeron anteriormente, como una vista de página que se insertó antes de cargar la biblioteca de etiquetas.

Puede cambiar este comportamiento con la opción scope para escuchar solo los eventos anteriores o futuros. Para saber cómo mantiene ACDL los eventos anteriores, consulte Cola e historial.

Evite los bucles interminables loops

Un oyente puede insertar en la capa de datos. Procesa los mensajes push inmediatamente antes de que vuelva el oyente. Si un agente de escucha inserta algo que déclencheur al mismo agente de escucha de nuevo, las llamadas nunca finalizarán hasta que el explorador emita un error de desbordamiento de pila, como RangeError: Maximum call stack size exceeded. Por ejemplo, un agente de escucha adobeDataLayer:change que inserta déclencheur de datos.

Push desde un listener solo cuando el nuevo push no puede almacenar en déclencheur el mismo listener.

recommendation-more-help
experience-platform-help-collection