Javascript apis
-# API Javascript
--CCM19 ofrece varias API Javascript que pueden utilizarse para acceder a las funcionalidades del Gestor de Cookies y responder a las interacciones de los usuarios.
Objeto global
-Las opciones de control directo de CCM19 están agrupadas en el objeto global Javascript CCM
:
Variable/método Tipo Descripción | ||
---|---|---|
-CCM.acceptedCookies string[] Lista de los nombres de todas las [cookies] aceptadas(https://www.ccm19.de/glossar/13 Cookies.html#13). | ||
-- - CCM.acceptedEmbeddings string[ { id: string , name: string , } , ... ] Lista de todos los [embeddings] aceptados(docs.ccm19.com/functions/cookies and other/ "Cookies & embeddings CCM19 Cookie Consent Manager Documentation"). (a partir de la versión 2020.10.28) |
||
CCM.availableLocales() string[] Lista de idiomas activos - por ejemplo ['de_DE', 'en_US'] (a partir de la versión 2022.03.24) |
||
CCM.closeControlPanel() Cierra el diálogo para seleccionar los propósitos a aceptar. | ||
-CCM.closeWidget() Cierra el diálogo de cookies. | ||
-CCM.consent boolean Indica si el visitante del sitio ha definido y guardado su configuración de consentimiento. También puede significar que todo ha sido rechazado. | ||
-----CCM.crossDomainConsentString string Identificador de fragmento para compilar manualmente una URL para la división Consent. (a partir de la versión 2020.10.14) | ||
CCM.fullConsentGiven boolean Indica si el visitante de la página ha dado su consentimiento a todas las opciones. Un resultado positivo implica lo mismo para CCM.consent . (a partir de la versión 2023.03.29) |
||
-----CCM.navigate(url[, replace[, navigateTop]]) Navega a otra URL (como location.href = url ), pero tiene en cuenta la división Consent. replace controla si se utiliza location.replace y navigateTop controla si se navega por la página completa para los marcos. (a partir de la versión 2020.10.14) |
||
CCM.openControlPanel() Abre el diálogo para seleccionar los propósitos a aceptar. | ||
-CCM.openWidget() Abre de nuevo el diálogo de cookies. | ||
CCM.switchLocale(localeName) Cambia el idioma - véase CCM.availableLocales() (a partir de la versión 2022.03.24) |
||
--CCM.ucid ?string El ID de consentimiento único, o null si aún no se ha emitido ningún Consent. | ||
-CCM.version string Contiene la versión actual de CCM19. (a partir de la versión 2020.10.28) |
Alternativamente, los diálogos también pueden controlarse mediante enlaces con los objetivos #CCM.openWidget
, #CCM.closeWidget
, #CCM.openControlPanel
y #CCM.closeControlPanel
.
-
Extensión para publicidad y redes sin seguimiento
---Si la opción "Mi sitio web forma parte de una red libre de publicidad y seguimiento " está activa en el área Configuración del desarrollador > Comportamiento del frontend del dominio, se definen los siguientes endpoints, que pueden utilizarse en el frontend.
Los siguientes endpoints se publicaron con la versión 2023.03.20 y no están disponibles en versiones anteriores.
¡<!-- --table header=true >
| | | Variable/método Tipo Descripción |
| ------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| | | CCM.denyAllPrivileges() Función Alias de CCM.revokeAllPrivileges()
. |
| | |-CCM.grantAllPrivileges() Función Permite todas las categorías, incrustaciones, proveedores TCF, etc. Esta función asume que el visitante del sitio ha dado su pleno consentimiento. Dependiendo de CCM.requiresConsentUpdate
, puede ser necesario renovar el consentimiento. Por favor, llame sólo una vez por cada interacción del usuario, no repetidamente por cada vista de página.Desde la versión 2023.07.17, también se activa el evento ccm19WidgetClosed
. |
| | |-CCM.revokeAllPrivileges() Función Rechaza todas las categorías, vinculaciones, proveedores TCF, etc. Esta función asume que esto ha sido indicado por el visitante del sitio. Los enlaces técnicamente necesarios se siguen cargando. Por favor, llámela sólo una vez por cada interacción del usuario, no repetidamente por cada vista de página.Desde la versión 2023.07.17, también se activa el evento ccm19WidgetClosed
. |
| | |-CCM.requiresConsentUpdate boolean Indica que CCM19 espera una actualización de la configuración del consentimiento.-Esto significa que - aún no se ha configurado ningún Consentimiento (primera visita a la página) o - ha cambiado algo legalmente relevante en la configuración de CCM19 o - ha expirado el periodo de validez especificado. Este valor debe comprobarse y tenerse en cuenta cada vez que se acceda a la página.En los casos anteriores, el evento ccm19WidgetOpened
también se activa desde la versión 2023.07.17. |
| | | CCM.embeddings Object[] Devuelve un array de todos los embeddings y pone a disposición el contenido textual para su uso posterior. Las traducciones para todos los idiomas que están activos para el frontend se proporcionan tanto para los embeddings como para sus assets
(cookies). - CCM.embeddings[].name
- CCM.embeddings[].vendor
- CCM.embeddings[].l10n.de_DE
- CCM.embeddings[].l10n.en_US
- CCM.embeddings[].l10n._
- CCM.embeddings[].assets[].-name
- CCM.embeddings[].assets[].type
- CCM.embeddings[].assets[].l10n
Con l10n._
, las entradas de idioma del idioma alternativo (definido para cada cuenta de cliente) están disponibles para su recuperación además de las configuraciones regionales activas.-Como no todas las configuraciones de CMP proporcionan los mismos idiomas para el banner, esto proporciona una entrada generalmente disponible; sin embargo, el idioma de las entradas depende de la configuración. (después de la versión 2024.03.13) |
| | |--CCM.tcf.customVendors string[] Contiene todos los proveedores definidos en los enlaces CCM19 pero que no son proveedores TCF. (a partir de la versión 2023.06.01) |
| | |-CCM.tcf.enabled boolean Indica si está activo el soporte para el marco IAB. |
| | |--CCM.tcf.stacks int[] Contiene los stacks TCF que representan la configuración CCM19 dada de un sitio web. (a partir de la versión 2023.06.01) |
| | |-CCM.tcf.vendors Object[] Además del ID del vendedor, cada objeto contiene también los propósitos utilizados. Los ID de todos los vendedores activos pueden leerse con CCM.tcf.vendors.map(x => x.id)
. Hasta la versión 2023.05.25, esta propiedad aún se implementaba como un objeto en lugar de como un array; el ajuste se realizó en consulta con el primer usuario de esta característica. |
- Dado que las interfaces anteriores sólo están disponibles si está activa la opción correspondiente para redes sin publicidad ni seguimiento, el operador de la red debe comprobar la disponibilidad en su código para evitar el acceso a propiedades no definidas. Por lo tanto, su propio código debería incluir los siguientes corchetes, por ejemplo
if (typeof window.CCM == 'object' && typeof window.CCM.denyAllPrivileges == 'function') {
- // la opción "Mi sitio web forma parte de una red libre de publicidad y seguimiento" está activa
// y se puede acceder a las propiedades.
}
else {
console.log('Por favor, active la opción en CCM19.');
}
-## Eventos Javascript
-Algunos eventos en CCM19 se asignan a CustomEvents en el objeto window
y se puede reaccionar a ellos con window.addEventListener(...)
.
- | Detalle del evento Propiedad Descripción | |
---|---|---|
ccm19CookieAccepted { name: string , code: string , purpose: string , mandatory: boolean , } El usuario ha aceptado una cookie. Este evento se desencadena para cada cookie listada en los propósitos aceptados; estos eventos se producen cuando el visitante otorga su consentimiento y se repiten en cada visita posterior a la página cuando ésta se carga. Obsoleto: Por favor, cambie a ccm19EmbeddingAccepted . |
||
ccm19EmbeddingAccepted { name: string , code: string , purpose: string , mandatory: boolean , } El usuario ha aceptado una incrustación. Estos eventos se producen cuando el visitante da su consentimiento y se repiten en cada vista de página. (a partir de la versión 2020.10.28) |
||
--ccm19WidgetClosed null Se activa en cuanto se cierra el último elemento visible del widget CCM19.-Esto puede ser el resultado de un clic en un botón Guardar que lleva al cierre del widget. | ||
--ccm19WidgetOpened null Se activa en cuanto se muestra el primer elemento del widget CCM19.-Puede tratarse de la apertura inicial al abrir la página o de una interacción posterior, por ejemplo, a través del icono de configuración. | ||
ccm19WidgetLoaded null Se activa en cuanto se inicializa CCM19. |