Funciones personalizadas

¿Cómo hacer funciones personalizadas del banner?

Nelson
Escrito por NelsonÚltima actualización hace 28 días

En algunos casos, es posible que necesites controlar el comportamiento de tu banner de cookies mediante programación o leer el estado actual del consentimiento del usuario. CookieScript proporciona un conjunto de funciones que se pueden utilizar para personalizar los controles de cookies mediante programación.

Se puede acceder a estas funciones a través de CookieScript.Instance una vez que se inicializan.

Lista de funciones de CookieScript y su descripción

Nombre

Parámetros

Descripción

show

Ninguno

Fuerza la aparición del banner de cookies.

hide

Ninguno

Fuerza el cierre del banner de cookies.

currentState

Ninguno

Devuelve el estado actual del consentimiento del usuario como un objeto con dos propiedades:

acción: 'accept' | 'reject' ;

categorías: ['strict', 'performance', 'targeting', 'functionality', 'unclassified'].

categories

Ninguno

Devuelve una matriz de las categorías de cookies disponibles como una matriz de los siguientes tipos de cookies:

['strict', 'performance', 'targeting', 'functionality', 'unclassified'].

acceptAllAction

Ninguno

Acepta manualmente todas las cookies.

rejectAllAction

Ninguno

Rechaza manualmente todas las cookies excepto las estrictamente necesarias.

acceptAction

Categorías de matriz de cadenas

Acepta manualmente algunas de las categorías de cookies pasadas como parámetro:

CookieScript.instance.acceptAction(['performance', 'targeting']).

Mostrar u ocultar el banner de cookies

El banner de CookieScript se puede mostrar u ocultar con las siguientes funciones:

CookieScript.instance.show() 
CookieScript.instance.hide()

Esto equivaldría a hacer que el banner aparezca haciendo clic en la insignia de la cookie o cerrar el banner haciendo clic en el botón de cierre.

Obtenga el estado de consentimiento actual

La elección de cookie actual del usuario puede leerse llamando a esta función:

CookieScript.instance.currentState()

La función devuelve un objeto con 2 propiedades:

{
    action: 'accept' | 'reject',
    categories: ['strict', 'performance', 'targeting', 'functionality', 'unclassified']
}

La propiedad de la action puede ser accept o reject.

La propiedad de categories es un conjunto de lo que el usuario ha aceptado y puede contener cualquiera de las siguientes categorías: [ strictperformancetargetingfunctionalityunclassified ].

Nombre

Descripción

accept

Significa que el usuario ha aceptado una o más categorías de cookies. La lista de categorías aceptadas se puede encontrar en la propiedad de category.

reject

Significa que el usuario rechazó todas las cookies. En este caso, la propiedad de categories aún almacena una categoría de cookie strict, ya que no se puede rechazar.

Obtenga las categorías disponibles

Algunos sitios web no requieren ni utilizan todas las categorías de cookies mencionadas anteriormente. Los tipos de cookies disponibles actualmente para que el usuario pueda elegir se pueden ver mediante la siguiente función:

CookieScript.instance.categories()

La función devuelve una serie de claves de categoría disponibles:

let categories = CookieScript.instance.categories();
// the variable categories is going to look
// somewhat like this:
// ['performance', 'targeting', 'functionality']

Aceptar/rechazar la política de cookies

Puede aceptar o rechazar la política de cookies con las funciones integradas. Esto puede resultar útil si quieres colocar un enlace pidiéndole al usuario que acepte las cookies antes de que alguna funcionalidad esté disponible.

Aceptar todas las cookies

Se pueden aceptar todas las cookies con la siguiente función:

CookieScript.instance.acceptAllAction()

Esto es lo mismo que hacer clic en el botón Aceptar todo.

Rechazar todas las cookies

Se pueden rechazar todas las cookies (excepto las estrictamente necesarias) con esta función:

CookieScript.instance.rejectAllAction()

Es lo mismo que hacer clic en el botón Rechazar todas.

Aceptar algunas cookies

Si las categorías de cookies están habilitadas, se pueden aceptar mediante programación mediante esta función:

CookieScript.instance.acceptAction(categories)

La función requiere un parámetro con una lista de las categorías que se van a aceptar, como en este ejemplo:

var categories = ['performance', 'targeting', 'functionality', 'unclassified'] CookieScript.instance.acceptAction(categories)

Ejemplos de código

¿Cómo dejar de mostrar el banner de cookies de CookieScript?

Si existe el problema de que algunos editores de sitios web muestran siempre el banner de cookies de CookieScript, puedes dejar de mostrarlo con este código. El código también es útil si tu banner aparece en el iframe que se carga en el mismo dominio y no necesitas mostrar el banner en ese iframe.

<script type="text/javascript" 
        charset="UTF-8" 
        src="//cdn.cookie-script.com/s/xxxxxxxxxxxxxxxxxxxxxxxxxxxx.js" 
        data-cs-restrict-domain="true">
</script>

Un enlace que hace que aparezca el banner de cookies:

<a href="javascript:CookieScript.instance.show()">show popup</a>

Esto equivale a hacer clic en la insignia de CookieScript.

Un enlace que permite al usuario aceptar todas las cookies:

<a href="javascript:CookieScript.instance.acceptAllAction()">
    By continuing you are accepting all cookies.
</a>

Un enlace que permite al usuario aceptar algunas categorías

<a href="javascript:CookieScript.instance.acceptAction(['performance', 'targeting'])">
    Accept
</a>

Eventos de CookieScript

CookieScript también ofrece una variedad de eventos para escuchar las acciones de Cookie Banner. Hemos creado una explicación detallada de cómo funcionan los eventos personalizados

.

¿Ha respondido esto a tu pregunta?