Info
Innehåll
Böcker
CMP
JavaScript-API
JavaScript-API

JavaScript-API

Smakämnen 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 )
__tcfapi( Command, Version, Callback, Parameter )
__gpp( Command, Version, Callback, Parameter )

Tog bort: Var medveten om att __uspapi() inte längre existerar och ersattes av __gpp().

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 Funktion 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

__cmp()

__tcfapi()

__gpp()

Beroende på den använda funktionen:

__cmp('ping') kommer att returnera falskt.

__tcfapi('ping') kommer att returnera IAB TCF v2-pingobjektet.

__gpp('ping',callback) returnerar GPP-pingobjektet.
addEventListener

__cmp()

__tcfapi()

Lägger till en ny händelse lyssnare. Se detaljer här.

Observera att parametrarna beror på den använda funktionen.
removeEventListener

__cmp()

__tcfapi()

 Tar bort en händelse lyssnare. Se ovan.
getCMPData __cmp()

Skaffa ett objekt som innehåller all relevant information om samtycke.

{
 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()

Få samtycke sträng och info om användarval ges. Det returnerade statusobjektet ser ut så här: {'consentExists': true/false, 'consentData': '…'}

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. __cmp('setVendorConsent',['s30', 1 ]) ställer in samtycke (acceptera) för leverantör s30. Möjliga statusvärden:

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.

Om du vill ställa in samtycke för ett ändamål och alla leverantörer som är tilldelade detta ändamål, kan du ställa in det tredje fältet till sant, t.ex.

__cmp('setPurposeConsent',[52, 1, true ])
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 inställningshanterare (beroende på besökarnas plats/kontoinställningar). Notera: Du kan använda den andra parametern för att indikera vilken sida som ska öppnas (använd t.ex. "c52" för att öppna sidan för ändamålet c52).
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.

setUserID anger det externa ID (ID 2, ID 3) för vilket användaren är känd. getUserID och setUserID båda returnerar ett användar-ID-objekt: {'external': ..., 'external2': ..., 'external3': ..., 'internal': ...}
Obs: Det interna användar-ID är endast tillgängligt om det är aktiverat i CMP-inställningar och efter att "inställningar" -händelse har avbrutits (se CMP-evenemang).
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.

 

Detaljer
Revision nr 20
Skapad 4 år sedan by jan
Uppdaterad 1 månad sedan by Falko
Har du inte ett konto än?

Bli GDPR-kompatibel med vår GDPR Cookie Consent Manager lösning. Prova nu gratis!

GDPR-kaka Consent Manager
Tillbaka till toppen