Documentación AEM 6.4 Guía de desarrollo

Añadir el seguimiento de Adobe Analytics a los componentes adding-adobe-analytics-tracking-to-components

Last update: Fri May 05 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Temas:
Developing

Creado para:

Developer

CAUTION

AEM 6.4 ha llegado al final de la compatibilidad ampliada y esta documentación ya no se actualiza. Para obtener más información, consulte nuestra períodos de asistencia técnica. Buscar las versiones compatibles here.

Inclusión del módulo Adobe Analytics en un componente de página including-the-adobe-analytics-module-in-a-page-component

Componentes de plantilla de página (p. ej. head.jsp, body.jsp) necesita JSP incluye para cargar ContextHub y la integración de Adobe Analytics (que forma parte de los Cloud Services). Todos incluyen la carga de archivos JavaScript.

La entrada de ContextHub debe incluirse inmediatamente debajo del <head> , mientras que los Cloud Services deben incluirse en la variable <head> y antes de la </body> sección; por ejemplo:

<head>
   <sling:include path="contexthub" resourceType="granite/contexthub/components/contexthub" />
...
   <cq:include script="/libs/cq/cloudserviceconfigs/components/servicelibs/servicelibs.jsp"/>
...
</head>
<body>
...
    <cq:include path="cloudservices" resourceType="cq/cloudserviceconfigs/components/servicecomponents"/>
</body>

La variable contexthub que inserta después de la <head> agrega las características de ContextHub a la página.

La variable cloudservices secuencias de comandos que agregue al <head> y <body> las secciones se aplican a las configuraciones de servicios de nube que se agregan a la página. (Si la página utiliza más de una configuración de Cloud Services, debe incluir el jsp de ContextHub y el jsp de Cloud Services solo una vez).

Cuando se agrega un marco de Adobe Analytics a la página, la variable cloudservices las secuencias de comandos generan javascript relacionado con Adobe Analytics y referencias a bibliotecas del lado del cliente, de forma similar al siguiente ejemplo:

<div class="sitecatalyst cloudservice">
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/sitecatalyst.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/util.js"></script>
<script type="text/javascript" src="/content/geometrixx-outdoors/_jcr_content/analytics.sitecatalyst.js"></script>
<script type="text/javascript" src="/etc/clientlibs/mac/mac-sc.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/plugins.js"></script>
<script type="text/javascript">
<!--
CQ_Analytics.Sitecatalyst.frameworkComponents = ['foundation/components/page'];
/**
 * Sets Adobe Analytics variables accordingly to mapped components. If <code>options</code>
 * object is provided only variables matching the options.componentPath are set.
 *
 * @param {Object} options Parameter object from CQ_Analytics.record() call. Optional.
 */
CQ_Analytics.Sitecatalyst.updateEvars = function(options) {
    this.frameworkMappings = [];
 this.frameworkMappings.push({scVar:"pageName",cqVar:"pagedata.title",resourceType:"foundation/components/page"});
    for (var i=0; i<this.frameworkMappings.length; i++){
  var m = this.frameworkMappings[i];
  if (!options || options.compatibility || (options.componentPath == m.resourceType)) {
   CQ_Analytics.Sitecatalyst.setEvar(m);
  }
    }
}

