Integreer het Web SDK van het Platform om de gegevens van de klanteninstemming te verwerken

Met de Adobe Experience Platform Web SDK kunt u de door CMP's (Consent Management Platforms) gegenereerde toestemmingssignalen van klanten ophalen en deze naar Adobe Experience Platform verzenden wanneer er zich een gebeurtenis voordoet waarbij toestemming wordt gewijzigd.

SDK interface niet met om het even welke CMPs uit de doos. Het is aan u om te bepalen hoe te om SDK in uw website te integreren, naar toestemmingsveranderingen in CMP te luisteren, en het aangewezen bevel te roepen. Dit document biedt algemene richtlijnen voor het integreren van uw CMP met de Platform Web SDK.

Vereisten prerequisites

In deze zelfstudie wordt ervan uitgegaan dat u al hebt bepaald hoe u gegevens over Adobe binnen uw CMP kunt genereren en dat u een gegevensset hebt gemaakt die machtigingsvelden bevat die voldoen aan de standaard voor transparantie en instemming van IAB (TCF) 2.0. Als u deze dataset nog niet hebt gecreeerd, verwijs naar de volgende leerprogramma's alvorens aan deze gids terug te keren:

Deze handleiding volgt de workflow voor het instellen van de SDK met de tagextensie in de gebruikersinterface. Raadpleeg de volgende documenten in plaats van deze handleiding als u de extensie niet wilt gebruiken en de zelfstandige versie van de SDK rechtstreeks op uw site wilt insluiten:

De installatiestappen in deze handleiding vereisen een goed begrip van de uitbreidingen van tags en hoe deze in webtoepassingen worden geïnstalleerd. Raadpleeg de volgende documentatie voor meer informatie:

Een gegevensstroom instellen

SDK kan alleen gegevens naar Experience Platform verzenden als u eerst een gegevensstroom configureert. Selecteer Datastreams in de linkernavigatie in de gebruikersinterface voor gegevensverzameling of de gebruikersinterface van het Experience Platform.

Nadat u een nieuwe gegevensstroom hebt gemaakt of een bestaande gegevensstroom hebt geselecteerd om te bewerken, selecteert u de schakelknop naast Adobe Experience Platform . Gebruik vervolgens de hieronder vermelde waarden om het formulier in te vullen.

Veld DataStream
Waarde
Sandbox
De naam van de zandbak van het Platform 🔗 die de vereiste het stromen verbinding en datasets aan opstelling de datastream bevat.
Event Dataset
Een XDM ExperienceEvent dataset die u van plan bent om gebeurtenisgegevens naar het gebruiken van SDK te verzenden. Terwijl u een gebeurtenissendataset moet verstrekken om een gegevensstroom van het Platform tot stand te brengen, gelieve te merken dat de toestemmingsgegevens die via gebeurtenissen worden verzonden niet in stroomafwaartse handhavingswerkschema's worden nageleefd.
Profile Dataset
Profile - toegelaten dataset met de gebieden van de klantentoestemming die u 🔗 creeerde.

Als u klaar bent, selecteert u Save onder aan het scherm en gaat u verder met het volgen van eventuele extra aanwijzingen om de configuratie te voltooien.

De Platform Web SDK installeren en configureren

Zodra u een gegevensstroom zoals die in de vorige sectie wordt beschreven hebt gecreeerd, moet u de uitbreiding van SDK van het Web van het Platform dan vormen die u uiteindelijk op uw plaats zult opstellen. Als de SDK-extensie niet op de eigenschap tag is geïnstalleerd, selecteert u Extensions in de linkernavigatie, gevolgd door de tab Catalog . Selecteer vervolgens Install onder de extensie Platform SDK in de lijst met beschikbare extensies.

Selecteer onder Edge Configurations bij het configureren van de SDK de gegevensstroom die u in de vorige stap hebt gemaakt.

Selecteer Save om de extensie te installeren.

Een gegevenselement maken om de standaardtoestemming in te stellen

Met de geïnstalleerde uitbreiding SDK, hebt u de optie om een gegevenselement tot stand te brengen om de waarde van de standaard gegevensinzamelingstoestemming (collect.val) voor uw gebruikers te vertegenwoordigen. Dit kan handig zijn als u verschillende standaardwaarden wilt hebben, afhankelijk van de gebruiker, zoals pending voor gebruikers in de Europese Unie en in voor gebruikers in Noord-Amerika.

In dit geval kunt u het volgende implementeren om standaardtoestemming in te stellen op basis van het gebied van de gebruiker:

  1. Bepaal het gebied van de gebruiker op de Webserver.
  2. Geef vóór de tag script (code insluiten) op de webpagina een aparte script -tag weer die een adobeDefaultConsent -variabele instelt op basis van het gebied van de gebruiker.
  3. Stel een gegevenselement in dat de variabele adobeDefaultConsent JavaScript gebruikt en gebruik dit gegevenselement als de standaardwaarde voor de toestemming voor de gebruiker.

