API de JavaScript - Consentmanager Staging

El CMP de consentmanager.net es compatible con varias API de JavaScript para permitir que los sitios web recuperen la información de consentimiento.

Uso de la API

Para todas las solicitudes a la API, utiliza siempre y exclusivamente las funciones públicas que se mencionan a continuación. ¡No accedas directamente al objeto interno window.cmpmngr!

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

Ejemplo:

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

Funciones de la API

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

__cmp( Command, Parameter, Callback, Async )

__tcfapi( Command, Version, Callback, Parameter )

__gpp( Command, Version, Callback, Parameter )

Eliminado: Ten en cuenta que la función __uspapi() ya no existe y ha sido sustituida por la función __gpp().

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

Instrucciones

La API admite los siguientes comandos:

Ten en cuenta que nuestra API puede devolver objetos a los comandos TCF v1+v2 que difieren del estándar. Consulta aquí para obtener más detalles.

Comando	Función	Descripción
`getTCData`	`__tcfapi()`	Obtener el objeto de datos de consentimiento según IAB TCF v2.
`noncompliant_getTCData`	`__tcfapi()`	Obtener el objeto de datos de consentimiento según IAB TCF v2 en caso de una configuración no conforme del CMP.
`ping`	`__cmp()` `__tcfapi()` `__gpp()`	Dependiendo de la función utilizada: `__cmp('ping')` devolverá false. `__tcfapi('ping')` Devolverá el objeto ping de IAB TCF v2. `__gpp('ping',callback)` Devolverá el objeto ping de GPP.
`addEventListener`	`__cmp()` `__tcfapi()`	Añade un nuevo detector de eventos. Consulte los detalles aquí. Ten en cuenta que los parámetros dependen de la función utilizada.
`removeEventListener`	`__cmp()` `__tcfapi()`	Elimina un detector de eventos. Véase más arriba.
`getCMPData`	`__cmp()`	Obtiene un objeto que contiene 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()`	Obtiene la cadena de consentimiento y la información si el usuario ha realizado una elección. El objeto de estado devuelto tendrá este aspecto: `{'consentExists': true/false, 'consentData': '…'}` Ten en cuenta que esto no indica consentimiento, sino solo que el usuario ha tomado una decisión.
`setConsent`	`__cmp()`	Simula 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 proveedor determinado. El ID del proveedor y el estado deben pasarse como una matriz a través del parámetro 2, p. ej. `__cmp('setVendorConsent',['s30', 1 ])` establece el consentimiento (aceptar) para el proveedor s30. Valores de estado posibles: 0 = rechazar 1 = aceptar 2 = rechazar, no contar 3 = aceptar, no contar
`setPurposeConsent`	`__cmp()`	Establece el estado de consentimiento para un fin determinado. El ID del fin y el estado deben pasarse como matriz a través del parámetro 2, p. ej. `__cmp('setPurposeConsent',[52, 1 ])` establece el consentimiento (aceptar) para la finalidad 52. Si desea establecer el consentimiento para una finalidad y todos los proveedores asignados a dicha finalidad, puede establecer el tercer campo en «true», p. ej. `__cmp('setPurposeConsent',[52, 1, true ])`
`exportConsent`	`__cmp()`	Exporta la información de consentimiento para compartir el consentimiento entre dispositivos.
`importConsent`	`__cmp()`	Importa la información de consentimiento para este visitante.
`cancelwait`	`__cmp()`	Detiene la CMP para que no espere llamadas entrantes de importación de consentimiento.

`showScreen`	`__cmp()`	Mostrar pantalla de bienvenida (dependiendo de la ubicación del visitante o la configuración de la cuenta).
`showScreenAdvanced`	`__cmp()`	Mostrar el gestor de preferencias (dependiendo de la ubicación del visitante o la configuración de la cuenta). Nota: Puede utilizar el segundo parámetro para indicar qué página debe abrirse (por ejemplo, utilice «c52» para abrir la página del propósito c52).
`showCookies`	`__cmp()`	Mostrar la tabla de cookies.
`close`	`__cmp()`	Cerrar la capa de consentimiento.

`setAgeCallback`	`__cmp()`	Establecer la función de devolución de llamada para la verificación de la edad.
`setUserID`	`__cmp()`	Establecer el ID de usuario externo 1. `setUserID` Establece el ID externo (ID 2, ID 3) con el que se conoce al usuario. `getUserID` y `setUserID` ambos devuelven un objeto de ID de usuario: `{'external': ..., 'external2': ..., 'external3': ..., 'internal': ...}` Nota: El ID de usuario interno solo está disponible si se habilita en la configuración de CMP y después de que se active el evento «settings» (véase Eventos de CMP).
`setUserID2`	`__cmp()`	Establecer ID de usuario externo 2
`setUserID3`	`__cmp()`	Establecer el ID de usuario externo 3
`getUserID`	`__cmp()`	Obtener todos los ID de usuario
`checkBlocking`	`__cmp()`	Comprueba si los elementos bloqueados se pueden desbloquear y los desbloquea.
`checkShowScreen`	`__cmp()`	Comprueba si se debe mostrar (de nuevo) la capa de consentimiento.

`privacyLink`	`__cmp()`	Redirige al visitante a la página de la política de privacidad.
`tacLink`	`__cmp()`	Redirige al visitante a la página de Términos y condiciones.
`imprintLink`	`__cmp()`	Redirige al visitante a la página de aviso legal/pie de imprenta.

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!