Types de conditions pour les extensions web

Remarque : Adobe Experience Platform Launch est en train d’être rebaptisé en tant que suite de technologies de collecte de données dans Experience Platform. Ces modifications seront appliquées à l’ensemble de la documentation du produit au cours des prochaines semaines. Reportez-vous au document suivant pour une référence consolidée des modifications terminologiques.

Un module de bibliothèque de type de condition a un seul objectif : évaluer si quelque chose est vrai ou faux. Ce qu’il évalue ne dépend que de vous.

REMARQUE

Ce document couvre les types de conditions pour les extensions web. Si vous développez une extension Edge, reportez-vous au guide sur les types de condition pour les extensions Edge à la place.

Ce document suppose que vous connaissez les modules de bibliothèque et leur intégration dans les extensions de Platform Launch. Si vous avez besoin d’une introduction, consultez la présentation sur le formatage des modules de bibliothèque avant de revenir à ce guide.

Par exemple, si vous souhaitez évaluer si l’utilisateur se trouve sur l’hôte example.com, votre module peut se présenter comme suit :

module.exports = function(settings) {
  return document.location.hostname === 'example.com';
};

Maintenant, imaginez une situation où vous souhaitez rendre le nom d’hôte configurable par l’utilisateur Adobe Experience Platform Launch. Vous pouvez autoriser l’utilisateur à saisir un nom d’hôte, puis enregistrer ce dernier dans l’objet settings. L’objet pourrait ressembler à ceci :

{
  "hostname": "example.com"
}

Pour fonctionner sur le nom d’hôte défini par l’utilisateur, votre module doit changer de la façon suivante :

module.exports = function(settings) {
  return document.location.hostname === settings.hostname;
};

Données contextuelles de l’événement

Un second argument qui contient des informations contextuelles concernant l’événement qui a déclenché la règle est transmis à votre module. Ces informations peuvent être utiles dans certains cas et peuvent être consultées comme suit :

module.exports = function(settings, event) {
  // event contains information regarding the event that fired the rule
};

L’objet event doit contenir les propriétés suivantes :

Propriété Description
$type Chaîne décrivant le nom de l’extension et le nom de l’événement, joints à l’aide d’un point. Par exemple : youtube.play.
$rule Objet contenant des informations sur la règle en cours d’exécution. L’objet doit contenir les sous-propriétés suivantes :
  • id : ID de la règle en cours d’exécution.
  • name : nom de la règle en cours d’exécution.

L’extension fournissant le type d’événement qui a déclenché la règle peut éventuellement ajouter toute autre information utile à cet objet event.

Sur cette page