Show Menu
SUJETS×

Personnalisation d’Adobe Analytics Framework

La structure d’Adobe Analytics détermine les informations suivies avec Adobe Analytics. Pour personnaliser la structure par défaut, vous utilisez javascript pour ajouter un suivi personnalisé, intégrer des modules externes Adobe Analytics et modifier les paramètres généraux de la structure utilisée pour le suivi.

À propos du javascript généré pour des frameworks

When a page is associated with a Adobe Analytics framework, and the page includes references to the Analytics module , a analytics.sitecatalyst.js file is automatically generated for the page.
The javascript in the page creates an s_gi object (that the s_code.js Adobe Analytics library defines) and assigns values to its properties. Le nom de l’instance d’objet est s . The code examples that are presented in this section makes several references to this s variable.
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 un code javascript personnalisé pour personnaliser le framework, vous modifiez le contenu de ce fichier.

Configuration des propriétés Adobe Analytics

Adobe Analytics comporte un certain nombre de variables prédéfinies configurables sur une structure. The charset , cookieLifetime , currencyCode and trackInlineStats variables are included in the General Analytics Settings list by default.
Vous pouvez ajouter des noms de variables et des valeurs à la liste. These predefined variables and any variables that you add are used to configure the properties of the s object in the analytics.sitecatalyst.js file. L’exemple suivant montre comment 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 :
  1. Dans la page de structure d’Adobe Analytics, développez la zone Paramètres d’Analytics généraux.
  2. Sous la liste des variables, cliquez sur Ajouter un élément pour ajouter une nouvelle variable à la liste.
  3. Dans la cellule de gauche, entrez le nom de la variable, par exemple prop10 .
  4. Dans la colonne de droite, entrez une valeur pour la variable, par exemple CONSTANT .
  5. Pour supprimer une variable, cliquez sur le bouton (-) à côté de la variable.
Lorsque vous entrez des variables et des valeurs, assurez-vous qu’elles sont correctement mises en forme et orthographiées, sinon les appels ne seront pas envoyés avec la paire valeur/variable correcte. Les variables et les valeurs mal orthographiées peuvent même empêcher les appels de se produire.
Consultez votre représentant Adobe Analytics pour vous assurer que ces variables sont correctement définies.
Some of the variables in this list are mandatory in order for Adobe Analytics calls to function correctly, (e.g. currencyCode , charSet )
Ainsi, même s’ils sont supprimés de la structure elle-même, ils seront toujours associés à une valeur par défaut lors de l’appel Adobe Analytics.

Ajout de code JavaScript personnalisé à une structure Adobe Analytics

The free-from javascript box in the General Analytics Settings area enables you to add custom code to a Adobe Analytics framework.
Le code que vous ajoutez est ajouté au fichier analytics.sitecatalyst.js. Therefore, you can access the s variable, which is an instance of the s_gi javascript object that is defined in 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';
The code in the analytics.sitecatalyst.js file (which includes the content of the Adobe Analytics s-code.js file) contains the following code:
if (s.usePlugins) s.doPlugins(s)
La procédure suivante explique comment utiliser la zone javascript pour personnaliser le suivi Adobe Analytics. If your javascript needs to use Adobe Analytics plugins, integrate them into AEM.
  1. Ajoutez le code javascript suivant à la zone afin que s.doPlugins soit exécuté :
    s.usePlugins=true;
    function s_doPlugins(s) {
        //add your custom code here
    }
    s.doPlugins=s_doPlugins;
    
    
    Ce code est nécessaire si vous souhaitez envoyer des variables dans un appel Adobe Analytics qui ont été personnalisées d’une manière qui ne peut pas être effectuée via l’interface de base de glisser-déplacer OU via javascript intégré dans la vue Adobe Analytics.
    Si les variables personnalisées sont en dehors de la fonction s_doPlugins, elles sont envoyées sous la forme *undefined *dans l’appel Adobe Analytics
  2. Add your javascript code in the s_doPlugins function.
L’exemple suivant concatène les données capturées sur une page dans l’ordre hiérarchique, en utilisant un séparateur commun de "|".
Une structure Adobe Analytics possède les configurations suivantes :
  • La variable prop2 Adobe Analytics est associée à la propriété pagedata.sitesection du site.
  • La variable prop3 Adobe Analytics est associée à la propriété pagedata.subsection du site.
  • Le code suivant est ajouté à la zone javascript au format libre :
    s.usePlugins=true;
     function s_doPlugins(s) {
     s.prop1 = s.prop2+'|'+s.prop3;
     }
     s.doPlugins=s_doPlugins;
    
    
  • Lorsque la page Web qui utilise le cadre est visitée (ou, en mode d’édition, la page est rechargée ou prévisualisée), les appels à Adobe Analytics sont effectués.
Par exemple, les valeurs suivantes sont générées dans Adobe Analytics :

Adding Global Custom Code for All Adobe Analytics Frameworks

Fournissez du code JavaScript personnalisé qui est intégré à toutes les infrastructures Adobe Analytics. When a page's Adobe Analytics framework contains no custom free-form javascript , the javascript that the /libs/cq/analytics/components/sitecatalyst/config.js.jsp script generates is appended to the analytics.sitecatalyst.js file. Par défaut, le script n’a aucun effet car il est commenté. The code also sets s.usePlugins to 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 comprend le contenu du fichier s_code.js d’Adobe Analytics) contient le code suivant :
if (s.usePlugins) s.doPlugins(s)
Therefore, your javascript should set s.usePlugins to true so that any code in the s_doPlugins function is executed. Pour personnaliser le code, superposez le fichier config.js.jsp avec celui qui utilise votre propre javascript. If your javascript needs to use Adobe Analytics plugins, integrate them into AEM.
Ne modifiez pas le fichier /libs/cq/analytics/components/sitecatalyst/config.js.jsp. Certaines tâches de mise à niveau ou de maintenance d’AEM peuvent réinstaller le fichier d’origine, en supprimant vos modifications.
  1. Dans CRXDE Lite, créez la structure de dossier /apps/cq/analytics/components :
    1. Sélectionnez le dossier /apps et cliquez sur Créer > Créer un dossier.
    2. Indiquez cq comme nom de dossier, puis cliquez sur OK.
    3. Similarly, create the analytics and components folders.
  2. Cliquez avec le bouton droit sur le dossier components que vous venez de créer et cliquez sur Créer > Créer un composant. Spécifiez les valeurs de propriété suivantes :
    • Libellé: sitecatalyst
    • Titre: sitecatalyst
    • Super Type : /libs/cq/analytics/components/sitecatalyst
    • Groupe: hidden
  3. Cliquez plusieurs fois sur Suivant jusqu’à ce que le bouton OK soit activé, puis cliquez sur OK.
    Le composant sitecatalyst contient le fichier sitecatalyst.jsp automatiquement créé.
  4. Cliquez avec le bouton droit sur le fichier sitecatalyst.jsp et cliquez sur Supprimer.
  5. Cliquez avec le bouton droit sur le composant sitecatalyst et cliquez sur Créer > Créer un fichier. Indiquez le nom config.js.jsp , puis cliquez sur OK.
    Le fichier config.js.jsp s’ouvre automatiquement pour se faire modifier.
  6. Ajoutez le texte suivant au fichier, puis cliquez sur Enregistrer tout :
    <%@page session="true"%>
    /* Plugin Config */
    s.usePlugins=true;
    function s_doPlugins(s) {
        //add your custom plugin code here
    }
    s.doPlugins=s_doPlugins;
    
    
    Le code JavaScript généré par le script /apps/cq/analytics/components/sitecatalyst/config.js.jsp est maintenant inséré dans le fichier analytics.sitecatalyst.js pour toutes les pages qui utilisent une structure Adobe Analytics.
  7. Ajoutez le code javascript que vous voulez exécuter dans la fonction s_doPlugins , puis cliquez sur Enregistrer tout.
