Integreer de Experience Platform Web SDK om gegevens over toestemming van klanten 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 een gebeurtenis plaatsvindt die aanleiding geeft tot wijziging van de toestemming.

SDK interface niet met om het even welke CMPs uit de doos. Het is aan u om te bepalen hoe te om de 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 Experience Platform Web SDK.

Vereisten prerequisites

In deze zelfstudie wordt ervan uitgegaan dat u al hebt bepaald hoe u gegevens over toestemming binnen uw CMP kunt genereren en dat u een gegevensset hebt gemaakt die machtigingsvelden bevat die voldoen aan de Adobe-standaard of de TCF 2.0-standaard (IAB Transparency and Consent Framework). 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 liever 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

Als de SDK gegevens naar Experience Platform moet verzenden, moet u eerst een gegevensstroom configureren. Selecteer Datastreams in de linkernavigatie in de gebruikersinterface voor gegevensverzameling of de gebruikersinterface van 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.

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.

Experience Platform Web SDK installeren en configureren

Zodra u een gegevensstroom zoals die in de vorige sectie wordt beschreven hebt gecreeerd, moet u dan de uitbreiding vormen van Experience Platform Web SDK die u uiteindelijk op uw plaats zult opstellen. Als u de extensie SDK niet op de eigenschap tag hebt geïnstalleerd, selecteert u Extensions in de linkernavigatie, gevolgd door de tab Catalog . Selecteer vervolgens Install onder de extensie Experience 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

Als de extensie SDK is geïnstalleerd, kunt u een gegevenselement maken dat de waarde voor de standaardtoestemming voor gegevensverzameling (collect.val) voor uw gebruikers vertegenwoordigt. 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:

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

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 van SDK van het Web pagina. 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 gids ​ in de markeringen documentatie voor gedetailleerde informatie over hoe te om uw bijgewerkte bibliotheek op te stellen bouwt.

Opdrachten voor wijzigen van toestemming maken commands

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

De opdracht setConsent voert twee handelingen uit:

Wanneer wordt setConsent aangeroepen

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

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 Adobe-standaard bevat.

De vereiste toestemmingsgebieden voor de norm van 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"
      }
    }
  }]
});

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 Experience Platform Web SDK
  alloy("setConsent", {
    consent: [{
      standard: "Adobe",
      version: "2.0",
      value: consentXDM
    }]
  });
});

SDK-reacties verwerken

Alle Experience 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 Bevel ​ voor meer informatie.

Nadat u setConsent -aanroepen met de SDK hebt uitgevoerd, kunt u met de profielviewer in de Experience Platform-gebruikersinterface controleren of gegevens in het Profile Store worden gedownload. Zie de sectie over ​ doorbladerend profielen door identiteit ​ voor meer informatie.

Volgende stappen

Door deze gids te volgen, hebt u de uitbreiding van Experience Platform Web SDK 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: