Integrieren des Platform Web SDK zur Verarbeitung von Daten zur Kundenzustimmung

Mit dem Adobe Experience Platform Web SDK können Sie von Consent Management Platforms (CMP) generierte Zustimmungssignale von Kunden abrufen und an Adobe Experience Platform senden, sobald ein Zustimmungsänderungsereignis eintritt.

Das SDK verfügt nicht standardmäßig über eine Schnittstelle mit CMPs. Sie müssen bestimmen, wie das SDK in Ihre Website integriert werden kann, auf Zustimmungsänderungen in der CMP warten und den entsprechenden Befehl aufrufen. Dieses Dokument enthält allgemeine Anleitungen zur Integration Ihres CMP mit dem Platform Web SDK.

Voraussetzungen prerequisites

In diesem Tutorial wird davon ausgegangen, dass Sie bereits ermittelt haben, wie Einwilligungsdaten in Ihrer CMP generiert werden, und einen Datensatz mit Einwilligungsfeldern erstellt haben, die dem Adobe-Standard oder dem IAB Transparency and Consent Framework (TCF) 2.0-Standard entsprechen. Wenn Sie diesen Datensatz noch nicht erstellt haben, lesen Sie die folgenden Tutorials, bevor Sie zu diesem Handbuch zurückkehren:

Dieses Handbuch folgt dem Workflow zum Einrichten des SDK mithilfe der Tag-Erweiterung in der Benutzeroberfläche. Wenn Sie die -Erweiterung nicht verwenden möchten und die eigenständige Version des SDK lieber direkt auf Ihrer Site einbetten möchten, lesen Sie die folgenden Dokumente anstelle dieses Handbuchs:

Die Installationsschritte in diesem Handbuch erfordern ein grundlegendes Verständnis der Tag-Erweiterungen und deren Installation in Webanwendungen. Weiterführende Informationen finden Sie in der folgenden Dokumentation:

Einrichten eines Datastreams

Damit das SDK Daten an Experience Platform senden kann, müssen Sie zunächst einen Datastream konfigurieren. Wählen Sie in der Datenerfassungs-Benutzeroberfläche oder Experience Platform-Benutzeroberfläche im linken Navigationsbereich Datastreams aus.

Nachdem Sie einen neuen Datenspeicher erstellt oder einen vorhandenen zum Bearbeiten ausgewählt haben, wählen Sie die Umschalter-Schaltfläche neben Adobe Experience Platform aus. Verwenden Sie anschließend die unten aufgeführten Werte, um das Formular auszufüllen.

Wenn Sie fertig sind, wählen Sie am unteren Bildschirmrand Speichern und fahren Sie mit den weiteren Anweisungen fort, um die Konfiguration abzuschließen.

Installieren und Konfigurieren des Platform Web SDK

Nachdem Sie einen Datenspeicher erstellt haben, wie im vorherigen Abschnitt beschrieben, müssen Sie die Platform Web SDK-Erweiterung konfigurieren, die Sie letztendlich auf Ihrer Site bereitstellen werden. Wenn die SDK-Erweiterung nicht in Ihrer Tag-Eigenschaft installiert ist, wählen Sie im linken Navigationsbereich Erweiterungen und dann die Registerkarte Katalog aus. Wählen Sie dann Installieren unter der Platform SDK-Erweiterung in der Liste der verfügbaren Erweiterungen aus.

Wählen Sie beim Konfigurieren des SDK unter Edge-Konfigurationen den im vorherigen Schritt erstellten Datastream aus.

Wählen Sie Speichern aus, um die Erweiterung zu installieren.

Erstellen eines Datenelements zum Festlegen der Standardzustimmung

Wenn die SDK-Erweiterung installiert ist, können Sie ein Datenelement erstellen, das den standardmäßigen Datenerfassungs-Zustimmungswert (collect.val) für Ihre Benutzer darstellt. Dies kann nützlich sein, wenn Sie je nach Benutzer unterschiedliche Standardwerte haben möchten, z. B. pending für Benutzer der Europäischen Union und in für Benutzer in Nordamerika.

