Iubenda logo
Crie Agora

Documentação

Tabela de conteúdos

Como configurar sua Cookie Solution (guia avançado)

Aqui você encontrará uma visão detalhada de:

💡 Precisa de uma introdução? Conheça as opções do configurador, como alterar o estilo do banner, a posição e muito mais em nosso manual de introdução à Cookie Solution.

Rápida recapitulação:

  • É implementado através da inserção de um simples código/script em todas as páginas do site;
  • Mostra um aviso contendo um texto padrão, é totalmente personalizável, além de conter um link para a política de cookies;
  • Ele tem um design totalmente adaptável, otimizado para diversas resoluções e tamanhos de dispositivo;
  • Garantimos que a política de cookies possa ser visualizada antes mesmo do fornecimento do consentimento do usuário;
  • Garantimos o funcionamento adequado do bloqueio de scripts – consulte o manual introdutório ao bloqueio de cookies para mais informações sobre este tema;
  • Registra preferências por meio da navegação contínua do usuário, por exemplo, por meio da rolagem;
  • Após a coleta do consentimento, ele ativa de forma assíncrona (ou seja, sem recarregar a página) todos os scripts que foram bloqueados anteriormente;
  • Se o consentimento já foi fornecido pelo usuário, o banner de cookie não aparece e os scripts são executados automaticamente;
  • Personalize de maneira fácil com nosso configurador. Edite a aparência, os detalhes, os recursos da solução, tudo com alguns cliques.

Depois de gerar seu banner de cookie (Cookie Solution > Ativar/Editar), você obterá um snippet de código semelhante:


Para exibir o banner de cookie em seu site, copie e cole o snippet acima (lembre-se de gerar seu próprio código em Cookie Solution > Ativar/Editar) no final da tag HEAD de suas páginas, ou use um de nossos plugins para:

Também temos manuais de inserção com o passo a passo para sites personalizados, Shopify, Webflow, Wix e Squarespace.

Usuários do Drupal podem acessar a aula por download direto ou Packagist e encontrar instruções completas no manual da aula de PHP.

Além de exibir um banner de cookie, você também deve bloquear os cookies antes do consentimento:

Muitas Autoridades de Proteção de Dados em toda a UE alinharam, portanto, suas regras de cookies e rastreadores aos requisitos do GDPR, em particular, é necessário que você registre e armazene provas das preferências de seus usuários.

Clique aqui para mais informações sobre como ativar el Registro de Preferência de Cookies dentro de sua Cookie Solution.

Observação: todos os parâmetros a seguir precisam ser incluídos no _iub.csConfiguration {}.

1. Parâmetros obrigatórios

siteId – Código ID do seu site (aviso: este ID é usado para compartilhar as preferências entre várias políticas de cookies nos diferentes idiomas atribuídos ao mesmo site/aplicativo)

cookiePolicyId – Código ID da sua política de cookies

lang – Este parâmetro define o idioma onde o conteúdo do banner de cookie será exibido (por exemplo, “it” para italiano, “en” para inglês, “es” para espanhol, etc.). Todas as localizações de idiomas disponíveis no gerador também estão disponíveis para o conteúdo do banner.

2. Configurações de compliance

countryDetection (boolean, default false) – Permite detectar automaticamente o país do usuário.

Para o GDPR

Para limitar as solicitações de bloqueio prévio e consentimento de cookies dos usuários da UE (onde isso é um requisito legal) enquanto executa normalmente os scripts de cookies em regiões onde você ainda tem permissão legal para fazê-lo, defina este parâmetro como true se gdprAppliesGlobally estiver definido como false.

Se você desativar esta opção, lembre-se de definir gdprApplies:false em todas as visualizações de página onde o consentimento não estiver sendo solicitado.

Para a CCPA

Para ativar as proteções CCPA somente para usuários aos quais o CCPA se aplica, defina este parâmetro como true se ccpaApplies estiver definido como false.

2.1 GDPR

enableGdpr (boolean, default true) – se for true, você ativará/disponibilizará a funcionalidade GDPR na Cookie Solution (sem efetivamente aplicá-la).

gdprAppliesGlobally (boolean, default true) – se for true, você aplicará proteções GDPR a todos os usuários. Defina este parâmetro como false e countryDetection:true para solicitar consentimento apenas para usuários da UE. Lembre-se de que, se você estiver na UE, deverá aplicar o GDPR também a usuários localizados fora da UE.

gdprApplies (boolean, default true) – se for false, você não aplicará as proteções GDPR ao usuário atual e ele não verá o banner do cookie. Se você definiu countryDetection:false, deve colocar gdprApplies:false em todas as visualizações de página onde o consentimento não está sendo solicitado.

Botões (aceitar, personalizar, rejeitar, fechar)

As opções listadas abaixo devem estar contidas no objeto banner {}:

acceptButtonDisplay (boolean, default false) – determina a exibição ou não exibição do botão “Aceitar”.

customizeButtonDisplay (boolean, default false) – determina a exibição ou não exibição do botão “Saiba mais e personalize”.

rejectButtonDisplay (boolean, default false) – determina a exibição ou não exibição do botão “Rejeitar”. Quando o banner.closeButtonDisplay true for forçado para false. Veja a demonstração no CodePen.

closeButtonDisplay (boolean, default true) – se for definido como false, o botão de fechamento do banner não será exibido.

Consentimento para navegação contínua, rolagem e interação com a página

consentOnContinuedBrowsing (boolean, default true) – se for definido como false, consentOnScroll, consentOnDocument e consentOnLinkAndButton serão definidos como false e consentOnElement não será definido como nenhum elemento. Desta forma, você aceitará apenas o consentimento explícito, enquanto o consentimento na rolagem e na interação da página não será fornecido.

consentOnScroll (boolean,default true) – você pode definir este parâmetro como false para evitar o registro do consentimento do usuário quando a página é rolada.

consentOnHorizontalScroll (boolean, default false) – ao definir este parâmetro como true, o consentimento será dado mesmo em casos de rolagem horizontal.

consentOnScrollOnElement (string|DOMElement, default null) – o evento de rolagem é observado no elemento transmitido como um parâmetro (incluindo seletores como classes e ids). O elemento DOM pode ainda não estar disponível quando a Cookie Solution for inicializada. Nesse caso, você pode usar o método API setConsentOnScrollOnElement.

consentOnLinkAndButton (boolean, default true) – o consentimento do usuário normalmente também é registrado após um clique no botão (button) da página, bem como nos links (a). Se definido como false, o parâmetro consentOnLinkAndButton(anteriormente consentOnButton) alterará o funcionamento padrão, garantindo que o consentimento resulte como “não fornecido” nesses casos.

consentOnElement (string|DOMElement, default “input, textarea, form”) – o consentimento do usuário é registrado ao clicar em um dos elementos html (incluindo seletores como classes e ids) listados no parâmetro. Diferente de consentOnLinkAndButton (veja acima), a opção não gerencia as tags a e button. Importante: se novos elementos html forem adicionados e você precisar que os elementos padrão permaneçam ativos, você deve se manifestar novamente.

consentOnDocument (boolean, default false) – se definido como true, o consentimento do usuário será registrado se você clicar em qualquer lugar da página (com exceção da área do banner).

Consentimento por categoria

perPurposeConsent (boolean, default false) – Definir este parâmetro como true dá aos usuários controle granular sobre quais categorias de cookies eles consentem (veja abaixo). As categorias são exibidas com uma breve descrição e alternam para que os usuários possam conceder ou rejeitar o consentimento para a finalidade específica de processamento.

As categorias exibidas no modal são detectadas automaticamente e transferidas de sua política de cookies da iubenda para a Cookie Solution. No entanto, as categorias exibidas também podem ser personalizadas usando o parâmetro purposes, abaixo.

Exemplos:

Codificação manual e consentimento por categoria

Se você ativou o recurso de consentimento por categoria, precisará especificar as categorias de scripts que instalam cookies antes do consentimento com o atributo especial data-iub-purposes separado por vírgulas. Leia este manual para obter mais orientações e exemplos sobre o uso da marcação manual e consentimento por categoria.

purposes (string, default null) – as finalidades são agrupadas em 5 categorias (estritamente necessário, interações e funcionalidades básicas, otimização da experiência, medição, direcionamento e publicidade), cada uma com um id (1, 2, 3, 4, 5). Por padrão, usamos as finalidades da política de cookies da iubenda conectadas à sua configuração, mas você pode personalizar quais categorias exibir com purposes (por exemplo, se você usar sua própria política de cookies).

Aqui estão as finalidades incluídas em cada categoria:

  1. Estritamente necessário (id 1). Finalidades incluídas:
    • Salvar e gestão de backup
    • Hospedagem e infraestrutura de backend
    • Gerenciamento de página Inicial e de convite
    • Serviços de plataforma e hospedagem
    • Proteção anti-spam
    • Otimização e distribuição de tráfego
    • Monitoramento de infraestrutura
    • Processamento de pagamentos
  2. Interações e funcionalidades básicas (id 2). Finalidades incluídas:
    • Contatar o Usuário
    • Interação com as plataformas de chat ao vivo
    • Gerenciamento de webconferências e telefonia online
    • Gestão de solicitações de suporte e contato
    • Interação com as plataformas de suporte e de feedback
    • Gerenciamento de tags
    • Registro e autenticação
    • Gerenciamento de banco de dados de Usuários
  3. Otimização da experiência (id 3). Finalidades incluídas:
    • Comentário de conteúdo
    • Interação com plataformas de coleta de dados e outros terceiros
    • Visualizar conteúdo de plataformas externas
    • Interação com redes sociais e plataformas externas
    • Interação com as plataformas de pesquisa online
    • Gereciamento de RSS feed
    • Características sociais
  4. Medição (id 4). Finalidades incluídas:
    • Estatísticas
    • Beta testing
    • Desempenho de conteúdo e características de teste (teste A/B)
    • Mapeamento térmico e gravação de sessão
    • Gerenciamento de coleta de dados e pesquisas online
  5. Direcionamento e publicidade (id 5). Finalidades incluídas:
    • Publicidade
    • Infraestrutura de serviço de publicidade
    • Afiliação comercial
    • Gerenciamento de contactos e envio de mensagens
    • Remarketing e objetivo comportamental

Então, por exemplo, se você estiver usando todas as 5 categorias e não estiver usando uma política de cookies da iubenda, você precisará especificar a "purposes": "1, 2, 3, 4, 5", se você não usar a Medição (id 4), você pode simplesmente especificar a "purposes": "1, 2, 3, 5" e assim por diante.

Observação: para funcionar, este parâmetro requer que o parâmetro perPurposeConsent esteja definido como true (obtenha mais detalhes acima).

listPurposes (boolean, default false) – Se for true, ele exibirá as finalidades na primeira fase do banner do cookie (para funcionar, o perPurposeConsent deve ser definido como true). Esta opção deve estar contida no objeto banner {}.

2.2 CCPA

enableCcpa (boolean, default false) – se for true, você ativará/disponibilizará a funcionalidade CCPA na Cookie Solution (sem efetivamente aplicá-la).

ccpaApplies (boolean, default false) – se for true, você aplicará as proteções CCPA ao usuário atual.

ccpaNoticeDisplay (boolean, default true) – se for false, você não exibirá um banner propriamente dito para notificar os usuários sobre o CCPA (vigente apenas se o GDPR não se aplicar).

ccpaAcknowledgeOnDisplay (boolean, default false) – se for ccpaNoticeDisplay: true, permitirá que você especifique o que constitui a aceitação do aviso: o simples carregamento do aviso (true) ou a interação explícita após o carregamento do aviso (false).

ccpaAcknowledgeOnLoad (boolean, default false) – se definido como true e ccpaAcknowledgeOnDisplay: false, o aviso é reconhecido quando a página é carregada.

ccpaLspa (boolean, default false) – permite que você especifique se a transação deve ser realizada nos termos do Limited Service Provider Agreement (LSPA) do IAB.

Classes

iubenda-ccpa-opt-out – Ao adicionar esta classe a qualquer elemento da página, o clique no item aciona a abertura de uma caixa de diálogo onde o usuário pode confirmar sua intenção de cancelar a venda de suas informações pessoais (link “Não venda minhas informações pessoais”).

As principais redes de publicidade agora exigem que as editoras obtenham o consentimento antes de exibir anúncios personalizados. Neste manual, você aprenderá como pode atender a esse requisito com a IAB Transparency and Consent Framework e a nossa Cookie Solution.

enableTcf (boolean, default false) – se for true, os usuários poderão gerenciar suas preferências de rastreamento de publicidade de acordo com a IAB Transparency and Consent Framework.

googleAdditionalConsentMode (boolean, default false) – Se definido como true, você poderá obter o consentimento dos parceiros de anúncios do Google que ainda não fazem parte da Transparency and Consent Framework, mas estão na lista do Google’s Ad Tech Providers (ATP).

tcfPurposes (object) – o TCF v2.0 tem 10 finalidades, cada uma com um id:

  1. Armazenar e/ou acessar informações em um dispositivo
  2. Selecionar anúncios básicos
  3. Criar um perfil de anúncios personalizados
  4. Selecionar anúncios personalizados
  5. Criar um perfil de conteúdos personalizados
  6. Selecionar conteúdos personalizados
  7. Medir o desempenho do anúncio
  8. Medir o desempenho dos conteúdos
  9. Aplicar pesquisas de mercado de forma a gerar perspectivas sobre o público
  10. Desenvolver e melhorar produtos

