Personnalisation du framework Adobe Analytics customizing-the-adobe-analytics-framework

Le framework Adobe Analytics détermine les informations suivies avec Adobe Analytics. Afin de personnaliser le framework par défaut, utilisez JavasSript pour ajouter un suivi personnalisé, intégrer les modules externes Adobe Analytics et modifier les paramètres généraux dans le framework utilisé pour le suivi.

À propos du code JavasSript généré pour les frameworks about-the-generated-javascript-for-frameworks

Lorsqu’une page est associée à un cadre Adobe Analytics et qu’elle contient des références au module Analytics, un fichier analytics.sitecatalyst.js est automatiquement généré pour la page.

Le code JavaScript dans la page crée un objet s_gi (que la bibliothèque Adobe Analytics s_code.js définit) et affecte des valeurs à ses propriétés. Le nom de l’instance d’objet est s. Les exemples de code présentés dans cette section font référence à cette variable s à plusieurs reprises.

L’exemple de code suivant est similaire au code d’un fichier 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;
*/

Lorsque vous utilisez du code JavaScript personnalisé pour personnaliser le framework, vous modifiez le contenu de ce fichier.

Configuration des propriétés Adobe Analytics configuring-adobe-analytics-properties

Un certain nombre de variables prédéfinies dans Adobe Analytics sont configurables sur un framework. Les variables charset, cookieLifetime, currencyCode et trackInlineStats font, par défaut, partie de la liste des Paramètres généraux d’Analytics.

Vous pouvez ajouter des valeurs et des noms de variables à la liste. Ces variables prédéfinies et les variables que vous ajoutez sont utilisées pour configurer les propriétés de l’objet s dans le fichier analytics.sitecatalyst.js. L’exemple suivant montre la façon dont la propriété prop10 ajoutée de la valeur CONSTANT est représentée dans le code 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";

Utilisez la procédure suivante pour ajouter des variables à la liste :

Ajout de code JavaScript personnalisé à un framework Adobe Analytics adding-custom-javascript-to-an-adobe-analytics-framework

La zone Javascript au format libre de la zone Paramètres généraux d’Analytics vous permet d’ajouter du code personnalisé à un framework Adobe Analytics.

Le code que vous ajoutez est ajouté au fichier analytics.sitecatalyst.js. Par conséquent, vous pouvez accéder à la variable s qui est une instance de l’objet Javascript s_gi défini dans s_code.js. Par exemple, l’ajout du code suivant équivaut à ajouter une variable nommée prop10 de valeur CONSTANT, qui est l’exemple de la section précédente :

s.prop10= 'CONSTANT';

Le code du fichier analytics.sitecatalyst.js (qui inclut le contenu du fichier Adobe Analytics s-code.js) contient le code suivant :

if (s.usePlugins) s.doPlugins(s)

La procédure suivante montre comment utiliser la zone JavaScript pour personnaliser le suivi Adobe Analytics. Si votre code Javascript doit utiliser les modules externes d’Adobe Analytics, intégrez-les à AEM.

L’exemple suivant concatène les données capturées sur une page dans l’ordre hiérarchique, en utilisant un séparateur commun « | ».

Un framework Adobe Analytics possède les configurations suivantes :

Par exemple, les valeurs suivantes sont générées dans Adobe Analytics :

Ajout de code personnalisé global pour tous les frameworks Adobe Analytics adding-global-custom-code-for-all-adobe-analytics-frameworks

Entrez du code JavaScript personnalisé intégré à tous les frameworks Adobe Analytics. Lorsque le framework Adobe Analytics d’une page ne contient pas de code JavaScript au format libre personnalisé, le code JavaScript généré par le script /libs/cq/analytics/components/sitecatalyst/config.js.jsp est ajouté au fichier analytics.sitecatalyst.js. Par défaut, le script n’a aucun effet car il est commenté. Le code définit également s.usePlugins sur false :

/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
    //add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/

Le code du fichier analytics.sitecatalyst.js (qui inclut le contenu du Adobe Analytics s_code.js) contient le code suivant :

if (s.usePlugins) s.doPlugins(s)

Par conséquent, votre code JavaScript doit définir s.usePlugins sur true pour que le code de la fonction s_doPlugins soit exécuté. Pour personnaliser le code, superposez le fichier config.js.jsp avec celui qui utilise votre propre code JavaScript. Si votre code JavaScript doit utiliser les modules externes d’Adobe Analytics, intégrez-les à AEM.

Utilisation des modules externes Adobe Analytics dans AEM using-adobe-analytics-plugins-in-aem

Obtenez le code JavaScript pour les modules externes d’Adobe Analytics et intégrez-les à votre framework Adobe Analytics dans AEM. Ajoutez le code dans un dossier de bibliothèque cliente de la catégorie sitecatalyst.plugins afin qu’il soit disponible pour votre code JavaScript personnalisé.

Par exemple, si vous intégrez le module externe getQueryParams, vous pouvez appeler le module externe depuis la fonction s_doPlugins de votre code JavaScript personnalisé. L’exemple de code suivant envoie la chaîne de requête dans le « pid » de l’URL du référent sous la forme eVar1, lorsqu’un appel Adobe Analytics est déclenché.

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 installe les modules externes Adobe Analytics suivants qui sont donc disponibles par défaut :

Le dossier de bibliothèque cliente /libs/cq/analytics/clientlibs/sitecatalyst/plugins contient ces modules externes dans la catégorie sitecatalyst.plugins.

Suivez la procédure ci-après pour créer le dossier de bibliothèque cliente de vos modules externes. Vous n’avez à réaliser cette opération qu’une seule fois. Pour ajouter un module externe au dossier de bibliothèque cliente, procédez comme suit.

Procédez comme suit pour obtenir le code du module externe, stocker le code dans le référentiel AEM et l’ajouter dans votre dossier de bibliothèque cliente.