Types d’éléments de données pour les extensions Edge

Un module Bibliothèque de type d’élément de données a un seul objectif : récupérer un élément de données. C’est à vous de décider comment récupérer cette donnée. Par exemple, vous pouvez utiliser un type d’élément de données pour permettre aux utilisateurs Adobe Experience Platform Launch de récupérer cette donnée provenant d’un enregistrement local, d’un cookie ou d’un élément DOM.

IMPORTANT

Ce document couvre les types d’éléments de données pour les extensions web. Si vous développez une extension Edge, reportez-vous au guide sur les types d’éléments de données 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.

Supposons que vous souhaitiez autoriser les utilisateurs à récupérer cette donnée dans un élément d’enregistrement local nommé productName. Votre module peut se présenter comme suit :

module.exports = function(settings) {
  return localStorage.getItem('productName');
}

Si vous souhaitez que le nom de l’élément d’enregistrement local soit configurable par l’utilisateur de Platform Launch, vous pouvez autoriser l’utilisateur à saisir un nom, puis enregistrer le nom dans l’objet settings. L’objet pourrait ressembler à ceci :

{
  itemName: "campaignId"
}

Pour fonctionner avec le nom d’élément d’enregistrement local défini par l’utilisateur, votre module doit changer comme suit :

module.exports = function(settings) {
  return localStorage.getItem(settings.itemName);
}

Prise en charge de la valeur par défaut

Gardez à l’esprit que les utilisateurs ont la possibilité de configurer une valeur par défaut pour tout élément de données. Si votre module Bibliothèque d’éléments de données renvoie la valeur undefined ou null, il sera automatiquement remplacé par la valeur par défaut configurée par l’utilisateur pour l’élément de données.

Données contextuelles de l’événement

Si l’élément de données est récupéré suite au déclenchement d’une règle (par exemple, les éléments de données sont utilisés dans les conditions et les actions de la règle), un second argument sera transmis à votre module, contenant des informations contextuelles concernant l’événement qui a déclenché la règle. 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

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free