JavaScript-API
Der consentmanager.net CMP unterstützt verschiedene JavaScript-APIs, damit Websites Zustimmungsinformationen abrufen können.
Verwenden der API
Verwenden Sie für alle Anfragen an die API immer nur die unten genannten öffentlichen Funktionen. Bitte unterlassen Sie Greifen Sie direkt auf das interne window.cmpmngr-Objekt zu!
Um Informationen von / an die API zu senden oder zu empfangen, können Sie die allgemeine öffentliche Funktion verwenden __cmp(...)
. Diese Funktion kann die meisten generischen Anforderungen verarbeiten. Darüber hinaus bietet das CMP auch öffentliche Funktionen __tcfapi(...)
für die Einhaltung von IAB TCF v2 und __uspapi(...)
für die Einhaltung der US-Datenschutzbestimmungen von IAB.
Beispiel:
var x = __cmp('consentStatus');
if(x.consentExists){/* do something */}
API-Funktionen
Die drei API-Funktionen verwenden aufgrund der unterschiedlichen Spezifikationen, denen diese Funktionen folgen, unterschiedliche Parameter. Die API-Funktionen sind:
__cmp( Command, Parameter, Callback, Async )
__uspapi( Command, Version, Callback, Parameter )
__tcfapi( Command, Version, Callback, Parameter )
Bitte beachten Sie, dass für __cmp()
alle Parameter außer Command
sind optional.
Befehle
Die API unterstützt die folgenden Befehle:
Bitte beachten Sie, dass unsere API möglicherweise Objekte an TCF v1 + v2-Befehle zurückgibt, die sich vom Standard unterscheiden. Sehen Sie hier für weitere Details.
Befehl | Funktion | Beschreibung |
getVendorConsents |
__cmp() |
Abrufen des Datenobjekts für die Zustimmung des Anbieters gemäß IAB TCF v1. |
noncompliant_getVendorConsents |
__cmp() |
Abrufen des Datenobjekts für die Zustimmung des Anbieters gemäß IAB TCF v1 bei nicht konformer Einrichtung des CMP. |
getConsentData |
__cmp() |
Einwilligungsdatenobjekt gemäß IAB TCF v1 abrufen. |
noncompliant_getConsentData |
__cmp() |
Abrufen des Zustimmungsdatenobjekts gemäß IAB TCF v1 bei nicht konformer Einrichtung des CMP. |
getTCData |
__tcfapi() |
Einwilligungsdatenobjekt gemäß IAB TCF v2 abrufen. |
noncompliant_getTCData |
__tcfapi() |
Abrufen des Zustimmungsdatenobjekts gemäß IAB TCF v2 bei nicht konformer Einrichtung des CMP. |
getUSPData |
__uspapi() |
Erhalten Sie eine Einwilligungsdatenzeichenfolge gemäß der IAB US-Datenschutzspezifikation. |
ping |
|
Abhängig von der verwendeten Funktion:
|
addEventListener |
|
Fügt einen neuen Ereignis-Listener hinzu. Details finden Sie hier. Bitte beachten Sie, dass die Parameter von der verwendeten Funktion abhängen. |
removeEventListener |
|
Entfernt einen Ereignis-Listener. Siehe oben. |
getCMPData |
__cmp() |
Holen Sie sich ein Objekt, das alle relevanten Zustimmungsdaten enthält.
|
|
||
consentStatus |
__cmp() |
Erhalten Sie eine Zustimmungszeichenfolge und Informationen, wenn der Benutzer die Wahl hat. Das zurückgegebene Statusobjekt sieht folgendermaßen aus: Bitte beachten Sie, dass dies der Fall ist nicht Zustimmung signalisieren, aber nur, wenn der Benutzer eine Wahl getroffen hat. |
setConsent |
__cmp() |
Simulieren Sie einen Benutzer, indem Sie auf Alle akzeptieren (Parameter = 1) oder Alle ablehnen (Parameter = 0) klicken. |
setVendorConsent |
__cmp() |
Legt den Zustimmungsstatus für einen bestimmten Anbieter fest. Hersteller-ID und Status müssen über Parameter 2 als Array übergeben werden, z __cmp('setVendorConsent',['s30', 1 ]) legt die Zustimmung (akzeptieren) für den Verkäufer s30 fest. |
setPurposeConsent |
__cmp() |
Legt den Zustimmungsstatus für einen bestimmten Zweck fest. Zweck-ID und Status müssen über Parameter 2 als Array übergeben werden, z __cmp('setPurposeConsent',[52, 1 ]) legt die Zustimmung (Annahme) für den Zweck fest 52. |
exportConsent |
__cmp() |
Exportiert Zustimmungsinformationen für Geräteübergreifende Einwilligungsfreigabe. |
importConsent |
__cmp() |
Importiert Zustimmungsinformationen für diesen Besucher. |
showScreen |
__cmp() |
Begrüßungsbildschirm anzeigen (abhängig vom Standort des Besuchers / Kontoeinrichtung). |
showGDPRScreen |
__cmp() |
Begrüßungsbildschirm für GDPR anzeigen |
showCCPAScreen |
__cmp() |
Begrüßungsbildschirm für CCPA anzeigen |
showScreenAdvanced |
__cmp() |
Voreinstellungsmanager anzeigen (abhängig vom Standort des Besuchers / Kontoeinrichtung). |
showGDPRScreenAdvanced |
__cmp() |
Zeige Präferenzmanager für GDPR |
showGDPRScreenVendors |
__cmp() |
Einstellungsmanager für GDPR anzeigen> Seite Alle Anbieter |
showCCPAScreenAdvanced |
__cmp() |
Zeige Präferenzmanager für CCPA |
showCookies |
__cmp() |
Cookie-Tabelle anzeigen. |
close |
__cmp() |
Zustimmungsschicht schließen. |
setAgeCallback |
__cmp() |
Setzen Rückruffunktion zur Altersüberprüfung. |
setUserID |
__cmp() |
Stellen Sie die externe Benutzer-ID 1 ein.
|
setUserID2 |
__cmp() |
Stellen Sie die externe Benutzer-ID 2 ein |
setUserID3 |
__cmp() |
Stellen Sie die externe Benutzer-ID 3 ein |
getUserID |
__cmp() |
Holen Sie sich alle Benutzer-IDs |
checkBlocking |
__cmp() |
Überprüft, ob blockierte Elemente entsperrt werden können und entsperrt sie. |