CQ_Analytics.CCM.addListener("storesinitialize", function(e) {
 var collect = true;
    var lte = s.linkTrackEvents;
    s.pageName="content:geometrixx-outdoors:en";
    CQ_Analytics.Sitecatalyst.collect(collect);
    if (collect) {
  CQ_Analytics.Sitecatalyst.updateEvars();
     /************* DO NOT ALTER ANYTHING BELOW THIS LINE ! **************/
     var s_code=s.t();if(s_code)document.write(s_code);
     s.linkTrackEvents = lte;
     if(s.linkTrackVars.indexOf('events')==-1){delete s.events};
     $CQ(document).trigger("sitecatalystAfterCollect");
    }
});
//-->
</script>
<script type="text/javascript">
<!--
if(navigator.appVersion.indexOf('MSIE')>=0)document.write(unescape('%3C')+'\!-'+'-')
//-->
</script>
<noscript><img src="https://daydocumentation.112.2o7.net/b/ss/daydocumentation/1/H.25--NS/1380120772954?cdp=3&gn=content%3Ageometrixx-outdoors%3Aen" height="1" width="1" border="0" alt=""/></noscript>
<span data-tracking="{event:'pageView', values:{}, componentPath:'foundation/components/page'}"></span>
<div id="cq-analytics-texthint" style="background:white; padding:0 10px; display:none;">
 <h3 class="cq-texthint-placeholder">Component clientcontext is missing or misplaced.</h3>
</div>
<script type="text/javascript">
$CQ(function(){
 if( CQ_Analytics &&
  CQ_Analytics.ClientContextMgr &&
  !CQ_Analytics.ClientContextMgr.isConfigLoaded )
  {
   $CQ("#cq-analytics-texthint").show();
  }
});
</script>
</div>

Se incluye este código en todos AEM sitios de muestra, como los Geometrixx Outdoors.

Evento sitecatalystAfterCollect the-sitecatalystaftercollect-event

La variable cloudservices déclencheur de secuencia de comandos sitecatalystAfterCollect evento:

$CQ(document).trigger("sitecatalystAfterCollect");

Este evento se activa para indicar que el seguimiento de página se ha completado. Si está realizando operaciones de seguimiento adicionales en esta página, debe escuchar este evento en lugar del evento de carga del documento o de preparación del documento. Al usar la variable sitecatalystAfterCollect evita conflictos u otro comportamiento impredecible.

NOTE

La variable /libs/cq/analytics/clientlibs/sitecatalyst/sitecatalyst.js La biblioteca de incluye el código de Adobe Analytics s_code.js archivo.

Implementación del seguimiento de Adobe Analytics para componentes personalizados implementing-adobe-analytics-tracking-for-custom-components

Habilite los componentes de AEM para que interactúen con el marco de trabajo de Adobe Analytics. A continuación, configure el marco para que Adobe Analytics rastree los datos del componente.

Los componentes que interactúan con el marco de Adobe Analytics aparecen en SideKick al editar un marco. Después de arrastrar el componente a la estructura, aparecen las propiedades del componente y puede asignarlas con propiedades de Adobe Analytics. (Consulte Configuración de un marco para el seguimiento básico.)

Los componentes pueden interactuar con la infraestructura de Adobe Analytics cuando el componente tiene un nodo secundario denominado analytics. La variable analytics tiene las siguientes propiedades:

cq:trackevents: Identifica los eventos de CQ que expone el componente. (Consulte Eventos personalizados.)
cq:trackvars: Nombra las variables de CQ que están asignadas con propiedades de Adobe Analytics.
cq:componentName: Nombre del componente que aparece en la barra de tareas.
cq:componentGroup: Grupo en la barra de tareas que incluye el componente.

El código del componente JSP agrega el javascript a la página que déclencheur el seguimiento y define los datos de los que se realiza el seguimiento. El nombre del evento y los nombres de datos utilizados en javascript deben coincidir con los valores correspondientes de la variable analytics propiedades del nodo.

Utilice el atributo de seguimiento de datos para rastrear los datos de evento cuando se carga una página. (Consulte Seguimiento de eventos personalizados al cargar la página.)
Utilice la función CQ_Analytics.record para rastrear los datos de evento cuando los usuarios interactúan con las funciones de la página. (Consulte Seguimiento de eventos personalizados después de la carga de la página.)

Cuando se utilizan estos métodos de seguimiento de datos, el módulo de integración de Adobe Analytics realiza automáticamente las llamadas a Adobe Analytics para registrar los eventos y datos.

Ejemplo: Rastreo de clics de navegación superior example-tracking-topnav-clicks

