Información
Contenido

API de JavaScript

La consentmanager.net CMP admite varias API de JavaScript para permitir que los sitios web recuperen información de consentimiento.

Usando la API

Para todas las solicitudes a la API, utilice siempre las funciones públicas mencionadas a continuación. Por favor no ¡acceda al objeto interno window.cmpmngr directamente!

Para enviar o recibir información de / a la API, puede utilizar la función pública general __cmp(...). Esta función puede manejar la mayoría de las solicitudes genéricas. Además de esto, el CMP también ofrece funciones públicas __tcfapi(...) para el cumplimiento de IAB TCF v2 y __uspapi(...) para el cumplimiento de la privacidad de IAB US.

Ejemplo:

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

Funciones API

Las tres funciones API utilizan diferentes parámetros debido a las diferentes especificaciones que siguen estas funciones. Las funciones de la API son:

__cmp( Command, Parameter, Callback, Async )
__uspapi( Command, Version, Callback, Parameter )
__tcfapi( Command, Version, Callback, Parameter )

Tenga en cuenta que para __cmp() todos los parámetros excepto Command son opcionales

Comandos

La API admite los siguientes comandos:

Tenga en cuenta que nuestra API puede devolver objetos a los comandos TCF v1 + v2, que son diferentes del estándar. Vea aquí para más detalles.

Comando Función Descripción
getVendorConsents __cmp() Obtenga el objeto de datos de consentimiento del proveedor de acuerdo con IAB TCF v1.
noncompliant_getVendorConsents __cmp() Obtenga el objeto de datos de consentimiento del proveedor de acuerdo con IAB TCF v1 en caso de una configuración no compatible del CMP.
getConsentData __cmp() Obtenga el objeto de datos de consentimiento de acuerdo con IAB TCF v1.
noncompliant_getConsentData __cmp() Obtenga el objeto de datos de consentimiento de acuerdo con IAB TCF v1 en caso de una configuración no compatible del CMP.
getTCData __tcfapi() Obtenga el objeto de datos de consentimiento de acuerdo con IAB TCF v2.
noncompliant_getTCData __tcfapi() Obtenga el objeto de datos de consentimiento de acuerdo con IAB TCF v2 en caso de una configuración no compatible del CMP.
getUSPData __uspapi() Obtenga la cadena de datos de consentimiento de acuerdo con las especificaciones de privacidad de IAB US.
ping

__cmp()

__tcfapi()

Dependiendo de la función utilizada:

__cmp('ping') devolverá el objeto ping IAB TCF v1.

__tcfapi('ping') devolverá el objeto ping IAB TCF v2.

addEventListener

__cmp()

__tcfapi()

Agrega un nuevo oyente de eventos. Ver detalles aquí.

Tenga en cuenta que los parámetros dependen de la función utilizada.

removeEventListener

__cmp()

__tcfapi()

Elimina un oyente de eventos. Véase más arriba.
getCMPData __cmp()

Obtenga un objeto que contenga todos los datos de consentimiento relevantes.

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

Obtenga la cadena de consentimiento y la información si se da la opción del usuario. El objeto de estado devuelto se verá así: {'consentExists': true/false, 'consentData': '…'}

Tenga en cuenta que esto sí no señal de consentimiento, pero solo si el usuario hizo una elección.

setConsent __cmp() Simule un clic del usuario en aceptar todo (Parámetro = 1) o rechazar todo (Parámetro = 0).
setVendorConsent __cmp() Establece el estado de consentimiento para un determinado proveedor. El ID y el estado del proveedor deben pasarse como matriz a través del parámetro 2, por ejemplo __cmp('setVendorConsent',['s30', 1 ]) establece el consentimiento (aceptar) para el proveedor s30.
setPurposeConsent __cmp() Establece el estado de consentimiento para un determinado propósito. El ID de propósito y el estado deben pasarse como una matriz a través del parámetro 2, p. Ej. __cmp('setPurposeConsent',[52, 1 ]) establece el consentimiento (aceptar) para el propósito 52.
exportConsent __cmp() Información de consentimiento de exportaciones para intercambio de consentimiento entre dispositivos.
importConsent __cmp() Importa información de consentimiento para este visitante.
showScreen __cmp() Mostrar pantalla de bienvenida (dependiendo de la ubicación de los visitantes / configuración de la cuenta).
showGDPRScreen __cmp() Mostrar pantalla de bienvenida para GDPR
showCCPAScreen __cmp() Mostrar pantalla de bienvenida para CCPA
showScreenAdvanced __cmp() Mostrar administrador de preferencias (dependiendo de la ubicación de los visitantes / configuración de la cuenta).
showGDPRScreenAdvanced __cmp() Mostrar administrador de preferencias para GDPR
showCCPAScreenAdvanced __cmp() Mostrar administrador de preferencias para CCPA
setAgeCallback __cmp() Conjuntos función de devolución de llamada para verificación de edad.
setUserID __cmp()

Establecer ID de usuario externo 1.

setUserID establece la ID externa (ID 2, ID 3) para la que se conoce al usuario. getUserID y setUserID ambos devuelven un objeto de ID de usuario: {'external': ..., 'external2': ..., 'external3': ..., 'internal': ...}
Nota: La ID de usuario interna solo está disponible si está habilitada en la configuración de CMP y después de que se active el evento "configuración" (consulte Eventos CMP).

setUserID2 __cmp() Establecer ID de usuario externo 2
setUserID3 __cmp() Establecer ID de usuario externo 3
getUserID __cmp() Obtenga todas las ID de usuario
checkBlocking __cmp() Comprueba si los elementos bloqueados se pueden desbloquear y desbloquearlos.

 

Volver arriba