Tracking des diffusions

⚠️ Cette section n'est valable que pour les diffuseurs de missions par API et/ou par campagne. Dans les widgets, les impressions de missions sont automatiquement capturées.

Quelles sont les étapes du parcours de l'engagement que l'API Engagement traque ?

  • Sur la partie gauche, dans le cadre bleu (Site diffuseur B, vous), l'API traque les impressions.

  • Sur la partie droite, dans le cadre vert (Site annonceur A), l'API traque plusieurs étapes du parcours de l'engagement. L'API peut ainsi donner des statistiques consolidées à ses partenaires :

    • sur le nombre de candidatures pour une mission donnée.

    • sur le nombre d'inscriptions (ou de création de comptes) sur le site annonceur

Qu'est ce qu'une impression ?

L'API Engagement appelle impression, la vue d'une page de mission (ou d'un élément portant un lien tracké comme par exemple un bouton ou une bannière dans le cadre d'une campagne) par un utilisateur sur votre site/appli.

Pour que l'API comptabilise une impression, il faut que la mission ou l'élément portant un lien tracké API soit visualisé au moins 1,5 seconde par l'internaute.

Pourquoi l'API Engagement tracke les impressions de missions ou d'éléments portant un lien tracké ?

L'API Engagement permet aux annonceurs et diffuseurs de faciliter l'engagement en France en mettant à disposition d'outils facilitant la mise en relation entre bénévoles/volontaires et organisations.

Pour rendre compte de la performance de cette mise en relation et afin de fournir à ses partenaires annonceurs et diffuseurs des statistiques poussées, l'API demande de transmettre ces informations d'impressions :

  • les diffuseurs peuvent ainsi valoriser leur impact en mesurant combien de fois une mission ou une campagne a été exposée à ses visiteurs.

  • les annonceurs peuvent comprendre où ont été diffusées leurs missions et quel est le niveau d'attractivité de leur offre par rapport aux redirections (clics) et candidatures reçues.

Quelles sont les impressions que l'API tracke ?

  • Toutes les missions de bénévolat et volontariat diffusées par API.

  • Les liens trackés qui seront cliqués sur votre site ou application (exemples : des boutons ou des images figurant sur votre site). ⚠️ En revanche, les liens trackés placés dans des emails ne peuvent pas faire l'objet d'un tracking d'impressions.

Comment mesurer les impressions et envoyer l'information à l'API Engagement ?

1. Rajouter la balise "API Engagement" sur votre site

La Balise API Engagement, doit être ajoutée en haut de la balise <head> et avant tout autre script ou balise CSS. 

<script>
(function (i, s, o, g, r, a, m) {
i["ApiEngagementObject"] = r; (i[r] = i[r] || function () { (i[r].q = i[r].q || []).push(arguments); }), (i[r].l = 1 * new Date()); (a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]); a.async = 1; a.src = g; m.parentNode.insertBefore(a, m);
})(window, document, "script", "https://app.api-engagement.beta.gouv.fr/jstag.js", "apieng");
apieng("config", "votre-id-de-partenaire");
</script>

Ce script effectue trois actions principales :

  1. Crée un élément <script> pour démarrer le téléchargement asynchrone de la bibliothèque JavaScript jstag.js depuis https://app.api-engagement.beta.gouv.fr/jstag.js

  2. Initialise une fonction globale apieng (appelée "file d'attente de commandes apieng()") permettant de planifier l'exécution des commandes une fois la bibliothèque jstag.js chargée et prête à être utilisée

  3. Ajoute la commande apieng() à la varaiable window qui permet d'accéder à toutes les fonctionnalités de tracking de l'API Engagement.

2. S'assurer que le lien de redirection de l'API est visible sur le bouton (ou la bannière)

Pour le vérifier, il vous suffit de faire clic droit, puis "Inspecter". Dans la console, vous devez voir un lien dans la balise de type <a href="https://api.api-engagement.beta.gouv.fr/r/......."> </a>

Si ce lien est visible, alors il n'y a rien de plus à faire et l'API pourra tracker les impressions.

⚠️ S'il n'est pas possible de mettre le lien visible tel que mentionné ci-dessus, consultez l'alternative expliquée ci-dessous :

Altenative : Tracking des impressions par le pixel (utilisable dans le contexte de la diffusion de missions par API ou pour les liens trackés)

Le rajout de la balise décrite en (1.) reste requis. Cependant, si l'implémentation décrite en (2.) ne convient pas, alors il est possible de tracker les impressions via la méthode du pixel.

Sur le bouton (ou la bannière) qui sert à rediriger les utilisateurs vers la page cible (de l'annonceur), vous devez ajouter une balise <span> de la forme suivante :

<span name="tracker_counter" data-id="mission_id" />

où tracker_counter n’est pas à changer (c’est avec ce nom que le script retrouve le tracker) et mission_id est l’identifiant que l’API fournit de la mission.

Comment vérifier que l'intégration fonctionne bien ?

Vous pouvez vous rendre dans le dashboard API, dans "Activité en temps", et regarder si des impressions s'enregistrent :

PreviousDiffuser des missions par lien trackéNext/mission

Last updated