JavaScript-API - Consentmanager Staging

CMP:n consentmanager.net stöder olika JavaScript-API:er för att göra det möjligt för webbplatser att hämta samtyckesinformation.

Använda API:et

För alla förfrågningar till API:et, använd alltid endast de offentliga funktionerna som nämns nedan. Vänligen gå inte direkt in i det interna window.cmpmngr-objektet!

För att skicka eller ta emot information från/till API:et kan du använda den allmänna funktionen __cmp(...). Denna funktion kan hantera de flesta generiska förfrågningarna. Utöver detta erbjuder CMP även allmänna funktioner __tcfapi(...) för IAB TCF v2-efterlevnad och __gpp(...) för IAB GPP-efterlevnad.

Exempel:

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

API-funktioner

De tre API-funktionerna använder olika parametrar på grund av de olika specifikationer som dessa funktioner följer. API-funktionerna är:

__cmp( Command, Parameter, Callback, Async )

__tcfapi( Command, Version, Callback, Parameter )

__gpp( Command, Version, Callback, Parameter )

Borttaget: Observera att __uspapi() inte längre finns och har ersatts av __gpp().

Observera att för __cmp() alla parametrar utom Command är valfria.

Kommandon

API:et 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()`	Hämta samtyckesdataobjekt enligt IAB TCF v2.
`noncompliant_getTCData`	`__tcfapi()`	Hämta samtyckesdataobjekt enligt IAB TCF v2 vid en icke-kompatibel konfiguration av CMP.
`ping`	`__cmp()` `__tcfapi()` `__gpp()`	Beroende på vilken funktion som används: `__cmp('ping')` returnerar false. `__tcfapi('ping')` returnerar IAB TCF v2-pingobjektet. `__gpp('ping',callback)` returnerar GPP-pingobjektet.
`addEventListener`	`__cmp()` `__tcfapi()`	Lägger till en ny händelselyssnare. Se detaljer här. Observera att parametrarna beror på vilken funktion som används.
`removeEventListener`	`__cmp()` `__tcfapi()`	Tar bort en händelselyssare. Se ovan.
`getCMPData`	`__cmp()`	Hämta ett objekt som innehåller all relevant samtyckesdata. `{ 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()`	Hämta samtyckessträng och information om användaren har gjort ett val. Det returnerade statusobjektet ser ut så här: `{'consentExists': true/false, 'consentData': '…'}` Observera att detta inte signalerar samtycke, utan endast att användaren har gjort ett val.
`setConsent`	`__cmp()`	Simulera ett användarklick på acceptera alla (parameter = 1) eller avvisa alla (parameter = 0).
`setVendorConsent`	`__cmp()`	Ställer in samtyckesstatus för en viss leverantör. Leverantörs-ID och status måste skickas som en array via parameter 2, t.ex. `__cmp('setVendorConsent',['s30', 1 ])` ställer in samtycke (godkänn) för leverantör s30. Möjliga statusvärden: 0 = avvisa 1 = godkänn 2 = avvisa, räkna inte 3 = godkänn, räkna inte
`setPurposeConsent`	`__cmp()`	Ställer in samtyckesstatus för ett visst syfte. Syfte-ID och status måste skickas som en matris via parameter 2, t.ex. `__cmp('setPurposeConsent',[52, 1 ])` ställer in samtycke (godkännande) för syfte 52. Om du vill ställa in samtycke för ett syfte och alla leverantörer som är tilldelade detta syfte kan du ställa in det tredje fältet till true, t.ex. `__cmp('setPurposeConsent',[52, 1, true ])`
`exportConsent`	`__cmp()`	Exporterar samtyckesinformation för delning av samtycke mellan enheter.
`importConsent`	`__cmp()`	Importerar samtyckesinformation för denna besökare.
`cancelwait`	`__cmp()`	Stoppa CMP från att vänta på inkommande samtal om import av samtycke.

`showScreen`	`__cmp()`	Visa välkomstskärm (beroende på besökarens plats/kontoinställningar).
`showScreenAdvanced`	`__cmp()`	Visa inställningshanteraren (beroende på besökarens plats/kontoinställningar). Obs: Du kan använda den andra parametern för att ange vilken sida som ska öppnas (använd t.ex. ”c52” för att öppna sidan för syfte c52).
`showCookies`	`__cmp()`	Visa cookietabellen.
`close`	`__cmp()`	Stäng samtyckeslagret.

`setAgeCallback`	`__cmp()`	Ställ in återuppringningsfunktion för åldersverifiering.
`setUserID`	`__cmp()`	Ställ in externt användar-ID 1. `setUserID` ställer in det externa ID (ID 2, ID 3) som användaren är känd under. `getUserID` och `setUserID` båda returnerar ett användar-ID-objekt: `{'external': ..., 'external2': ..., 'external3': ..., 'internal': ...}` Obs: Det interna användar-ID:t är endast tillgängligt om det är aktiverat i CMP-inställningarna och efter att händelsen ”inställningar” har utlösts (se CMP-händelser).
`setUserID2`	`__cmp()`	Ställ in externt användar-ID 2
`setUserID3`	`__cmp()`	Ställ in externt användar-ID 3
`getUserID`	`__cmp()`	Hämta alla användar-ID
`checkBlocking`	`__cmp()`	Kontrollerar om blockerade element kan avblockeras och avblockerar dem.
`checkShowScreen`	`__cmp()`	Kontrollerar om samtyckeslagret ska visas (igen).

`privacyLink`	`__cmp()`	Omdirigerar besökaren till sidan med integritetspolicy.
`tacLink`	`__cmp()`	Omdirigerar besökaren till sidan med användarvillkor.
`imprintLink`	`__cmp()`	Omdirigerar besökaren till sidan med juridisk information/impressum.

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!