API JavaScript - Consentmanager Staging

Il CMP di consentmanager.net supporta varie API JavaScript per consentire ai siti web di recuperare le informazioni relative al consenso.

Utilizzo dell'API

Per tutte le richieste all'API, si prega di utilizzare sempre e solo le funzioni pubbliche menzionate di seguito. Si prega di non accedere direttamente all'oggetto interno window.cmpmngr!

Per inviare o ricevere informazioni da/verso l'API puoi utilizzare la funzione pubblica generale __cmp(...). Questa funzione è in grado di gestire la maggior parte delle richieste generiche. Oltre a ciò, il CMP offre anche funzioni pubbliche __tcfapi(...) per la conformità IAB TCF v2 e __gpp(...) per la conformità IAB GPP.

Esempio:

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

Funzioni API

Le tre funzioni API utilizzano parametri diversi a causa delle diverse specifiche a cui queste funzioni si attengono. Le funzioni API sono:

__cmp( Command, Parameter, Callback, Async )

__tcfapi( Command, Version, Callback, Parameter )

__gpp( Command, Version, Callback, Parameter )

Rimosso: tieni presente che la funzione __uspapi() non esiste più ed è stata sostituita da __gpp().

Si prega di notare che, per __cmp() tutti i parametri, ad eccezione di Command sono opzionali.

Comandi

L'API supporta i seguenti comandi:

Tieni presente che la nostra API potrebbe restituire oggetti ai comandi TCF v1+v2 che differiscono dallo standard. Vedi qui per maggiori dettagli.

Comando	Funzione	Descrizione
`getTCData`	`__tcfapi()`	Ottieni l'oggetto dati del consenso secondo IAB TCF v2.
`noncompliant_getTCData`	`__tcfapi()`	Ottieni l'oggetto dati del consenso secondo IAB TCF v2 in caso di configurazione non conforme del CMP.
`ping`	`__cmp()` `__tcfapi()` `__gpp()`	A seconda della funzione utilizzata: `__cmp('ping')` restituirà false. `__tcfapi('ping')` restituirà l'oggetto ping IAB TCF v2. `__gpp('ping',callback)` restituirà l'oggetto ping GPP.
`addEventListener`	`__cmp()` `__tcfapi()`	Aggiunge un nuovo listener di eventi. Vedi i dettagli qui. Si prega di notare che i parametri dipendono dalla funzione utilizzata.
`removeEventListener`	`__cmp()` `__tcfapi()`	Rimuove un listener di evento. Vedi sopra.
`getCMPData`	`__cmp()`	Ottiene un oggetto che contiene tutti i dati di consenso rilevanti. `{ 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()`	Ottiene la stringa di consenso e le informazioni se l'utente ha espresso una scelta. L'oggetto di stato restituito avrà questo aspetto: `{'consentExists': true/false, 'consentData': '…'}` Si prega di notare che questo non indica il consenso, ma solo se l'utente ha effettuato una scelta.
`setConsent`	`__cmp()`	Simula un clic dell'utente su "Accetta tutto" (Parametro = 1) o "Rifiuta tutto" (Parametro = 0).
`setVendorConsent`	`__cmp()`	Imposta lo stato di consenso per un determinato fornitore. L'ID del fornitore e lo stato devono essere passati come array tramite il parametro 2, ad es. `__cmp('setVendorConsent',['s30', 1 ])` imposta il consenso (accetta) per il fornitore s30. Valori di stato possibili: 0 = rifiuta 1 = accetta 2 = rifiuta, non conteggiare 3 = accetta, non conteggiare
`setPurposeConsent`	`__cmp()`	Imposta lo stato del consenso per una determinata finalità. L'ID della finalità e lo stato devono essere passati come array tramite il parametro 2, ad es. `__cmp('setPurposeConsent',[52, 1 ])` imposta il consenso (accetta) per lo scopo 52. Se si desidera impostare il consenso per una finalità e per tutti i fornitori assegnati a tale finalità, è possibile impostare il terzo campo su true, ad es. `__cmp('setPurposeConsent',[52, 1, true ])`
`exportConsent`	`__cmp()`	Esporta le informazioni sul consenso per la condivisione del consenso tra dispositivi.
`importConsent`	`__cmp()`	Importa le informazioni sul consenso per questo visitatore.
`cancelwait`	`__cmp()`	Impedisce al CMP di attendere le chiamate in entrata per l'importazione del consenso.

`showScreen`	`__cmp()`	Mostra la schermata di benvenuto (a seconda della posizione del visitatore/configurazione dell'account).
`showScreenAdvanced`	`__cmp()`	Mostra il gestore delle preferenze (a seconda della posizione del visitatore/configurazione dell'account). Nota: è possibile utilizzare il secondo parametro per indicare quale pagina deve essere aperta (ad es. utilizzare "c52" per aprire la pagina per lo scopo c52).
`showCookies`	`__cmp()`	Mostra la tabella dei cookie.
`close`	`__cmp()`	Chiudi il layer di consenso.

`setAgeCallback`	`__cmp()`	Imposta la funzione di callback per la verifica dell'età.
`setUserID`	`__cmp()`	Imposta l'ID utente esterno 1. `setUserID` imposta l'ID esterno (ID 2, ID 3) con cui l'utente è conosciuto. `getUserID` e `setUserID` entrambi restituiscono un oggetto ID utente: `{'external': ..., 'external2': ..., 'external3': ..., 'internal': ...}` Nota: l'ID utente interno è disponibile solo se abilitato nelle impostazioni CMP e dopo l'attivazione dell'evento "settings" (vedi eventi CMP).
`setUserID2`	`__cmp()`	Imposta ID utente esterno 2
`setUserID3`	`__cmp()`	Imposta ID utente esterno 3
`getUserID`	`__cmp()`	Ottieni tutti gli ID utente
`checkBlocking`	`__cmp()`	Verifica se gli elementi bloccati possono essere sbloccati e li sblocca.
`checkShowScreen`	`__cmp()`	Verifica se mostrare (di nuovo) il layer di consenso.

`privacyLink`	`__cmp()`	Reindirizza il visitatore alla pagina dell'informativa sulla privacy.
`tacLink`	`__cmp()`	Reindirizza il visitatore alla pagina dei Termini e condizioni.
`imprintLink`	`__cmp()`	Reindirizza il visitatore alla pagina delle note legali/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!