Esta página descreve o método setConsent do SDK do Servidor. Para o Web SDK, consulte setConsent.
O método setConsent informa ao Server SDK se ele pode enviar dados para um visitante (aceitar) ou se deve descartá-los (recusar). O SDK envia as preferências do visitante para o Edge Network e, em seguida, armazena o resultado no cookie kndctr_<orgId>_consent por meio do serviço de cookie que você passa para o forRequest.
O SDK é compatível com os seguintes padrões de consentimento:
- Adobe standard: versões 1.0 e 2.0.
- Estrutura de transparência e consentimento (TCF) do IAB: Versão 2.0.
Este método está disponível somente quando a instância inclui o componente de Consentimento, que createInstance inclui por padrão.
Chamar setConsent para um visitante call
O consentimento pertence a um único visitante, portanto, sempre chame setConsent no identificador forRequest desse visitante, nunca na instância de nível superior. O exemplo a seguir usa o padrão Adobe 2.0:
const visitor = alloy.forRequest({ request: req, cookie: visitorCookies });
await visitor.setConsent({
consent: [{
standard: "Adobe",
version: "2.0",
value: {
collect: { val: "y" }
}
}]
});
O exemplo a seguir usa o padrão Adobe 1.0:
await visitor.setConsent({
consent: [{
standard: "Adobe",
version: "1.0",
value: { general: "in" }
}]
});
O exemplo a seguir usa o padrão IAB TCF 2.0:
await visitor.setConsent({
consent: [{
standard: "IAB TCF",
version: "2.0",
value: "CO052l-O052l-DGAMBFRACBgAIBAAAAAAIYgEawAQEagAAAA",
gdprApplies: true
}]
});
Se você usar o padrão TCF do IAB e quiser dados de consentimento no perfil do visitante, inclua as informações de consentimento do IAB no objeto do evento xdm também. O SDK não o adiciona aos eventos automaticamente.
Como o consentimento é lembrado stored-consent
O SDK lê e grava o cookie de consentimento por meio do serviço cookie que você passa para forRequest:
- Se o serviço de cookies ler os cookies do navegador do visitante, o consentimento de que o visitante tenha gravado anteriormente, no servidor ou no navegador com o Web SDK, já se aplica. Você não precisa chamar
setConsentnovamente até que as preferências do visitante mudem. - Se você não passar um serviço de cookie, a SDK não se lembrará do consentimento entre as solicitações. Cada solicitação começa em
defaultConsent.
O SDK ignora a solicitação se já tiver enviado as mesmas preferências para o visitante. Ela rastreia as preferências enviadas por meio do serviço storage, de modo que essa verificação funciona em solicitações somente se você passar pelo serviço storage desse visitante para forRequest. Caso contrário, cada chamada envia uma solicitação para a Edge Network, mesmo se as preferências do visitante não tiverem sido alteradas. Chame setConsent quando o visitante fizer ou alterar uma escolha de consentimento, em vez de em cada solicitação.
A solicitação não está autenticada. Certifique-se de que sua sequência de dados aceite solicitações não autenticadas. Consulte Definir o tipo de acesso da sequência de dados.
Opções options
O método setConsent aceita um objeto com as seguintes propriedades:
consent: Obrigatório. Uma matriz de objetos de consentimento, cada um em um dos padrões compatíveis.identityMap: Um mapa de identidade para o visitante. A Edge Network aplica o consentimento no nível do dispositivo, portanto, usa somente oECIDdeste mapa.edgeConfigOverrides: um objeto de substituição da configuração de sequência de dados para esta solicitação.
Objeto de resultado result
O método setConsent retorna uma promessa que resolve com um objeto vazio quando o Edge Network aceita as preferências de consentimento.