Intégrer Experience Platform Web SDK pour traiter les données de consentement des clients

Adobe Experience Platform Web SDK 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 changement de consentement se produit.

Le SDK n’est pas compatible avec les CMP prêts à l’emploi. C’est à vous de déterminer comment intégrer SDK à votre site web, d’être attentif aux modifications apportées au consentement dans la CMP et d’appeler la commande appropriée. Ce document fournit des instructions générales sur l’intégration de votre CMP à Experience Platform Web SDK.

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 de 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 à la documentation suivante au lieu de ce guide :

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

Configurer un flux de données

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

Après avoir créé un flux de données ou sélectionné un flux de données 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 invites supplémentaires pour terminer la configuration.

Installation et configuration d’Experience Platform Web SDK

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 Experience Platform Web SDK que vous déploierez finalement 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 Experience Platform SDK dans la liste des extensions disponibles.

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

Sélectionnez Enregistrer 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 pour représenter 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 définir différentes valeurs par défaut en fonction de l’utilisateur, par exemple 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 implémenter 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 suivre les étapes suivantes à la place :

Pour créer un élément de données dans l’interface utilisateur, sélectionnez Éléments de données dans le volet de navigation de gauche, puis sélectionnez Ajouter un élément de données pour accéder à la boîte de dialogue de création d’é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 Web SDK. Dans 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éployez l’extension sur votre site web

Une fois la configuration de l’extension terminée, elle peut être intégrée à votre site web. Pour obtenir des informations détaillées sur le déploiement de la version de bibliothèque mise à jour🔗 consultez le guide de publication dans la documentation sur les balises.

Exécution de commandes de modification du consentement commands

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

La commande setConsent effectue deux actions :

Quand appeler setConsent

Il existe deux scénarios dans lesquels setConsent doit être appelé sur votre site :

syntaxe setConsent

La commande setConsent exige un objet de payload 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 Adobe sont affichés dans l’exemple d’appel de 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 peut être utilisée comme rappel dans un écouteur d’événement ou un hook 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 Experience Platform Web SDK
  alloy("setConsent", {
    consent: [{
      standard: "Adobe",
      version: "2.0",
      value: consentXDM
    }]
  });
});

Gestion des réponses SDK

Toutes les commandes Experience 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 de messages de confirmation au client. Voir Réponses des commandes pour plus d’informations.

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

Étapes suivantes

En suivant ce guide, vous avez configuré l’extension Experience Platform Web SDK pour envoyer des données de consentement à Experience Platform. Pour obtenir des conseils sur le test de votre implémentation, reportez-vous à la documentation de la norme de consentement que vous implémentez :