Evénements de suivi statistique

Cette page est destinée aux intégrateurs ayant un minimum connaissances en HTML, CSS, XML, XSL, I18N.
Vous devez avoir lu la page Intégration graphique de la newsletter

Presentation

Il est possible d'obtenir des statistiques sur les newsletters via un gestionnaire de suivi comme Google Analytics ou Matomo. Le suivi porte sur les événements suivants :

  • Sending: when a newsletter is validated, an event is generated for each e-mail sent.
  • Opening: when a user views the e-mail of a newsletter, an event is generated.
  • Clic sur un lien : les clics sur les liens de la newsletter dirigeant vers une page du site sont intégrés dans une "campagne.

On peut choisir le gestionnaire via un paramètre de configuration du site :

Integration

The sending event doesn't require any special integration; it's handled by the e-mail sending engine, outside the graphic charter.

L'intégration des deux autres événements se fait dans le gabarit de la newsletter, dans le fichier skins/<myskin>/newsletter/<template>/stylesheets/template.xsl. Un exemple de ce gabarit se trouve dans la charte de démonstration, accessible à l'adresse suivante : https://code.ametys.org/projects/WEB/repos/template-web/browse/webapp/cms/skins/demo/newsletter/default/stylesheets/template.xsl 

La feuille de style stylesheets/wa-newsletter.xsl dans le plugin newsletter fournit des templates XSL à appeler pour mettre en place l'envoi des événements. Pour l'inclure dans le gabarit, l'instruction suivante est à placer en en-tête du fichier template.xsl:

<xsl:include href="plugin:newsletter://stylesheets/wa-newsletter.xsl" />

Avant la version 2.11 du plugin Newsletter, on gérait seulement Google Analytics donc la xsl s'appellait plugin:newsletter://stylesheets/ga-newsletter.xsl

The following parameters are passed to the XSL template (but must still be declared as xsl:param):

  • categoryTitle: the category title
  • title: newsletter title
  • number: newsletter number (can be empty if the "number" field in the content is not filled in)
  • date: the date of the newsletter in yyyy-MM-dd format (may be empty if the "date" content field is not filled in)

Opening

To generate an event when the newsletter is opened, you need to call the following template (defined in the ga-newsletter.xsl file):

<xsl:call-template name="wa-analytics-newsletter">
<xsl:with-param name="categoryTitle" select="$categoryTitle"/>
<xsl:with-param name="title" select="$title"/>
<xsl:with-param name="number" select="$number"/>
<xsl:with-param name="date" select="$date"/>
</xsl:call-template>

Avant la version 2.11 du plugin Newsletter, on gérait seulement Google Analytics donc le template xsl s'appellait google-analytics-newsletter

Ce template crée une balise <img> dont la source se trouve sur les serveurs du gestionnaire de suivi. Quand l'utilisateur visualise la newsletter, un événement est généré, ayant les propriétés suivantes :

  • Category: "Newsletters / Title of the category
  • Action: "Open"
  • Label: "Title / Number / Date" where Title, Number and Date are the newsletter fields.

Le template "wa-analytics-newsletter" ne génère la balise <img> que si le paramètre de site "Suivi des lettres d'information" est activé et que le ou les paramètres du gestionnaire de suivie sont renseignés.

Links

Quand le fichier wa-newsletter.xsl est inclus, les liens vers les pages du site sont identifiés comme venant de la newsletter.

Quand l'utilisateur clique sur un lien de la newsletter, le clic est pris en compte dans les "sources de trafic" avec les propriétés suivantes :

  • Campaign: "Newsletters / Category title".
  • Support: email
  • Source: "Title / Number / Date" where Title, Number and Date are the newsletter fields.

Le gestionnaire de suivi doit être intégré sur le site pour que le suivi soit effectif.

Back to top

Newsletter