Integrera Platform Web SDK för att bearbeta data om kundernas samtycke

Med Adobe Experience Platform Web SDK kan du hämta kundens medgivandesignaler som genererats av CMP (Consent Management Platforms) och skicka dem till Adobe Experience Platform när en händelse om ändring av samtycke inträffar.

SDK:n samverkar inte med några CMP:er i rutan. Det är upp till dig att bestämma hur du ska integrera SDK i din webbplats, lyssna efter medgivandeändringar i CMP och anropa lämpligt kommando. Det här dokumentet innehåller allmän vägledning om hur du integrerar din CMP med Platform Web SDK.

Förhandskrav prerequisites

I den här självstudien förutsätts det att du redan har fastställt hur data för samtycke ska genereras i din CMP och att du har skapat en datauppsättning som innehåller medgivandefält som överensstämmer med Adobe-standarden eller standarden IAB Transparency and Consent Framework (TCF) 2.0. Om du inte har skapat den här datauppsättningen än, se följande självstudiekurser innan du återgår till den här guiden:

Den här guiden följer arbetsflödet för att konfigurera SDK med hjälp av taggtillägget i användargränssnittet. Om du inte vill använda tillägget och vill bädda in den fristående versionen av SDK direkt på din webbplats kan du läsa följande dokument i stället för den här handboken:

Installationsstegen i den här handboken kräver en fungerande förståelse för taggtillägg och hur de installeras i webbprogram. Mer information finns i följande dokumentation:

Konfigurera en datastream

För att SDK ska kunna skicka data till Experience Platform måste du först konfigurera ett datastream. I användargränssnittet för datainsamlingen eller användargränssnittet för Experience Platform väljer du Datastreams i den vänstra navigeringen.

När du har skapat ett nytt datastam eller valt ett befintligt som ska redigeras, markerar du växlingsknappen bredvid Adobe Experience Platform. Använd sedan värdena nedan för att fylla i formuläret.

När du är klar väljer du Save längst ned på skärmen och fortsätter att följa eventuella ytterligare uppmaningar för att slutföra konfigurationen.

Installera och konfigurera Platform Web SDK

När du har skapat ett datastream enligt beskrivningen i föregående avsnitt måste du konfigurera det Platform Web SDK-tillägg som du slutligen distribuerar på din plats. Om du inte har SDK-tillägget installerat på taggegenskapen väljer du Extensions i den vänstra navigeringen, följt av fliken Catalog. Välj sedan Install under plattforms-SDK-tillägget i listan över tillgängliga tillägg.

När du konfigurerar SDK, under Edge Configurations, markerar du datastream som du skapade i föregående steg.

Välj Save om du vill installera tillägget.

Skapa ett dataelement för att ange standardsamtycke

Med SDK-tillägget installerat kan du skapa ett dataelement som representerar standardvärdet för datainsamlingsmedgivande (collect.val) för dina användare. Detta kan vara användbart om du vill ha olika standardvärden beroende på användaren, till exempel pending för användare i Europeiska unionen och in för användare i Nordamerika.

I det här fallet kan du implementera följande för att ange standardsamtycke baserat på användarens region:

Om användarens region bestäms av en CMP kan du använda följande steg i stället:

Om du vill skapa ett dataelement i användargränssnittet väljer du Data Elements i den vänstra navigeringen och sedan Add Data Element för att navigera till dialogrutan för att skapa dataelement.

härifrån måste du skapa ett JavaScript Variable-dataelement baserat på adobeDefaultConsent. Välj Save när du är klar.

När dataelementet har skapats går du tillbaka till konfigurationssidan för Web SDK-tillägget. Under avsnittet Privacy väljer du Provided by data element och använder den angivna dialogrutan för att välja det standardelement med medgivandedata som du skapade tidigare.

Distribuera tillägget på webbplatsen

När du har konfigurerat tillägget kan det integreras med webbplatsen. Mer information om hur du distribuerar det uppdaterade biblioteksbygget finns i publiceringshandboken i taggdokumentationen.

Kommandon för att ändra samtycke commands

När du har integrerat SDK-tillägget på webbplatsen kan du börja använda kommandot Platform Web SDK setConsent för att skicka medgivandedata till plattformen.

Kommandot setConsent utför två åtgärder:

När setConsent ska anropas

Det finns två scenarier där setConsent ska anropas på din plats:

Syntax för setConsent

Kommandot setConsent förväntar sig ett nyttolastobjekt som innehåller en enda arraytypsegenskap: consent. Arrayen consent måste innehålla minst ett objekt som innehåller de obligatoriska medgivandefälten för Adobe-standarden.

De obligatoriska medgivandefälten för Adobe-standarden visas i följande exempel på setConsent-anrop:

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

Följande JavaScript innehåller ett exempel på en funktion som hanterar ändringar av medgivandeinställningar på en webbplats, som kan användas som återanrop i en händelseavlyssnare eller en CMP-krok:

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

Hantera SDK-svar

Alla Platform SDK-kommandon returnerar löften som anger om anropet lyckades eller misslyckades. Du kan sedan använda dessa svar för ytterligare logik, till exempel för att visa bekräftelsemeddelanden för kunden. Mer information finns i Kommandosvar.

När du har gjort setConsent anrop med SDK kan du använda profilvisningsprogrammet i plattformsgränssnittet för att kontrollera om data landar i profilarkivet. Mer information finns i avsnittet Bläddra bland profiler efter identitet.

Nästa steg

Genom att följa den här guiden har du konfigurerat plattformstillägget för Web SDK för att skicka data om samtycke till Experience Platform. Anvisningar om hur du testar implementeringen finns i dokumentationen för den standard för samtycke som du implementerar: