Collecte de données de page avec Adobe Analytics

Découvrez comment utiliser les fonctionnalités intégrées de la couche de données client d’Adobe avec les composants principaux d’AEM pour collecter des données sur une page dans Adobe Experience Manager Sites. Experience Platform Launch et l’extension Adobe Analytics seront utilisés pour créer des règles permettant d’envoyer des données de page à Adobe Analytics. 🔗

Ce que vous allez créer

Suivi des données de page

Dans ce tutoriel, vous allez déclencher une règle Launch basée sur un événement de la couche de données client Adobe, ajouter des conditions pour le moment où la règle doit être déclenchée et envoyer le Nom de page et le Modèle de page d’une page AEM à Adobe Analytics.

Objectifs

  1. Créez une règle basée sur les événements dans Launch en fonction des modifications apportées à la couche de données.
  2. Mappage des propriétés de couche de données de page aux éléments de données dans Launch
  3. Collectez les données de page et envoyez-les à Adobe Analytics avec la balise de page vue.

Prérequis

Les éléments suivants sont requis :

REMARQUE

Besoin d’aide pour intégrer Launch et votre site AEM ? Voir cette série de vidéos.

Changement d’environnements Launch pour le site WKND

https://wknd. site est un site public créé à partir d’ un projet Open Source conçu comme référence et 🔗 tutoriel pour les mises en oeuvre d’AEM.

Au lieu de configurer un environnement AEM et d’installer la base de code WKND, vous pouvez utiliser le débogueur Experience Platform pour changer la https://wknd.site/ en votre propriété Launch. Bien sûr, vous pouvez utiliser votre propre site d’AEM s’il dispose déjà de la couche de données client d’Adobe activée

  1. Connectez-vous à Experience Platform Launch et créez une propriété Launch (le cas échéant).

  2. Vérifiez qu’une bibliothèque Launch initiale a été créée et convertie en environnement Launch.

  3. Copiez le code incorporé Launch de l’environnement dans lequel votre bibliothèque a été publiée.

    Copier le code incorporé Launch

  4. Dans votre navigateur, ouvrez un nouvel onglet et accédez à https://wknd.site/

  5. Ouvrez l’extension de navigateur du débogueur Experience Platform.

    Débogueur Experience Platform

  6. Accédez à Launch > Configuration et sous Codes incorporés injectés remplacez le code incorporé Launch existant par votre code incorporé copié à partir de l’étape 3.

    Remplacer le code incorporé

  7. Activez Journalisation de la console et Verrouiller le débogueur dans l’onglet WKND.

    Journalisation de la console

Vérifier la couche de données client Adobe sur le site WKND

Le projet de référence WKND est créé avec les composants principaux d’AEM et la couche de données client d’Adobe est activée par défaut. Vérifiez ensuite que la couche de données client d’Adobe est activée.

  1. Accédez à https://wknd.site.

  2. Ouvrez les outils de développement du navigateur et accédez à la console. Exécutez la commande suivante :

    adobeDataLayer.getState();
    

    Cette opération renvoie l’état actuel de la couche de données client Adobe.

    Adobe de l’état de la couche de données

  3. Développez la réponse et examinez l’entrée page. Vous devriez voir un schéma de données comme suit :

    page-2eee4f8914:
        @type: "wknd/components/page"
        dc:description: WKND is a collective of outdoors, music, crafts, adventure sports, and travel enthusiasts that want to share our experiences, connections, and expertise with the world.
        dc:title: "WKND Adventures and Travel"
        repo:modifyDate: "2020-08-31T21:02:21Z"
        repo:path: "/content/wknd/us/en.html"
        xdm:language: "en-US"
        xdm:tags: ["Attract"]
        xdm:template: "/conf/wknd/settings/wcm/templates/landing-page-template"
    

    Nous utiliserons les propriétés standard dérivées du schéma de page, dc:title, xdm:language et xdm:template de la couche de données pour envoyer les données de page à Adobe Analytics.

    REMARQUE

    Vous ne voyez pas l’objet JavaScript adobeDataLayer ? Vérifiez que la couche de données client d’Adobe a été activée sur votre site.

Créer une règle Page chargée