Si du texte est présent dans le javascript au format libre de l’infrastructure d’une page (même uniquement les espaces), config.js.jsp est ignoré.

Using Adobe Analytics Plugins in AEM

Procurez-vous le code JavaScript pour les modules externes Adobe Analytics et intégrez-les dans votre structure 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 javascript personnalisé. The following example code sends the query string in "pid" from the referrer's URL as eVar1 , when a Adobe Analytics call is triggered.
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, de sorte qu’ils soient disponibles par défaut :
  • getQueryParam()
  • getPreviousValue()
  • split()
Le dossier de bibliothèque client /libs/cq/analytics/clientlibs/sitecatalyst/plugins comprend ces modules externes dans la catégorie sitecatalyst.plugins.
Créez un dossier de bibliothèque cliente pour vos modules externes. Do not add plugins to the /libs/cq/analytics/clientlibs/sitecatalyst/plugins folder. Cette pratique garantit que votre contribution à la catégorie sitecatalyst.plugins ne se retrouve pas remplacée lors de réinstallations d’AEM ou d’activités de mise à niveau.
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.
  1. Dans un navigateur Web, ouvrez CRXDE Lite. ( http://localhost:4502/crx/de )
  2. Cliquez avec le bouton droit sur le dossier /apps/my-app/clientlibs, puis cliquez sur Créer > Créer un noeud. Entrez les valeurs de propriété suivantes, puis cliquez sur OK :
    • Nom : nom de votre dossier de bibliothèque cliente, par exemple, mes-modules-externes
    • Type : cq:ClientLibraryFolder
  3. Sélectionnez le dossier de bibliothèque cliente que vous venez de créer et utilisez la barre de propriétés en bas à droite pour ajouter la propriété suivante :
    • Nom : categories
    • Type : Chaîne
    • Valeur : sitecatalyst.plugins
    • Multi : sélectionné
    Cliquez sur OK dans la fenêtre Modifier pour confirmer la valeur de la propriété.
  4. Cliquez avec le bouton droit sur le dossier de la bibliothèque cliente que vous venez de créer et cliquez sur Créer > Créer un fichier. Pour le nom de fichier, tapez js.txt, puis cliquez sur OK.
  5. Cliquez sur Enregistrer tout.
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.
  1. Log in to sc.omniture.com using your Adobe Analytics account.
  2. Sur la page d’accueil, accédez à Help (Aide) > Help Home (Aide Accueil).
  3. Dans la table des matières sur le côté gauche, cliquez sur Implementation Plug-ins (Modules externes d’implémentation).
  4. Cliquez sur le lien vers le module externe que vous souhaitez ajouter. Quand la page s’ouvre, recherchez le code source javascript pour le module externe, puis sélectionnez-le et copiez-le.
  5. Cliquez avec le bouton droit sur le dossier de votre bibliothèque cliente, puis cliquez sur Créer > Créer un fichier. Pour le nom de fichier, tapez le nom du module externe que vous intégrez, suivi du suffixe .js, puis cliquez sur OK. Par exemple, si vous intégrez le module externe getQueryParam, nommez le fichier getQueryParam.js.
    Lorsque vous créez le fichier, il s’ouvre pour se faire modifier.
  6. Collez le code javascript du module externe dans le fichier, cliquez sur Enregistrer tout, puis fermez le fichier.
  7. Ouvrez le fichier js.txt à partir du dossier de votre bibliothèque cliente.
  8. Dans une nouvelle ligne, ajoutez le nom du fichier qui contient le module externe, par exemple getQueryParam.js. Ensuite, cliquez sur Enregistrer tout et fermez le fichier.
Lors de l’utilisation de modules externes, assurez-vous d’intégrer des modules externes de support. À défaut, le module externe javascript ne reconnaîtra pas les appels qu’il passe aux fonctions du module externe de support. Par exemple, le module externe getPreviousValue () requiert le module externe split() pour fonctionner correctement.
Le nom du module externe de support doit également être ajouté à js.txt .