Par le tag

Balise API Engagement

La bibliothèque apieng.js, également appelée "Balise API Engagement", est une bibliothèque JavaScript permettant de mesurer l'impact des redirections de l'API Engagement.

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>

Vous pouvez retrouver ce script sur votre espace partenaire via le chemin suivant :

Partager des missions > Paramètres > Suivi des statistiques

Ce script effectue quatre 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 une commande à la file d'attende de commandes apieng() pour créer un nouvel objet de suivi pour la propriété spécifiée via le paramètre 'config'.

  4. Ajoute une autre commande à la file d'attente de commandes apieng() pour envoyer une candidature à l'API Engagement correspondant à la page actuelle.

Que faire pour mesurer une candidature ?

La commande de comptage d'une candidature est la suivante :

window.apieng && window.apieng("trackApplication")

Vous pouvez trouver cette commande sur votre espace partenaire, via le même chemin que le script ci-dessus :

Partager des missions > Paramètres > Suivi des statistiques

Last updated