Tutoriel - Comment construire une destination serveur avec le JS sandbox

Exemple de destination créée avec le sandbox J0 dans le Destination Builder

Le Destination builder vous permet de créer des destinations server-side personnalisées en utilisant du server-side javascript (aka Node.js), mais avec un sous-ensemble simplifié de Node.js : le Javascript Sandbox.

Ce tutoriel vous apprendra les bases pour écrire votre propre template de destination server-side et le publier dans votre(vos) propre(s) catalogue(s) de destinations.

Une destination server-side reçoit des données d'événements entrantes depuis vos sources, les transforme, et envoie les données où vous le souhaitez. Tant que l'outil destination accepte des requêtes HTTP, il peut accepter des données depuis une destination server-side.

Exemple basique : Slack

Dans ce tutoriel, vous allez créer une destination qui envoie des données d'événements à Slack en utilisant un seul webhook_url paramètre. Slack est un outil de messagerie et de collaboration qui supporte l'intégration par webhook. Le cas d'utilisation peut être : « Je veux recevoir sur un canal Slack un message chaque fois qu'un événement "sign_up" est reçu »

Configuration de la destination

Pour commencer, créez le template de destination en naviguant vers la Destination section du menu et en cliquant New dans la Destination Builder section. Ensuite, donnez à votre destination un nom, un logo, une catégorie et une description.

Puis, allez dans la Fields section de l'éditeur pour ajouter des options de configuration pour votre destination. Vous avez trois options pour construire votre destination :

Total Configuration: Créer un champ de configuration pour chaque paramètre, permettant à l'utilisateur de tout définir explicitement.
No Configuration: Ne pas inclure d'options pour configurer la destination. À la place, toutes les données sont prises directement depuis l'événement.
Some Configuration: Inclure des champs pour certains paramètres mais pas pour d'autres.

Bien qu'avoir un champ pour chaque paramètre soit flexible, cela peut entraîner beaucoup de travail dupliqué pour l'utilisateur. Par conséquent, il est préférable que le code gère la configuration des données non ambiguës et universelles. Par exemple, si vous construisez une destination analytics, vous ne voulez pas demander à l'utilisateur de saisir l'URL de l'API analytics à chaque fois qu'il configurera cette destination. Vous préférerez hardcoder l'URL dans votre code plutôt que de demander à l'utilisateur de la saisir. D'un autre côté, si vous construisez votre destination pour obtenir les données uniquement depuis l'événement, sans ajouter de champ dans les paramètres pour l'utilisateur, l'utilisateur ne pourra pas personnaliser la destination. Par exemple, si la destination nécessite un token, ce token peut varier selon le contexte (prod, dev, pays...), donc si vous hardcodez un token dans le code... Ou, peut-être que les hypothèses faites par la destination concernant la structure des données d'événements entrantes ne correspondent pas à la réalité pour des événements/propriétés personnalisés. Dans les deux scénarios, l'utilisateur est incapable de continuer.

En conclusion, certaines données doivent toujours être extraites de l'événement tandis que d'autres données doivent être configurées par l'utilisateur. C'est à vous de décider afin que le résultat final soit convivial.

Dans le cas de notre destination Slack, nous souhaitons ajouter un champ afin que l'utilisateur puisse copier/coller son webhook url Slack. Nous choisissons un champ de texte comme ceci :

Maintenant, nous pouvons aller à l'onglet Code et commencer à écrire le code de notre template de destination.

Comment obtenir les données dans votre code ?

Vous pouvez vouloir obtenir 2 types de données :

données saisies par l'utilisateur (champs remplis dans l'onglet settings)
données d'événement (certaines propriétés de votre événement que vous souhaitez envoyer au partenaire)

1. Données saisies par l'utilisateur

Toutes les données remplies dans les différents champs par l'utilisateur sont accessibles dans l'objet data dans votre code. Dans votre exemple, nous avons un seul champ nommé "url", et la valeur que l'utilisateur final saisira sera accessible via data.url

2. Données d'événement

Vous souhaiterez obtenir certaines propriétés de vos événements pour les envoyer au serveur du partenaire. Vous pouvez utiliser l'une de ces 2 fonctions pour obtenir vos données d'événement :

getAllEventData() => renverra un objet contenant toutes les propriétés de l'événement
getEventData(myProperty) => renverra la valeur d'une propriété spécifique dans votre événement

Implémentation de la destination

Après avoir configuré la destination, vous pouvez procéder à l'implémentation de son comportement dans le Javascript Sandbox.

L'exemple Slack nécessite les quatre étapes suivantes :

Obtenir la webhook URL depuis les paramètres de la destination.
Créer le message qui sera envoyé à l'API Slack.
Envoyer une requête au serveur de collecte Slack pour transmettre les données.
Tester votre code, pour s'assurer que la destination se comportera correctement en production.

Il est important de noter que le code ne doit pas effectuer certaines actions, car elles relèvent de la responsabilité de l'onglet filter. Plus précisément, le code ne doit pas pas:

Gérer le consentement pour déterminer si l'événement doit être envoyé ou non. C'est la responsabilité du menu déroulant de catégorie de consentement dans l'onglet Filter . Il est important de ne pas outrepasser cette fonctionnalité, afin de ne pas casser les rapports de Data Governance
Analyser les propriétés de l'événement pour déterminer si cela doit être exécuté. N'oubliez pas que l'utilisateur pourra choisir dans l'onglet Filter tab quel(s) événement(s) seront envoyés à la destination. Vous pouvez souhaiter restreindre votre code à certains types d'événements, mais vous ne devez pas supprimer la possibilité pour l'utilisateur de filtrer ses événements sur certaines propriétés (ex : l'utilisateur peut vouloir n'envoyer que les événements dont la propriété "country" est égale à "UK")
Retourner une erreur globale (data.onFailure()) lorsque certains types d'événements ne conviennent pas à la destination. Préférez utiliser une erreur silencieuse avec data.onFailure({ status: 'filtered'})

Si vous créez un template de destination qui effectue l'une de ces actions, cela peut causer de la confusion pour les utilisateurs de votre destination. Par exemple, une destination qui envoie des erreurs à Event Delivery chaque fois que des événements non pris en charge sont détectés peut entraîner des avertissements inutiles dans les rapports Health. Cela violerait les attentes des utilisateurs concernant le comportement attendu de la destination.

Dans cet esprit, voici un exemple annoté de l'implémentation du tag dans le Javascript sandbox :

const sendHttpRequest = require('sendHttpRequest');
const getAllEventData = require('getAllEventData');

//Nous récupérons les données de l'événement (toutes les propriétés de l'événement)
const eventModel = getAllEventData();

if (eventModel.event_name == 'sign_up') {
    //récupérer l'url depuis ce que l'utilisateur a écrit dans le champ webhook url
    //Les données de Settings arrivent dans le code sandboxé comme une 
    //variable prédéfinie appelée 'data'.
    const url = data.url; 
    //Construire le corps du message, concaténant le nom de l'utilisateur dans la phrase à envoyer
    const postBody = '{"text": "' + eventModel.user.firstname + ' ' + eventModel.user.lastname + 'just signed up!"}';

    // Envoyer les données au serveur Slack
    //La fonction sendHttpRequest prend une URL, un callback de résultat, éventuellement un header, une méthode et un body.
    sendHttpRequest(url, (statusCode, headers, body) => {
        if (statusCode >= 200 && statusCode < 300) {
            //envoyer une information de succès au rapport Event Delivery
            data.onSuccess();
        } else {
           //envoyer une erreur au rapport Event Delivery
            data.onFailure();
        }
    }, { headers: { 'Content-Type': 'application/json' }, method: 'POST', timeout: 1000 }, postBody);
}
else {
    //échec silencieux qui n'enverra pas d'erreur dans le rapport Event Delivery
    data.onFailure({ status: 'filtered', detail: 'unsupported_event' });
}

Notez que la data.onSuccess() est obligatoire dans votre code. Les data.onSuccess()et data.onFailure() valeurs indiquent à la plateforme quand la destination a terminé ou échoué sa tâche, et sont ensuite utilisées comme signal pour Event Delivery dashboard et Destination Live Invent Inspector

PrécédentConstructeur de destination Javascript SuivantHelpers javascript côté serveur

Mis à jour il y a 1 an

Ce contenu vous a-t-il été utile ?