Intégrer le SDK Web Platform pour traiter les données de consentement du client

Le SDK Web de Adobe Experience Platform vous permet de récupérer les signaux de consentement des clients générés par les plateformes de gestion du consentement (CMP) et de les envoyer à Adobe Experience Platform chaque fois qu’un événement de modification du consentement se produit.

Le SDK n’interface pas de CMP prêtes à l’emploi. C’est à vous de déterminer comment intégrer le SDK à votre site web, écouter les modifications apportées au consentement dans la CMP et appeler la commande appropriée. Ce document fournit des instructions générales sur la manière d’intégrer votre CMP au SDK Web de Platform.

Conditions préalables prerequisites

Ce tutoriel suppose que vous avez déjà déterminé comment générer des données de consentement dans votre CMP et que vous avez créé un jeu de données contenant des champs de consentement conformes à la norme Adobe ou à la norme IAB Transparency and Consent Framework (TCF) 2.0. Si vous n’avez pas encore créé ce jeu de données, reportez-vous aux tutoriels suivants avant de revenir à ce guide :

Ce guide suit le processus de configuration du SDK à l’aide de l’extension de balise dans l’interface utilisateur. Si vous ne souhaitez pas utiliser l’extension et que vous préférez incorporer directement la version autonome du SDK sur votre site, reportez-vous aux documents suivants au lieu de ce guide :

Les étapes d’installation de ce guide nécessitent une compréhension pratique des extensions de balise et de leur installation dans les applications web. Pour plus d’informations, reportez-vous à la documentation suivante :

Configuration d’un flux de données

Pour que le SDK envoie des données à l’Experience Platform, vous devez d’abord configurer un flux de données. Dans l’interface utilisateur de la collecte de données ou l’interface utilisateur Experience Platform, sélectionnez Datastreams dans le volet de navigation de gauche.

Après avoir créé un nouveau flux de données ou sélectionné un flux existant à modifier, cliquez sur le bouton de basculement en regard de Adobe Experience Platform. Ensuite, utilisez les valeurs répertoriées ci-dessous pour remplir le formulaire.

Lorsque vous avez terminé, sélectionnez Enregistrer en bas de l’écran et continuez à suivre les autres invites pour terminer la configuration.

Installation et configuration du SDK Web de Platform

Une fois que vous avez créé un flux de données comme décrit dans la section précédente, vous devez configurer l’extension SDK Web Platform que vous allez déployer sur votre site. Si l’extension SDK n’est pas installée sur votre propriété de balise, sélectionnez Extensions dans le volet de navigation de gauche, suivi de l’onglet Catalogue . Sélectionnez ensuite Installer sous l’extension du SDK Platform dans la liste des extensions disponibles.

Lors de la configuration du SDK, sous Configurations d’Edge, sélectionnez la banque de données que vous avez créée à l’étape précédente.

Sélectionnez Save pour installer l’extension.

Créer un élément de données pour définir le consentement par défaut

Une fois l’extension SDK installée, vous avez la possibilité de créer un élément de données représentant la valeur de consentement de collecte de données par défaut (collect.val) pour vos utilisateurs. Cela peut s’avérer utile si vous souhaitez avoir différentes valeurs par défaut en fonction de l’utilisateur, telles que pending pour les utilisateurs de l’Union européenne et in pour les utilisateurs d’Amérique du Nord.

Dans ce cas d’utilisation, vous pouvez mettre en oeuvre les éléments suivants pour définir le consentement par défaut en fonction de la région de l’utilisateur :

Si la région de l’utilisateur est déterminée par une CMP, vous pouvez plutôt utiliser les étapes suivantes :

Pour créer un élément de données dans l’interface utilisateur, sélectionnez Data Elements dans le volet de navigation de gauche, puis sélectionnez Add Data Element pour accéder à la boîte de dialogue de création de l’élément de données.

À partir de là, vous devez créer un élément de données Variable JavaScript basé sur adobeDefaultConsent. Lorsque vous avez terminé, cliquez sur Enregistrer.

Une fois l’élément de données créé, revenez à la page de configuration de l’extension SDK Web. Sous la section Confidentialité, sélectionnez Fourni par l’élément de données et utilisez la boîte de dialogue fournie pour sélectionner l’élément de données de consentement par défaut que vous avez créé précédemment.

Déployer l’extension sur votre site web

Une fois que vous avez terminé de configurer l’extension, elle peut être intégrée à votre site web. Pour plus d’informations sur le déploiement de votre version de bibliothèque mise à jour, reportez-vous au guide de publication dans la documentation sur les balises.

Exécution de commandes de changement de consentement commands

Une fois que vous avez intégré l’extension SDK à votre site web, vous pouvez commencer à utiliser la commande SDK Web Platform setConsent pour envoyer les données de consentement à Platform.

La commande setConsent effectue deux actions :

Quand appeler setConsent

Il existe deux scénarios où setConsent doit être appelé sur votre site :

Syntaxe setConsent

La commande setConsent exige un objet de charge utile contenant une seule propriété de type tableau : consent. Le tableau consent doit contenir au moins un objet qui fournit les champs de consentement requis pour la norme Adobe.

Les champs de consentement requis pour la norme d’Adobe sont affichés dans l’exemple d’appel setConsent suivant :

alloy("setConsent", {
  consent: [{
    standard: "Adobe",
    version: "2.0",
    value: {
      collect: {
        val: "y"
      },
      share: {
        val: "y"
      },
      personalize: {
        content: {
          val: "y"
        }
      },
      metadata: {
        time: "YYYY-10-12T15:52:25+00:00"
      }
    }
  }]
});

Le JavaScript suivant fournit un exemple de fonction qui gère les modifications des préférences de consentement sur un site web, qui peuvent être utilisées comme rappel dans un écouteur d’événement ou un crochet de CMP :

var setConsent = function () {

  // Retrieve the current consent data.
  var categories = getConsentData();

  // If the script is running on a consent change, generate a new timestamp.
  // If the script is running on page load, set the timestamp to when the consent values last changed.
  var now = new Date();
  var collectedAt = consentChanged ? now.toISOString() : categories.collectedAt;

  //  Map the consent values and timestamp to XDM
  var consentXDM = {
    collect: {
      val: categories.collect !== -1 ? "y" : "n"
    },
    personalize: {
      content: {
        val: categories.personalizeContent !== -1 ? "y" : "n"
      }
    },
    share: {
      val: categories.share !== -1 ? "y" : "n"
    },
    metadata: {
      time: collectedAt
    }
  };

  // Pass the XDM object to the Platform Web SDK
  alloy("setConsent", {
    consent: [{
      standard: "Adobe",
      version: "2.0",
      value: consentXDM
    }]
  });
});

Gestion des réponses du SDK

Toutes les commandes Platform SDK renvoient des promesses indiquant si l’appel a réussi ou échoué. Vous pouvez ensuite utiliser ces réponses pour une logique supplémentaire, telle que l’affichage des messages de confirmation au client. Voir Réponses de commande pour plus d’informations.

Une fois que vous avez effectué avec succès des appels setConsent avec le SDK, vous pouvez utiliser la visionneuse de profils dans l’interface utilisateur de Platform pour vérifier si les données arrivent dans la banque de profils. Pour plus d’informations, consultez la section sur la navigation des profils par identité .

Étapes suivantes

En suivant ce guide, vous avez configuré l’extension SDK Web Platform pour envoyer des données de consentement à Experience Platform. Pour plus d’informations sur le test de votre mise en oeuvre, reportez-vous à la documentation de la norme de consentement que vous mettez en oeuvre :