La couche de données client Adobe est une couche de données pilotée par event. Lorsque la couche de données Page d’AEM est chargée, elle déclenche un événement cmp:show. Créez une règle qui sera déclenchée en fonction de l’événement cmp:show .

  1. Accédez à Experience Platform Launch et à la propriété Web intégrée au site AEM.

  2. Accédez à la section Règles de l’interface utilisateur de Launch, puis cliquez sur Créer une règle.

    Créer une règle

  3. Nommez la règle Page chargée.

  4. Cliquez sur Événements Ajouter pour ouvrir l’assistant Configuration des événements.

  5. Sous Type d’événement, sélectionnez Code personnalisé.

    Attribuez un nom à la règle et ajoutez l’événement de code personnalisé

  6. Cliquez sur Ouvrir l’éditeur dans le panneau principal et saisissez le fragment de code suivant :

    var pageShownEventHandler = function(evt) {
       // defensive coding to avoid a null pointer exception
       if(evt.hasOwnProperty("eventInfo") && evt.eventInfo.hasOwnProperty("path")) {
          //trigger Launch Rule and pass event
          console.debug("cmp:show event: " + evt.eventInfo.path);
          var event = {
             //include the path of the component that triggered the event
             path: evt.eventInfo.path,
             //get the state of the component that triggered the event
             component: window.adobeDataLayer.getState(evt.eventInfo.path)
          };
    
          //Trigger the Launch Rule, passing in the new `event` object
          // the `event` obj can now be referenced by the reserved name `event` by other Launch data elements
          // i.e `event.component['someKey']`
          trigger(event);
       }
    }
    
    //set the namespace to avoid a potential race condition
    window.adobeDataLayer = window.adobeDataLayer || [];
    //push the event listener for cmp:show into the data layer
    window.adobeDataLayer.push(function (dl) {
       //add event listener for `cmp:show` and callback to the `pageShownEventHandler` function
       dl.addEventListener("cmp:show", pageShownEventHandler);
    });
    

    Le fragment de code ci-dessus ajoute un écouteur d’événement en insérant une fonction dans la couche de données. Lorsque l’événement cmp:show est déclenché, la fonction pageShownEventHandler est appelée. Dans cette fonction, quelques contrôles d’intégrité sont ajoutés et un nouveau event est créé avec le dernier état de la couche de données pour le composant qui a déclenché l’événement.

    Ensuite, trigger(event) est appelé. trigger() est un nom réservé dans Launch qui “déclenche” la règle Launch. Nous transmettons l’objet event en tant que paramètre qui sera à son tour exposé par un autre nom réservé dans Launch nommé event. Les éléments de données de Launch peuvent désormais référencer diverses propriétés comme suit : event.component['someKey'].

  7. Enregistrez les modifications.

  8. Ensuite, sous Actions cliquez sur Ajouter pour ouvrir l’assistant Configuration de l’action.

  9. Sous Type d’action, sélectionnez Code personnalisé.

    Type d’action Custom Code

  10. Cliquez sur Ouvrir l’éditeur dans le panneau principal et saisissez le fragment de code suivant :

    console.debug("Page Loaded ");
    console.debug("Page name: " + event.component['dc:title']);
    console.debug("Page type: " + event.component['@type']);
    console.debug("Page template: " + event.component['xdm:template']);
    

    L’objet event est transmis à partir de la méthode trigger() appelée dans l’événement personnalisé. component est la page active dérivée de la couche de données getState dans l’événement personnalisé. Rappelez-vous de la section Schéma de page exposée par la couche de données afin de voir les différentes clés exposées en dehors de la zone.

  11. Enregistrez les modifications et exécutez un build dans Launch pour convertir le code en environnement utilisé sur votre site AEM.

    REMARQUE

    Il peut s’avérer très utile d’utiliser le débogueur Adobe Experience Platform pour passer le code incorporé à un environnement de développement.

  12. Accédez à votre site AEM et ouvrez les outils de développement pour afficher la console. Actualisez la page. Vous devriez constater que les messages de la console ont été enregistrés :

    Messages de la console chargés en page

Création d’éléments de données

Créez ensuite plusieurs éléments de données pour capturer différentes valeurs de la couche de données client Adobe. Comme nous l’avons vu dans l’exercice précédent, il est possible d’accéder aux propriétés de la couche de données directement par le biais du code personnalisé. L’avantage de l’utilisation des éléments de données est qu’ils peuvent être réutilisés dans les règles de Launch.

Rappelez-vous d’avant le Schéma de page exposé par la couche de données :

Les éléments de données seront mappés aux propriétés @type, dc:title et xdm:template.

Type de ressource de composant

  1. Accédez à Experience Platform Launch et à la propriété Web intégrée au site AEM.

  2. Accédez à la section Éléments de données et cliquez sur Créer un élément de données.

  3. Pour Nom, saisissez Type de ressource de composant.

  4. Pour Type d’élément de données, sélectionnez Code personnalisé.

    Type de ressource de composant

  5. Cliquez sur Ouvrir l’éditeur et saisissez ce qui suit dans l’éditeur de code personnalisé :

    if(event && event.component && event.component.hasOwnProperty('@type')) {
        return event.component['@type'];
    }
    

    Enregistrez les modifications.

    REMARQUE

    N’oubliez pas que l’objet event est rendu disponible et défini sur la portée en fonction de l’événement qui a déclenché la règle dans Launch. La valeur d’un élément de données n’est pas définie tant que l’élément de données n’est pas référencé dans une règle. Par conséquent, il est sans risque d’utiliser cet élément de données à l’intérieur d’une règle comme la règle Page chargée créée à l’étape précédente mais ne serait pas utilisable en toute sécurité dans d’autres contextes.

Nom de page

  1. Cliquez sur Ajouter un élément de données.

  2. Pour Nom, saisissez Nom de page.

  3. Pour Type d’élément de données, sélectionnez Code personnalisé.

  4. Cliquez sur Ouvrir l’éditeur et saisissez ce qui suit dans l’éditeur de code personnalisé :

    if(event && event.component && event.component.hasOwnProperty('dc:title')) {
        return event.component['dc:title'];
    }
    

    Enregistrez les modifications.

Modèle de page

  1. Cliquez sur Ajouter un élément de données.

  2. Pour Nom, saisissez Modèle de page.

  3. Pour Type d’élément de données, sélectionnez Code personnalisé.

  4. Cliquez sur Ouvrir l’éditeur et saisissez ce qui suit dans l’éditeur de code personnalisé :

    if(event && event.component && event.component.hasOwnProperty('xdm:template')) {
        return event.component['xdm:template'];
    }
    

    Enregistrez les modifications.

  5. Vous devez maintenant avoir trois éléments de données dans votre règle :

    Éléments de données dans la règle

Ajout de l’extension Analytics

Ajoutez ensuite l’extension Analytics à votre propriété Launch. Nous devons envoyer ces données quelque part !

  1. Accédez à Experience Platform Launch et à la propriété Web intégrée au site AEM.

  2. Accédez à Extensions > Catalogue

  3. Recherchez l’extension Adobe Analytics et cliquez sur Installer.

    Extension Adobe Analytics

  4. Sous Gestion des bibliothèques > Suites de rapports, saisissez les identifiants de suite de rapports que vous souhaitez utiliser avec chaque environnement Launch.

    Saisie des identifiants de suite de rapports

    REMARQUE

    Vous pouvez utiliser une suite de rapports pour tous les environnements dans ce tutoriel, mais dans la vie réelle, vous souhaiterez utiliser des suites de rapports distinctes, comme illustré ci-dessous.

    CONSEIL

    Nous vous recommandons d’utiliser l’option Gérer la bibliothèque pour moi comme paramètre de gestion des bibliothèques, car cela facilite la mise à jour de la bibliothèque AppMeasurement.js.

  5. Cochez la case pour activer Utiliser Activity Map.

    Activer Use Activity Map

  6. Sous Général > Serveur de suivi, saisissez votre serveur de suivi, par exemple tmd.sc.omtrdc.net. Entrez votre serveur de suivi SSL si votre site prend en charge https://

    Renseignez les serveurs de tracking

  7. Cliquez sur Enregistrer pour enregistrer les modifications.

Ajouter une condition à la règle Page chargée

Ensuite, mettez à jour la règle Page chargée pour utiliser l’élément de données Type de ressource de composant afin de vous assurer que la règle ne se déclenche que lorsque l’événement cmp:show correspond à la page. D’autres composants peuvent déclencher l’événement cmp:show ; par exemple, le composant Carrousel le déclenche lorsque les diapositives changent. Il est donc important d’ajouter une condition pour cette règle.

  1. Dans l’interface utilisateur de Launch, accédez à la règle Page chargée créée précédemment.

  2. Sous Conditions cliquez sur Ajouter pour ouvrir l’assistant Configuration de condition.

  3. Pour Type de condition, sélectionnez Comparaison de valeurs.

  4. Définissez la première valeur du champ de formulaire sur %Component Resource Type%. Vous pouvez utiliser l’icône d’élément de données icône d’élément de données pour sélectionner l’élément de données Type de ressource de composant. Laissez le comparateur défini sur Equals.

  5. Définissez la seconde valeur sur wknd/components/page.

    Configuration de condition pour la règle chargée sur la page

    REMARQUE

    Il est possible d’ajouter cette condition dans la fonction de code personnalisé qui écoute l’événement cmp:show créé précédemment dans le tutoriel. Toutefois, l’ajout de cette règle dans l’interface utilisateur offre une plus grande visibilité aux utilisateurs supplémentaires qui peuvent avoir besoin d’apporter des modifications à la règle. De plus, nous pouvons utiliser notre élément de données .

  6. Enregistrez les modifications.

