setConsent
Creado para:
- Desarrollador
El comando setConsent indica a Web SDK si debe enviar datos (adhesión), descartar datos (exclusión) o utilizar defaultConsent (consentimiento desconocido).
Web SDK admite los siguientes estándares:
-
estándar Adobe: Se admiten los estándares 1.0 y 2.0.
-
Marco de transparencia y consentimiento IAB: Si usa este estándar, el Perfil del cliente en tiempo real del visitante se actualiza con la información de consentimiento si la implementación está configurada correctamente:
- El esquema de perfil individual de XDM contiene el grupo de campos de consentimiento TCF de IAB 2.0.
- El esquema Experience Event contiene el grupo de campos de consentimiento TCF 2.0 de IAB.
- Incluya la información de consentimiento de IAB en el evento objeto XDM. Web SDK no incluye automáticamente la información de consentimiento al enviar datos de evento.
Después de utilizar este comando, Web SDK escribe las preferencias del usuario en una cookie. La próxima vez que el usuario cargue el sitio web en el explorador, SDK recuperará estas preferencias persistentes para determinar si los eventos se pueden enviar a Adobe.
Adobe recomienda almacenar todas las preferencias del cuadro de diálogo de consentimiento por separado del consentimiento de Web SDK. Web SDK no ofrece una forma de obtener el consentimiento. Para asegurarse de que las preferencias del usuario permanecen sincronizadas con SDK, puede llamar al comando setConsent en cada carga de página. Web SDK solo realiza una llamada al servidor cuando cambia el consentimiento.
Consideraciones de sincronización de identidad
El comando setConsent solo usa ECID del mapa de identidad, ya que el comando funciona en el nivel de dispositivo. El comando setConsent no tiene en cuenta otras identidades del mapa de identidad.
Usando defaultConsent junto con setConsent
Web SDK ofrece dos comandos de configuración de consentimiento complementarios:
defaultConsent: este comando está diseñado para capturar las preferencias de consentimiento de los clientes de Adobe que utilizan Web SDK.setConsent: este comando está diseñado para capturar las preferencias de consentimiento de los visitantes del sitio.
Cuando se utilizan juntos, esta configuración puede llevar a diferentes resultados de recopilación de datos y configuración de cookies, según sus valores configurados.
Consulte la tabla siguiente para comprender cuándo se produce la recopilación de datos y cuándo se configuran las cookies, según la configuración de consentimiento.
inininoutinpendinginpendingoutpendingoutinoutoutoutLas siguientes cookies se establecen cuando la configuración de consentimiento lo permite:
idMigrationEnabled está habilitado. Ayuda al realizar la transición a Web SDK mientras algunas partes del sitio siguen utilizando visitor.js.s_ecid=MCMID|<ECID>.Definición del consentimiento mediante la extensión de etiqueta Web SDK
La configuración del consentimiento se realiza como una acción dentro de una regla de la interfaz de etiquetas de recopilación de datos de Adobe Experience Platform.
- Inicie sesión en experience.adobe.com con sus credenciales de Adobe ID.
- Vaya a Recopilación de datos > Etiquetas.
- Seleccione la propiedad de etiquetas que desee.
- Vaya a Reglas y luego seleccione la regla que desee.
- En Acciones, seleccione una acción existente o cree una acción.
- Establezca el campo desplegable Extension en Adobe Experience Platform Web SDK y establezca Action Type en Set permission.
- Establece los campos deseados a la derecha, incluidos Estándar y Consentimiento general.
- Haga clic en Conservar cambios y, a continuación, ejecute el flujo de trabajo de publicación.
Puede incluir varios objetos de consentimiento dentro de esta acción.
Definir el consentimiento mediante la biblioteca JavaScript de Web SDK
Ejecute el comando setConsent al llamar a la instancia configurada de Web SDK. Puede incluir los siguientes objetos en este comando:
consent[]: una matriz deconsentobjetos. El objeto de consentimiento tiene un formato diferente en función del estándar y la versión que elija. Consulte las pestañas siguientes para ver ejemplos de cada objeto de consentimiento, según el estándar de consentimiento.identityMap: un objeto que controla cómo se genera un ECID y a qué ID está asociada la información de consentimiento. Adobe recomienda incluir este objeto cuandosetConsentse ejecute antes que otros comandos, comosendEvent.edgeConfigOverrides: un objeto que contiene anulaciones de configuración de secuencia de datos.
Objeto consent estándar de Adobe 2.0
Si utiliza Adobe Experience Platform, deberá incluir un grupo de campos de esquema de privacidad en el esquema de perfil. Consulte Gobernanza, privacidad y seguridad en Adobe Experience Platform para obtener más información sobre el estándar Adobe 2.0. Puede agregar datos dentro del objeto de valor siguiente correspondiente al esquema del campo consents del grupo de campos de perfil Consentimientos y preferencias.
-
standard: el estándar de consentimiento que elija. Establezca esta propiedad en"Adobe"para el estándar Adobe 2.0. -
version: cadena que representa la versión del estándar de consentimiento. Establezca esta propiedad en"2.0"para el estándar Adobe 2.0. -
value: un objeto que contiene valores de consentimiento.value.collect.val: el valor de consentimiento. Establezca esto en"y"cuando los usuarios acepten la inclusión y en"n"cuando los usuarios acepten la exclusión.value.metadata.time: marca de tiempo de la última vez que los usuarios actualizaron su configuración de consentimiento.
// Set consent using the Adobe 2.0 standard
alloy("setConsent", {
"consent": [{
"standard": "Adobe",
"version": "2.0",
"value": {
"collect": {
"val": "y"
},
"metadata": {
"time": "YYYY-03-17T15:48:42-07:00"
}
}
}]
});
Objeto consent estándar de IAB TCF 2.0
Para registrar las preferencias de consentimiento del usuario proporcionadas mediante el estándar del marco de transparencia y consentimiento (TCF) de Advertising Bureau Europe (IAB) interactivo, establezca la cadena de consentimiento como se muestra a continuación.
Cuando el consentimiento se establece de esta manera, el Perfil del cliente en tiempo real se actualiza con la información de consentimiento. Para que esto funcione, el esquema XDM de perfil debe contener el grupo de campos del esquema de privacidad del perfil. Al enviar eventos, la información de consentimiento de IAB debe añadirse manualmente al objeto XDM de evento. Web SDK no incluye automáticamente la información de consentimiento en los eventos.
Para enviar la información de consentimiento en eventos, debe agregar el grupo de campos Privacidad de Experience Event al esquema XDM ExperienceEvent habilitado para Profile. Consulte la sección sobre actualización del esquema de ExperienceEvent en la guía de preparación de conjuntos de datos para ver los pasos sobre cómo configurarlo.
standard: el estándar de consentimiento que elija. Establezca esta propiedad en"IAB TCF"para el estándar IAB TCF 2.0.version: cadena que representa la versión del estándar de consentimiento. Establezca esta propiedad en"2.0"para el estándar IAB TCF 2.0.value: cadena que contiene el valor de consentimiento.gdprApplies: Un booleano que determina si el RGPD se aplica a este valor de consentimiento. Su valor predeterminado estrue.gdprContainsPersonalData: un booleano que determina si los datos de evento asociados con este usuario contienen datos personales. Su valor predeterminado esfalse.
// Set consent using the IAB TCF 2.0 standard
alloy("setConsent", {
consent: [{
"standard": "IAB TCF",
"version": "2.0",
"value": "CO052l-O052l-DGAMBFRACBgAIBAAAAABIYgEawAQEagAAAA",
"gdprApplies": true,
"gdprContainsPersonalData": true
}]
});
Objeto consent estándar de Adobe 1.0
standard: el estándar de consentimiento que elija. Establezca esta propiedad en"Adobe"para el estándar Adobe 1.0.version: cadena que representa la versión del estándar de consentimiento. Establezca esta propiedad en"1.0"para el estándar Adobe 1.0.value.general: el valor de consentimiento. Establezca esto en"in"cuando los usuarios acepten la inclusión y en"out"cuando los usuarios acepten la exclusión.
// Set consent using the Adobe 1.0 standard
alloy("setConsent", {
"consent": [{
"standard": "Adobe",
"version": "1.0",
"value": {
"general": "in"
}
}]
});
Envío de varios estándares en una solicitud
Web SDK también admite el envío de más de un objeto de consentimiento en una solicitud, como se muestra en el ejemplo siguiente.
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
}]
});
Persistencia de las preferencias de consentimiento
Una vez que haya comunicado las preferencias de usuario a Web SDK mediante el comando setConsent, SDK conserva las preferencias de usuario respecto a una cookie. La próxima vez que el usuario cargue el sitio web en el explorador, Web SDK recuperará y utilizará estas preferencias persistentes para determinar si se pueden enviar o no eventos a Adobe.
Deberá almacenar las preferencias de usuario de forma independiente para poder mostrar el cuadro de diálogo de consentimiento con las preferencias actuales. No hay forma de recuperar las preferencias de usuario de Web SDK. Para asegurarse de que las preferencias del usuario permanecen sincronizadas con SDK, puede llamar al comando setConsent en cada carga de página. Web SDK solo realizará una llamada al servidor si las preferencias han cambiado.