JavaScript-API
Du har nu möjlighet consentmanager.net CMP stöder olika JavaScript API: er för att tillåta webbplatser att hämta samtyckeinformation.
Använda API: n
Använd alltid de offentliga funktionerna som nämns nedan för alla förfrågningar till API: n. Snälla du returnera inte åtkomst till det interna windows.cmpmngr-objektet direkt!
För att skicka eller ta emot information från / till API kan du använda den allmänna funktionen __cmp(...)
. Denna funktion kan hantera de flesta generiska förfrågningar. Utöver detta erbjuder CMP också offentliga funktioner __tcfapi(...)
för IAB TCF v2-överensstämmelse och __uspapi(...)
för IAB US Privacy compliance.
Exempelvis:
var x = __cmp('consentStatus');
if(x.consentExists){/* do something */}
API-funktioner
De tre API-funktionerna använder olika parametrar på grund av de olika specifikationerna som dessa funktioner följer. API-funktionerna är:
__cmp( Command, Parameter, Callback, Async )
__uspapi( Command, Version, Callback, Parameter )
__tcfapi( Command, Version, Callback, Parameter )
Observera att för __cmp()
alla parametrar utom Command
är valfria.
Kommandon
API stöder följande kommandon:
Observera att vårt API kan returnera objekt till TCF v1 + v2-kommandon, som skiljer sig från standarden. Se här för mer information.
Kommando | Fungera | Beskrivning |
getTCData |
__tcfapi() |
Skaffa godkännandedataobjekt enligt IAB TCF v2. |
noncompliant_getTCData |
__tcfapi() |
Skaffa godkännandedataobjekt enligt IAB TCF v2 i händelse av en icke-kompatibel installation av CMP. |
getUSPData |
__uspapi() |
Hämta samtyckesdatasträng enligt IAB US Privacy Spec. |
ping |
|
Beroende på den använda funktionen:
|
addEventListener |
|
Lägger till en ny händelse lyssnare. Se detaljer här. Observera att parametrarna beror på den använda funktionen. |
removeEventListener |
|
Tar bort en händelse lyssnare. Se ovan. |
getCMPData |
__cmp() |
Skaffa ett objekt som innehåller all relevant information om samtycke.
|
|
||
consentStatus |
__cmp() |
Få samtycke sträng och info om användarval ges. Det returnerade statusobjektet ser ut så här: Observera att detta gör det inte signal godkännande, men bara om användaren gjorde ett val. |
setConsent |
__cmp() |
Simulera ett användarklick på accept all (Parameter = 1) eller avvisa alla (Parameter = 0). |
setVendorConsent |
__cmp() |
Ställer in samtyckestatus för en viss leverantör. Leverantör-ID och status måste skickas som array via parameter 2, t.ex. 0 = avvisa 1 = acceptera 2 = avvisa, räknas inte 3 = acceptera, räknas inte |
setPurposeConsent |
__cmp() |
Ställer in samtyckestatus för ett visst syfte. Syfte-ID och status måste skickas som array via parameter 2, t.ex. __cmp('setPurposeConsent',[52, 1 ]) sätter samtycke (accepterar) för syfte 52. |
exportConsent |
__cmp() |
Exporterar samtyckeinformation för dela enhetens samtycke över enheter. |
importConsent |
__cmp() |
Importerar samtyckeinformation för den här besökaren. |
cancelwait |
__cmp() |
Stoppa CMP från att vänta på inkommande samtalsimportsamtal. |
showScreen |
__cmp() |
Visa välkomstskärm (beroende på besökarnas plats / kontoinställning). |
showGDPRScreen |
__cmp() |
Visa välkomstskärm för GDPR |
showCCPAScreen |
__cmp() |
Visa välkomstskärm för CCPA |
showScreenAdvanced |
__cmp() |
Visa preferenshanteraren (beroende på besökarens plats / kontoinställning). |
showGDPRScreenAdvanced |
__cmp() |
Visa preferenschef för GDPR |
showGDPRScreenVendors |
__cmp() |
Visa preferensansvarig för GDPR> Sida Alla leverantörer |
showCCPAScreenAdvanced |
__cmp() |
Visa preferenshanterare för CCPA |
showCookies |
__cmp() |
Visa kakabord. |
close |
__cmp() |
Stäng tillståndsskiktet. |
setAgeCallback |
__cmp() |
uppsättning återuppringningsfunktion för åldersverifiering. |
setUserID |
__cmp() |
Ställ in externt användar-ID 1.
|
setUserID2 |
__cmp() |
Ställ in externt användar-ID 2 |
setUserID3 |
__cmp() |
Ställ in externt användar-ID 3 |
getUserID |
__cmp() |
Få alla användar-ID |
checkBlocking |
__cmp() |
Kontrollerar om blockerade element kan avblockeras och avblockerar dem. |
checkShowScreen |
__cmp() |
Kontrollerar om samtyckesskiktet ska visas (igen). |
privacyLink |
__cmp() |
Omdirigerar besökaren till sidan för sekretesspolicy. |
tacLink |
__cmp() |
Omdirigerar besökaren till sidan Allmänna villkor. |
imprintLink |
__cmp() |
Omdirigerar besökaren till sidan om juridiskt meddelande / avtryck. |