Intégration JS
Cette page explique comment envoyer des évènements avec un maximum d’informations vers Forecast Signals depuis une page web à l’aide de Forecast JS.
Prérequis
Avant d’utiliser ses fonctionnalités, Forecast doit être installé et configuré. La page Premiers pas explique comment démarrer avec Forecast.Configurer la page
Pour enrichir les évènements envoyés, les pages web doivent être correctement configurées.
Propriétés de l’évènement
Pour permettre aux évènements de porter un maximum d’informations, vous devez indiquer les balises HTML décrites ci-dessous dans votre page web.
URL de la page
URL de la page visitée.
<link rel="canonical" href="url">
Type de la page
Type de la page actuellement visitée. Valeurs acceptées : article, home, search, search_results.
<script type="text/javascript">
__forecast.config.pageType = "article"; // ou "home", ou "search", ou "search_results"
</script>
Identifiant Sirius
Identifiant Sirius de l’article.
<script type="text/javascript">
__forecast.config.article.globalId = "123abc";
</script>
URL de l’article
URL de l’article visité.
<script type="text/javascript">
__forecast.config.article.canonicalUrl = "url";
</script>
Article débloqué
Pour indiquer si l’article est débloqué dans le contexte actuel, vous pouvez définir :
<script type="text/javascript">
__forecast.config.article.isUnlocked = true; // ou `false`
</script>
Conteneur de l’article
Balise du conteneur de l’article.
<script type="text/javascript">
__forecast.config.contentSelector = "selector"; // Sélecteur CSS de l'élément parent du contenu de l'article
</script>
Type de navigation
Indique le type de navigation de la page. Les valeurs possibles sont listées ici : https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming/type.
Attention
Forecast JS calcule automatiquement cette configuration. Nous vous conseillons de ne l’ajuster manuellement que si vous en maîtrisez bien l’impact.<script type="text/javascript">
__forecast.config.eventProperties.navigationType = "reload"; // ou "navigate", ou "back_forward"
</script>
Propriétés de l’utilisateur
Pour permettre aux évènements de porter un maximum d’informations concernant l’utilisateur, vous devez indiquer les balises HTML décrites ci-dessous dans votre page web.
ID de l’utilisateur
Identifiant de l’utilisateur.
<script type="text/javascript">
__forecast.config.user.id = "123abc";
</script>
Status de l’utilisateur
Pour indiquer si l’utilisateur est un abonné ou pas.
<script type="text/javascript">
__forecast.config.user.isSubscriber = true; // ou `false`
</script>
Accès à l’article
Pour indiquer si l’utilisateur a accès au contenu de l’article.
<script type="text/javascript">
__forecast.config.user.hasArticleAccess = true; // ou `false`
</script>
Configurer les zones de tracking
Pour assurer le suivi des impressions et des clics sur des zones spécifiques (listes, carrousels, mises en avant), vous devez baliser le HTML avec les attributs décrits ci-dessous. Les identifiants de zones doivent correspondre à ceux définis dans l’administration Sirius.
Identifiant de la zone
L’attribut data-fcst-tz-id définit le conteneur principal de la zone. Renseignez l’identifiant récupéré depuis Sirius.
<div data-fcst-tz-id="">
<!-- Contenu de la zone -->
</div>
Identifiant des articles de la zone
L’attribut data-fcst-article-id identifie un article au sein d’une zone. Il doit être placé sur un élément enfant de la zone définie par data-fcst-tz-id.
<div data-fcst-tz-id="">
<article data-fcst-article-id=""></article>
</div>
Envoyer des évènements
Pour transmettre des évènements vers Forecast Signals, utilisez les fonctions qui se trouvent dans la page Forecast JS.
Notez que certains évènements sont transmis automatiquement lors du chargement de Forecast JS, sans nécessiter l’appel à une méthode Javascript spécifique.
Désactiver des envois
Pour désactiver l’envoi automatique de certains évènements, vous pouvez définir :
<script type="text/javascript">
__forecast.config.disabledEvents = [
'pageview' // désactive l'envoi des évènements de page vue.
'read' // désactive l'envoi des évènements de lecture.
];
</script>