Personnalisation du framework Adobe Analytics

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

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

Lorsqu’une page est associée à un framework 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 javascript dans la page crée un objet s_gi (que la bibliothèque Adobe Analytics s_code.js définit) et attribue 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 un code javascript personnalisé pour personnaliser le framework, vous modifiez le contenu de ce fichier.

Configuration des propriétés Adobe Analytics

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 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. Sur votre page de framework Adobe Analytics, développez la zone Paramètres généraux d’Analytics.

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.

Ajout de code JavaScript personnalisé à un framework Adobe Analytics

La zone javascript au format libre dans 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 tracking Adobe Analytics. Si votre javascript doit utiliser les modules externes d’Adobe Analytics, intégrez-les à 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;
   

   ATTENTION

   Ce code est nécessaire si vous souhaitez envoyer des variables dans un appel Adobe Analytics qui ont été personnalisées autrement que via l’interface basique de glisser-déposer OU via le javascript intégré en mode Adobe Analytics.

   Si les variables personnalisées sont en dehors de la fonction s_doPlugins, elles sont envoyées comme undefined dans l’appel Adobe Analytics

2. Ajoutez votre code javascript dans la fonction s_doPlugins.

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 :

• La variable Adobe Analytics prop2 est mappée à la propriété pagedata.sitesection du site.

• La variable Adobe Analytics prop3 est mappé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;
  

• Si la page Web qui utilise le framework est consulté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 :

Ajout de code personnalisé global pour tous les frameworks Adobe Analytics

Entrez un code javascript personnalisé intégré à tous les frameworks Adobe Analytics. Lorsque le framework Adobe Analytics d’une page ne contient pas de javascript au format libre, le 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 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 javascript. Si votre javascript doit utiliser les modules externes d’Adobe Analytics, intégrez-les à AEM.

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. De même, créez les dossiers analytics et components.

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 désormais inséré dans le fichier analytics.sitecatalyst.js pour toutes les pages utilisant un framework Adobe Analytics.

7. Ajoutez le code javascript que vous voulez exécuter dans la fonction s_doPlugins, puis cliquez sur Enregistrer tout.

Utilisation des modules externes Adobe Analytics dans AEM

Obtenez le code javascript pour les modules externes 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 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 :

• getQueryParam()
• getPreviousValue()
• split()

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.

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 sur Créer > Créer un nœud. 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. Connectez-vous à sc.omniture.com en utilisant votre compte Adobe Analytics.

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.

Ressources Business.Adobe.com

Automated Onboarding Personalized Experiences Content Intelligence Mobile Forms Version History Digital Asset Management