Integrare Platform Web SDK per elaborare i dati sul consenso dei clienti

Adobe Experience Platform Web SDK consente di recuperare i segnali di consenso del cliente generati dalle piattaforme di gestione del consenso (CMP, Consent Management Platforms) e di inviarli a Adobe Experience Platform ogni volta che si verifica un evento di modifica del consenso.

L'SDK non si interfaccia con CMP predefiniti. Sta a te determinare come integrare l’SDK nel tuo sito web, ascoltare le modifiche del consenso nella CMP e chiamare il comando appropriato. Questo documento fornisce indicazioni generali su come integrare la CMP con Platform Web SDK.

Prerequisiti prerequisites

Questa esercitazione presuppone che tu abbia già determinato come generare i dati sul consenso all’interno della tua CMP e che sia stato creato un set di dati contenente campi di consenso conformi allo standard Adobe o allo standard IAB Transparency and Consent Framework (TCF) 2.0. Se non hai ancora creato questo set di dati, consulta le seguenti esercitazioni prima di tornare a questa guida:

Questa guida segue il flusso di lavoro per la configurazione dell’SDK utilizzando l’estensione tag nell’interfaccia utente. Se non desideri utilizzare l'estensione e preferisci incorporare direttamente la versione autonoma dell'SDK sul tuo sito, consulta i seguenti documenti invece di questa guida:

I passaggi di installazione descritti in questa guida richiedono una buona conoscenza delle estensioni tag e del modo in cui vengono installate nelle applicazioni web. Per ulteriori informazioni, consulta la seguente documentazione:

Configurare un flusso di dati

Affinché l’SDK possa inviare dati ad Experience Platform, devi prima configurare uno stream di dati. Nell'interfaccia utente di Data Collection o Experience Platform, seleziona Datastreams nell'area di navigazione a sinistra.

Dopo aver creato un nuovo flusso di dati o averne selezionato uno esistente da modificare, seleziona il pulsante di attivazione/disattivazione accanto a Adobe Experience Platform. Quindi, utilizzare i valori elencati di seguito per completare il modulo.

Al termine, seleziona Salva nella parte inferiore della schermata e continua seguendo eventuali altre richieste per completare la configurazione.

Installare e configurare Platform Web SDK

Dopo aver creato un flusso di dati come descritto nella sezione precedente, devi configurare l’estensione Platform Web SDK che infine distribuirai sul sito. Se l'estensione SDK non è installata nella proprietà tag, seleziona Estensioni nel menu di navigazione a sinistra, seguito dalla scheda Catalogo. Quindi, seleziona Installa nell'estensione Platform SDK all'interno dell'elenco delle estensioni disponibili.

Durante la configurazione dell'SDK, in Configurazioni Edge, seleziona lo stream di dati creato nel passaggio precedente.

Seleziona Salva per installare l'estensione.

Creare un elemento dati per impostare il consenso predefinito

Con l'estensione SDK installata, puoi creare un elemento dati che rappresenti il valore di consenso predefinito per la raccolta dati (collect.val) per i tuoi utenti. Questo può essere utile se si desidera avere valori predefiniti diversi a seconda dell'utente, ad esempio pending per gli utenti dell'Unione Europea e in per gli utenti nordamericani.

In questo caso d’uso, puoi implementare quanto segue per impostare il consenso predefinito in base all’area geografica dell’utente:

Se l’area geografica dell’utente è determinata da una CMP, puoi utilizzare i seguenti passaggi:

Per creare un elemento dati nell'interfaccia utente, seleziona Elementi dati nell'area di navigazione a sinistra, quindi seleziona Aggiungi elemento dati per accedere alla finestra di dialogo di creazione dell'elemento dati.

Da qui è necessario creare un elemento dati Variabile JavaScript basato su adobeDefaultConsent. Al termine, seleziona Salva.

Una volta creato l’elemento dati, torna alla pagina di configurazione dell’estensione Web SDK. Nella sezione Privacy, seleziona Fornito dall'elemento dati, quindi utilizza la finestra di dialogo fornita per selezionare l'elemento dati di consenso predefinito creato in precedenza.

Distribuire l’estensione sul sito web

Una volta completata la configurazione dell'estensione, puoi integrarla nel sito web. Per informazioni dettagliate su come distribuire la build della libreria aggiornata, consulta la guida alla pubblicazione nella documentazione dei tag.

Esecuzione di comandi per la modifica del consenso commands

Dopo aver integrato l’estensione SDK nel sito web, puoi iniziare a utilizzare il comando Platform Web SDK setConsent per inviare i dati sul consenso a Platform.

Il comando setConsent esegue due azioni:

Quando chiamare setConsent

Esistono due scenari in cui setConsent deve essere chiamato sul sito:

Sintassi setConsent

Il comando setConsent prevede un oggetto payload contenente una singola proprietà di tipo array: consent. L'array consent deve contenere almeno un oggetto che fornisca i campi di consenso richiesti per lo standard Adobe.

I campi di consenso richiesti per lo standard Adobe sono mostrati nella seguente chiamata di esempio setConsent:

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"
      }
    }
  }]
});

Il seguente JavaScript fornisce un esempio di funzione che gestisce le modifiche delle preferenze di consenso su un sito web, che può essere utilizzato come callback in un listener di eventi o in 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 Platform Web SDK
  alloy("setConsent", {
    consent: [{
      standard: "Adobe",
      version: "2.0",
      value: consentXDM
    }]
  });
});

Gestione delle risposte SDK

Tutti i comandi Platform SDK restituiscono promesse che indicano se la chiamata è riuscita o meno. Puoi quindi utilizzare queste risposte per una logica aggiuntiva, ad esempio per visualizzare i messaggi di conferma al cliente. Per ulteriori informazioni, vedere Risposte ai comandi.

Dopo aver effettuato correttamente setConsent chiamate con l'SDK, puoi utilizzare il visualizzatore di profili nell'interfaccia utente di Platform per verificare se i dati vengono inviati nell'archivio profili. Per ulteriori informazioni, consulta la sezione su esplorazione dei profili per identità.

Passaggi successivi

Seguendo questa guida, hai configurato l’estensione Platform Web SDK per inviare i dati sul consenso ad Experience Platform. Per informazioni su come testare l’implementazione, consulta la documentazione dello standard di consenso che stai implementando: