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

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 Datenerfassungs-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 Verständnis der Tag-Erweiterungen und deren Installation in Webanwendungen. Weitere 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 Datenspeicher konfigurieren. Wählen Sie in der Datenerfassungs-Benutzeroberfläche im linken Navigationsbereich Datastreams aus.

Nachdem Sie einen neuen Datastream 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.

Datenspeicherfeld Wert
Sandbox Der Name der Plattform Sandbox, die die erforderliche Streaming-Verbindung und Datensätze zum Einrichten des Datastreams enthält.
Streaming-Inlet Eine gültige Streaming-Verbindung für die Experience Platform. Lesen Sie das Tutorial zu Erstellen einer Streaming-Verbindung , wenn Sie keinen vorhandenen Streaming-Inlet haben.
Ereignis-Datensatz Ein XDM ExperienceEvent -Datensatz, an den Sie Ereignisdaten mit dem SDK senden möchten. Sie müssen zwar einen Ereignis-Datensatz bereitstellen, um einen Platform-Datenspeicher zu erstellen, beachten Sie jedoch, dass über Ereignisse gesendete Zustimmungsdaten in nachgelagerten Durchsetzungs-Workflows nicht berücksichtigt werden.
Profildatensatz Der Profile-aktivierte Datensatz mit Feldern zur Kundenzustimmung, den Sie früher erstellt haben.

Wählen Sie nach Abschluss des Vorgangs Speichern am unteren Bildschirmrand aus und folgen Sie den weiteren Anweisungen, 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 danach die Registerkarte Katalog aus. Wählen Sie dann Install unter der Platform SDK-Erweiterung in der Liste der verfügbaren Erweiterungen aus.

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

Wählen Sie Save 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:

  1. Bestimmen Sie die Region des Benutzers auf dem Webserver.
  2. Rendern Sie vor dem Tag script (Einbettungscode) auf der Web-Seite ein separates Tag script , das eine adobeDefaultConsent -Variable basierend auf der Region des Benutzers festlegt.
  3. Richten Sie ein Datenelement ein, das die JavaScript-Variable adobeDefaultConsent verwendet, und verwenden Sie dieses Datenelement als standardmäßigen Zustimmungswert für den Benutzer.

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

  1. Behandeln Sie das Ereignis "CMP geladen"auf der Seite.
  2. Legen Sie im Ereignishandler eine adobeDefaultConsent -Variable auf Grundlage der Region des Benutzers fest und laden Sie dann das Tag-Bibliotheksskript mit JavaScript.
  3. Richten Sie ein Datenelement ein, das die JavaScript-Variable adobeDefaultConsent verwendet, und verwenden Sie dieses Datenelement als standardmäßigen Zustimmungswert für den Benutzer.

Um ein Datenelement in der Datenerfassungs-Benutzeroberfläche zu erstellen, wählen Sie Datenelemente im linken Navigationsbereich und dann Datenelement hinzufügen aus, um zum Dialogfeld für die Datenelementerstellung zu navigieren.

Von hier aus müssen Sie ein JavaScript-Variable-Datenelement erstellen, das auf adobeDefaultConsent basiert. 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. Ausführliche Informationen zum Bereitstellen des aktualisierten Bibliotheks-Builds finden Sie im Publishing-Handbuch in der Tag-Dokumentation.

Festlegen von Befehlen zur Änderung der Zustimmung

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

WICHTIG

Der Befehl setConsent aktualisiert nur Daten direkt im Profilspeicher und sendet keine Daten an den Data Lake.

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

  1. Wenn die Einwilligung auf der Seite geladen wird (d. h. bei jedem Laden der Seite)
  2. Als Teil eines CMP-Hooks oder Ereignis-Listeners, der Änderungen in den Zustimmungseinstellungen erkennt
HINWEIS

Eine Einführung in die allgemeine Syntax für Platform SDK-Befehle finden Sie im Dokument zu Ausführen von Befehlen.

Der Befehl setConsent erwartet zwei Argumente:

  1. Eine Zeichenfolge, die den Befehlstyp angibt (in diesem Fall "setConsent").
  2. 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 für den Aufruf setConsent dargestellt:

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-Eigenschaft Beschreibung
standard Der verwendete Zustimmungsstandard. Für den Adobe-Standard muss dieser Wert auf Adobe gesetzt werden.
version Die Versionsnummer des Zustimmungsstandards, angegeben unter standard. Dieser Wert muss auf 2.0 gesetzt werden, damit die Zustimmungsverarbeitung nach Adobe-Standard erfolgt.
value Die aktualisierten Zustimmungsinformationen des Kunden, die als XDM-Objekt bereitgestellt werden, das der Struktur der Einwilligungsfelder des Profilaktivierten Datensatzes entspricht.
HINWEIS

Wenn Sie andere Zustimmungsstandards zusammen mit Adobe verwenden (z. B. IAB TCF), können Sie dem consent-Array für jeden Standard zusätzliche Objekte hinzufügen. Jedes Objekt muss die entsprechenden Werte für standard, version und value für den Zustimmungsstandard enthalten, den sie darstellen.

Das folgende JavaScript zeigt ein Beispiel für eine Funktion, die Änderungen der Zustimmungsvoreinstellungen auf einer Website verarbeitet, die als Rückruf in einem Ereignis-Listener oder CMP-Erweiterungspunkt 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. Spezifische Beispiele finden Sie im Abschnitt Umgang mit Erfolg oder Fehler im Handbuch zum Ausführen von SDK-Befehlen .

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 Browsing profiles by identity .

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:

Auf dieser Seite