Aggiunta del tracciamento di Adobe Analytics ai componenti

Inclusione del modulo Adobe Analytics in un componente pagina

Componenti modello pagina (ad esempio head.jsp, body.jsp) è necessario che JSP includa per caricare ContextHub e l'integrazione Adobe Analytics (che fa parte dei Cloud Services). Tutti gli elementi includono il caricamento di file JavaScript.

La voce ContextHub deve essere inclusa immediatamente sotto il tag <head>, mentre i Cloud Services devono essere inclusi nella sezione <head> e prima della sezione </body>; ad esempio:

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

Lo script contexthub inserito dopo l’elemento <head> aggiunge le funzioni di ContextHub alla pagina.

Gli script cloudservices aggiunti nelle sezioni <head> e <body> si applicano alle configurazioni dei servizi cloud aggiunte alla pagina. Se la pagina utilizza più di un Cloud Services di configurazione, devi includere il jsp ContextHub e il jsp dei Cloud Services una sola volta.

Quando si aggiunge alla pagina un framework Adobe Analytics, gli script cloudservices generano JavaScript relativi ad Adobe Analytics e riferimenti a librerie lato client, in modo simile all’esempio seguente:

<div class="sitecatalyst cloudservice">
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/sitecatalyst.js?lang=it"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/util.js?lang=it"></script>
<script type="text/javascript" src="/content/geometrixx-outdoors/_jcr_content/analytics.sitecatalyst.js?lang=it"></script>
<script type="text/javascript" src="/etc/clientlibs/mac/mac-sc.js?lang=it"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/sitecatalyst/plugins.js?lang=it"></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>

Questo codice è incluso in tutti AEM siti di esempio, come i Geometrixx Outdoors.

Evento sitecatalystAfterCollect

Lo script cloudservices attiva l'evento sitecatalystAfterCollect :

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

Questo evento viene attivato per indicare che il tracciamento della pagina è stato completato. Se esegui ulteriori operazioni di tracciamento su questa pagina, è necessario ascoltare questo evento invece dell'evento di caricamento del documento o di preparazione del documento. L'utilizzo dell'evento sitecatalystAfterCollect evita conflitti o altri comportamenti imprevedibili.

NOTA

La libreria /libs/cq/analytics/clientlibs/sitecatalyst/sitecatalyst.js include il codice del file Adobe Analytics s_code.js.

Implementazione del tracciamento di Adobe Analytics per i componenti personalizzati

Abilita i tuoi componenti AEM per interagire con il framework Adobe Analytics. Quindi, configura il tuo framework in modo che Adobe Analytics tenga traccia dei dati dei componenti.

I componenti che interagiscono con il framework Adobe Analytics vengono visualizzati in SideKick quando modifichi un framework. Dopo aver trascinato il componente nel framework, vengono visualizzate le proprietà del componente ed è quindi possibile mapparle con le proprietà di Adobe Analytics. (Vedere Impostazione di un framework per il tracciamento di base.)

I componenti possono interagire con il framework Adobe Analytics quando il componente ha un nodo figlio denominato analytics. Il nodo analytics ha le seguenti proprietà:

  • cq:trackevents: Identifica gli eventi CQ che il componente espone. (Consulta Eventi personalizzati.)
  • cq:trackvars: Assegna un nome alle variabili CQ mappate con le proprietà di Adobe Analytics.
  • cq:componentName: Nome del componente visualizzato nella barra laterale.
  • cq:componentGroup: Il gruppo nella barra laterale che include il componente .

Il codice nel componente JSP aggiunge il codice javascript alla pagina che attiva il tracciamento e definisce i dati che vengono tracciati. Il nome dell'evento e i nomi dei dati utilizzati in javascript devono corrispondere ai valori corrispondenti delle proprietà del nodo analytics .

Quando utilizzi questi metodi di tracciamento dei dati, il modulo di integrazione Adobe Analytics esegue automaticamente le chiamate ad Adobe Analytics per registrare gli eventi e i dati.

Esempio: Tracciamento dei clic di navigazione principali

Estendi il componente di navigazione iniziale in modo che Adobe Analytics tenga traccia dei clic sui collegamenti di navigazione nella parte superiore della pagina. Quando si fa clic su un collegamento di navigazione, Adobe Analytics registra il collegamento selezionato e la pagina su cui è stato fatto clic.

Le procedure seguenti richiedono che siano già state eseguite le seguenti attività:

  • Creazione di un'applicazione CQ.
  • Creazione di una configurazione Adobe Analytics e di un framework Adobe Analytics.

Copia il componente di navigazione principale

Copia il componente di navigazione principale nell’applicazione CQ. La procedura richiede che l’applicazione sia configurata in CRXDE Lite.

  1. Fai clic con il pulsante destro del mouse sul nodo /libs/foundation/components/topnav e fai clic su Copia.
  2. Fare clic con il pulsante destro del mouse sulla cartella Componenti all’interno della cartella dell’applicazione e scegliere Incolla.
  3. Fai clic su Salva tutto.

Integrazione Della Navigazione Principale Con Il Framework Adobe Analytics

Configura il componente di navigazione principale e modifica il file JSP per definire gli eventi e i dati di tracciamento.

  1. Fai clic con il pulsante destro del mouse sul nodo di navigazione principale e fai clic su Crea > Crea nodo. Specificare i seguenti valori di proprietà e fare clic su OK:

    • Nome: analytics
    • Tipo: nt:unstructured
  2. Aggiungi la seguente proprietà al nodo analytics per denominare l’evento di tracciamento:

    • Nome: cq:trackevents
    • Tipo: Stringa
    • Valore: topnavClick
  3. Aggiungi la seguente proprietà al nodo analytics per denominare le variabili di dati:

    • Nome: cq:trackvars
    • Tipo: Stringa
    • Valore: topnavTarget,topnavLocation
  4. Aggiungi la seguente proprietà al nodo analytics per denominare il componente per barra laterale:

    • Nome: cq:componentName
    • Tipo: Stringa
    • Valore: topnav (tracking)
  5. Aggiungi la seguente proprietà al nodo analytics per assegnare un nome al gruppo di componenti per la barra laterale:

    • Nome: cq:componentGroup
    • Tipo: Stringa
    • Valore: Generale
  6. Fai clic su Salva tutto.

  7. Apri il file topnav.jsp .

  8. Nell’elemento a , aggiungi il seguente attributo:

    onclick = "tracknav('<%= child.getPath() %>.html')" 
    
  9. Nella parte inferiore della pagina, aggiungi il seguente codice javascript:

    <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> 
    
  10. Fai clic su Salva tutto.

Il contenuto del file topnav.jsp dovrebbe essere visualizzato come segue:

<%@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?lang=it"%><%
%><%@ 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>  
NOTA

Spesso è opportuno tenere traccia dei dati da ContextHub. Per informazioni sull'utilizzo di javascript per ottenere queste informazioni, vedere Accesso ai valori in ContextHub.

Aggiunta del componente di tracciamento alla barra laterale

Aggiungi componenti abilitati per il tracciamento con la barra laterale da Adobe Analytics per aggiungerli al framework.

  1. Apri il framework Adobe Analytics dalla configurazione Adobe Analytics. (http://localhost:4502/etc/cloudservices/sitecatalyst.html)

  2. Nella barra laterale fate clic sul pulsante Progettazione .

  3. Nell’area Configurazione tracciamento collegamenti , fai clic su Configura ereditarietà.

    chlimage_1

  4. Nell’elenco Componenti consentiti, seleziona Navigazione superiore (tracciamento) nella sezione Generale, quindi fai clic su OK.

  5. Espandi la barra laterale per accedere alla modalità di modifica. Il componente è ora disponibile nel gruppo Generale .

Aggiunta del componente di navigazione principale al framework

Trascina il componente di navigazione principale nel framework Adobe Analytics e mappa le variabili e gli eventi del componente su variabili ed eventi Adobe Analytics. (Vedere Impostazione di un framework per il tracciamento di base.)

chlimage_1-1

Il componente di navigazione principale è ora integrato con il framework Adobe Analytics. Quando aggiungi il componente a una pagina, facendo clic sugli elementi nella barra di navigazione superiore i dati di tracciamento vengono inviati ad Adobe Analytics.

Invio di dati s.products ad Adobe Analytics

I componenti possono generare dati per la variabile s.products inviata ad Adobe Analytics. Progetta i componenti per contribuire alla variabile s.products :

  • Registra un valore denominato product di una struttura specifica.
  • Esponi i membri dati del valore product in modo che possano essere mappati con le variabili Adobe Analytics nel framework Adobe Analytics.

La variabile Adobe Analytics s.products utilizza la sintassi seguente:

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

Il modulo di integrazione Adobe Analytics costruisce la variabile s.products utilizzando i valori product generati AEM componenti. Il valore product nel codice JavaScript generato dai componenti AEM è una matrice di valori con la seguente struttura:

"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"
    }
}]

Quando un elemento dati viene omesso dal valore product, viene inviato come stringa vuota in s.products.

NOTA

Quando nessun evento è associato a un valore di prodotto, Adobe Analytics utilizza l'evento prodView per impostazione predefinita.

Il nodo analytics del componente deve esporre i nomi delle variabili utilizzando la proprietà cq:trackvars :

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

Il modulo eCommerce fornisce diversi componenti che generano dati variabili s.products . Ad esempio, il componente dell’ordine di invio (http://localhost:4502/crx/de/index.jsp#/libs/commerce/components/submitorder/submitorder.jsp) genera un codice javascript simile al seguente esempio:

<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>

Limitazione delle dimensioni delle chiamate di tracciamento

In genere, i browser web limitano la dimensione delle richieste GET. Poiché i valori di prodotto CQ e SKU sono percorsi dell'archivio, gli array di prodotti che includono più valori possono superare il limite di dimensione della richiesta. Pertanto, i componenti devono limitare il numero di elementi nell'array product di ogni elemento CQ_Analytics.record function. Crea più funzioni se il numero di elementi da monitorare può superare il limite.

Ad esempio, il componente per l’ordine di invio di eCommerce limita a quattro il numero di elementi product in una chiamata . Quando il carrello contiene più di quattro prodotti, genera più funzioni CQ_Analytics.record.

In questa pagina