Amplíe el componente de navegación superior de base para que Adobe Analytics rastree los clics en los vínculos de navegación en la parte superior de la página. Cuando se hace clic en un vínculo de navegación, Adobe Analytics registra el vínculo en el que se hizo clic y la página en la que se hizo clic.

Los procedimientos siguientes requieren que ya haya realizado las tareas siguientes:

Se ha creado una aplicación de CQ.
Se ha creado una configuración de Adobe Analytics y un marco de Adobe Analytics.

Copiar el componente de navegación superior copy-the-topnav-component

Copie el componente de navegación superior en su aplicación CQ. El procedimiento requiere que la aplicación esté configurada en CRXDE Lite.

Haga clic con el botón derecho en el /libs/foundation/components/topnav y haga clic en Copiar.
Haga clic con el botón derecho en la carpeta Componentes debajo de la carpeta de la aplicación y haga clic en Pegar.
Haga clic en Guardar todo.

Integración de la navegación superior con el marco de Adobe Analytics integrating-topnav-with-the-adobe-analytics-framework

Configure el componente de navegación superior y edite el archivo JSP para definir los eventos de seguimiento y los datos.

Haga clic con el botón derecho en el nodo de navegación superior y haga clic en Crear > Crear nodo. Especifique los siguientes valores de propiedad y haga clic en Aceptar:
- Nombre: analytics
- Tipo: nt:unstructured
Agregue la siguiente propiedad al nodo analytics para asignar un nombre al evento de seguimiento:
- Nombre: cq:trackevents
- Tipo: cadena
- Valor: topnavClick
Agregue la siguiente propiedad al nodo analytics para asignar un nombre a las variables de datos:
- Nombre: cq:trackvars
- Tipo: cadena
- Valor: topnavTarget,topnavLocation
Agregue la siguiente propiedad al nodo de análisis para asignar un nombre al componente de la barra de tareas:
- Nombre: cq:componentName
- Tipo: cadena
- Valor: topnav (seguimiento)
Agregue la siguiente propiedad al nodo de análisis para asignar un nombre al grupo de componentes de la barra de tareas:
- Nombre: cq:componentGroup
- Tipo: cadena
- Valor: General
Haga clic en Guardar todo.
Abra el archivo topnav.jsp .

En un elemento , agregue el atributo siguiente:

code language-xml
`onclick = "tracknav('<%= child.getPath() %>.html')"`

En la parte inferior de la página, añada el siguiente código javascript:

code language-xml

code language-xml
`<script type="text/javascript"> function tracknav(target) { if (CQ_Analytics.Sitecatalyst) { CQ_Analytics.record({ event: 'topnavClick', values: { topnavTarget: target, topnavLocation:'<%=currentPage.getPath() %>.html' }, componentPath: '<%=resource.getResourceType()%>' }); } } </script>`

<script type="text/javascript">
    function tracknav(target) {
            if (CQ_Analytics.Sitecatalyst) {
                CQ_Analytics.record({
                    event: 'topnavClick',
                    values: {
                        topnavTarget: target,
                        topnavLocation:'<%=currentPage.getPath() %>.html'
                    },
                    componentPath: '<%=resource.getResourceType()%>'
                });
            }
    }
</script>

Haga clic en Guardar todo.

El contenido del archivo topnav.jsp debe aparecer de la siguiente manera:

<%@page session="false"%><%--
  Copyright 1997-2008 Day Management AG
  Barfuesserplatz 6, 4001 Basel, Switzerland
  All Rights Reserved.

  This software is the confidential and proprietary information of
  Day Management AG, ("Confidential Information"). You shall not
  disclose such Confidential Information and shall use it only in
  accordance with the terms of the license agreement you entered into
  with Day.

  ==============================================================================

  Top Navigation component

  Draws the top navigation

