Forecast JS
Bibliothèque client Javascript de Forecast.
Cette section fournit une brève référence pour toutes les méthodes et événements disponibles via l’objet DOM window.__forecast
. Cet objet est créé à l’initialisation de Forecast JS.
Forecast JS est compatible avec les navigateurs supportant ECMAScript 6.
Méthodes
Les méthodes de l’objet __forecast
et leurs descriptions.
collectAdClick()
Permet de transmettre un Hit lorsque le visiteur a cliqué sur une publicité.
collectAdHover()
Permet de transmettre un Hit lorsque le visiteur a survolé une publicité.
collectChurn()
Permet de transmettre un Hit lorsque le visiteur a résilié sa souscription à une offre.
Permet de transmettre un Hit lorsque le visiteur a commenté la page courante.
Permet de transmettre un Hit lorsque le visiteur a accompli l’action d’achat d’une offre.
Paramètres
Nom | Type | Description |
---|
formula | Chaîne de caractères | Identifiant de l'offre |
collectGift()
Permet de transmettre un Hit lorsque le visiteur s’est vu offrir un accès non-payant à la page courante.
collectShare()
Permet de transmettre un Hit lorsque le visiteur a partagé la page courante.
collectShareFacebook()
Permet de transmettre un Hit lorsque le visiteur a partagé via Facebook la page courante.
collectShareMail()
Permet de transmettre un Hit lorsque le visiteur a partagé via e-mail la page courante.
Permet de transmettre un Hit lorsque le visiteur a partagé via Twitter la page courante.
collectTunnelAccess(page, formula, minutesAgo)
Permet de transmettre un Hit lorsque le visiteur a accédé au tunnel de commande.
Paramètres
Nom | Type | Description |
---|
page | Chaîne de caractères | Type de la page courante du tunnel. Valeurs possibles :Valeur | Description |
---|
offer_select | page présentant les offres | checkout | page après voir séléctionné une offre |
|
formula | Chaîne de caractères | Identifiant de l'offre |
minutesAgo | Nombre | Temps écoulé depuis que l'événement a eu lieu |
collectUnsubwill()
Permet de transmettre un Hit lorsque le visiteur a montré une volonté de résilier sa souscription à une offre.
getLeadHistory()
Retourne une promesse représentant le dernier article non-gratuit visité par un non-abonné, depuis le présent navigateur.
Permet de créer un widget puis de l’afficher.
Paramètres
Nom | Type | Description |
---|
config | Objet | Configuration du widget.Nom | Type | Description |
---|
capping | Nombre | Limite maximale d'impression du widget | delay | Nombre | Dépréciée. Délai minimal à respecter entre la date d'abandon de l'utilisateur et l'affichage du widget. | displayLimitDate | Chaîne de caractère | La date limite à partir de laquelle un widget n'est plus affiché. La date doit être renseignée en UTC et sous ce format : YYYY-MM-DDTHH:mm:ss.sssZ . | displayLimitPerSession | Nombre | Le nombre maximum de fois qu'un widget peut être affiché lors d'une seule session. Voir aussi sessionDuration . | displayStartDate | Chaîne de caractère | La date de début à partir de laquelle un widget commence à être affiché. La date doit être renseignée en UTC et sous ce format : YYYY-MM-DDTHH:mm:ss.sssZ . | events | Objet | Configuration des fonctions à appeler à chaque fois que des évènements sont envoyés aux widgets.Nom | Type | Description |
---|
click(widget, event) | Méthode | Fonction à appeler suite au clic sur un lien contenu dans le widget. Les
paramètres que pourra recevoir la fonction sont :Nom | Type | Description |
---|
widget | Objet | Objet représentant le widget ciblé par l'évènement déclenché. | event | Objet | L'évènement qui s'est produit sous forme d'objet qui implémente l'interface Event. |
| load(widget) | Méthode | Fonction à appeler suite au chargement du widget. Les paramètres que pourra
recevoir la fonction sont :Nom | Type | Description |
---|
widget | Objet | Objet représentant le widget ciblé par l'évènement déclenché. |
| visible(widget) | Méthode | Fonction à appeler suite à l'apparition du widget. Les paramètres que pourra
recevoir la fonction sont :Nom | Type | Description |
---|
widget | Objet | Objet représentant le widget ciblé par l'évènement déclenché. |
|
| expire | Nombre | Dépréciée. Temps maximal à respecter entre la date d'abandon de l'utilisateur et l'affichage du widget. | failovers | Tableau d'objet | Tableau contenant les configurations des widgets à charger en cas d'échec du widget parent. | minVisitsThreshold | Nombre | Le nombre de visites minimum requis avant que le widget puisse être affiché. Voir aussi numberOfDisplayPerThreshold . | name | Chaîne de caractère | Identifiant du widget. Ce nom est utilisé pour identifier chaque widget dans les rapports de suivi d'affichage, de performance, etc. Cet identifiant doit être unique. | numberOfDisplayPerThreshold | Nombre | Le nombre maximum de fois que le widget peut être affiché une fois le seuil minimum de visites atteint. Voir aussi minVisitsThreshold . | options | Objet | Permet de configurer les éléments à afficher dans le widget. | passLead | Booléen | Permet d'activer la transmission de l'identifiant du visiteur lors du chargement du widget | passUrl | Booléen | Permet d'activer la transmission de l'URL courante lors du chargement du widget | pathWhitelist | Tableau | Liste des chemins d'URL autorisés pour l'affichage du widget. Le widget s'affiche uniquement si le chemin de l'URL courante correspond à un élément de cette liste. Chaque entrée doit être un chemin d'URL (par exemple, /chemin/vers/la/page ). | sessionDuration | Nombre | La durée (en secondes) pendant laquelle une session est considérée comme active. Voir aussi displayLimitPerSession . | subname | Chaîne de caractères | Dépréciée. Optionnel. Suffixe à l'identifiant du widget. | targetSelector | Chaîne de caractères | Sélecteur CSS de l'élément HTML à l'intérieur duquel le widget sera chargé. | template | Chaîne de caractères | Identifiant du modèle du widget à charger. Valeurs possibles : antichurn , cta , recommendations , retargeting , tops . | timeToLiveAfterFirstDisplay | Nombre | La durée de vie (en secondes) du widget après son premier affichage sur l'écran du visiteur. Ce délai s'applique de manière individuelle pour chaque visiteur. Une fois ce délai écoulé, le widget ne sera plus chargé. | type | Chaîne de caractères | Optionnel. Type de comportement à appliquer au widget. Valeurs possibles : antichurn , retargeting . | versions | Objet | Configuration des différentes déclinaisons au widget.Nom | Type | Description |
---|
frequency | Chaîne de caractères | Fréquence de rotation entre les différentes déclinaisons du widget. Valeurs possibles : ([0-9]+)([dmyhis]{1}) | items | Tableau d'objet | Configuration des différentes déclinaisons du widget. L'objet de chaque déclinaison contient ces propriétés failovers , options dont la description est similaire à celle du widget parent. À ces propriétés s'ajoutent celles-ci :Nom | Type | Description |
---|
rate | Nombre | Nombre désignant un pourcentage à appliquer dans l'a/b testing de la déclinaison. |
| startDate | Type | Date à laquelle démarre la rotation entre les différentes déclinaisons du widget. | type | Chaîne de caractères | Type de comportement à appliquer aux différentes déclinaisons du widget. Valeurs possibles : abtest , rotation . |
|
|
key | Chaîne de caractères | Identifiant du widget à utiliser lorsque la configuration du widget n'indique pas la propriété name . Cet identifiant doit être unique. |