Pages

 

Avant-propos

Avant de commencer l’implémentation du plugin Page, veuillez-vous assurer d’avoir initialisé le Tracker JavaScript AT Internet et sélectionné le plugin depuis l’interface Tag Composer.

 

Principe

Le plugin JavaScript Page propose la mesure des pages de votre site.

 

Marquage

Le Tracker dispose d’une méthode « page.set() » permettant de définir les valeurs du marqueur de page. Elle prend un objet en paramètre dont les propriétés sont les suivantes :

  • name : Libellé de la page.
  • chapter1 : Premier niveau de chapitre.
  • chapter2 : Deuxième niveau de chapitre.
  • chapter3 : Troisième niveau de chapitre.
  • level2: Niveau 2.
  • customObject : Paramètres personnalisés.

Si le paramètre « name » est vide (name: '') et les paramètres « chapter1 », « chapter2 » et « chapter3 » ne sont pas définis, l’URL de la page sera utilisée comme nom de page dans vos rapports.

Si les paramètres « chapter1 », « chapter2 » ou « chapter3 » sont vides, ils remonteront comme tel dans les analyses*.

* Depuis la version 5.5.0, une nouvelle option (ignoreEmptyChapterValue) vous permet de choisir si les chapitres vides doivent être pris en compte (false) ou non (true).
>= 5.5.0

L’envoi du hit de page se fait dans ce cas par l’intermédiaire de la méthode « tag.dispatch() ».

 

Exemples de marquage

  1. Marquage d’une page :
    var tag = new ATInternet.Tracker.Tag();
    tag.page.set({
        name:'pageName'
    });
    tag.dispatch();
  2. Marquage d’une page avec niveau 2 :
    var tag = new ATInternet.Tracker.Tag();
    tag.page.set({
        name:'pageName',
        level2:'123'
    });
    tag.dispatch();
  3. Marquage d’une page avec chapitres :
    var tag = new ATInternet.Tracker.Tag();
    tag.page.set({
        name:'pageName',
        chapter1:'chap1',
        chapter2:'chap2',
        chapter3:'chap3'
    });
    tag.dispatch();
  4. Marquage d’une page avec ajout d’un objet personnalisé :
    var tag = new ATInternet.Tracker.Tag();
    tag.page.set({
        name:'pageName',
        customObject: {
            param1: 'val1',
            param2: 'val2'
        }
    });
    tag.dispatch();
  5. Marquage d’un chapitre vide :
    var tag = new ATInternet.Tracker.Tag();
    tag.page.set({
        name:'pageName',
        chapter1:'chapter1',
        chapter2:''
    });
    tag.dispatch();

    Ce qui donnera dans le hit : « chapter1::::pageName », et créera un chapitre de niveau 2 vide dans les analyses.

Le Tracker dispose aussi d’une méthode « page.send() » utile pour l’envoi ponctuel d’un hit, en dehors du chargement de page. Cette méthode peut être appelée sur une action ou un événement de votre choix.

Des paramètres optionnels supplémentaires sont alors disponibles :

  • elem : Element du DOM marqué.
  • event : Evénement JavaScript (bloque la propagation de l’événement passé en paramètre) – depuis v5.7.0.
  • callback : Fonction à exécuter – depuis v5.7.0.

Les données d’un contexte de page définies lors d’un appel à la méthode « page.set() » sont ignorées par la méthode « page.send() ».

  1. Marquage complet :
var tag = new ATInternet.Tracker.Tag();
tag.page.send({
    name:'pageName',
    chapter1:'chap1',
    chapter2:'chap2',
    chapter3:'chap3',
    level2:'123',
    customObject: {
        param1: 'val1',
        param2: 'val2'
    },
    event: anEvent,
    callback: function(){}
});

Il est inutile de faire appel à la méthode « tag.dispatch() » dans ce cas.

 

Marquer une page sur un clic

Afin de marquer une page sur un clic, vous pouvez utiliser la méthode « page.send() » :

<a href="/mypage.html" onclick="return tag.page.send({elem:this, name:'Page', chapter1: 'mychapter', level2: '2'})">Link</a>
 

Les caractères autorisés

Le nom de page passant par notre serveur via le protocole http (standard du web), il est assujetti à quelques règles permettant d’atteindre un niveau important de compatibilité avec les navigateurs.

Les règles sont :

  • pas de caractères accentués,
  • pas d’espace (remplacer les espaces par « l’underscore », c’est-à-dire « _ »),
  • pas de caractères autres que des lettres et des chiffres (ne pas utiliser les virgules, le ‘+’, les guillemets et les apostrophes).

Les caractères autorisés sont les suivants :

  • Les lettres abcdefghijklmnopqrstuvwxyz en majuscules ou minuscules
  • Les chiffres 1234567890
  • Les points .
  • Les slashs /
  • Les moins –
  • Les underscores _
  • Les tildes ~

Vous pouvez encoder la valeur si nécessaire

 

Le paramètre « customObject »

Le paramètre « customObject » permet de mutualiser l’ensemble des paramètres que vous souhaitez mesurer : voir la page intitulée « Objet personnalisé » pour plus de détails.

Dernière mise à jour : 17/05/2019