--%><%@include file="/libs/foundation/global.jsp"%><%
%><%@ page import="java.util.Iterator,
        com.day.text.Text,
        com.day.cq.wcm.api.PageFilter,
        com.day.cq.wcm.api.Page,
        com.day.cq.commons.Doctype,
        org.apache.commons.lang3.StringEscapeUtils" %><%

    // get starting point of navigation
    long absParent = currentStyle.get("absParent", 2L);
    String navstart = Text.getAbsoluteParent(currentPage.getPath(), (int) absParent);

    //if not deep enough take current node
    if (navstart.equals("")) navstart=currentPage.getPath();

    Resource rootRes = slingRequest.getResourceResolver().getResource(navstart);
    Page rootPage = rootRes == null ? null : rootRes.adaptTo(Page.class);
    String xs = Doctype.isXHTML(request) ? "/" : "";
    if (rootPage != null) {
        Iterator<Page> children = rootPage.listChildren(new PageFilter(request));
        while (children.hasNext()) {
            Page child = children.next();
            %><a onclick = "tracknav('<%= child.getPath() %>.html')"  href="<%= child.getPath() %>.html"><%
            %><img alt="<%= StringEscapeUtils.escapeXml(child.getTitle()) %>" src="<%= child.getPath() %>.navimage.png"<%= xs %>></a><%
        }
    }
%><script type="text/javascript">
    function tracknav(target) {
            if (CQ_Analytics.Sitecatalyst) {
                CQ_Analytics.record({
                    event: 'topnavClick',
                    values: {
                        topnavTarget:target,
                        topnavLocation:'<%=currentPage.getPath() %>.html'
                    },
                    componentPath: '<%=resource.getResourceType()%>'
                });
            }
    }
</script>

NOTE

A menudo, es deseable realizar el seguimiento de los datos de ContextHub. Para obtener información sobre el uso de javascript para obtener esta información, consulte Acceso a los valores en ContextHub.

Adición del componente de seguimiento a la barra de tareas adding-the-tracking-component-to-sidekick

Agregue a la barra de tareas componentes que estén habilitados para el seguimiento con Adobe Analytics para poder agregarlos a la estructura.

Abra el marco de Adobe Analytics desde la configuración de Adobe Analytics. (http://localhost:4502/etc/cloudservices/sitecatalyst.html)
En la barra de tareas, haga clic en el botón Diseño .
En el área Configuración del seguimiento de vínculos , haga clic en Configurar herencia.
En la lista Componentes permitidos , seleccione navegación superior (seguimiento) en la sección General y, a continuación, haga clic en Aceptar.
Expanda la barra de tareas para entrar en el modo de edición. El componente ya está disponible en el grupo General .

Adición del componente de navegación superior a su marco adding-the-topnav-component-to-your-framework

Arrastre el componente de navegación superior a su marco de Adobe Analytics y asigne las variables y los eventos del componente a las variables y los eventos de Adobe Analytics. (Consulte Configuración de un marco para el seguimiento básico.)

Chlimage_1-1

El componente de navegación superior ahora está integrado con el marco de Adobe Analytics. Cuando agrega el componente a una página, hacer clic en los elementos de la barra de navegación superior hace que los datos de seguimiento se envíen a Adobe Analytics.

Envío de datos de s.products a Adobe Analytics sending-s-products-data-to-adobe-analytics

Los componentes pueden generar datos para la variable s.products que se envía a Adobe Analytics. Diseñe sus componentes para contribuir a la variable s.products :

Registrar un valor llamado product de una estructura específica.
Exponer los miembros de datos de la variable product para que se puedan asignar con variables de Adobe Analytics en la infraestructura de Adobe Analytics.

La variable s.products de Adobe Analytics utiliza la siguiente sintaxis:

s.products="category;product;quantity;price;eventY={value}|eventZ={value};evarA={value}|evarB={value}"

El módulo de integración de Adobe Analytics crea el s.products usando la variable product valores que generan los componentes de AEM. La variable product en el javascript que generan AEM componentes es una matriz de valores que tienen la siguiente estructura:

"product": [{
    "category": "",
    "sku"     : "path to product node",
    "quantity": quantity,
    "price"   : price,
    "events   : {
      "eventName1": "eventValue1",
      "eventName_n": "eventValue_n"
    }
    "evars"   : {
      "eVarName1": "eVarValue1",
      "eVarName_n": "eVarValue_n"
    }
}]