In diesem Anwendungsfall können Sie Folgendes implementieren, um die Standardzustimmung auf Grundlage der Region des Benutzers festzulegen:

Wenn die Region des Benutzers durch eine CMP bestimmt wird, können Sie stattdessen die folgenden Schritte verwenden:

Um ein Datenelement in der Benutzeroberfläche zu erstellen, wählen Sie im linken Navigationsbereich Datenelemente aus und klicken Sie dann auf Datenelement hinzufügen , um zum Dialogfeld zur Datenelementerstellung zu navigieren.

Von hier aus müssen Sie ein auf adobeDefaultConsent basierendes Datenelement der JavaScript-Variablen 1} erstellen. ​ Wählen Sie Speichern, wenn Sie fertig sind.

Nachdem das Datenelement erstellt wurde, navigieren Sie zurück zur Konfigurationsseite der Web SDK-Erweiterung . Wählen Sie im Abschnitt Datenschutz die Option Wird durch Datenelement bereitgestellt und wählen Sie im bereitgestellten Dialogfeld das zuvor erstellte standardmäßige Datenelement für die Einwilligung aus.

Bereitstellen der Erweiterung auf Ihrer Website

Nachdem Sie die Konfiguration der Erweiterung abgeschlossen haben, kann sie in Ihre Website integriert werden. Detaillierte Informationen zum Bereitstellen des aktualisierten Bibliotheks-Builds finden Sie im Publishing-Handbuch in der Tag-Dokumentation.

Festlegen von Befehlen zur Änderung der Zustimmung commands

Nachdem Sie die SDK-Erweiterung in Ihre Website integriert haben, können Sie mit der Verwendung des Befehls Platform Web SDK setConsent beginnen, um Zustimmungsdaten an Platform zu senden.

Der Befehl setConsent führt zwei Aktionen durch:

Wann wird setConsent aufgerufen?

Es gibt zwei Szenarien, in denen setConsent auf Ihrer Site aufgerufen werden sollte:

Syntax setConsent

Der Befehl setConsent erwartet ein Payload-Objekt, das eine einzelne Eigenschaft vom Typ Array enthält: consent. Das Array consent muss mindestens ein Objekt enthalten, das die erforderlichen Einwilligungsfelder für den Adobe-Standard bereitstellt.

Die erforderlichen Einwilligungsfelder für den Adobe-Standard sind im folgenden Beispiel-Aufruf setConsent aufgeführt:

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

Im folgenden JavaScript finden Sie ein Beispiel für eine Funktion, mit der Änderungen der Zustimmungsvoreinstellungen auf einer Website verarbeitet werden, die als Callback in einem Ereignis-Listener oder CMP-Hook verwendet werden kann:

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

Umgang mit SDK-Antworten

Alle Platform SDK-Befehle geben Zusagen zurück, die angeben, ob der Aufruf erfolgreich war oder fehlgeschlagen ist. Sie können diese Antworten dann für zusätzliche Logik verwenden, z. B. für die Anzeige von Bestätigungsnachrichten an den Kunden. Weitere Informationen finden Sie unter Befehlsantworten .

Nachdem Sie mit dem SDK erfolgreich setConsent -Aufrufe durchgeführt haben, können Sie mit dem Profil-Viewer in der Platform-Benutzeroberfläche überprüfen, ob Daten im Profilspeicher landen. Weitere Informationen finden Sie im Abschnitt zum Durchsuchen von Profilen nach Identität .

Nächste Schritte

In diesem Handbuch haben Sie die Platform Web SDK-Erweiterung so konfiguriert, dass Einwilligungsdaten an Experience Platform gesendet werden. Eine Anleitung zum Testen Ihrer Implementierung finden Sie in der Dokumentation zum Einverständnisstandard, den Sie implementieren: