Personalizzazione del framework Adobe Analytics
- Si applica a:
- Experience Manager 6.5
Creato per:
- Sviluppatore
Il framework Adobe Analytics determina le informazioni tracciate con Adobe Analytics. Per personalizzare il framework predefinito, puoi utilizzare JavaScript per aggiungere il tracciamento personalizzato, integrare i plug-in di Adobe Analytics e modificare le impostazioni generali nel framework utilizzato per il tracciamento.
Informazioni sul JavaScript generato per i framework
Quando una pagina è associata a un framework Adobe Analytics e la pagina include riferimenti al modulo Analytics, per la pagina viene generato automaticamente un file analytics.sitecatalyst.js.
Il JavaScript nella pagina crea un oggetto s_gi
definito dalla libreria Adobe Analytics s_code.js e assegna valori alle relative proprietà. Il nome dell'istanza dell'oggetto è s
. Gli esempi di codice presentati in questa sezione fanno diversi riferimenti a questa variabile s
.
Il codice di esempio seguente è simile al codice di un file analytics.sitecatalyst.js:
var s_account = "my_sitecatalyst_account";
var s = s_gi(s_account);
s.fpCookieDomainPeriods = "3";
s.currencyCode= 'USD';
s.trackInlineStats= true;
s.linkTrackVars= 'None';
s.charSet= 'UTF-8';
s.linkLeaveQueryString= false;
s.linkExternalFilters= '';
s.linkTrackEvents= 'None';
s.trackExternalLinks= true;
s.linkDownloadFileTypes= 'exe,zip,wav,mp3,mov,mpg,avi,wmv,doc,pdf,xls';
s.linkInternalFilters= 'javascript:,'+window.location.hostname;
s.trackDownloadLinks= true;
s.visitorNamespace = "mynamespace";
s.trackingServer = "xxxxxxx.net";
s.trackingServerSecure = "xxxxxxx.net";
/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
//add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/
Quando si utilizza un codice JavaScript personalizzato per personalizzare il framework, si modifica il contenuto di questo file.
Configurazione delle proprietà di Adobe Analytics
In Adobe Analytics sono disponibili diverse variabili predefinite configurabili in un framework. Per impostazione predefinita, le variabili charset, cookieLifetime, currencyCode e trackInlineStats sono incluse nell'elenco Impostazioni generali di Analytics.
Puoi aggiungere nomi e valori di variabili all’elenco. Queste variabili predefinite ed eventuali variabili aggiunte vengono utilizzate per configurare le proprietà dell'oggetto s
nel file analytics.sitecatalyst.js. Nell'esempio seguente viene illustrato come la proprietà prop10
aggiunta del valore CONSTANT
è rappresentata nel codice JavaScript:
var s_account = "my_sitecatalyst_account";
var s = s_gi(s_account);
s.fpCookieDomainPeriods = "3";
s.currencyCode= 'USD';
s.trackInlineStats= true;
s.linkTrackVars= 'None';
s.charSet= 'UTF-8';
s.linkLeaveQueryString= false;
s.linkExternalFilters= '';
s.linkTrackEvents= 'None';
s.trackExternalLinks= true;
s.linkDownloadFileTypes= 'exe,zip,wav,mp3,mov,mpg,avi,wmv,doc,pdf,xls';
s.prop10= 'CONSTANT';
s.linkInternalFilters= 'javascript:,'+window.location.hostname;
s.trackDownloadLinks= true;
s.visitorNamespace = "mynamespace";
s.trackingServer = "xxxxxxx.net";
s.trackingServerSecure = "xxxxxxx.net";
Per aggiungere variabili all’elenco, utilizza la procedura seguente:
-
Nella pagina del framework di Adobe Analytics, espandi l'area Impostazioni generali di Analytics.
-
Sotto l’elenco delle variabili, fai clic su Aggiungi elemento per aggiungere una nuova variabile all’elenco.
-
Nella cella di sinistra immettere un nome per la variabile, ad esempio
prop10
. -
Nella colonna di destra immettere un valore per la variabile, ad esempio
CONSTANT
. -
Per rimuovere una variabile, fai clic sul pulsante (-) accanto alla variabile.
Aggiunta di JavaScript personalizzati a un framework Adobe Analytics
La casella free-from JavaScript nell'area General Analytics Settings (Impostazioni generali di Analytics) consente di aggiungere codice personalizzato a un framework Adobe Analytics.
Il codice aggiunto viene aggiunto al file analytics.sitecatalyst.js. È quindi possibile accedere alla variabile s
, che è un'istanza dell'oggetto JavaScript s_gi
definito in s_code.js
. Ad esempio, l'aggiunta del codice seguente equivale all'aggiunta di una variabile denominata prop10
del valore CONSTANT
, che è l'esempio della sezione precedente:
s.prop10= 'CONSTANT';
Il codice nel file analytics.sitecatalyst.js (che include il contenuto del file Adobe Analytics s-code.js
) contiene il seguente codice:
if (s.usePlugins) s.doPlugins(s)
La procedura seguente illustra come utilizzare la casella JavaScript per personalizzare il tracciamento di Adobe Analytics. Se il tuo JavaScript deve utilizzare i plug-in di Adobe Analytics, integrali nell'AEM.
-
Aggiungere il codice JavaScript seguente alla casella in modo che
s.doPlugins
venga eseguito:s.usePlugins=true; function s_doPlugins(s) { //add your custom code here } s.doPlugins=s_doPlugins;
CAUTION
Questo codice è necessario se desideri inviare variabili in una chiamata Adobe Analytics che sono state personalizzate in un modo che non può essere fatto tramite l’interfaccia di trascinamento di base O tramite JavaScript in linea nella vista Adobe Analytics.Se le variabili personalizzate sono esterne alla funzione s_doPlugins, verranno inviate come *non definito *nella chiamata di Adobe Analytics -
Aggiungi il codice JavaScript nella funzione s_doPlugins.
L’esempio seguente concatena i dati acquisiti su una pagina in ordine gerarchico, utilizzando un separatore comune di "|".
Un framework Adobe Analytics presenta le seguenti configurazioni:
-
La variabile Adobe Analytics
prop2
è mappata alla proprietà del sitopagedata.sitesection
. -
La variabile Adobe Analytics
prop3
è mappata alla proprietà del sitopagedata.subsection
. -
Il codice seguente viene aggiunto alla casella di controllo JavaScript non associato:
s.usePlugins=true; function s_doPlugins(s) { s.prop1 = s.prop2+'|'+s.prop3; } s.doPlugins=s_doPlugins;
-
Quando viene visitata la pagina web che utilizza il framework (o, in modalità di modifica, quando la pagina viene ricaricata o visualizzata in anteprima), vengono eseguite le chiamate ad Adobe Analytics.
Ad esempio, in Adobe Analytics vengono generati i seguenti valori:
Aggiunta di codice personalizzato globale per tutti i framework di Adobe Analytics
Fornisci un codice JavaScript personalizzato integrato in tutti i framework di Adobe Analytics. Quando il framework Adobe Analytics di una pagina non contiene JavaScript in formato libero personalizzato, il JavaScript generato dallo script /libs/cq/analytics/components/sitecatalyst/config.js.jsp viene aggiunto al file analytics.sitecatalyst.js. Per impostazione predefinita, lo script non ha alcun effetto perché è stato escluso. Il codice imposta anche s.usePlugins
su false
:
/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
//add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/
Il codice nel file analytics.sitecatalyst.js (che include il contenuto del file Adobe Analytics s_code.js) contiene il seguente codice:
if (s.usePlugins) s.doPlugins(s)
Pertanto, il tuo JavaScript deve impostare s.usePlugins
su true
in modo che venga eseguito qualsiasi codice nella funzione s_doPlugins
. Per personalizzare il codice, sovrapponi il file config.js.jsp con uno che utilizza il tuo JavaScript. Se il tuo JavaScript deve utilizzare i plug-in di Adobe Analytics, integrali nell'AEM.
-
In CRXDE Lite, crea la struttura di cartelle /apps/cq/analytics/components:
- Fai clic con il pulsante destro del mouse sulla cartella /apps e scegli Crea > Crea cartella.
- Specificare
cq
come nome della cartella e fare clic su OK. - Creare le cartelle
analytics
ecomponents
.
-
Fare clic con il pulsante destro del mouse sulla cartella
components
creata e scegliere Crea > Crea componente. Specifica i seguenti valori delle proprietà:- Etichetta:
sitecatalyst
- Titolo:
sitecatalyst
- Super Type:
/libs/cq/analytics/components/sitecatalyst
- Gruppo:
hidden
- Etichetta:
-
Fare clic ripetutamente su Avanti finché il pulsante OK non viene attivato, quindi scegliere OK.
Il componente sitecatalyst contiene il file sitecatalyst.jsp creato automaticamente.
-
Fai clic con il pulsante destro del mouse sul file sitecatalyst.jsp e fai clic su Elimina.
-
Fai clic con il pulsante destro del mouse sul componente SiteCatalyst e scegli Crea > Crea file. Specificare il nome
config.js.jsp
e quindi fare clic su OK.Il file config.js.jsp viene aperto automaticamente per la modifica.
-
Aggiungere il testo seguente al file, quindi fare clic su Salva tutto:
<%@page session="true"%> /* Plugin Config */ s.usePlugins=true; function s_doPlugins(s) { //add your custom plugin code here } s.doPlugins=s_doPlugins;
Il codice JavaScript generato dallo script /apps/cq/analytics/components/sitecatalyst/config.js.jsp viene ora inserito nel file analytics.sitecatalyst.js per tutte le pagine che utilizzano un framework Adobe Analytics.
-
Aggiungere il codice JavaScript che si desidera eseguire nella funzione
s_doPlugins
e quindi fare clic su Salva tutto.
Utilizzo dei plug-in di Adobe Analytics nell’AEM
Ottieni il codice JavaScript per i plug-in di Adobe Analytics e integrali nel framework Adobe Analytics in AEM. Aggiungere il codice a una cartella della libreria client della categoria sitecatalyst.plugins
in modo che sia disponibile per il codice JavaScript personalizzato.
Se ad esempio si integra il plug-in getQueryParams
, è possibile chiamare il plug-in dalla funzione s_doPlugins
del JavaScript personalizzato. Il codice di esempio seguente invia la stringa di query in "pid" dall'URL del referente come eVar1 quando viene attivata una chiamata Adobe Analytics.
s.usePlugins=true;
function s_doPlugins(s) {
// take the query string from the referrer
s.eVar1=s.getQueryParam('pid','',document.referrer);
}
s.doPlugins=s_doPlugins;
AEM installa i seguenti plug-in di Adobe Analytics, in modo che siano disponibili per impostazione predefinita:
- getQueryParam()
- getPreviousValue()
- split()
La cartella della libreria client /libs/cq/analytics/clientlibs/sitecatalyst/plugins include questi plug-in nella categoria sitecatalyst.plugins.
/libs/cq/analytics/clientlibs/sitecatalyst/plugins
. Questa procedura garantisce che il contributo alla categoria sitecatalyst.plugins
non venga sovrascritto durante le reinstallazioni o le attività di aggiornamento AEM.Utilizza la procedura seguente per creare la cartella della libreria client per i plug-in. È necessario eseguire questa procedura una sola volta. Per aggiungere un plug-in alla cartella della libreria client, attenersi alla procedura seguente.
-
In un browser web, apri CRXDE Lite. (http://localhost:4502/crx/de)
-
Fai clic con il pulsante destro del mouse sulla cartella /apps/my-app/clientlibs e scegli Crea > Crea nodo. Immettere i valori delle proprietà seguenti e quindi fare clic su OK:
-
Nome: un nome per la cartella della libreria client, ad esempio my-plugins
-
Tipo: cq:ClientLibraryFolder
-
-
Seleziona la cartella della libreria client creata e utilizza la barra delle proprietà in basso a destra per aggiungere la seguente proprietà:
- Nome: categorie
- Tipo: String
- Valore: sitecatalyst.plugins
- Multiplo: selezionato
Fare clic su OK nella finestra Modifica per confermare il valore della proprietà.
-
Fare clic con il pulsante destro del mouse sulla cartella della libreria client creata e scegliere Crea > Crea file. Per il nome file, digitare js.txt e quindi fare clic su OK.
-
Fai clic su Salva tutto.
Utilizza la procedura seguente per ottenere il codice del plug-in, archiviarlo nell’archivio AEM e aggiungerlo alla cartella della libreria client.
-
Accedi a sc.omniture.com con il tuo account Adobe Analytics.
-
Nella pagina di destinazione, vai a Aiuto > Home dell’Aiuto.
-
Nel sommario a sinistra, fai clic su Plug-in di implementazione.
-
Fai clic sul collegamento al plug-in che desideri aggiungere e, all’apertura della pagina, individua il codice sorgente JavaScript per il plug-in, quindi selezionalo e copialo.
-
Fai clic con il pulsante destro del mouse sulla cartella della libreria client e fai clic su Crea > Crea file. Per il nome del file, digitare il nome del plug-in da integrare seguito da .js e quindi fare clic su OK. Ad esempio, se integri il plug-in getQueryParam, assegna al file il nome getQueryParam.js.
Quando create il file, questo viene aperto per la modifica.
-
Incolla il codice JavaScript del plug-in nel file, fai clic su Salva tutto, quindi chiudi il file.
-
Apri il file js.txt dalla cartella della libreria client.
-
In una nuova riga, aggiungi il nome del file che contiene il plug-in, ad esempio getQueryParam.js. Quindi, fate clic su Salva tutto (Save All) e chiudete il file.