Com a TCF v2.0 você pode:

  • limitar a base legal apenas para o consentimento ou apenas para o interesse legítimo, ou ambos; e
  • escolher quais finalidades da TCF solicitar

Veja como fazer. Graças a tcfPurposes, no exemplo a seguir, iremos:

  • desativar a finalidade número 1 (“Armazenar e/ou acessar informações em um dispositivo”, definido como consent_not_needed, possível apenas se nossa legislação não exigir consentimento para essa finalidade) *,
  • desativar a finalidade número 2 (“Selecionar anúncios básicos”, defina como false),
  • limitar a base legal ao interesse legítimo apenas (li_only) para a finalidade número 4 (“Selecionar anúncios personalizados”), e
  • limitar a base legal para consentimento apenas (consent_only) para a finalidade número 7 (“Medir o desempenho do anúncio”)
_iub.csConfiguration = {
    "lang": "en",
    "siteId": xxxxxx, //use your siteId
    "cookiePolicyId": yyyyyy, //use your cookiePolicyId
    "enableTcf": true,
    ...
    "tcfPurposes": {
        "1": "consent_not_needed",
        "2": false,
        "4": "li_only",
        "7": "consent_only"
    },
    "tcfPublisherCC": "DE",
    "banner": {
        ...
    }
}

* Observação sobre a PurposeOneTreatment: anteriormente, em alguns países, não era necessário obter o consentimento do usuário para a finalidade número 1 (“Armazenar e/ou acessar informações em um dispositivo”). Nesses casos, a solicitação de consentimento para uma finalidade poderia ser desativada pelo uso do "1": "consent_not_needed". No entanto, uma vez que esta opção só deve ser ativada se for legalmente compatível com a legislação aplicada a você e, no momento em que este documento foi escrito, nenhum país da UE apoiava esta opção legislativa – desaconselhamos a sua utilização.

askConsentIfCMPNotFound (boolean, default true) – se definido como true e a preferência do IAB Framework não for encontrada, a Cookie Solution irá, por padrão, solicitar um novo consentimento dos usuários que forneceram consentimento antes da ativação do Framework. Defina esta opção como false para desativar este comportamento padrão.

newConsentAtVendorListUpdate (number, default undefined) – número de dias de espera para acionar uma nova solicitação de consentimento após a atualização do vendorlist.json. Se definido como indefinido, os usuários que já deram consentimento não verão o banner do cookie novamente e o consentimento para novos fornecedores será desativado. Se definido como 0, os usuários receberão uma nova solicitação de consentimento quando a lista de fornecedores for atualizada.

Classes

iubenda-advertising-preferences-link – Ao adicionar esta classe a qualquer elemento da página, o clique no item aciona a abertura do modal de configurações de rastreamento de publicidade (permitindo que usuários atualizem suas preferências da TCF mesmo após o fechamento do banner de cookie).

Observe que, como alternativa a esta classe TCF específica, você também pode usar o iubenda-cs-preferences-link “genérico” e o resultado será o mesmo.

iubenda-vendor-list-link – Adicione esta classe a qualquer elemento da página para permitir que os usuários reabram a lista de fornecedores da TCF.

3. Estilo e texto

3.1 Formato e posição

position (string, default “float-top-center”) – define a posição do banner de cookie. Valores disponíveis: top, bottom, float-top-left, float-top-right, float-bottom-left, float-bottom-right, float-top-center, float-bottom-center e float-center.

backgroundOverlay (boolean, default false) – defina este parâmetro como true para adicionar um efeito de sobreposição de plano de fundo opaco ao resto da página quando o banner de cookie for exibido.

3.2 Tema

Logotipo

logo (string) – URL (recomendado o uso de https) ou equivalente a base64 de uma imagem a ser usada como logotipo para o cabeçalho do banner de cookie. Use um SVG branco com fundo transparente para obter melhor resultado.

