Les triggers

 

Avant-propos

Ce guide de marquage est destiné aux utilisateurs avancés.

 

Principe

Notre bibliothèque fonctionne avec des déclencheurs (triggers en anglais) qui provoquent des traitements particuliers en fonction d’événements prédéfinis. Elle permet par défaut l’accès à un ensemble de données contextuelles transmises lors du déclenchement d’événements spécifiques et fournit à l’utilisateur avancé un système de gestion d’événements personnalisés. Ce dernier peut de plus associer une fonction de rappel (callback en anglais) à un trigger qui sera exécutée lors de la « levée » de l’événement associé.

 

Format d’un trigger

Un trigger est un libellé constitué d’un ensemble de champs (niveaux ou catégories) séparés par le caractère « : »

 

Exemple

Dans cet exemple, le trigger est défini au niveau du Tracker et se déclenche après l’envoi d’un hit réussi.

Il est possible techniquement de se brancher sur cet événement pour éventuellement déclencher des actions. Des informations détaillées telles que la valeur du hit au moment de l’envoi sont automatiquement ajoutées lors de l’exécution du trigger.

 

Inscription sur un trigger

Le Tracker dispose d’une méthode « onTrigger() » permettant de s’inscrire sur un trigger. Elle prend trois paramètres en entrée :

  • trigger : Libellé du trigger sur lequel vous souhaitez vous inscrire ; obligatoire
  • callback : Méthode que vous souhaitez exécuter.
  • singleUse : Si vous souhaitez appeler une seule fois la méthode callback où à chaque déclenchement de l’événement (« true » ou « false » ; « false » par défaut).

Pour s’inscrire sur un trigger spécifique, il est nécessaire de connaître sa valeur exacte.

Exemple avec un marqueur de page :

Exemple de données ajoutées dans la console par la méthode personnalisée « callback() » :

Vous avez la possibilité de vous inscrire sur une liste de triggers appartenant à une même catégorie.

Exemple de triggers appartenant à une même catégorie :

Nous avons ici deux triggers déclenchés respectivement lorsque le hit a été correctement envoyé ou lorsque ce dernier est en échec (erreur réseau, etc.).

Le système de gestion des triggers permet de s’inscrire sur une liste de triggers appartenant à une même catégorie grâce à l’utilisation du caractère spécial « * ».

Dans cet exemple, l’inscription sur le trigger ‘Tracker:Hit:Sent:*’ permettra d’ajouter des informations dans la console pour savoir si le hit est correctement envoyé ou si il est en erreur.

Par extension vous pouvez vous inscrire sur l’ensemble des triggers en utilisant directement « * » en tant que libellé.

 

Création d’un trigger

Le Tracker dispose d’une méthode « emit() » permettant de générer un trigger. Elle prend deux paramètres en entrée :

  • trigger : Libellé du trigger à émettre ; obligatoire
  • data : Données que vous souhaitez transmettre.

Exemple complet avec un marqueur de page (utilisation des fonctions « emit() » et « onTrigger() ») :

Exemple de données ajoutées dans la console par la méthode personnalisée « callback() » :

 

Les triggers existants

 

Description

Notre bibliothèque génère par défaut une série de triggers fournissant un ensemble de données liées à leur contexte spécifique d’exécution et sur lesquels il est possible de s’inscrire.

Certains triggers ne sont accessibles que dans la version debug du smartTag.

Les triggers peuvent être d’origine technique c’est-à-dire en relation directe avec le fonctionnement du Tracker.

  • Chaque helper (méthode de marquage d’un plugin) crée un trigger selon le format ‘[PluginName]:[Object]:[Helper]‘.
  • Certaines valeurs de marquage sont vérifiées et des erreurs peuvent être levées dans le cas où elles ne correspondent pas au format attendu. Un trigger au format ‘[PluginName]:[Object]:[Helper]:[Property]:Error‘ sera levé.
  • Certains plugins procèdent à une vérification de marquage au moment de l’envoi de hit par la méthode « dispatch() ». Ils génèrent des triggers de la forme ‘[PluginName]:onDispatch:Error‘ dans le cas où une erreur ou un avertissement est levé. Il s’agit des plugins NuggAd, SalesTracker et TvTracking.
  • Certains plugins envoient des informations détaillées au moment de leur initialisation, via un trigger au format ‘[PluginName]:Ready‘. C’est le cas notamment des plugins ClientSideUserId, ContextVariables, IdentifiedVisitor, InternalSearch, Offline et OnSiteAds.
 

Liste des triggers par fonctionnalités

 

Cet article vous a-t-il été utile ?
Oui
Non
Dernière mise à jour : 08/12/2017