setConsent
O comando setConsent
informa ao SDK da Web se ele deve enviar dados (aceitação), descartar dados (recusa) ou usar defaultConsent
(consentimento desconhecido).
O SDK da Web é compatível com os seguintes padrões:
-
Adobe standard: os padrões 1.0 e 2.0 são suportados.
-
Estrutura de transparência e consentimento do IAB: se você usar esse padrão, o Perfil de cliente em tempo real do visitante será atualizado com as informações de consentimento se a implementação estiver configurada corretamente:
- O esquema de perfil individual XDM contém o Grupo de campos de Consentimento do TCF 2.0 do IAB.
- O esquema do Evento de experiência contém o Grupo de campos de Consentimento da TCF 2.0 do IAB.
- Você inclui as informações de consentimento do IAB no evento objeto XDM. O SDK da Web não inclui automaticamente as informações de consentimento ao enviar dados do evento.
Após usar esse comando, o SDK da Web grava as preferências do usuário em um cookie. Na próxima vez que o usuário carregar o site no navegador, o SDK recuperará essas preferências persistentes para determinar se os eventos podem ser enviados para o Adobe.
A Adobe recomenda que você armazene todas as preferências da caixa de diálogo de consentimento separadamente do consentimento do SDK da Web. O SDK da Web não oferece uma maneira de recuperar o consentimento. Para garantir que as preferências do usuário permaneçam sincronizadas com o SDK, você pode chamar o comando setConsent
em cada carregamento de página. O SDK da Web só faz uma chamada de servidor quando o consentimento é alterado.
Usando defaultConsent
junto com setConsent
using-consent
O SDK da Web oferece dois comandos complementares de configuração de consentimento:
defaultConsent
: este comando destina-se a capturar as preferências de consentimento dos clientes do Adobe que usam o SDK da Web.setConsent
: este comando tem como objetivo capturar as preferências de consentimento dos visitantes do site.
Quando usadas juntas, essas configurações podem levar a diferentes resultados de coleta de dados e configuração de cookie, dependendo de seus valores configurados.
Consulte a tabela abaixo para entender quando ocorre a coleta de dados e quando os cookies são definidos, com base nas configurações de consentimento.
in
in
in
out
in
pending
in
pending
out
pending
out
in
out
out
out
Os seguintes cookies são definidos quando a configuração de consentimento permite:
idMigrationEnabled
estiver habilitado. Ajuda na transição para o SDK da Web enquanto algumas partes do site ainda usam o visitor.js
.s_ecid=MCMID|<ECID>
.Definir o consentimento usando a extensão de tag do SDK da Web
A configuração do consentimento é executada como uma ação em uma regra na interface das tags da Coleção de dados da Adobe Experience Platform.
- Faça logon em experience.adobe.com usando suas credenciais da Adobe ID.
- Navegue até Coleção de dados > Marcas.
- Selecione a propriedade de tag desejada.
- Navegue até Regras e selecione a regra desejada.
- Em Ações, selecione uma ação existente ou crie uma ação.
- Defina o campo suspenso Extensão como Adobe Experience Platform Web SDK e defina o Tipo de ação como Definir consentimento.
- Defina os campos desejados à direita, incluindo Padrão e Consentimento geral.
- Clique em Manter alterações e execute o fluxo de trabalho de publicação.
Você pode incluir vários objetos de consentimento nesta ação.
Definir o consentimento usando a biblioteca JavaScript do SDK da Web
Execute o comando setConsent
ao chamar a instância configurada do SDK da Web. Você pode incluir os seguintes objetos nesse comando:
consent[]
: uma matriz deconsent
objetos. O objeto de consentimento é formatado de forma diferente dependendo do padrão e da versão escolhidos. Consulte as guias abaixo para obter exemplos de cada objeto de consentimento, dependendo do padrão de consentimento.identityMap
: um objeto que controla como uma ECID é gerada e a quais IDs as informações de consentimento estão vinculadas. A Adobe recomenda incluir este objeto quandosetConsent
for executado antes de outros comandos, comosendEvent
.edgeConfigOverrides
: Um objeto que contém substituições de configuração de sequência de dados.
Adobe 2.0 objeto consent
padrão
Se você estiver usando o Adobe Experience Platform, precisará incluir um grupo de campos de esquema de privacidade no esquema do perfil. Consulte Governança, privacidade e segurança no Adobe Experience Platform para obter mais informações sobre o padrão Adobe 2.0. Você pode adicionar dados dentro do objeto de valor abaixo correspondente ao esquema do campo consents
do grupo de campos de perfil Consentimentos e Preferências.
-
standard
: o padrão de consentimento escolhido. Defina esta propriedade como"Adobe"
para o padrão Adobe 2.0. -
version
: uma cadeia de caracteres que representa a versão do padrão de consentimento. Defina esta propriedade como"2.0"
para o padrão Adobe 2.0. -
value
: um objeto contendo valores de consentimento.value.collect.val
: o valor de consentimento. Defina como"y"
quando os usuários optarem por entrar e como"n"
quando os usuários optarem por não participar.value.metadata.time
: O carimbo de data/hora quando os usuários atualizaram suas configurações de consentimento pela última vez.
code language-js |
---|
|
Objeto consent
padrão IAB TCF 2.0
Para registrar as preferências de consentimento do usuário fornecidas por meio do padrão Estrutura de transparência e consentimento (TCF) do Interative Advertising Bureau Europe (IAB), defina a string de consentimento como mostrado abaixo.
Quando o consentimento é definido dessa forma, o Perfil do cliente em tempo real é atualizado com as informações de consentimento. Para que isso funcione, o esquema XDM do perfil precisa conter o grupo de campos de esquema Privacidade do perfil. Ao enviar eventos, as informações de consentimento do IAB precisam ser adicionadas manualmente ao objeto XDM do evento. O SDK da Web não inclui automaticamente as informações de consentimento nos eventos.
Para enviar as informações de consentimento nos eventos, você deve adicionar o grupo de campos Privacidade de eventos de experiência ao esquema XDM ExperienceEvent habilitado para Profile. Consulte a seção sobre atualização do esquema ExperienceEvent no guia de preparação do conjunto de dados para obter etapas sobre como configurar isso.
standard
: o padrão de consentimento escolhido. Defina essa propriedade como"IAB TCF"
para o padrão IAB TCF 2.0.version
: uma cadeia de caracteres que representa a versão do padrão de consentimento. Defina essa propriedade como"2.0"
para o padrão IAB TCF 2.0.value
: uma cadeia de caracteres que contém o valor de consentimento.gdprApplies
: um booleano que determina se o GDPR se aplica a este valor de consentimento. Seu valor padrão étrue
.gdprContainsPersonalData
: um booleano que determina se os dados do evento associados a este usuário contêm dados pessoais. Seu valor padrão éfalse
.
code language-js |
---|
|
Adobe 1.0 objeto consent
padrão
standard
: o padrão de consentimento escolhido. Defina esta propriedade como"Adobe"
para o padrão Adobe 1.0.version
: uma cadeia de caracteres que representa a versão do padrão de consentimento. Defina esta propriedade como"1.0"
para o padrão Adobe 1.0.value.general
: o valor de consentimento. Defina como"in"
quando os usuários optarem por entrar e como"out"
quando os usuários optarem por não participar.
code language-js |
---|
|
Envio de vários padrões em uma solicitação multiple-standards
O SDK da Web também permite enviar mais de um objeto de consentimento em uma solicitação, como mostrado no exemplo abaixo.
alloy("setConsent", {
consent: [{
standard: "Adobe",
version: "2.0",
value: {
collect: {
val: "y"
},
metadata: {
time: "2021-03-17T15:48:42-07:00"
}
}
}, {
standard: "IAB TCF",
version: "2.0",
value: "CO1Z4yuO1Z4yuAcABBENArCsAP_AAH_AACiQGCNX_T5eb2vj-3Zdt_tkaYwf55y3o-wzhhaIse8NwIeH7BoGP2MwvBX4JiQCGBAkkiKBAQdtHGhcCQABgIhRiTKMYk2MjzNKJLJAilsbe0NYCD9mnsHT3ZCY70--u__7P3fAwQgkwVLwCRIWwgJJs0ohTABCOICpBwCUEIQEClhoACAnYFAR6gAAAIDAACAAAAEEEBAIABAAAkIgAAAEBAKACIBAACAEaAhAARIEAsAJEgCAAVA0JACKIIQBCDgwCjlACAoAAAAA.YAAAAAAAAAAA",
gdprApplies: true
}]
});
Persistência das preferências de consentimento persistence
Depois de comunicar as preferências do usuário ao SDK da Web usando o comando setConsent
, o SDK mantém as preferências do usuário em um cookie. Na próxima vez que o usuário carregar o site no navegador, o SDK da Web recuperará e usará essas preferências persistentes para determinar se os eventos podem ou não ser enviados para o Adobe.
Você precisará armazenar as preferências do usuário independentemente para poder mostrar a caixa de diálogo de consentimento com as preferências atuais. Não há como recuperar as preferências do usuário no SDK da Web. Para garantir que as preferências do usuário permaneçam sincronizadas com o SDK, você pode chamar o comando setConsent
em cada carregamento de página. O SDK da Web só fará uma chamada de servidor se as preferências tiverem sido alteradas.
Sincronização de identidades ao definir o consentimento sync-identities
Quando o consentimento padrão (definido por meio do parâmetro defaultConsent) é definido como pending
ou out
, a configuração setConsent
pode ser a primeira solicitação que sai e estabelece a identidade. Por isso, pode ser importante sincronizar identidades na primeira solicitação. Você pode adicionar o mapa de identidade ao comando setConsent
da mesma forma que no comando sendEvent
. Consulte usando identityMap para obter um exemplo de como incluir o mapa de identidade no comando.