Als het gebied van de gebruiker door CMP wordt bepaald, kunt u de volgende stappen in plaats daarvan gebruiken:

  1. Verwerk de gebeurtenis "CMP geladen" op de pagina.
  2. Stel in de gebeurtenishandler een variabele adobeDefaultConsent in op basis van het gebied van de gebruiker en laad vervolgens het script van de tagbibliotheek met JavaScript.
  3. Stel een gegevenselement in dat de variabele adobeDefaultConsent JavaScript gebruikt en gebruik dit gegevenselement als de standaardwaarde voor de toestemming voor de gebruiker.

Als u een gegevenselement in de gebruikersinterface wilt maken, selecteert u Data Elements in de linkernavigatie en selecteert u Add Data Element om naar het dialoogvenster voor het maken van gegevenselementen te navigeren.

Van hieruit moet u een JavaScript Variable data-element maken op basis van adobeDefaultConsent . Selecteer Save wanneer u klaar bent.

Zodra het gegevenselement wordt gecreeerd, navigeer terug naar de de uitbreidingsconfig-pagina van SDK van het Web. Selecteer onder de sectie Privacy de optie Provided by data element en gebruik het dialoogvenster dat verschijnt om het gegevenselement met standaardtoestemmingen te selecteren dat u eerder hebt gemaakt.

De extensie op uw website implementeren

Nadat u de extensie hebt geconfigureerd, kunt u deze integreren in uw website. Verwijs naar de het publiceren gidsin de markeringen documentatie voor gedetailleerde informatie over hoe te om uw bijgewerkte bibliotheek op te stellen bouwt.

Opdrachten voor wijzigen van toestemming maken commands

Nadat u de SDK-extensie hebt geïntegreerd in uw website, kunt u de opdracht Platform Web SDK setConsent gebruiken om gegevens met toestemming naar Platform te verzenden.

De opdracht setConsent voert twee handelingen uit:

  1. Hiermee werkt u de profielkenmerken van de gebruiker rechtstreeks bij in het archief Profiel. Hiermee worden geen gegevens naar het datumpigment verzonden.
  2. Creeert een Gebeurtenis van de Ervaringdie een timestamped rekening van de gebeurtenis van de toestemmingsverandering registreert. Deze gegevens worden rechtstreeks naar het datumpigment verzonden en kunnen worden gebruikt om wijzigingen in de voorkeur voor toestemming in de loop van de tijd bij te houden.

Wanneer wordt setConsent aangeroepen

Er zijn twee situaties waarin setConsent op uw site moet worden aangeroepen:

  1. Wanneer toestemming op de pagina wordt geladen (met andere woorden op elke pagina die wordt geladen)
  2. Als onderdeel van een CMP-haak of gebeurtenislistener die wijzigingen in toestemmingsinstellingen detecteert

setConsent syntaxis

De opdracht setConsent verwacht een payload-object dat een enkele array-type eigenschap bevat: consent . De array consent moet ten minste één object bevatten dat de vereiste toestemmingsvelden voor de standaard Adobe bevat.

De vereiste toestemmingsgebieden voor de norm van de Adobe worden getoond in het volgende voorbeeld setConsent vraag:

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"
      }
    }
  }]
});
Payload, eigenschap
Beschrijving
standard
De gebruikte toestemmingsnorm. Voor de standaard Adobe moet deze waarde worden ingesteld op Adobe .
version
Het versienummer van de toestemmingsnorm die onder standard wordt vermeld. Deze waarde moet worden ingesteld op 2.0 voor verwerking van toestemming volgens de Adobe.
value
De bijgewerkte toestemmingsinformatie van de klant, die als voorwerp XDM wordt verstrekt die aan de structuur van de profiel-Toegelaten de toestemmingsgebieden van de dataset in overeenstemming is.
NOTE
Als u andere toestemmingsnormen samen met Adobe (zoals IAB TCF) gebruikt, kunt u extra voorwerpen aan de consent serie voor elke norm toevoegen. Elk object moet geschikte waarden voor standard , version en value bevatten voor de toestemmingsstandaard die ze vertegenwoordigen.

De volgende JavaScript biedt een voorbeeld van een functie die de voorkeurswijzigingen voor toestemming op een website verwerkt. Deze functie kan worden gebruikt als callback in een gebeurtenislistener of een CMP-haak:

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

Reacties in SDK verwerken

Alle Platform SDK opdrachten retourneren beloftes die aangeven of de aanroep is geslaagd of mislukt. U kunt deze reacties vervolgens gebruiken voor extra logica, zoals het weergeven van bevestigingsberichten aan de klant. Zie reacties van het Bevelvoor meer informatie.

Nadat u setConsent -aanroepen met de SDK hebt uitgevoerd, kunt u met de profielviewer in de gebruikersinterface van het platform controleren of gegevens in het archief met profielen worden geplaatst. Zie de sectie over doorbladerend profielen door identiteitvoor meer informatie.

Volgende stappen

Door deze gids te volgen, hebt u de uitbreiding van SDK van het Web van het Platform gevormd om toestemmingsgegevens naar Experience Platform te verzenden. Raadpleeg voor hulp bij het testen van uw implementatie de documentatie voor de toestemmingsnorm die u implementeert:

recommendation-more-help
5741548a-2e07-44b3-9157-9c181502d0c5