Présentation du développement d’extension

REMARQUE

Adobe Experience Platform Launch est désormais une suite de technologies destinées à la collecte de données dans Adobe Experience Platform. Plusieurs modifications terminologiques ont par conséquent été apportées à la documentation du produit. Reportez-vous au document suivant pour consulter une référence consolidée des modifications terminologiques.

L’un des principaux objectifs des balises dans Adobe Experience Platform est de créer un réseau ouvert où les ingénieurs extérieurs à Adobe peuvent exposer des fonctionnalités supplémentaires sur leurs sites web et applications mobiles. Les extensions de balises permettent cela. Une fois qu’une extension a été installée sur une propriété de balise, cette fonctionnalité d’extension est alors disponible auprès de tous les utilisateurs de la propriété.

Ce document décrit les composants principaux d’une extension et fournit des liens vers d’autres documents pour vous guider dans le processus de développement d’extensions.

Structure de l’extension

Une extension est un répertoire de fichiers. Plus précisément, une extension se compose d’un fichier manifeste, de modules de bibliothèque et de vues.

Fichier de manifeste

Un fichier manifeste (extension.json) doit exister à la racine du répertoire. Ce fichier décrit la composition de l’extension et l’emplacement de certains fichiers dans le répertoire. Le fonctionnement du manifeste est similaire à celui d’un fichier package.json dans un projet npm.

Modules Bibliothèque

Les modules de bibliothèque sont les fichiers qui décrivent les différents composants fournis par une extension (en d’autres termes, la logique à émettre dans la bibliothèque d’exécution de balise). Le contenu de chaque fichier de module de bibliothèque doit respecter les normes du module CommonJS.

Par exemple, si vous créez un type d’action appelé « Envoyer une balise », vous devez disposer d’un fichier contenant la logique qui envoie la balise. Si vous utilisez JavaScript, le fichier peut être appelé sendBeacon.js. Le contenu de ce fichier sera émis dans la bibliothèque d’exécution de balise.

Vous pouvez placer les fichiers de module de bibliothèque n’importe où dans le répertoire d’extension, à condition que vous décriviez leur emplacement dans extension.json.

Vues

Une vue est un fichier HTML pouvant être chargé dans un iframeélément dans l’application de balises, en particulier via l’interface utilisateur de la collecte de données. La vue doit inclure un script fourni par l’extension et se conformer à une petite API pour communiquer avec l’application.

Le plus important fichier de vue de toute extension est sa configuration. Pour plus d’informations, consultez la section consacrée aux configurations d’extension.

Il n’y a aucune restriction quant aux bibliothèques utilisées dans vos vues. En d’autres termes, vous pouvez utiliser jQuery, Underscore, React, Angular, Bootstrap ou d’autres. Toutefois, il est toujours recommandé de faire en sorte que votre extension ait un aspect similaire à celui de l’interface utilisateur de la collecte de données.

Il est recommandé de placer tous les fichiers liés aux vues (HTML, CSS, JavaScript) dans un seul sous-répertoire isolé des fichiers du module Bibliothèque. Dans extension.json, vous pouvez décrire l’emplacement de ce sous-répertoire de vue. Platform servira alors ce sous-répertoire (et uniquement celui-ci) à partir de ses serveurs web.

Composants de bibliothèque

Chaque extension définit un ensemble de fonctionnalités. Ces fonctionnalités sont implémentées en étant incluses dans une bibliothèque déployée sur votre site web ou votre application. Les bibliothèques sont une collection de composants individuels, notamment des conditions, des actions, des éléments de données, etc. Chaque composant de bibliothèque est un élément de code réutilisable (fourni par une extension) émis dans l’exécution de balise.

Selon que vous développez une extension web ou une extension Edge, les types de composants disponibles et leur utilisation diffèrent. Reportez-vous aux sous-sections ci-dessous pour une présentation des composants disponibles pour chaque type d’extension.

Composants pour les extensions web

Dans les extensions web, les règles sont déclenchées par des événements qui peuvent alors exécuter des actions spécifiques si un ensemble donné de conditions est satisfait. Consultez la présentation du flux de module dans les extensions web pour en savoir davantage.

Outre les modules principaux fournis par Adobe, vous pouvez définir les composants de bibliothèque suivants dans vos extensions web :

REMARQUE

Pour plus d’informations sur le format requis pour l’implémentation des composants de bibliothèque dans les extensions web, consultez la présentation du format de module.

Composants pour les extensions Edge

Dans les extensions Edge, les règles sont déclenchées par des contrôles de condition qui exécutent ensuite des actions spécifiques si ces contrôles réussissent. Pour plus d’informations, consultez la présentation du flux d’extensions Edge.

Vous pouvez définir les composants de bibliothèque suivants dans vos extensions Edge :

REMARQUE

Pour plus d’informations sur le format requis pour l’implémentation des modules de bibliothèque dans les extensions Edge, consultez la présentation du format de module.

Configuration d’extension

La configuration d’une extension fait référence à la manière dont elle rassemble les paramètres globaux d’un utilisateur. La configuration se compose d’un composant d’affichage qui exporte et émet des paramètres dans la bibliothèque d’exécution de balise en tant qu’objet simple.

Prenons l’exemple d’une extension qui permet à l’utilisateur d’envoyer une balise à l’aide d’une action « Envoyer la balise », la balise devant toujours contenir un identifiant de compte. Plutôt que de demander un identifiant de compte aux utilisateurs chaque fois qu’ils configurent une action « Envoyer la balise », l’extension ne doit demander l’identifiant de compte qu’une fois depuis la vue de configuration de l’extension. Chaque fois qu’une balise doit être envoyée, l’action « Envoyer la balise » peut extraire l’identifiant de compte de la configuration de l’extension et l’ajouter à la balise.

Lorsque les utilisateurs installent une extension sur une propriété dans l’interface utilisateur, la vue de configuration de l’extension leur est présentée. Ils doivent alors la compléter pour terminer l’installation.

Pour en savoir plus, consultez le guide sur les configurations d’extension.

Envoi d’extensions

Une fois la création de votre extension terminée, vous pouvez l’envoyer pour qu’elle soit répertoriée dans le catalogue d’extensions de Platform. Pour plus d’informations, consultez la présentation du processus d’envoi des extensions.

Sur cette page