Définition des variables Analytics et déclenchement de la balise Page vue

Actuellement, la règle Page chargée génère simplement une instruction de console. Ensuite, utilisez les éléments de données et l’extension Analytics pour définir les variables Analytics comme une action dans la règle Page chargée. Nous définirons également une action supplémentaire pour déclencher la balise de page vue et envoyer les données collectées à Adobe Analytics.

  1. Dans la règle Page chargée remove l’action Core - Code personnalisé (instructions de la console) :

    Suppression d’une action de code personnalisé

  2. Sous Actions, cliquez sur Ajouter pour ajouter une nouvelle action.

  3. Définissez le type Extension sur Adobe Analytics et définissez le Type d’action sur Définir des variables.

    Définition de l’extension d’action sur Analytics Set Variables

  4. Dans le panneau principal, sélectionnez un eVar disponible et définissez comme valeur de l’élément de données Modèle de page. Utilisez l’icône Éléments de données Icône Éléments de données pour sélectionner l’élément Modèle de page.

    Définir comme modèle de page d’eVar

  5. Faites défiler l’écran vers le bas, sous Paramètres supplémentaires et définissez Nom de page sur l’élément de données Nom de page :

    Jeu de variables d’environnement de nom de page

    Enregistrez les modifications.

  6. Ajoutez ensuite une action supplémentaire à droite de Adobe Analytics - Set Variables en appuyant sur l’icône plus :

    Ajout d’une action de lancement supplémentaire

  7. Définissez le type Extension sur Adobe Analytics et définissez le Type d’action sur Envoyer la balise. Puisqu’il est considéré comme une page vue, laissez le suivi par défaut défini sur s.t().

    Action Envoyer la balise Adobe Analytics

  8. Enregistrez les modifications. La règle Page chargée doit maintenant avoir la configuration suivante :

    Configuration finale du lancement

    • 1. Prêtez attention à l’ cmp:show événement.
    • 2. Vérifiez que l’événement a été déclenché par une page.
    • 3. Définition de variables Analytics pour le nom de page et le modèle de page
    • 4. Envoyer la balise de page vue Analytics
  9. Enregistrez toutes les modifications et créez votre bibliothèque Launch, en effectuant la promotion vers l’environnement approprié.

Validation de la balise de page vue et de l’appel Analytics

Maintenant que la règle Page chargée envoie la balise Analytics, vous devriez être en mesure de voir les variables de suivi Analytics à l’aide du débogueur Experience Platform.

  1. Ouvrez le site WKND dans votre navigateur.

  2. Cliquez sur l’icône Debugger Icône Debugger Experience Platform pour ouvrir Debugger Experience Platform.

  3. Assurez-vous que le débogueur mappe la propriété Launch à votre environnement de développement, comme décrit précédemment et que la journalisation de la console est cochée.

  4. Ouvrez le menu Analytics et vérifiez que la suite de rapports est définie sur votre suite de rapports. Le Nom de page doit également être renseigné :

    Débogueur de l’onglet Analytics

  5. Faites défiler la page vers le bas et développez Requêtes réseau. Vous devriez être en mesure de trouver l’evar défini pour le modèle de page :

    Evar et nom de page définis

  6. Revenez au navigateur et ouvrez la console de développement. Cliquez sur Carrousel en haut de la page.

    Clic sur la page du carrousel

  7. Observez l’instruction de la console dans la console du navigateur :

    Condition non remplie

    En effet, le carrousel ne déclenche pas d’événement cmp:show mais en raison de la vérification du type de ressource de composant, aucun événement n’est déclenché.

    REMARQUE

    Si vous ne voyez aucun journal de la console, assurez-vous que Journalisation de la console est coché sous Launch dans le débogueur Experience Platform.

  8. Accédez à une page d’article telle que Ouest de l’Australie. Observez que le nom de page et le type de modèle changent.

Félicitations !

Vous venez d’utiliser la couche de données client et l’Experience Platform Launch Adobe pilotés par les événements pour collecter les données de page de données d’un site AEM et les envoyer à Adobe Analytics.

Étapes suivantes

Consultez le tutoriel suivant pour savoir comment utiliser la couche de données client Adobe orientée événement pour suivre les clics de composants spécifiques sur un site Adobe Experience Manager.

Sur cette page