setConsent
Erstellt für:
- Entwickler
Der Befehl setConsent teilt der Web-SDK mit, ob Daten gesendet (Opt-in), Daten verworfen (Opt-out) oder defaultConsent verwendet werden sollen (Einverständnis unbekannt).
Web SDK unterstützt die folgenden Standards:
-
Adobe Standard: Es werden sowohl 1.0- als auch 2.0-Standards unterstützt.
-
IAB Transparency & Consent Framework: Wenn Sie diesen Standard verwenden, wird das Echtzeit-Kundenprofil des Besuchers mit den Einverständnisinformationen aktualisiert, sofern Ihre Implementierung korrekt konfiguriert ist:
- Das Schema Individuelles XDM-Profil enthält die Feldergruppe IAB TCF 2.0-Einverständnis.
- Das Erlebnisereignis-Schema enthält die IAB TCF 2.0-Einverständnis-Feldergruppe.
- Sie schließen die IAB-Einverständnisinformationen in das Ereignis (XDMObjekt). Web SDK enthält die Einverständnisinformationen beim Senden von Ereignisdaten nicht automatisch.
Nach Verwendung dieses Befehls schreibt die Web-SDK die Benutzereinstellungen in ein Cookie. Wenn der Benutzer das nächste Mal Ihre Website im Browser lädt, ruft die SDK diese persistierten Voreinstellungen ab, um zu ermitteln, ob Ereignisse an Adobe gesendet werden können.
Adobe empfiehlt, alle Voreinstellungen für das Einverständnisdialogfeld getrennt vom Einverständnis für Web SDK zu speichern. Web SDK bietet keine Möglichkeit, Einverständnis abzurufen. Um sicherzustellen, dass die Benutzereinstellungen mit der SDK synchron bleiben, können Sie bei jedem Laden der Seite den Befehl setConsent aufrufen. Web SDK führt nur dann einen Server-Aufruf durch, wenn sich das Einverständnis ändert.
Überlegungen zur Identitätssynchronisierung
Der Befehl setConsent verwendet nur die ECID aus der Identitätszuordnung, da der Befehl auf Geräteebene ausgeführt wird. Andere Identitäten aus der Identitätszuordnung werden vom setConsent-Befehl nicht berücksichtigt.
Verwenden von defaultConsent zusammen mit setConsent
Web SDK bietet zwei komplementäre Einverständniskonfigurationsbefehle:
defaultConsent: Dieser Befehl soll die Einverständnisvoreinstellungen von Adobe-Kunden erfassen, die Web-SDK verwenden.setConsent: Dieser Befehl soll die Einverständnisvoreinstellungen Ihrer Site-Besucher erfassen.
Wenn diese Einstellungen zusammen verwendet werden, können sie je nach den konfigurierten Werten zu unterschiedlichen Ergebnissen bei der Datenerfassung und der Cookie-Einstellung führen.
In der folgenden Tabelle erfahren Sie, wann eine Datenerfassung erfolgt und wann Cookies gesetzt werden, basierend auf den Einstellungen für das Einverständnis.
inininoutinpendinginpendingoutpendingoutinoutoutoutDie folgenden Cookies werden gesetzt, wenn die Einverständniskonfiguration Folgendes zulässt:
idMigrationEnabled vorhanden. Dies ist hilfreich bei der Umstellung auf Web SDK, während einige Teile der Site noch visitor.js verwenden.s_ecid=MCMID|<ECID>.Festlegen des Einverständnisses mit der Tag-Erweiterung „Web SDK"
Das Festlegen des Einverständnisses wird als Aktion innerhalb einer Regel in der Tags-Benutzeroberfläche der Datenerfassung von Adobe Experience Platform ausgeführt.
- Melden Sie sich mit Ihren Adobe IDAnmeldeinformationen beiexperience.adobe.com) an.
- Navigieren Sie Datenerfassung > Tags.
- Wählen Sie die gewünschte Tag-Eigenschaft aus.
- Navigieren Sie zu Regeln und wählen Sie dann die gewünschte Regel aus.
- Wählen unter "" eine vorhandene Aktion aus oder erstellen Sie eine Aktion.
- Legen Sie im DropdownFeld Erweiterung“ den Wert Adobe Experience Platform Web SDK fest und legen Sie als Aktionstyp „Einverständnis ".
- Legen Sie die gewünschten Felder auf der rechten Seite fest, einschließlich Standard und Allgemeines Einverständnis.
- Klicken Sie Änderungen beibehalten und führen Sie dann den Veröffentlichungs-Workflow aus.
Sie können mehrere Einverständnisobjekte in diese Aktion einbeziehen.
Festlegen des Einverständnisses mit der Web SDK JavaScript-Bibliothek
Führen Sie den setConsent Befehl aus, wenn Sie Ihre konfigurierte Instanz der Web-SDK aufrufen. Sie können die folgenden Objekte in diesen Befehl einbeziehen:
consent[]: Ein Array vonconsent. Das Einverständnisobjekt wird je nach ausgewähltem Standard und Version unterschiedlich formatiert. Auf den folgenden Registerkarten finden Sie Beispiele für jedes Einverständnisobjekt, abhängig vom Einverständnisstandard.identityMap: Ein Objekt, das steuert, wie eine ECID generiert wird und mit welchen IDs Einverständnisinformationen verknüpft sind. Adobe empfiehlt, dieses Objekt einzubeziehen, wennsetConsentvor anderen Befehlen wiesendEventausgeführt wird.edgeConfigOverrides: Ein Objekt, das Überschreibungen der Datenstromkonfiguration enthält.
Adobe 2.0-consent
Wenn Sie Adobe Experience Platform verwenden, müssen Sie eine Datenschutzschemafeldgruppe in Ihr Profilschema aufnehmen. Weitere zum Adobe 2.0-Standard finden Sie unterGovernance, Datenschutz und Sicherheit in Adobe Experience Platform". Sie können im folgenden Wertobjekt Daten hinzufügen, die dem Schema des consents Felds der Profilfeldgruppe Einverständnis und Voreinstellungen entsprechen.
-
standard: Der von Ihnen gewählte Einverständnisstandard. Legen Sie diese Eigenschaft für den Adobe 2.0-Standard auf"Adobe"fest. -
version: Eine Zeichenfolge, die die Version des Einverständnisstandards darstellt. Legen Sie diese Eigenschaft für den Adobe 2.0-Standard auf"2.0"fest. -
value: Ein Objekt, das Einverständniswerte enthält.value.collect.val: Der Einverständniswert. Legen Sie dies auf"y"beim Opt-in des Benutzers und auf"n"beim Opt-out des Benutzers fest.value.metadata.time: Der Zeitstempel, zu dem Benutzer ihre Einverständniseinstellungen zuletzt aktualisiert haben.
// Set consent using the Adobe 2.0 standard
alloy("setConsent", {
"consent": [{
"standard": "Adobe",
"version": "2.0",
"value": {
"collect": {
"val": "y"
},
"metadata": {
"time": "YYYY-03-17T15:48:42-07:00"
}
}
}]
});
IAB TCF 2.0-consent
Um die Benutzereinverständnisvoreinstellungen aufzuzeichnen, die über den Standard des Transparency and Consent Framework (TCF) des Interactive Advertising Bureau Europe (IAB) bereitgestellt werden, legen Sie die Einverständniszeichenfolge wie unten dargestellt fest.
Wenn das Einverständnis auf diese Weise festgelegt wird, wird das Echtzeit-Kundenprofil mit den Einverständnisinformationen aktualisiert. Dazu muss das Profil-XDM-Schema die Feldergruppe Profil-Datenschutzschema“ enthalten. Beim Senden von Ereignissen müssen die IAB-Einverständnisinformationen manuell zum Ereignis-XDM-Objekt hinzugefügt werden. Web SDK enthält die Einverständnisinformationen nicht automatisch in die Ereignisse.
Um die Einverständnisinformationen in -Ereignissen zu senden, müssen Sie die Feldergruppe Erlebnisereignis-Datenschutz zu Ihrem Profile aktivierten XDM ExperienceEvent hinzufügen. Anweisungen zur Konfiguration finden im Abschnitt zum AktualisierenExperienceEvent-Schemas im Handbuch zur Datensatzvorbereitung.
standard: Der von Ihnen gewählte Einverständnisstandard. Legen Sie diese Eigenschaft für den IAB TCF 2.0-Standard auf"IAB TCF"fest.version: Eine Zeichenfolge, die die Version des Einverständnisstandards darstellt. Legen Sie diese Eigenschaft für den IAB TCF 2.0-Standard auf"2.0"fest.value: Eine Zeichenfolge, die den Einverständniswert enthält.gdprApplies: Ein boolescher Wert, der bestimmt, ob die DSGVO für diesen Einverständniswert gilt. Der Standardwert lautettrue.gdprContainsPersonalData: Ein boolescher Wert, der bestimmt, ob die mit diesem Benutzer verknüpften Ereignisdaten personenbezogene Daten enthalten. Der Standardwert lautetfalse.
// Set consent using the IAB TCF 2.0 standard
alloy("setConsent", {
consent: [{
"standard": "IAB TCF",
"version": "2.0",
"value": "CO052l-O052l-DGAMBFRACBgAIBAAAAABIYgEawAQEagAAAA",
"gdprApplies": true,
"gdprContainsPersonalData": true
}]
});
Adobe 1.0-consent
standard: Der von Ihnen gewählte Einverständnisstandard. Legen Sie diese Eigenschaft für den Adobe 1.0-Standard auf"Adobe"fest.version: Eine Zeichenfolge, die die Version des Einverständnisstandards darstellt. Legen Sie diese Eigenschaft für den Adobe 1.0-Standard auf"1.0"fest.value.general: Der Einverständniswert. Legen Sie dies auf"in"beim Opt-in des Benutzers und auf"out"beim Opt-out des Benutzers fest.
// Set consent using the Adobe 1.0 standard
alloy("setConsent", {
"consent": [{
"standard": "Adobe",
"version": "1.0",
"value": {
"general": "in"
}
}]
});
Mehrere Standards in einer Anfrage senden
Web SDK unterstützt auch das Senden von mehr als einem Einverständnisobjekt in einer Anfrage, wie im folgenden Beispiel gezeigt.
alloy("setConsent", {
consent: [{
standard: "Adobe",
version: "2.0",
value: {
collect: {
val: "y"
},
metadata: {
time: "2021-03-17T15:48:42-07:00"
}
}
}, {
standard: "IAB TCF",
version: "2.0",
value: "CO1Z4yuO1Z4yuAcABBENArCsAP_AAH_AACiQGCNX_T5eb2vj-3Zdt_tkaYwf55y3o-wzhhaIse8NwIeH7BoGP2MwvBX4JiQCGBAkkiKBAQdtHGhcCQABgIhRiTKMYk2MjzNKJLJAilsbe0NYCD9mnsHT3ZCY70--u__7P3fAwQgkwVLwCRIWwgJJs0ohTABCOICpBwCUEIQEClhoACAnYFAR6gAAAIDAACAAAAEEEBAIABAAAkIgAAAEBAKACIBAACAEaAhAARIEAsAJEgCAAVA0JACKIIQBCDgwCjlACAoAAAAA.YAAAAAAAAAAA",
gdprApplies: true
}]
});
Beständigkeit der Zustimmungseinstellungen
Nachdem Sie Benutzereinstellungen mithilfe des setConsent-Befehls an die Web-SDK übermittelt haben, behält die SDK Benutzereinstellungen für ein Cookie bei. Wenn der Benutzer das nächste Mal Ihre Website im Browser lädt, ruft die Web-SDK diese persistierten Voreinstellungen ab und verwendet sie, um zu bestimmen, ob Ereignisse an Adobe gesendet werden können oder nicht.
Sie müssen die Benutzereinstellungen unabhängig speichern, um das Einverständnisdialogfeld mit den aktuellen Einstellungen anzeigen zu können. Es gibt keine Möglichkeit, die Benutzereinstellungen von der Web-SDK abzurufen. Um sicherzustellen, dass die Benutzereinstellungen mit der SDK synchron bleiben, können Sie bei jedem Laden der Seite den Befehl setConsent aufrufen. Die Web-SDK führt nur dann einen Server-Aufruf aus, wenn sich die Voreinstellungen geändert haben.