Personalización del marco de trabajo de Adobe Analytics customizing-the-adobe-analytics-framework
El marco de Adobe Analytics determina la información que se rastrea con Adobe Analytics. Para personalizar el marco predeterminado, utilice javascript para agregar seguimiento personalizado, integrar complementos de Adobe Analytics y cambiar la configuración general dentro del marco utilizado para el seguimiento.
Acerca del javascript generado para módulos about-the-generated-javascript-for-frameworks
Cuando una página está asociada a un marco de Adobe Analytics, y la página incluye referencias al módulo Analytics, se genera automáticamente un archivo analytics.sitecatalyst.js para la página.
El javascript de la página crea un s_gi
(que define la biblioteca s_code.js de Adobe Analytics) y asigna valores a sus propiedades. El nombre de la instancia del objeto es s
. Los ejemplos de código que se presentan en esta sección hacen varias referencias a esta s
variable.
El siguiente código de ejemplo es similar al código de un archivo 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;
*/
Al utilizar código personalizado de javascript para personalizar el marco, se modifica el contenido de este archivo.
Configuración de las propiedades de Adobe Analytics configuring-adobe-analytics-properties
Hay varias variables predefinidas dentro de Adobe Analytics que se pueden configurar en un marco . El charset, cookieLifetime, currencyCode y trackInlineStats se incluyen en la variable Configuración general de análisis de forma predeterminada.
Puede agregar nombres y valores de variables a la lista. Estas variables predefinidas y cualquier variable que agregue se utilizan para configurar las propiedades de la variable s
en el archivo analytics.sitecatalyst.js. El siguiente ejemplo muestra cómo se ha añadido la variable prop10
propiedad de value CONSTANT
se representa en el código 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";
Utilice el siguiente procedimiento para añadir variables a la lista:
-
En la página del marco de Adobe Analytics, expanda la Configuración general de análisis .
-
Debajo de la lista de variables, haga clic en Agregar elemento para agregar una variable nueva a la lista.
-
En la celda de la izquierda, introduzca un nombre para la variable, por ejemplo
prop10
. -
En la columna derecha, introduzca un valor para la variable, por ejemplo
CONSTANT
. -
Para eliminar una variable, haga clic en el botón (-) situado junto a la variable .
Adición de javascript personalizado a un Adobe Analytics Framework adding-custom-javascript-to-an-adobe-analytics-framework
El cuadro de javascript libre de la variable Configuración general de análisis area permite agregar código personalizado a un marco de Adobe Analytics.
El código que agregue se añadirá al archivo analytics.sitecatalyst.js . Por lo tanto, puede acceder al s
, que es una instancia de la variable s_gi
objeto de javascript definido en s_code.js
. Por ejemplo, agregar el siguiente código equivale a agregar una variable denominada prop10
de valor CONSTANT
, que es el ejemplo de la sección anterior:
s.prop10= 'CONSTANT';
El código de la variable analytics.sitecatalyst.js (que incluye el contenido de Adobe Analytics) s-code.js
) contiene el siguiente código:
if (s.usePlugins) s.doPlugins(s)
El siguiente procedimiento muestra cómo utilizar el cuadro de javascript para personalizar el seguimiento de Adobe Analytics. Si su javascript necesita utilizar complementos de Adobe Analytics, integrarlos en AEM.
-
Agregue el siguiente código javascript al cuadro para que
s.doPlugins
se ejecuta:code language-none s.usePlugins=true; function s_doPlugins(s) { //add your custom code here } s.doPlugins=s_doPlugins;
note caution CAUTION Este código es necesario si desea enviar variables en una llamada de Adobe Analytics que se hayan personalizado de alguna manera que no se puedan realizar a través de la interfaz básica de arrastrar y soltar o a través de javascript en línea en la vista de Adobe Analytics. Si las variables personalizadas están fuera de la función s_doPlugins , se enviarán como *undefined *en la llamada de Adobe Analytics -
Agregue el código de javascript en la s_doPlugins función.
En el siguiente ejemplo se concatenan los datos capturados en una página en orden jerárquico, utilizando un separador común de "|".
Un marco de Adobe Analytics tiene las siguientes configuraciones:
-
La variable
prop2
La variable de Adobe Analytics está asignada a la variablepagedata.sitesection
propiedad site . -
La variable
prop3
La variable de Adobe Analytics está asignada a la variablepagedata.subsection
propiedad site . -
El siguiente código se agrega al cuadro javascript libre:
code language-none s.usePlugins=true; function s_doPlugins(s) { s.prop1 = s.prop2+'|'+s.prop3; } s.doPlugins=s_doPlugins;
-
Cuando se visita la página web que utiliza la estructura (o, en modo de edición, se vuelve a cargar o previsualiza la página), se realizan las llamadas a Adobe Analytics.
Por ejemplo, en Adobe Analytics se generan los siguientes valores:
Adición de código personalizado global para todos los marcos de Adobe Analytics adding-global-custom-code-for-all-adobe-analytics-frameworks
Proporcione código javascript personalizado que esté integrado en todos los marcos de Adobe Analytics. Cuando el marco de Adobe Analytics de una página no contiene ninguna variable personalizada javascript de forma libre, el javascript que genera el script /libs/cq/analytics/components/sitecatalyst/config.js.jsp se anexa al analytics.sitecatalyst.js archivo. De forma predeterminada, la secuencia de comandos no tiene ningún efecto porque está comentada. El código también establece s.usePlugins
a false
:
/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
//add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/
El código del archivo analytics.sitecatalyst.js (que incluye el contenido del archivo s_code.js de Adobe Analytics) contiene el siguiente código:
if (s.usePlugins) s.doPlugins(s)
Por lo tanto, su javascript debe establecer s.usePlugins
a true
para que cualquier código de la variable s_doPlugins
se ejecuta. Para personalizar el código, superponga el archivo config.js.jsp con uno que utilice su propio javascript. Si su javascript necesita utilizar complementos de Adobe Analytics, integrarlos en AEM.
-
En el CRXDE Lite, cree la estructura de carpetas /apps/cq/analytics/components:
- Haga clic con el botón derecho en la carpeta /apps y haga clic en Crear > Crear carpeta.
- Especifique
cq
como nombre de la carpeta y haga clic en Aceptar. - Del mismo modo, cree la variable
analytics
ycomponents
carpetas.
-
Haga clic con el botón derecho en el
components
carpeta que acaba de crear y haga clic en Crear > Crear componente. Especifique los siguientes valores de propiedad:- Etiqueta:
sitecatalyst
- Título:
sitecatalyst
- Super Type:
/libs/cq/analytics/components/sitecatalyst
- Grupo:
hidden
- Etiqueta:
-
Haga clic en Siguiente varias veces hasta que el botón Aceptar esté habilitado y, a continuación, haga clic en Aceptar.
El componente sitecatalyst contiene el archivo sitecatalyst.jsp creado automáticamente.
-
Haga clic con el botón derecho en el archivo sitecatalyst.jsp y, a continuación, haga clic en Eliminar.
-
Haga clic con el botón derecho en el componente de sitecatalyst y, a continuación, haga clic en Crear > Crear archivo. Especifique el nombre
config.js.jsp
y, a continuación, haga clic en Aceptar.El archivo config.js.jsp se abre automáticamente para su edición.
-
Agregue el siguiente texto al archivo y haga clic en Guardar todo:
code language-java <%@page session="true"%> /* Plugin Config */ s.usePlugins=true; function s_doPlugins(s) { //add your custom plugin code here } s.doPlugins=s_doPlugins;
El código javascript que genera el script /apps/cq/analytics/components/sitecatalyst/config.js.jsp ahora se inserta en el archivo analytics.sitecatalyst.js para todas las páginas que utilizan un marco de Adobe Analytics.
-
Agregue el código de javascript que desea ejecutar en la
s_doPlugins
y, a continuación, haga clic en Guardar todo.
Uso de complementos de Adobe Analytics en AEM using-adobe-analytics-plugins-in-aem
Obtenga el código de javascript para los complementos de Adobe Analytics e inclúyalos en la infraestructura de Adobe Analytics en AEM. Añadir el código a una carpeta de biblioteca de cliente de la categoría sitecatalyst.plugins
para que estén disponibles para su código personalizado de javascript.
Por ejemplo, si integra la variable getQueryParams
complemento, puede llamar al complemento desde el complemento s_doPlugins
de su javascript personalizado. El siguiente código de ejemplo envía la cadena de consulta en "pid" de la dirección URL del referente como eVar1, cuando se activa una llamada de 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 instala los siguientes complementos de Adobe Analytics, de modo que estén disponibles de forma predeterminada:
- getQueryParam()
- getPreviousValue()
- split()
La carpeta de biblioteca de cliente /libs/cq/analytics/clientlibs/sitecatalyst/plugins incluye estos complementos en la categoría sitecatalyst.plugins .
/libs/cq/analytics/clientlibs/sitecatalyst/plugins
carpeta. Esta práctica garantiza que su contribución al sitecatalyst.plugins
no se sobrescriben durante AEM reinstalaciones o tareas de actualización.Utilice el siguiente procedimiento para crear la carpeta de la biblioteca del cliente para sus complementos. Solo debe realizar este procedimiento una vez. Para agregar un complemento a la carpeta de la biblioteca del cliente, utilice el procedimiento siguiente.
-
En un explorador web, abra CRXDE Lite. (http://localhost:4502/crx/de)
-
Haga clic con el botón derecho en la carpeta /apps/my-app/clientlibs y haga clic en Crear > Crear nodo. Introduzca los siguientes valores de propiedad y haga clic en Aceptar:
-
Nombre: Un nombre para la carpeta de la biblioteca del cliente, como my-plugins
-
Tipo: cq:ClientLibraryFolder
-
-
Seleccione la carpeta de la biblioteca de cliente que acaba de crear y utilice la barra de propiedades inferior derecha para añadir la siguiente propiedad:
- Nombre: categories
- Tipo: cadena
- Valor: sitecatalyst.plugins
- Varios: seleccionado
Haga clic en Aceptar en la ventana Editar para confirmar el valor de la propiedad.
-
Haga clic con el botón derecho en la carpeta de biblioteca de cliente que acaba de crear y haga clic en Crear > Crear archivo. Para el nombre de archivo, escriba js.txt y, a continuación, haga clic en Aceptar.
-
Haga clic en Guardar todo.
Utilice el siguiente procedimiento para obtener el código del complemento, almacenar el código en el repositorio de AEM y agregar el código a la carpeta de la biblioteca del cliente.
-
Iniciar sesión en sc.omniture.com usando su cuenta de Adobe Analytics.
-
En la página de aterrizaje, vaya a Ayuda > Página inicial de Ayuda.
-
En la tabla de contenido de la izquierda, haga clic en Complementos de implementación.
-
Haga clic en el vínculo al complemento que desee agregar y, cuando se abra la página, busque el código fuente de javascript para el complemento y, a continuación, seleccione el código y cópielo.
-
Haga clic con el botón derecho en la carpeta de la biblioteca del cliente y, a continuación, haga clic en Crear > Crear archivo. Para el nombre del archivo, escriba el nombre del complemento que está integrando seguido de .js y, a continuación, haga clic en Aceptar. Por ejemplo, si está integrando el complemento getQueryParam , asigne un nombre al archivo getQueryParam.js.
Cuando crea el archivo, se abre para su edición.
-
Pegue el código javascript del complemento en el archivo, haga clic en Guardar todo y cierre el archivo.
-
Abra el archivo js.txt desde la carpeta de la biblioteca del cliente.
-
En una nueva línea, añada el nombre del archivo que contiene el complemento, por ejemplo getQueryParam.js. A continuación, haga clic en Guardar todo y cierre el archivo.