Información general sobre la capa de datos del cliente Adobe
La capa de datos del cliente de Adobe (ACDL) es una pequeña biblioteca de JavaScript de código abierto que ofrece a su sitio web una forma estándar de exponer datos y eventos a cualquier script de la página. El código del sitio inserta datos y eventos en una matriz de JavaScript denominada adobeDataLayer. Las reglas de etiquetas, Web SDK y otros scripts leen esos datos y escuchan esos eventos, independientemente del momento en el que se cargue el script ACDL.
Esta guía documenta la biblioteca ACDL. Para usar ACDL en la IU de recopilación de datos, consulte la extensión de etiqueta de capa de datos del cliente de Adobe.
Razones para utilizar una capa de datos why
Sin una capa de datos, las etiquetas suelen crear secuencias de comandos de los valores de la página, como el texto del DOM o los parámetros de la URL. Estas implementaciones se rompen cuando cambia el diseño de la página y solo pueden recopilar lo que muestra la página. Una capa de datos separa dos responsabilidades:
- El código del sitio describe lo que sucede en la página, como el nombre de la página, el producto que vio un visitante o el formulario que envió.
- Sus etiquetas y otros scripts deciden qué hacer con esa información, como qué datos enviar a Adobe y cuándo hacerlo.
ACDL añade las siguientes capacidades a este patrón:
- Carga asincrónica. El código del sitio puede insertar datos antes de que se cargue el script ACDL. ACDL procesa todo en orden cuando se carga, por lo que puede cargarlo con
asyncodefersin perder datos. - Eventos y oyentes. Los scripts pueden detectar eventos con nombre o cambios en los datos, incluidos los eventos que se produjeron antes de que se agregara el detector.
- Estado calculado. ACDL combina cada inserción de datos en un único objeto que cualquier secuencia de comandos puede leer en cualquier momento.
- Historial. La matriz mantiene un registro de los datos y los eventos insertados, lo que le ayuda a depurar la implementación.
Funcionamiento how-it-works
ACDL se basa en una matriz de JavaScript normal:
- La página crea la matriz
window.adobeDataLayersi aún no existe. - El código del sitio agrega elementos a la matriz con
push(). Un elemento puede ser un objeto de datos, un objeto de evento o una función. Antes de cargar ACDL, estos elementos esperan en la matriz como una cola. - Cuando se carga el script ACDL, agrega métodos a la matriz, como
getState()yaddEventListener(), y reemplazapush()por su propia versión. A continuación, procesa todos los elementos en cola en el orden en que se insertaron. - A partir de ese momento, ACDL procesa cada elemento nuevo tan pronto como se inserta. Combina datos en el estado calculado, llama a detectores de eventos que coinciden y mantiene los datos y los objetos de evento en la matriz como historial.
// Site code: describe what happened on the page
window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({
page: { title: "Home", language: "en" }
});
window.adobeDataLayer.push({ event: "page view" });
// Another script: react to what happened
window.adobeDataLayer.push(function(dl) {
dl.addEventListener("page view", function(event) {
console.log("Page title:", dl.getState("page.title"));
});
});
Como el agente de escucha usa el all ámbito predeterminado, se ejecuta para el evento page view aunque ese evento se insertó primero.
ACDL almacena y distribuye datos dentro de la página. No envía datos a ninguna parte. Para enviar datos a Adobe, utilice las etiquetas o Web SDK para leer desde la capa de datos. Ver Enviar datos de capa de datos del cliente de Adobe con Web SDK.
Cómo funciona ACDL con otras herramientas de Adobe adobe-tools
Formato de datos data-format
ACDL no requiere una estructura de datos específica. Puede insertar cualquier objeto sin formato y ACDL lo combina en el estado calculado. Dado que muchos scripts y equipos dependen de los mismos datos, tenga en cuenta las siguientes prácticas:
- Acepte una estructura antes de escribir en la capa de datos y documéntela para todos los que inserten datos o los lean.
- Use valores compatibles con JSON, como cadenas, números, valores booleanos, objetos simples y matrices. Otros valores, como
Dateobjetos y funciones, no sobreviven a la combinación. Consulte Tipos de valor. - Considera tu destino. Si envía los datos a Adobe Experience Platform, puede estructurarlos para que se asemejen a su esquema XDM, de modo que sea fácil de asignar, o bien mantener su propia estructura y asignarla al conjunto de datos con Preparación de datos para la recopilación de datos.
Requisitos del explorador browser-requirements
ACDL 3.x utiliza la función structuredClone() del explorador y la sintaxis moderna de JavaScript. Requiere uno de los siguientes exploradores o versiones posteriores:
- Chrome 98
- Edge 98
- Firefox 94
- Safari 15.4
ACDL 2.x requiere menos exploradores. Consulte Actualizar de 2.x a 3.x para ver las diferencias entre versiones.
Versiones y código fuente source
ACDL es de código abierto bajo la Licencia Apache 2.0.
- Código Source y problemas:
adobe/adobe-client-data-layeren GitHub - Paquete:
@adobe/adobe-client-data-layeren npm - Notas de la versión: Versiones de GitHub
Para comprobar qué versión se está ejecutando en una página, lea la propiedad version en la consola del explorador:
adobeDataLayer.version