Configuración del SDK web

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

IMPORTANT
configure es siempre 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

NOTE
Las configuraciones de Edge se han cambiado a Datastreams. Un ID de flujo de datos es lo mismo que un ID de configuración.
Tipo
Requerido
Valor predeterminado
Cadena
Ninguna

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

context 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 según se describe en Información automática. Si no se especifica esta configuración, se utilizan todas las categorías de forma predeterminada.

IMPORTANT
Todas las propiedades de contexto, excepto highEntropyUserAgentHints, están activadas 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 alta entropía en la implementación del SDK web, debe incluir los highEntropyUserAgentHints opción de contexto, junto con la configuración existente.

Por ejemplo, para recuperar sugerencias de cliente de alta entropía de las 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. Estableciendo esta configuración en true habilita las siguientes funciones:

Función
Función
Registro de consola
Permite mostrar mensajes de depuración en la consola JavaScript del explorador

edgeDomain edge-domain

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 edge-base-path

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

Tipo
Requerido
Valor predeterminado
Cadena
No
ee

orgId

Tipo
Requerido
Valor predeterminado
Cadena
Ninguna

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

Recopilación de datos

clickCollectionEnabled clickCollectionEnabled

Tipo
Requerido
Valor predeterminado
Booleano
No
true

Indica si los datos asociados con los 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 de vínculos 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 a la que se llame para cada evento justo antes de enviarlo. Un objeto con el campo xdm se envía a la llamada de retorno. Para cambiar lo que se envía, modifique la xdm objeto. Dentro de la llamada de retorno, la variable xdm ya tiene los datos pasados en el comando de evento y la información recopilada automáticamente. Para obtener más información sobre la temporización de esta llamada de retorno y ver un ejemplo, consulte Modificación global de eventos.

onBeforeLinkClickSend onBeforeLinkClickSend

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

Configure una llamada de retorno que se invoque para cada evento de seguimiento de clics en vínculos justo antes de enviarlo. La llamada de retorno envía un objeto con el xdm, clickedElement, y data campos.

Al filtrar el seguimiento de vínculos mediante 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 los datos que se envían, modifique la xdm y/o data objetos. Dentro de la llamada de retorno, la variable xdm ya tiene los datos pasados en el comando de evento y la información recopilada automáticamente.

  • Cualquier valor distinto de false permite procesar el evento y enviar la llamada de retorno.
  • Si la llamada de retorno devuelve el 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 de evento y devolviendo false si el evento no se debe enviar.
  • Si la llamada de retorno genera una excepción, el procesamiento del evento se detiene y el evento no se envía.

Opciones de privacidad

Tipo
Requerido
Valor predeterminado
Objeto
No
"in"

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

  • "in": cuando se establece esta configuración o no se proporciona ningún valor, el trabajo se realiza sin preferencias de consentimiento del usuario.
  • "pending": cuando se establece esta configuración, el trabajo se pone en cola hasta que el usuario proporciona 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 según las preferencias del usuario. Consulte Consentimiento de apoyo para obtener más información.

Opciones de personalización personalization

prehidingStyle prehidingStyle

Tipo
Requerido
Valor predeterminado
Cadena
No
Ninguna

Se utiliza para crear una definición de estilo CSS que oculta las áreas de contenido de la 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 podría provocar 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, utilice el siguiente estilo de ocultamiento previo:

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

targetMigrationEnabled 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 utilizan los at.js. Esto le ayuda a mantener el perfil del visitante mientras se desplaza de una página que utiliza el SDK web a una página que utiliza el at.js y viceversa.

Tipo
Requerido
Valor predeterminado
Booleano
No
false

Opciones de audiencias

cookieDestinationsEnabled

Tipo
Requerido
Valor predeterminado
Booleano
No
true

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

urlDestinationsEnabled

Tipo
Requerido
Valor predeterminado
Booleano
No
true

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

Opciones de identidad

idMigrationEnabled id-migration-enabled

Tipo
Requerido
Valor predeterminado
Booleano
No
true

Si el valor es True, el SDK lee y establece cookies AMCV antiguas. Esta opción ayuda a realizar 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 se define 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 utilice 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 se desea por motivos de privacidad.

recommendation-more-help
def05a9c-d048-422c-a3a1-88b2de863f4f