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

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

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

Prerequisiti

Questa esercitazione presuppone che tu abbia già determinato come generare i dati di consenso all’interno di CMP e che tu abbia creato un set di dati contenente i 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 configurare l’SDK utilizzando l’estensione tag nell’interfaccia utente Raccolta dati. Se non desideri utilizzare l'estensione e preferisci incorporare direttamente sul tuo sito la versione autonoma dell'SDK, consulta i seguenti documenti invece di questa guida:

I passaggi di installazione in questa guida richiedono una comprensione efficace delle estensioni dei tag e della loro installazione nelle applicazioni web. Per ulteriori informazioni, consulta la seguente documentazione:

Configurare un datastream

Affinché l’SDK invii dati ad Experience Platform, devi prima configurare un datastream. Nell’interfaccia utente Raccolta dati, seleziona Datastreams nel menu di navigazione a sinistra.

Dopo aver creato un nuovo datastream o aver selezionato uno esistente da modificare, seleziona il pulsante di attivazione accanto a Adobe Experience Platform. Quindi, utilizza i valori elencati di seguito per completare il modulo.

Campo Datastream Valore
Sandbox Il nome della piattaforma sandbox che contiene la connessione in streaming e i set di dati richiesti per impostare il datastream.
Ingresso streaming Una connessione in streaming valida, ad Experience Platform. Se non disponi di un'entrata in streaming, consulta l'esercitazione su creazione di una connessione in streaming .
Set di dati evento Un set di dati XDM ExperienceEvent che prevedi di inviare dati evento all’utilizzo dell’SDK. Anche se devi fornire un set di dati evento per creare un archivio dati Platform, tieni presente che i dati di consenso inviati tramite eventi non sono rispettati nei flussi di lavoro di applicazione a valle.
Set di dati del profilo Il set di dati abilitato Profile con i campi di consenso dei clienti creati before.

Al termine, seleziona Salva nella parte inferiore dello schermo e continua a seguire tutte le istruzioni aggiuntive per completare la configurazione.

Installare e configurare l’SDK per web di Platform

Dopo aver creato un datastream come descritto nella sezione precedente, devi configurare l’estensione Platform Web SDK che distribuirai in ultima analisi 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 sotto l'estensione Platform SDK all'interno dell'elenco delle estensioni disponibili.

Durante la configurazione dell'SDK, in Configurazioni bordi, seleziona il datastream 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 predefinito di consenso per la raccolta dati (collect.val) per i tuoi utenti. Questo può essere utile se desideri 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:

  1. Determinare la regione dell’utente sul server web.
  2. Prima del tag script (codice di incorporamento) sulla pagina web, esegui il rendering di un tag script separato che imposta una variabile adobeDefaultConsent in base all’area dell’utente.
  3. Imposta un elemento dati che utilizza la variabile JavaScript adobeDefaultConsent e utilizza questo elemento dati come valore di consenso predefinito per l’utente.

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

  1. Gestisci l’evento "CMP loaded" sulla pagina.
  2. Nel gestore eventi, imposta una variabile adobeDefaultConsent basata sull'area dell'utente, quindi carica lo script della libreria di tag utilizzando JavaScript.
  3. Imposta un elemento dati che utilizza la variabile JavaScript adobeDefaultConsent e utilizza questo elemento dati come valore di consenso predefinito per l’utente.

Per creare un elemento dati nell’interfaccia utente Raccolta dati, seleziona Elementi dati nel menu di navigazione a sinistra, quindi seleziona Aggiungi elemento dati per accedere alla finestra di dialogo per la creazione dell’elemento dati.

Da qui, devi creare un elemento dati JavaScript Variable basato su adobeDefaultConsent. Al termine, seleziona Salva.

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

Distribuire l'estensione sul sito web

Dopo aver configurato l'estensione, questa può essere integrata nel sito web. Per informazioni dettagliate su come distribuire la build della libreria aggiornata, consulta la guida alla pubblicazione nella documentazione sui tag .

Esecuzione di comandi di modifica del consenso

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

IMPORTANTE

Il comando setConsent aggiorna solo i dati direttamente nell'archivio profili e non invia dati al Data Lake.

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

  1. Quando il consenso viene caricato sulla pagina (in altre parole, a ogni caricamento di pagina)
  2. Come parte di un hook CMP o listener di eventi che rileva le modifiche nelle impostazioni di consenso
NOTA

Per un’introduzione alla sintassi comune per i comandi SDK di Platform, consulta il documento relativo all’ esecuzione di comandi.

Il comando setConsent prevede due argomenti:

  1. Una stringa che indica il tipo di comando (in questo caso, "setConsent")
  2. Un oggetto payload contenente una singola proprietà di tipo array: consent. La matrice 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 di 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: "2020-10-12T15:52:25+00:00"
      }
    }
  }]
});
Payload, proprietà Descrizione
standard Lo standard di consenso in uso. Per lo standard di Adobe, questo valore deve essere impostato su Adobe.
version Il numero di versione dello standard di consenso indicato in standard. Questo valore deve essere impostato su 2.0 per l’elaborazione del consenso standard di Adobe.
value Le informazioni di consenso aggiornate del cliente, fornite come oggetto XDM conforme alla struttura dei campi di consenso del set di dati abilitati per il profilo.
NOTA

Se utilizzi altri standard di consenso insieme a Adobe (ad esempio IAB TCF), puoi aggiungere altri oggetti alla matrice consent per ogni standard. Ogni oggetto deve contenere i valori appropriati per standard, version e value per lo standard di consenso che rappresenta.

Il seguente JavaScript fornisce un esempio di una funzione che gestisce le modifiche delle preferenze di consenso su un sito web, che può essere utilizzata come callback in un listener di eventi o 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 ottenere una logica aggiuntiva, ad esempio per visualizzare messaggi di conferma al cliente. Consulta la sezione sulla gestione del successo o dell'errore nella guida sull'esecuzione dei comandi SDK per esempi specifici.

Dopo aver effettuato con successo le chiamate setConsent con l’SDK, puoi utilizzare il visualizzatore del profilo nell’interfaccia utente di Platform per verificare se i dati sono di destinazione nell’archivio profili. Per ulteriori informazioni, consulta la sezione su come visualizzare i profili per identità .

Passaggi successivi

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

In questa pagina