Configuración del SDK web de Platform

La configuración del SDK se realiza con la variable configure comando.

IMPORTANTE

configure es always el primer comando llamado.

alloy("configure", {
  "edgeConfigId": "ebebf826-a01f-4458-8cec-ef61de241c93",
  "orgId":"ADB3LETTERSANDNUMBERS@AdobeOrg"
});

Hay muchas opciones que se pueden configurar durante la configuración. Todas las opciones se encuentran a continuación, agrupadas por categoría.

Opciones generales

edgeConfigId

NOTA

Las configuraciones de Edge se han cambiado a Datastreams. Un ID de conjunto de datos es el mismo que un ID de configuración.

Tipo Requerido Valor predeterminado
Cadena Ninguna

Su ID de configuración asignado, que vincula el SDK a las cuentas y la configuración adecuadas. Al configurar varias instancias en una sola página, debe configurar una edgeConfigId para cada instancia.

context

Tipo Requerido Valor predeterminado
Matriz de cadenas No ["web", "device", "environment", "placeContext", "highEntropyUserAgentHints"]

Indica las categorías de contexto que se recopilarán automáticamente, tal como se describe en Información automática. Si no se especifica esta configuración, todas las categorías se utilizan de forma predeterminada.

IMPORTANTE

Todas las propiedades de contexto, con la excepción de highEntropyUserAgentHints, están activados de forma predeterminada. Si ha especificado las propiedades de contexto manualmente en la configuración del SDK web, debe habilitar todas las propiedades de contexto para seguir recopilando la información necesaria.

Para habilitar sugerencias de cliente de entropía alta en la implementación del SDK web, debe incluir el highEntropyUserAgentHints contexto , junto con la configuración existente.

Por ejemplo, para recuperar sugerencias de cliente de alta entropía de propiedades web, la configuración tendría este aspecto:

context: ["highEntropyUserAgentHints", "web"]

debugEnabled

Tipo Requerido Valor predeterminado
Booleano No false

Indica si la depuración está habilitada. Establecer esta configuración como true habilita las siguientes funciones:

Función Función
Registro de consola Habilita la visualización de mensajes de depuración en la consola JavaScript del explorador

edgeDomain

Rellene este campo con el dominio de origen. Para obtener más información, consulte la documentación.

El dominio es similar a data.{customerdomain.com} para un sitio web en www.{customerdomain.com}.

edgeBasePath

Ruta después del edgeDomain utilizado para comunicarse e interactuar con los servicios de Adobe. A menudo, esto solo cambiaría cuando no se usara el entorno de producción predeterminado.

Tipo Requerido Valor predeterminado
Cadena No ee

orgId

Tipo Requerido Valor predeterminado
Cadena Ninguna

Su asignación Experience Cloud ID de organización. Al configurar varias instancias dentro de una página, debe configurar una orgId para cada instancia.

Recopilación de datos

clickCollectionEnabled

Tipo Requerido Valor predeterminado
Booleano No true

Indica si los datos asociados con clics en vínculos se recopilan automáticamente. Consulte Seguimiento automático de vínculos para obtener más información. Los vínculos también se etiquetan como vínculos de descarga si incluyen un atributo de descarga o si el vínculo termina con una extensión de archivo. Los calificadores del vínculo de descarga se pueden configurar con una expresión regular. El valor predeterminado es "\\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$"

onBeforeEventSend

Tipo Requerido Valor predeterminado
Función No () => sin definir

Configure una llamada de retorno que se llame para cada evento justo antes de enviarla. Un objeto con el campo xdm se envía a la rellamada. Para cambiar lo que se envía, modifique la variable xdm objeto. Dentro de la devolución de llamada, la variable xdm ya tiene los datos pasados en el comando event y la información recopilada automáticamente. Para obtener más información sobre la temporización de esta llamada de retorno y un ejemplo, consulte Modificación global de eventos.

onBeforeLinkClickSend

Tipo Requerido Valor predeterminado
Función No () => sin definir

Configure una llamada de retorno que se invoque para cada evento de rastreo de clics en vínculos justo antes de enviarse. La rellamada envía un objeto con la variable xdm, clickedElementy data campos.

Al filtrar el seguimiento de vínculos utilizando la estructura de elementos DOM, puede utilizar la variable clickElement comando. clickedElement es el nodo de elemento DOM en el que se hizo clic y que ha encapsulado el árbol de nodos principal.

Para cambiar qué datos se envían, modifique la variable xdm y/o data objetos. Dentro de la devolución de llamada, la variable xdm ya tiene los datos pasados en el comando event y la información recopilada automáticamente.

  • Cualquier valor distinto de false permite procesar el evento y enviar la llamada de retorno.
  • Si la rellamada devuelve la variable false , el procesamiento de eventos se detiene, sin error, y el evento no se envía. Este mecanismo permite filtrar ciertos eventos examinando los datos del evento y devolviendo false si no se debe enviar el evento.
  • Si la rellamada genera una excepción, el procesamiento del evento se detiene y no se envía el evento.

Opciones de privacidad

Tipo Requerido Valor predeterminado
Objeto No "in"

Establece el consentimiento predeterminado del usuario. Utilice esta configuración cuando no haya preferencias de consentimiento guardadas para el usuario. Los demás valores válidos son "pending" y "out". Este valor predeterminado no se mantiene en el perfil del usuario. El perfil del usuario solo se actualiza cuando setConsent se llama.

  • "in": Cuando se establece esta configuración o no se proporciona ningún valor, el trabajo continúa sin las preferencias de consentimiento del usuario.
  • "pending": Cuando se establece esta configuración, el trabajo se pone en cola hasta que el usuario proporcione las preferencias de consentimiento.
  • "out": Cuando se establece esta configuración, el trabajo se descarta hasta que el usuario proporcione las preferencias de consentimiento.
    Una vez proporcionadas las preferencias del usuario, el trabajo continúa o se interrumpe en función de sus preferencias. Consulte Compatibilidad con el consentimiento para obtener más información.

Opciones de personalización

prehidingStyle

Tipo Requerido Valor predeterminado
Cadena No Ninguna

Se utiliza para crear una definición de estilo CSS que oculte áreas de contenido de su página web mientras se carga contenido personalizado desde el servidor. Si no se proporciona esta opción, el SDK no intenta ocultar ninguna área de contenido mientras se carga el contenido personalizado, lo que potencialmente resulta en un "parpadeo".

Por ejemplo, si un elemento de la página web tiene un ID de container, cuyo contenido predeterminado desea ocultar mientras se carga contenido personalizado desde el servidor, use el siguiente estilo de preocultación:

  prehidingStyle: "#container { opacity: 0 !important }"

targetMigrationEnabled

Esta opción debe utilizarse al migrar páginas individuales desde at.js al SDK web.

Utilice esta opción para permitir que el SDK web lea y escriba el archivo heredado mbox y mboxEdgeCluster cookies que usa at.js. Esto le ayuda a mantener el perfil del visitante mientras pasa de una página que utiliza el SDK web a una página que usa el at.js biblioteca y viceversa.

Tipo Requerido Valor predeterminado
Booleano No false

Opciones de audiencias

cookieDestinationsEnabled

Tipo Requerido Valor predeterminado
Booleano No true

Habilitación Audience Manager destinos de cookies, que permite configurar cookies en función de la calificación de segmentos.

urlDestinationsEnabled

Tipo Requerido Valor predeterminado
Booleano No true

Habilitación Audience Manager Destinos de URL, que permite activar direcciones URL en función de la calificación de segmentos.

Opciones de identidad

idMigrationEnabled

Tipo Requerido Valor predeterminado
Booleano No true

Si es true, el SDK lee y establece cookies AMCV antiguas. Esta opción ayuda con la transición al uso del SDK web de Adobe Experience Platform, mientras que algunas partes del sitio pueden seguir utilizando Visitor.js.

Si la API de visitante está definida en la página, el SDK consulta la API de visitante para el ECID. Esta opción le permite etiquetar páginas con el SDK web de Adobe Experience Platform y seguir teniendo el mismo ECID.

thirdPartyCookiesEnabled

Tipo Requerido Valor predeterminado
Booleano No true

Habilita la configuración de cookies de terceros de Adobe. El SDK puede mantener el ID de visitante en un contexto de terceros para permitir que se use el mismo ID de visitante en todos los sitios. Utilice esta opción si tiene varios sitios o si desea compartir datos con socios; sin embargo, a veces esta opción no es deseada por motivos de privacidad.

En esta página