brandTextColor (string, default “#000”) – cor do texto do cabeçalho do modal/banner de cookie.

brandBackgroundColor (string, default “#fff”) – cor de fundo do cabeçalho do banner de cookie.

Cores do banner

backgroundColor (string, default “#000”) – a cor de fundo do banner.

textColor (string, default “#fff”) – a cor do texto do banner.

Botões

acceptButtonColor (string, default “#0073ce”) – cor de fundo do botão “Aceitar”.

acceptButtonCaptionColor (string, default “#fff”) – cor do texto do botão “Aceitar”.

customizeButtonColor (string, dark theme default “#212121”, light theme default “#dadada”) – cor de fundo do botão “Saiba mais e personalize”.

customizeButtonCaptionColor (string, dark theme default “#fff”, light theme default “#4d4d4d”) – cor do texto do botão “Saiba mais e personalize”.

rejectButtonColor (string, default “#0073ce”) – Cor de fundo do botão “Rejeitar”.

rejectButtonCaptionColor (string, default “#fff”) – cor do texto do botão “Rejeitar”.

Configurações avançadas

applyStyles (boolean, default true) – ao definir este parâmetro como false, o estilo/CSS padrão não será aplicado ao banner; este parâmetro pode ser útil, por exemplo, quando você desejar dar ao banner um estilo diferente do padrão.

O ponto de partida deve ser sempre o nosso CSS, que você pode encontrar aqui. Ele reaplica o mesmo estilo excluído desta opção, mas tem a vantagem de ser editável depois de inserido nas páginas. Segue um exemplo: Banner com CSS personalizado.

zIndex (number) – este é o zIndex do div do banner. O valor padrão é 99999998.

3.3 Texto

Tamanho da fonte

fontSize (string, default null) – a dimensão do texto do banner (incluindo o botão de fechamento). Se esta opção estiver ativa, os valores possíveis nas opções banner.fontSizeCloseButton e banner.fontSizeBody não serão considerados.

fontSizeCloseButton (string, default “20px”) – a dimensão do botão de fechamento do banner.

fontSizeBody (string, default “14px”) – a dimensão do conteúdo do texto do banner.

Cópia do banner

content (string) – este é o conteúdo textual dentro do banner de cookie. Por exemplo, para a versão em inglês, o valor padrão é:

Aviso
Nós, e alguns parceiros selecionados, usamos cookies ou tecnologias semelhantes, conforme especificado na %{cookie_policy_link}.

Shortcodes

Shortcodes são palavras especiais que podem ser usadas dentro do banner.content e banner.html como um espaço reservado para outra coisa. Você pode usá-los quando quiser personalizar o banner, mas ainda manter os elementos da interface do usuário que permitem ter o funcionamento padrão da Cookie Solution.

Códigos curtos disponíveis para banner.content:

  • %{cookie_policy_link} é substituído por um link para a cookiePolicyUrl e com a legenda especificada em banner.cookiePolicyLinkCaption
  • %{advertising_preferences_link} é substituído por um link para o widget da Transparency and Consent Framework
  • %{vendor_list_link} é substituído por um link para a lista de fornecedores da Transparency and Consent Framework
  • %{privacy_policy} é substituído por um link para a política de privacidade (necessário para a CCPA)
  • %{do_not_sell} é substituído por um link para cancelar a comercialização da CCPA

Segue abaixo um exemplo de banner de cookie com HTML e conteúdo personalizados.

Observações

  • %{cookie_policy_link} é o shortcode onde o link da política de cookies é inserido. Lembre-se de que, por padrão, a política de cookies vinculada ao banner é a mesma hospedada em nossos servidores. Para alterar o funcionamento padrão, você precisa modificar o parâmetro cookiePolicyUrl (consulte a respectiva seção deste manual para obter mais informações sobre a cookiePolicyUrl).
  • O conteúdo do banner de cookie será traduzido para todos os idiomas disponíveis no gerador (o idioma de exibição do conteúdo do banner é definido através do parâmetro lang).
  • Se você ativou a Transparency and Consent Framework, poderá notar que o texto do banner é muito longo. Isso é necessário para atender aos requisitos mínimos do IAB. Portanto, leia atentamente os requisitos do IAB antes de editar o conteúdo do banner.
  • Para garantir que a política de cookies seja exibida corretamente, é necessário que a classe iubenda-cs-cookie-policy-lnk não seja usada em outro lugar da mesma página.

acceptButtonCaption (string, default “Accept”) – o texto do botão “Aceitar” do banner.

customizeButtonCaption (string, default “Learn more and customize”) – o texto do botão “Saiba mais e customize” do banner.

rejectButtonCaption (string, default “Reject”) – o texto do botão “Rejeitar” do banner.

Configurações avançadas

html (string, default null) – é o HTML padrão do banner, através deste parâmetro, ele pode ser substituído pelo customizado.

Observações: alguns elementos são, de qualquer forma, necessários para o bom funcionamento do banner, especialmente:

  • div.iubenda-cs-content (o contêiner principal)
  • a.iubenda-cs-cookie-policy-lnk (o link href definido para vincular à política de cookies, ou seja, https://www.iubenda.com/privacy-policy/123456/cookie-policy?an=no&s_ck=false)
Shortcodes

Shortcodes são palavras especiais que podem ser usadas dentro do banner.content e do banner.html como um espaço reservado para outra coisa. Você pode usá-los quando quiser personalizar o banner, mas ainda manter os elementos da interface do usuário que permitem ter o funcionamento padrão do Cookie Solution.

Shortcodes disponíveis para banner.html:

%{banner_content} é substituído pelo valor especificado em  banner.content(ou o conteúdo do banner padrão). Observe que o  %{banner_content}é  obrigatório no caso da TCF v2  (a menos que tenhamos aprovado o seu texto personalizado).

Segue abaixo um  exemplo de banner de cookie com HTML e conteúdo personalizados.

innerHtmlCloseBtn (string, default “x”) – o texto do botão de fechamento do banner.

Rodapé

footer {} (object) – as opções listadas abaixo devem estar contidas no objeto footer {}.

btnCaption (string) – texto do botão (localizado na parte inferior da janela “Preferências de rastreamento”, consulte o consentimento por categoria) usado para salvar as preferências de consentimento. O valor padrão é “Salvar e continuar”.

i18next

i18n {} (object) – você pode traduzir/editar os textos de qualquer componente da Cookie Solution através da biblioteca JavaScript i18n. Veja esta demonstração no CodePen para obter uma lista de todos os componentes/strings que você pode editar e/ou traduzir.

Importante: se você ativou a Transparency and Consent Framework, a fim de atender aos requisitos mínimos de configuração do IAB, você deve necessariamente usar as traduções oficiais (veja a “Lista de traduções para descrições de finalidades v2.0”).

3.4 Widget de consentimento

floatingPreferencesButtonDisplay (string, default false) – define a posição do widget de privacidade (um recurso que permite que seus usuários acessem e editem a qualquer momento as preferências de rastreamento após a definição de suas preferências iniciais). Valores disponíveis: false, true, top-left, top-right, bottom-left, bottom-right (default if set to true), anchored-center-left, anchored-center-right, anchored-top-left, anchored-top-right, anchored-bottom-left, anchored-bottom-right.

Formato

floatingPreferencesButtonCaption (string, default false) – texto do botão do widget de privacidade.

floatingPreferencesButtonIcon (boolean, default true) – ícone do botão do widget de privacidade.

floatingPreferencesButtonHover (boolean, default false) – mostra o texto do widget de privacidade ao passar o mouse.

floatingPreferencesButtonRound (boolean, default false) – adiciona o atributo iubenda-tp-circle ao botão do widget de privacidade.

Cores

floatingPreferencesButtonColor (string, default “#fff”) – cor de fundo do botão do widget de privacidade.

floatingPreferencesButtonCaptionColor (string, default “#000”)  – cor do texto do botão do widget de privacidade.

4. Política de privacidade e cookies

privacyPolicyUrl (string) – permite que você personalize o link da política de privacidade.

cookiePolicyUrl (string) – esta é a URL da política de cookies vinculado ao banner. Ela está disponível na página de edição da sua política de privacidade na guia “inserção”. Se você não definir este parâmetro, ele fará referência à política de cookies gerada pela iubenda e hospedada em nossos servidores.

Alternativamente, você pode escolher hospedar a política de cookies em uma página do seu site e preencher este campo com a respectiva URL. Lembre-se que se você decidir hospedar a política de cookies em sua própria página, esta página não deve usar outros cookies além dos técnicos. Observação: este parâmetro será ineficaz se você estiver usando um HTML personalizado para o banner (consulte a configuração banner.html abaixo).

cookiePolicyInOtherWindow (boolean, default false) – se você definir este parâmetro como true, a política de privacidade e a política de cookies serão abertas em outra janela em vez da janela modal da iubenda.

cookiePolicyLinkCaption (string) – texto âncora do link para a política de cookies (o valor padrão é “política de cookies”). Esta opção deve estar contida no objeto banner {}.

5. Configurações avançadas

5.1 Configurações do banner

As opções listadas abaixo devem estar contidas no objeto banner {}:

slideDown (boolean, default true)  – você pode definir este parâmetro como  false  para desativar a animação do banner.

prependOnBody (boolean, default false) – se este parâmetro for definido como true, o código HTML do banner será introduzido no site como o primeiro elemento do BODY. Por padrão, prependOnBody é definido como false e o banner é colocado como o último elemento do BODY.

Você deve definir o prependOnBody como true quando quiser, por exemplo, colocar o banner acima do cabeçalho. Desta forma, o banner será o primeiro elemento da página e, para exibi-lo no topo do cabeçalho, basta aplicar um “padding-top” ao próximo item: #iubenda-cs-banner + * { padding-top: 180px; }

Exemplo com o banner posicionado acima do cabeçalho.

5.2 Configurações de coleta de consentimento

reloadOnConsent (boolean, default false) – você pode definir este parâmetro como true se quiser que a página seja recarregada após a coleta do consentimento.

askConsentAtCookiePolicyUpdate (boolean, default false) –  você pode definir este parâmetro como true se quiser solicitar um novo consentimento quando a Política de Cookie for atualizada.

enableRemoteConsent (boolean, default false) – você pode definir este parâmetro como true para permitir o registro de consentimento entre sites (pode ser útil quando o script for implementado em mais de um site da mesma rede). Sobretudo, se você definir este parâmetro como true, nossa solução cria um cookie técnico em iubenda.com (domínio) que será usado quando o cookie no domínio local não for encontrado.

priorConsent (boolean, default true) – ativa o bloqueio de scripts e sua reativação somente após a obtenção do consentimento do usuário. Se forem false, os scripts bloqueados serão sempre reativados, independente de o consentimento ter sido fornecido ou não (pode ser útil para fins de teste ou quando você está trabalhando em seu projeto localmente e não deseja contar as visualizações de página).

Aconselhamos a não definir "priorConsent":false se você precisar cumprir a legislação da UE. Observe que, se a configuração de bloqueio anterior tiver sido desativada no por parte do servidor (por meio da caixa de seleção na página de fluxo), este parâmetro será ineficaz se estiver definido como true ou false.

invalidateConsentWithoutLog (boolean, string, date, default false). Quando definido como true, um novo consentimento será solicitado sempre que o consentimento de um usuário não for encontrado no Registro de Preferência de Cookie. 
Se uma data for definida (formato: “aaaa-mm-dd”) quando o consentimento coletado antes dessa data não for encontrado no Registro de Preferências de Cookie, um novo consentimento será solicitado (por exemplo, invalidateConsentWithoutLog: "2022-01-10“)

5.3 Desenvolvimento

inlineDelay (integer, milliseconds, default 500) – o tempo máximo entre as ativações de trechos marcados com a classe _iub_cs_activate-inline (os trechos marcados dessa forma são ativados sequencialmente). Ao diminuir este valor, você reduzirá o tempo total de ativação. Atenção: o valor padrão é definido para que os snippets funcionem corretamente; reduzi-lo pode impedir a ativação bem-sucedida de algum fragmento. Recomenda-se verificar a ativação do snippet exibido em sua página se esta configuração for alterada.

consentOnScrollDelay (integer, milliseconds, default 500) – o atraso com que o consentimento via scroll é detectado, uma vez que o banner foi exibido. Esta opção deve estar contida no objeto banner {}.

rebuildIframe (boolean, default true) – assim que o consentimento do usuário for registrado, o funcionamento padrão da Cookie Solution será regenerar (ou reintegrar) totalmente os iframes anteriormente modificados. Ao definir esse parâmetro como false, os iframes anteriormente bloqueados serão restaurados após a coleta de consentimento.

Callbacks

callback {} (object) – este é o parâmetro através do qual você pode definir o callback que a Cookie Solution da iubenda pode realizar na ocorrência de um evento.

onReady (function) – Se o consentimento do usuário ainda não foi processado (por exemplo, por ser sua primeira visita) o callback onReady será acionado assim que o cookie de banner for exibido. Por outro lado, se o usuário já deu o seu consentimento para a instalação de cookies, este callback será invocado assim que inicializada a Cookie Solution da iubenda. O consentimento, dado ou não, é passado como um argumento, que pode ser true ou false.

onBannerShown (function) – usando este recurso você pode executar um script quando o banner for mostrado.

onBannerClosed (function) – usando este recurso você pode executar um script quando o banner for fechado.

onCookiePolicyShown (function) – solicitada quando a política de cookies for exibida (na janela modal ou em uma página separada).

onConsentGiven (function) – este callback é invocado se o usuário der o consentimento para a instalação de cookies, tanto na primeira vez quanto em todas as visitas subsequentes.

onConsentFirstGiven (function) – é invocado apenas na primeira vez que o usuário der o seu consentimento. Uma das seguintes strings é passada como argumento: documentScroll, documentMoved, bannerXClose, documentClicked ou cookiePolicyClosed.

onConsentRejected (function) – este callback é invocado se o usuário rejeitar o consentimento para a instalação de cookies.

onConsentFirstRejected (function) – invocado quando o consentimento é rejeitado, assim que o usuário dá sua preferência (não em todas as visualizações de página, como onConsentRejected).

onPreferenceExpressed (function) – é invocado sempre que uma preferência for expressa, seja ela de aceitar ou rejeitar.

onPreferenceFirstExpressed (function) – Invocado assim que o usuário dá sua preferência (não em todas as visualizações de página, como onPreferenceExpressed).

onPreferenceExpressedOrNotNeeded (function) – é invocado sempre que uma preferência é expressa ou não necessária, por exemplo quando:

  • gdprApplies:true e o usuário expressou sua preferência, ou
  • gdprApplies:false, ou
  • gdprAppliesGlobally:false, countryDetection:true e o usuário está localizado fora da UE

onPreferenceNotNeeded (function) – é invocada sempre que uma preferência não é necessária, por exemplo, quando:

  • gdprApplies:false, ou
  • gdprAppliesGlobally:false, countryDetection:true e o usuário está localizado fora da UE

onConsentRead (function) – é invocada na primeira vez que o usuário dá consentimento e em cada carregamento subsequente, quando o consentimento for detectado. O callback onConsentGiven se torna um pseudônimo para onConsentRead e não é invocado se este último estiver definido.

onStartupFailed (function) – é invocado quando a Cookie Solution da iubenda falha na fase de inicialização. Uma mensagem de erro é passada como argumento.

onError (function) – é invocado se a Cookie Solution da iubenda estiver com erro. Uma mensagem de erro é passada como argumento.

onFatalError (function) – é invocado quando a Cookie Solution da iubenda apresentar um erro que não a permita continuar. Uma mensagem de erro é passada como argumento.

onActivationDone (function) – é invocado quando a ativação do snippet é concluída.

onBeforePreload (function) – invocado quando a Cookie Solution é pré-carregada, ou seja, antes de os cookies serem carregados.

onCcpaAcknowledged (function) – invocado quando o aviso CCPA é reconhecido.

onCcpaFirstAcknowledged (function) – invocado na primeira vez que o aviso CCPA for reconhecido.

onCcpaOptOut (function) – invocado quando o usuário opta por sair da venda.

onCcpaFirstOptOut (function) – invocado na primeira vez em que o usuário optar por sair da venda.

Veja um exemplo de configuração ↓

Depuração

skipSaveConsent (boolean, default false) – ao definir este parâmetro como true, o consentimento não é salvo em um cookie de preferência.

logLevel (string) – define o detalhamento do logger (valores disponíveis: ‘debug’, ‘info’, ‘warn’, ‘error’, ‘fatal’; o valor padrão é ‘nolog’).

logViaAlert (boolean, default false) – ao definir este parâmetro como true, o registro é exibido por meio de alerta.

preferenceCookie {} (object) – este é o parâmetro pelo qual você pode personalizar a duração do cookie de preferência, instalado pela iubenda no navegador do usuário a fim de registrar o consentimento. Mais especificamente, o objeto a ser definido é expireAfter.

expireAfter (number, default 365) – representa o número de dias da vigência do consentimento dado pelo usuário em um determinado site. Observação: este valor é atualizado a cada visita do usuário.

ccpaCookie {} (object) – permite personalizar a expiração do cookie que armazena a aceitação do aviso. Mais especificamente, o objeto a ser definido é expireAfter.

expireAfter (number, default 365) – número de dias da vigência.

Caminho e domínio de consentimento local

localConsentDomain (string, default null) – o domínio no qual você deseja salvar o consentimento coletado dos usuários. Se não for definido, o consentimento será salvo em um cookie no domínio da página atual (por exemplo, visitando www.example.com, o consentimento será salvo em um cookie colocado no domínio example.com).

Se o comportamento padrão não for apropriado, por exemplo, se o site estiver localizado no domínio www.paesaggiurbani.italia.it, o consentimento deve ser fornecido para paesaggiurbani.italia.it (e não para italia.it), nesse caso, é necessário definir localConsentDomain com o valor ‘paesaggiurbani.italia.it’.

Observação: em uma situação semelhante, se o parâmetro não for fornecido, o banner pode continuar a aparecer para o mesmo usuário em cada visita/visualização de página.

localConsentPath (string, default ‘/’) – o caminho dentro do domínio local, no qual você deseja salvar o consentimento fornecido pelo usuário. Por padrão, o consentimento do usuário é salvo no domínio local dentro do cookie no caminho ‘/’. Desta forma, o cookie fica disponível independente do acesso à página do domínio.

Se você, por exemplo, não quiser que o cookie de preferência definido como www.example.com/percorso1 também se aplique a www.example.com/percorso2 (pela navegação), e vice-versa, você precisará fornecer o valor ‘/percorso1’ para este parâmetro no primeiro caso, e ‘/percorso2’ no segundo caso.

Parâmetros adicionais

whitelabel (boolean, default true) – defina este parâmetro como false para mostrar a marca da iubenda na segunda camada.

invalidateConsentBefore (“AAAA-MM-DD”, milésimos de segundo da data, default null) – todos os consentimentos coletados antes desta data serão invalidados. As autorizações recolhidas a partir desta data não serão invalidadas.

maxCookieSize (number, default 4096) – para evitar que os navegadores rejeitem cookies com mais de 4096 caracteres, a Cookie Solution permite dividir os cookies em vários blocos. Com o maxCookieSize você pode configurar o comprimento máximo de cada pedaço (veja também maxCookieChunks).

maxCookieChunks:(number, default 5) – com este parâmetro você pode configurar o número máximo de pedaços em que os cookies podem ser divididos (veja também maxCookieSize).

Observação: se o cookie a ser salvo for maior que maxCookieSize * maxCookieChunks (20480 caracteres com valores padrão), o cookie não será salvo.

timeoutLoadConfiguration (integer, milliseconds, default  30000) – o tempo de espera pela configuração remota antes de informar que ocorreu um intervalo. No caso de uma rede lenta, ao aumentar este valor, você garantirá que a Cookie Solution obtenha os recursos necessários a tempo.

startOnDomReady (boolean, default true) – se for true, a renderização do banner e/ou a ativação de snippets bloqueados, será realizada assim que o status do documento for ‘carregado’ (ou seja, quando o DOM atingir o status ‘carregado’). Se a opção for definida como false, a Cookie Solution será iniciada quando a página for totalmente carregada (ou seja, quando o status do DOM for ‘concluído’ e todos os recursos incluídos na página tiverem sido carregados).

Classes

iubenda-cs-close-btn – Ao adicionar esta classe a qualquer elemento da página, o clique no item fecha o banner e pressupõe que o consentimento foi dado (de forma equivalente ao clique no botão X do banner).

iub-prevent-consent – Adicione esta classe a determinados links/botões para evitar dar consentimento automático quando pressionados. Para ser eficaz, ele requer que o parâmetro consentOnLinkAndButton seja definido como true.

iubenda-cs-cookie-policy-lnk – Ao adicionar esta classe a qualquer elemento da página, o clique naquele elemento permite a exibição da Política de Cookies (equivale a clicar no link para a Política de Cookies). Observação: para garantir a exibição adequada da política de cookies, a classe iubenda-cs-cookie-policy-lnk (atribuída ao link para a política de cookies no banner) não deve ser usada em nenhum outro lugar da página.

iubenda-cs-preferences-link – Adicione esta classe a qualquer elemento da página para permitir que os usuários atualizem suas preferências de cookies, mesmo depois de fechar o banner de cookie.

5.4 Exemplos

Segue abaixo um exemplo de configuração com os parâmetros opcionais:

<script type="text/javascript">
    var _iub = _iub || [];
    _iub.csConfiguration = {
        "lang": "en",
        "siteId": 896537, //use your siteId
        "cookiePolicyId": 8207462, //use your cookiePolicyId
        "enableRemoteConsent": "false",
        "consentOnScroll": "false",
        "banner": {
            "position": "top",
            "slideDown": "false",
            "content": "This website or its third-party tools use cookies. Please refer to the %{cookie_policy_link} if you want to learn more or withdraw your consent.",
            "cookiePolicyLinkCaption": "cookie policy",
            "backgroundColor": "#CCC",
            "textColor": "#000",
            "fontSize": "14px",
            "innerHtmlCloseBtn": "OK"
        },
        "callback": {
            "onPreferenceExpressed": function(preference) {
                console.log('onPreferenceExpressed', preference);
            }
        },
        "preferenceCookie": {
            "expireAfter": 180
        }
    };
</script>
<script type="text/javascript" src="//cdn.iubenda.com/cs/iubenda_cs.js" charset="UTF-8" async></script>

Outros exemplos de possíveis configurações:

5.5 Marcador de posição personalizado para snippets bloqueados

Você pode querer mostrar um aviso personalizado que substitui o conteúdo que não pode ser visto até que o consentimento seja dado, ou o consentimento foi rejeitado para esse fim e, bloqueado pela Cookie Solution.

Para fazer isso, você pode criar um <div> elemento com o aviso personalizado que deseja mostrar no lugar do conteúdo indisponível e um script bloqueado anteriormente que remove o <div>, assim que o consentimento for concedido.

Exemplo

<div id="content-before-consent">This will be removed as
soon as the user gives consent to purpose X</div>
      // Where X is the purpose for which consent needs to be given to
         run that script

<script type="text/plain" class="_iub_cs_activate" data-iub-purposes="X">
     // Where X is the purpose for which consent needs to be given to
        run that script

  ;(function() {
    var divToRemove = document.getElementById('content-before-consent');
    if (divToRemove &amp;&amp; divToRemove.parentNode) {
      divToRemove.parentNode.removeChild(divToRemove);
    }
  })();
</script>

5.6 Ativador inline

É possível incluir a parte do código relativa aos scripts, diretamente in-page (inline); esse código é conhecido como ativador inline. Os scripts podem ser ativados por meio do ativador inline, ainda que o recurso principal iubenda_cs.js esteja genericamente indisponível ou com erro.

O ativador inline garante apenas a ativação do script, mas também pode receber uma permissão fornecida (consulte a opção forceSafeActivation a seguir). Ele não pode ser usado para mostrar o banner, a política de cookies ou para gerenciar a obtenção de consentimento.

Ele serve apenas como mais uma camada de proteção em caso de erros e não atua como um substituto para o código principal da Cookie Solution da iubenda.

Observe que o ativador inline apenas invocará o onActivationDone, enquanto os outros serão ignorados.

Duas opções de configuração adicionais estão disponíveis para o ativador inline:

  • safeTimeout (milliseconds, default 0) – o tempo que o ativador inline espera antes de começar a funcionar.
  • forceSafeActivation (boolean, default false) – se definidos como true, os scripts serão ativados independente do consentimento fornecido. Se definido como false, o ativador inline ativa os scripts apenas se o consentimento for dado (conforme memorizado no cookie de preferência do domínio da página do host).

O ativador inline está disponível em:

IAB Transparency and Consent Framework

Se  você ativou a compatibilidade da  IAB Transparency and Consent Framework (TCF)  para a personalização das preferências de rastreamento de publicidade, você pode  usar o ativador inline tanto para  safe.js quanto para safe-tcf-v2.js

safe-tcf-v2.js está disponível em:

Exemplos

O conteúdo de safe.js(e safe-tcf-v2.js) deve ser incluído na página depois das configurações iniciais e antes do código que carrega iubenda_cs.js.

ATUAL
<script type="text/javascript">
    var _iub = _iub || [];
    _iub.csConfiguration = {
        "lang": "en",
        "siteId": XXXXXX, //use your siteId
        "cookiePolicyId": YYYYYY, //use your cookiePolicyId
        "banner": {
            "position": "float-top-center",
            "acceptButtonDisplay": true,
            "customizeButtonDisplay": true
        }
    };
    _iub.csConfiguration.safeTimeout = 500; //custom option
    _iub.csConfiguration.forceSafeActivation = false; //custom option
</script>

<!-- inline activator - safe.js (current channel) -->
<script type="text/javascript">
    //<![CDATA[
    //copy content from cdn.iubenda.com/cs/safe.js and paste here
    //]]>
</script>

<script type="text/javascript" src="//cdn.iubenda.com/cs/iubenda_cs.js" charset="UTF-8" async></script>

Configuração da amostra com o IAB da TCF v2.0 ativado:

<script type="text/javascript">
    var _iub = _iub || [];
    _iub.csConfiguration = {
        "lang": "en",
        "enableTcf": true,
        "siteId": XXXXXX, //use your siteId
        "cookiePolicyId": YYYYYY, //use your cookiePolicyId
        "banner": {
            "position": "float-top-center",
            "acceptButtonDisplay": true,
            "customizeButtonDisplay": true
        }
    };
</script>

<script type="text/javascript" src="//cdn.iubenda.com/cs/tcf/stub-v2.js"></script>

<!-- inline activator - safe.js (current channel) -->
<script type="text/javascript">
    //<![CDATA[
    //copy content from cdn.iubenda.com/cs/safe.js and paste here
    //]]>
</script>

<!-- inline activator - safe-tcf-v2.js (current channel) -->
<script type="text/javascript">
    //<![CDATA[
    //copy content from cdn.iubenda.com/cs/tcf/safe-tcf-v2.js and paste here
    //]]>
</script>

<script type="text/javascript" src="//cdn.iubenda.com/cs/iubenda_cs.js" charset="UTF-8" async></script>
BETA
<script type="text/javascript">
    var _iub = _iub || [];
    _iub.csConfiguration = {
        "lang": "en",
        "siteId": XXXXXX, //use your siteId
        "cookiePolicyId": YYYYYY, //use your cookiePolicyId
        "banner": {
            "position": "float-top-center",
            "acceptButtonDisplay": true,
            "customizeButtonDisplay": true
        }
    };
    _iub.csConfiguration.safeTimeout = 500; //custom option
    _iub.csConfiguration.forceSafeActivation = false; //custom option
</script>

<!-- inline activator - safe.js (beta channel) -->
<script type="text/javascript">
    //<![CDATA[
    //copy content from cdn.iubenda.com/cs/beta/safe.js and paste here
    //]]>
</script>

<script type="text/javascript" src="//cdn.iubenda.com/cs/beta/iubenda_cs.js" charset="UTF-8" async></script>

Configuração da amostra com o IAB da TCF v2.0 ativado:

<script type="text/javascript">
    var _iub = _iub || [];
    _iub.csConfiguration = {
        "lang": "en",
        "enableTcf": true,
        "siteId": XXXXXX, //use your siteId
        "cookiePolicyId": YYYYYY, //use your cookiePolicyId
        "banner": {
            "position": "float-top-center",
            "acceptButtonDisplay": true,
            "customizeButtonDisplay": true
        }
    };
</script>

<script type="text/javascript" src="//cdn.iubenda.com/cs/tcf/beta/stub-v2.js"></script>

<!-- inline activator - safe.js (beta channel) -->
<script type="text/javascript">
    //<![CDATA[
    //copy content from cdn.iubenda.com/cs/beta/safe.js and paste here
    //]]>
</script>

<!-- inline activator - safe-tcf-v2.js (beta channel) -->
<script type="text/javascript">
    //<![CDATA[
    //copy content from cdn.iubenda.com/cs/tcf/beta/safe-tcf-v2.js and paste here
    //]]>
</script>

<script type="text/javascript" src="//cdn.iubenda.com/cs/beta/iubenda_cs.js" charset="UTF-8" async></script>
ESTÁVEL
<script type="text/javascript">
    var _iub = _iub || [];
    _iub.csConfiguration = {
        "lang": "en",
        "siteId": XXXXXX, //use your siteId
        "cookiePolicyId": YYYYYY, //use your cookiePolicyId
        "banner": {
            "position": "float-top-center",
            "acceptButtonDisplay": true,
            "customizeButtonDisplay": true
        }
    };
    _iub.csConfiguration.safeTimeout = 500; //custom option
    _iub.csConfiguration.forceSafeActivation = false; //custom option
</script>

<!-- inline activator - safe.js (stable channel) -->
<script type="text/javascript">
    //<![CDATA[
    //copy content from cdn.iubenda.com/cs/stable/safe.js and paste here
    //]]>
</script>

<script type="text/javascript" src="//cdn.iubenda.com/cs/stable/iubenda_cs.js" charset="UTF-8" async></script>

Configuração da amostra com o IAB da TCF v2.0 ativado:

<script type="text/javascript">
    var _iub = _iub || [];
    _iub.csConfiguration = {
        "lang": "en",
        "enableTcf": true,
        "siteId": XXXXXX, //use your siteId
        "cookiePolicyId": YYYYYY, //use your cookiePolicyId
        "banner": {
            "position": "float-top-center",
            "acceptButtonDisplay": true,
            "customizeButtonDisplay": true
        }
    };
</script>

<script type="text/javascript" src="//cdn.iubenda.com/cs/tcf/stable/stub-v2.js"></script>

<!-- inline activator - safe.js (stable channel) -->
<script type="text/javascript">
    //<![CDATA[
    //copy content from cdn.iubenda.com/cs/stable/safe.js and paste here
    //]]>
</script>

<!-- inline activator - safe-tcf-v2.js (stable channel) -->
<script type="text/javascript">
    //<![CDATA[
    //copy content from cdn.iubenda.com/cs/tcf/stable/safe-tcf-v2.js and paste here
    //]]>
</script>

<script type="text/javascript" src="//cdn.iubenda.com/cs/stable/iubenda_cs.js" charset="UTF-8" async></script>

O código ativador é parte integrante da Cookie Solution da iubenda e, como tal, pode ser modificado para incluir novos recursos, atualizações e correções.

Para facilitar o gerenciamento da versão do ativador em sua página, a variável _iub.csSafeActivatorVersionestá disponível, o que remete à versão iubenda_cs.js da qual o ativador foi extraído.

5.7 API

A Cookie Solution da iubenda apresenta uma API JS para facilitar a interação com algumas de suas principais funções.

Sintaxe: _iub.cs.api.METHOD_NAME

Os métodos disponíveis são:

printErrors() – Imprime quaisquer erros da Cookie Solution da iubenda no console do navegador.

showCP() – Exibe a Política de Cookies (da mesma forma que você clica no link da Política de Cookies no banner ou em outro link com a  iubenda-cs-cookie-policy-lnkclasse , conforme descrito  aqui).

openPreferences() – Permite que os usuários atualizem suas preferências de cookies mesmo depois de fechar o banner do cookie (da mesma forma que quando clicam em um elemento com a  iubenda-cs-preferences-link classe ).

showTcfVendors() – Reabre a lista de fornecedores da TCF (igual quando os usuários clicam em um elemento com a  iubenda-vendor-list-link classe ).

consentGiven() – Fornece consentimento. O método aceita o seguinte como parâmetros opcionais:

  • eventName (string) – um dos seguintes: documentClicked (default), documentScrolleddocumentMovedbannerXclose, cookiePolicyClosed. Indica o tipo de ação pela qual o consentimento é fornecido.
  • force (boolean)true | false (default) – Se false , o CS da iubenda garante que o banner seja exibido antes da aceitação do consentimento.  Por outro lado, ao fornecer essa opção como true, o consentimento é recebido em qualquer caso. Observação: a decisão de utilizar este método pressupõe que o consentimento fornecido é completamente equivalente a quando ele é fornecido através da interface do usuário, por exemplo, com rolagem de página. Portanto, todas as ações a derivadas do consentimento fornecido são realizadas, incluindo a atualização do cookie de preferência, a ativação dos snippets bloqueados anteriormente e a invocação dos onConsentFirstGivenonConsentReadcallbacks. Para ativar apenas os snippets, pode-se utilizar o  activateSnippets() método.

activateSnippets() – Ative os snippets anteriormente bloqueados. Este método pode ser invocado repetidamente – snippets já ativados não serão considerados. Portanto, isso é útil nas instalações em que, após a obtenção do consentimento, o conteúdo anteriormente bloqueado, que agora precisa ser ativado, é adicionado de forma dinâmica à página (por exemplo, carregamento lento ou rolagem infinita).

A opção runOnActivationDoneCallback (boolean, default false), se for true, executará o callback onActivationDone após a conclusão da ativação do snippet (consulte o callback onActivationDone).

isConsentGiven() (DOMElement, default window.document) – retorna para true se o consentimento tiver sido dado, caso contrário, retorna para false.

Observação: você não pode usar esta função se tiver definido como banner.rejectButtonDisplay: true ou perPurposeConsent: true. Além disso, se você ativou o Transparency and Consent Framework, você precisa, obrigatoriamente, adicionar o ativador síncrono (safe-tcf-v2.js).

setConsentOnScrollOnElement() (boolean) – a utilização deste método define o elemento no qual a rolagem será registrada para a finalidade de consentimento. Este método é útil quando você usufruir da opção consentOnScrollOnElement, mas o elemento DOM ainda não estará disponível quando a Cookie Solution for inicializada. Neste sentido, é possível usar o callback onBannerShow (exemplo) que ocorre quando o CS é inicializado.

storeConsent() – Armazena consentimento em cookies. Se você desejar, por exemplo, migrar consentimentos de um provedor antecessor, você pode utilizar este método dentro do onBeforePreload callback , quando o consentimento já tiver sido dado por outra plataforma. Ademais, se você for fornecedor, pode utilizar o para storeConsent() testar nossa solução (veja esta demonstração no CodePen).

gdprApplies() (boolean)  – retorna para true  se as proteções GDPR forem aplicadas ao usuário atual, caso contrário, retorna  para false.

ccpaApplies() (boolean) – retorna para true  se as proteções CCPA forem aplicadas ao usuário atual, caso contrário, retorna  para false .

askCcpaOptOut() – Abre a caixa de diálogo para solicitar a confirmação do cancelamento da venda.

isCcpaAcknowledged() – Retorna se o aviso CCPA for reconhecido.

isCcpaOptedOut() – Acionado quando o usuário opta por se opor à venda.

Observações: você também pode  invocar os métodos da API da Cookie Solution a partir de um iframe.

Veja também