Cuando se omite un elemento de datos del product , se envía como una cadena vacía en s.products.

NOTE

Cuando no hay ningún evento asociado con un valor de producto, Adobe Analytics usa la variable prodView de forma predeterminada.

La variable analytics El nodo del componente debe exponer los nombres de las variables mediante la variable cq:trackvars propiedad:

product.category
product.sku
product.quantity
product.price
product.events.eventName1
product.events.eventName_n
product.evars.eVarName1
product.evars.eVarName_n

El módulo eCommerce proporciona varios componentes que generan datos de variables s.products . Por ejemplo, el componente del subcontrolador (http://localhost:4502/crx/de/index.jsp#/libs/commerce/components/submitorder/submitorder.jsp) genera un javascript similar al siguiente ejemplo:

<script type="text/javascript">
    function trackCartPurchase() {
        if (CQ_Analytics.Sitecatalyst) {
            CQ_Analytics.record({
                "event": ["productsCartPurchase"],
                "values": {
                    "product": [
                        {
                            "category": "",
                            "sku"     : "/path/to/prod/1",
                            "quantity": 3,
                            "price"   : 179.7,
                            "evars"   : {
                                "childSku": "/path/to/prod/1/green/xs",
                                "size"    : "XS"
                            }
                        },
                        {
                            "category": "",
                            "sku"     : "/path/to/prod/2",
                            "quantity": 10,
                            "price"   : 150,
                            "evars"   : {
                                "childSku": "/path/to/prod/2",
                                "size"    : ""
                            }
                        },
                        {
                            "category": "",
                            "sku"     : "/path/to/prod/3",
                            "quantity": 2,
                            "price"   : 102,
                            "evars"   : {
                                "childSku": "/path/to/prod/3/m",
                                "size"    : "M"
                            }
                        }
                    ]
                },
                "componentPath": "commerce/components/submitorder"
            });
            CQ_Analytics.record({
                "event": ["discountRedemption"],
                "values": {
                    "discount": "/path/to/discount/1 - /path/to/discount/2",
                    "product" : [{
                        "category": "",
                        "sku"     : "Promotional Discount",
                        "events"  : {"discountRedemption": 20.00}
                    }]
                },
                "componentPath": "commerce/components/submitorder"
            });
            CQ_Analytics.record({
                "event": ["cartPurchase"],
                "values": {
                    "orderId"       : "00e40e2d-13a2-4a00-a8ee-01a9ebb0bf68",
                    "shippingMethod": "overnight",
                    "paymentMethod" : "Amex",
                    "billingState"  : "NY",
                    "billingZip"    : "10458",
                    "product"       : [{"category": "", "sku": "", "quantity": "", "price": ""}]
                },
                "componentPath": "commerce/components/submitorder"
            });
        }
        return true;
    }
</script>

Limitación del tamaño de las llamadas de seguimiento limiting-the-size-of-tracking-calls

Por lo general, los exploradores web limitan el tamaño de las solicitudes de GET. Debido a que los valores de SKU y producto de CQ son rutas de repositorio, las matrices de productos que incluyen varios valores pueden superar el límite de tamaño de solicitud. Por lo tanto, los componentes deben limitar el número de elementos en la variable product matriz de cada CQ_Analytics.record function. Cree varias funciones si el número de elementos que necesita rastrear puede superar el límite.

Por ejemplo, el componente del emisor de comercio electrónico limita el número de product elementos de una llamada a cuatro. Cuando el carro de compras contiene más de cuatro productos, genera varios CQ_Analytics.record funciones.

recommendation-more-help

2315f3f5-cb4a-4530-9999-30c8319c520e