JavaScript-API - Consentmanager Staging

Die CMP von consentmanager.net unterstützt verschiedene JavaScript-APIs, damit Websites Einwilligungsinformationen abrufen können.

Verwendung der API

Verwenden Sie für alle Anfragen an die API bitte immer nur die unten genannten öffentlichen Funktionen. Greifen Sie bitte nicht direkt auf das interne Objekt „window.cmpmngr“ zu!

Um Informationen an die API zu senden oder von ihr zu empfangen, können Sie die allgemeine öffentliche Funktion __cmp(...). Diese Funktion kann die meisten generischen Anfragen bearbeiten. Darüber hinaus bietet die CMP auch öffentliche Funktionen __tcfapi(...) für die IAB-TCF-v2-Konformität und __gpp(...) für die IAB-GPP-Konformität.

Beispiel:

var x = __cmp('consentStatus');
if(x.consentExists){/* do something */}

API-Funktionen

Die drei API-Funktionen verwenden unterschiedliche Parameter, da sie unterschiedlichen Spezifikationen folgen. Die API-Funktionen sind:

__cmp( Command, Parameter, Callback, Async )

__tcfapi( Command, Version, Callback, Parameter )

__gpp( Command, Version, Callback, Parameter )

Entfernt: Bitte beachten Sie, dass die Funktion __uspapi() nicht mehr existiert und durch __gpp() ersetzt wurde.

Bitte beachten Sie, dass für __cmp() alle Parameter außer Command optional sind.

Anweisungen

Die API unterstützt die folgenden Befehle:

Bitte beachten Sie, dass unsere API bei TCF v1+v2-Befehlen Objekte zurückgeben kann, die vom Standard abweichen. Weitere Details finden Sie hier.

Befehl	Funktion	Beschreibung
`getTCData`	`__tcfapi()`	Rufe das Einwilligungsdatenobjekt gemäß IAB TCF v2 ab.
`noncompliant_getTCData`	`__tcfapi()`	Rufe das Einwilligungsdatenobjekt gemäß IAB TCF v2 ab, falls die CMP nicht konform eingerichtet ist.
`ping`	`__cmp()` `__tcfapi()` `__gpp()`	Je nach verwendeter Funktion: `__cmp('ping')` gibt false zurück. `__tcfapi('ping')` gibt das IAB TCF v2-Ping-Objekt zurück. `__gpp('ping',callback)` gibt das GPP-Ping-Objekt zurück.
`addEventListener`	`__cmp()` `__tcfapi()`	Fügt einen neuen Ereignis-Listener hinzu. Details finden Sie hier. Bitte beachten Sie, dass die Parameter von der verwendeten Funktion abhängen.
`removeEventListener`	`__cmp()` `__tcfapi()`	Entfernt einen Ereignis-Listener. Siehe oben.
`getCMPData`	`__cmp()`	Ruft ein Objekt ab, das alle relevanten Einwilligungsdaten enthält. `{ consentstring: "IAB TCF consent string", uspstring: "IAB US Privacy String", gdprApplies: true/false, hasGlobalScope: true/false, tcfversion: 0/1/2, tcfcompliant: true/false, regulation: 0/1/2 (none / GDPR / CCPA), purposeConsents: {}, vendorConsents: {}, purposeLI: {}, vendorLI: {} googleVendorConsents: {} }`

`consentStatus`	`__cmp()`	Ruft die Einwilligungszeichenfolge und Informationen ab, wenn der Benutzer eine Auswahl getroffen hat. Das zurückgegebene Statusobjekt sieht wie folgt aus: `{'consentExists': true/false, 'consentData': '…'}` Bitte beachten Sie, dass dies keine Zustimmung signalisiert, sondern nur, dass der Benutzer eine Auswahl getroffen hat.
`setConsent`	`__cmp()`	Simuliert einen Benutzerklick auf „Alle akzeptieren“ (Parameter = 1) oder „Alle ablehnen“ (Parameter = 0).
`setVendorConsent`	`__cmp()`	Legt den Zustimmungsstatus für einen bestimmten Anbieter fest. Anbieter-ID und Status müssen als Array über Parameter 2 übergeben werden, z. B. `__cmp('setVendorConsent',['s30', 1 ])` Legt die Einwilligung (Akzeptieren) für den Anbieter s30 fest. Mögliche Statuswerte: 0 = Ablehnen 1 = akzeptieren 2 = ablehnen, nicht zählen 3 = akzeptieren, nicht zählen
`setPurposeConsent`	`__cmp()`	Legt den Zustimmungsstatus für einen bestimmten Zweck fest. Zweck-ID und Status müssen als Array über Parameter 2 übergeben werden, z. B. `__cmp('setPurposeConsent',[52, 1 ])` legt die Einwilligung (akzeptieren) für Zweck 52 fest. Wenn Sie die Einwilligung für einen Zweck und alle diesem Zweck zugewiesenen Anbieter festlegen möchten, können Sie das dritte Feld auf „true“ setzen, z. B. `__cmp('setPurposeConsent',[52, 1, true ])`
`exportConsent`	`__cmp()`	Exportiert Einwilligungsinformationen für die geräteübergreifende Weitergabe von Einwilligungen.
`importConsent`	`__cmp()`	Importiert Einwilligungsinformationen für diesen Besucher.
`cancelwait`	`__cmp()`	Verhindert, dass die CMP auf eingehende Einwilligungsimport-Aufrufe wartet.

`showScreen`	`__cmp()`	Willkommensbildschirm anzeigen (abhängig vom Standort des Besuchers/der Kontoeinrichtung).
`showScreenAdvanced`	`__cmp()`	Zeigt den Präferenzmanager an (abhängig vom Standort des Besuchers/der Kontoeinrichtung). Hinweis: Sie können den zweiten Parameter verwenden, um anzugeben, welche Seite geöffnet werden soll (verwenden Sie z. B. „c52“, um die Seite für den Zweck c52 zu öffnen).
`showCookies`	`__cmp()`	Zeigt die Cookie-Tabelle an.
`close`	`__cmp()`	Schließen Sie die Einwilligungs-Ebene.

`setAgeCallback`	`__cmp()`	Rufen Sie die Callback-Funktion für die Altersüberprüfung auf.
`setUserID`	`__cmp()`	Externe Benutzer-ID 1 festlegen. `setUserID` Legt die externe ID (ID 2, ID 3) fest, unter der der Benutzer bekannt ist. `getUserID` und `setUserID` beide geben ein Benutzer-ID-Objekt zurück: `{'external': ..., 'external2': ..., 'external3': ..., 'internal': ...}` Hinweis: Die interne Benutzer-ID ist nur verfügbar, wenn sie in den CMP-Einstellungen aktiviert ist und nachdem das „settings“-Ereignis ausgelöst wurde (siehe CMP-Ereignisse).
`setUserID2`	`__cmp()`	Externe Benutzer-ID 2 festlegen
`setUserID3`	`__cmp()`	Externe Benutzer-ID 3 festlegen
`getUserID`	`__cmp()`	Alle Benutzer-IDs abrufen
`checkBlocking`	`__cmp()`	Prüft, ob gesperrte Elemente entsperrt werden können, und entsperrt sie.
`checkShowScreen`	`__cmp()`	Prüft, ob die Einwilligungsschicht (erneut) angezeigt werden soll.

`privacyLink`	`__cmp()`	Leitet den Besucher zur Seite mit der Datenschutzerklärung weiter.
`tacLink`	`__cmp()`	Leitet den Besucher zur Seite mit den Allgemeinen Geschäftsbedingungen weiter.
`imprintLink`	`__cmp()`	Leitet den Besucher zur Seite mit den rechtlichen Hinweisen/dem Impressum weiter.

We do our best to keep this purely informative documentation up to date. However, if you notice that any of these guides need a little touch-up, let us know!