Kit de desarrollo de software para navegadores n.° 1

El SDK del navegador le permite enviar eventos a .

Inicializar el SDK

Debe inicializar el SDK antes de poder instrumentar cualquier evento. Se requiere la clave API de su proyecto de . Puede pasar un ID de usuario y un objeto de configuración opcionales en esta llamada. Puede usar el SDK en cualquier lugar después de que se inicialice en cualquier parte de una aplicación.

1// Opción 1, inicializar solo con API_KEY

2.en eso(CLAVE API);

3

4// Opción 2, inicializar con el ID del usuario si ya se conoce

5.en eso(CLAVE API, 'usuario@amplitude.com');

6

7// Opción 3, inicializar con configuración

8.en eso(CLAVE API, 'usuario@amplitude.com'opciones);

Configurar el SDK

Opciones de configuración

Junto con las opciones de configuración básicas, puede configurar la atribución.

Opciones de atribución

Configurar el comportamiento del procesamiento por lotes

Para admitir entornos de alto rendimiento, el SDK envía eventos en lotes. El método de seguimiento pone en cola en la memoria cada evento que registra. El SDK vacía los eventos en lotes en segundo plano. Personalice el comportamiento de los lotes con flushQueueSize y flushIntervalMillis. De forma predeterminada, la URL del servidor es https://api2.amplitude.com/2/httpapi. Para los clientes que desean enviar grandes lotes de datos a la vez, configure useBatch como verdadero para configurar setServerUrl en la API de carga de eventos por lotes https://api2.amplitude.com/batch. Tanto el modo normal como el modo por lotes utilizan el mismo umbral de carga de eventos e intervalos de tiempo de vaciado.

1.en eso(CLAVE API, ID USUARIO OPCIONAL, {

2 // Los eventos en cola en la memoria se vaciarán cuando la cantidad de eventos exceda el umbral de carga

3 // El valor predeterminado es 30

4 tamañoColaDescarga: 50,

5 // La cola de eventos se vaciará cada ciertos milisegundos según la configuración

6 // El valor predeterminado es 10000 milisegundos

7 FlujoIntervaloMillis: 20000,

8 // Uso del modo por lotes con el punto final de API por lotes, `https://api2.amplitude.com/batch`

9 usarBatch: verdadero

10});

Residencia de datos en la UE

Configure la zona del servidor cuando inicialice los datos del cliente en los servidores de la UE de . El SDK envía datos según la zona del servidor, si está configurada.

1.en eso(CLAVE API, ID USUARIO OPCIONAL, {

2 Zona del servidor: 'UE',

3});

Depuración

Controle el nivel de registros que el SDK imprime en la consola con las siguientes configuraciones de logLevel:

Nivel de registro Descripción ninguno Suprime todos los mensajes de registro error Muestra solo los mensajes de error warn Predeterminado. Muestra mensajes de error y advertencia. verbose Muestra mensajes informativos. debug Muestra todos los mensajes, incluida la información de contexto de función para cada método público que invoca el SDK. recomienda este nivel de registro solo para desarrollo.

Establezca el parámetro logLevel.

1.en eso(CLAVE_API_DE_AMPLITUD, ID_USUARIO_OPCIONAL, {

2 nivel de registro: .Tipos.LogLevel.Advertencia,

3});

El registrador predeterminado envía el registro a la consola del desarrollador. Puede proporcionar su propia implementación de registrador basada en la interfaz del registrador para cualquier propósito de personalización. Por ejemplo, recopilar mensajes de error del SDK en un entorno de producción.

Configure el registrador configurando loggerProvider con su propia implementación.

1.en eso(CLAVE_API_DE_AMPLITUD, ID_USUARIO_OPCIONAL, {

2 Proveedor de registradores: nuevo Mi registrador(),

3});

Modo de depuración

Habilite el modo de depuración configurando logLevel en “Depurar”, por ejemplo:

1.en eso(CLAVE_API_DE_AMPLITUD, ID_USUARIO_OPCIONAL, {

2 nivel de registro: .Tipos.LogLevel.Debug,

3});

Con el registrador predeterminado, se envía información de contexto de función adicional a la consola del desarrollador cuando se invoca cualquier método público del SDK, que incluye:

tipo: Categoría de este contexto, por ejemplo, “invocar método público”. nombre: Nombre de la función invocada, por ejemplo, “track”. argumentos: Argumentos de la función invocada. stacktrace: Stacktrace de la función invocada. tiempo: Marca de tiempo de inicio y fin de la invocación de la función. estados: Instantánea útil de estados internos antes y después de la invocación de la función.

Seguimiento de un evento

Los eventos representan cómo interactúan los usuarios con su aplicación. Por ejemplo, “Botón pulsado” podría ser una acción que desee rastrear.

1// Seguimiento de un evento básico

2.pista('Botón hecho clic');

3

4// Seguimiento de eventos con propiedades opcionales

5constante Propiedades del evento = {

6 color del boton: 'primario',

7};

8.pista('Botón hecho clic'propiedadesdelevento);

También puede pasar un objeto BaseEvent para realizar un seguimiento. Para obtener más información, consulte la interfaz BaseEvent para ver todos los campos disponibles.

1constante propiedades_del_evento = {

2 color del boton: 'primario',

3};

4

5constante evento = {

6 tipo de evento: “Botón hecho clic“,

7 propiedades_del_evento,

8 grupos: { 'role': 'ingeniería' },

9 propiedades_del_grupo: { 'clave de propiedad del grupo': 'valorpropiedadgrupo' }

10};

11

12.pista(evento);

Seguimiento de eventos en múltiples proyectos

De manera predeterminada, los SDK de envían datos a un proyecto de . Para enviar datos a más de un proyecto, agregue una instancia del SDK de para cada proyecto que desee recibir datos. Luego, pase las variables de instancia a donde desee llamar a . Cada instancia permite valores independientes de apiKey, userId, deviceId y configuración.

1constante Instancia predeterminada = .crearInstancia();

2Instancia predeterminada.en eso(CLAVE_API_PREDETERMINADA);

3

4constante envInstancia = .crearInstancia();

5envInstancia.en eso(ENV_CLAVE_API, {

6 nombre de instancia: 'Entorno',

7});

Seguimiento de eventos predeterminados

A partir de la versión 1.9.1 del SDK, el SDK del navegador realiza un seguimiento de los eventos predeterminados y agrega una configuración para controlar la recopilación de eventos predeterminados. El SDK del navegador realiza un seguimiento de los siguientes eventos predeterminados:

Vistas de página Sesiones Interacciones de formulario Descargas de archivos Nombre Valor Descripción config.defaultTracking.pageViews Opcional. booleano Habilita el seguimiento de vistas de página predeterminado. Si el valor es verdadero, rastrea los eventos de vistas de página en la inicialización. El valor predeterminado es falso.

Las propiedades del evento rastreadas incluyen: [] Dominio de la página, [] Ubicación de la página, [] Ruta de la página, [] Título de la página, [] URL de la página

Consulte Seguimiento de visitas a la página para obtener más información.

config.defaultTracking.sessions Opcional. booleano Habilita el seguimiento de sesiones. Si el valor es verdadero, rastrea los eventos de inicio y fin de sesión. El valor predeterminado es falso.

Consulte Sesiones de seguimiento para obtener más información.

config.defaultTracking.formInteractions Opcional. booleano Habilita el seguimiento de la interacción del formulario. Si el valor es verdadero, rastrea los eventos de inicio y envío del formulario. El valor predeterminado es falso.

Las propiedades del evento rastreadas incluyen: [] Identificación del formulario, [] Nombre del formulario, [] Formulario Destino

Consulte Seguimiento de interacciones del formulario para obtener más información.

config.defaultTracking.fileDownloads Opcional. booleano Habilita el seguimiento de descargas de archivos. Si el valor es verdadero, rastrea los eventos de descarga de archivos. El valor predeterminado es falso.

Las propiedades del evento rastreadas incluyen: [] Extensión de archivo, [] Nombre del archivo, [] Identificación del enlace, [] Texto del enlace, [] URL del enlace

Consulte Seguimiento de descargas de archivos para obtener más información.

Utilice el siguiente ejemplo de código para comenzar a realizar un seguimiento de todos los eventos predeterminados. O bien, omita la configuración para mantenerlos deshabilitados.

1.en eso(CLAVE API, ID USUARIO OPCIONAL, {

2 Seguimiento predeterminado: {

3 Páginas vistas: verdadero,

4 sesiones: verdadero,

5 FormularioInteracciones: verdadero,

6 Descargas de archivos: verdadero,

7 },

8});

Para realizar un seguimiento de todos los eventos predeterminados, también puede configurar config.defaultTracking como verdadero. Esta configuración permite que el SDK realice un seguimiento de cualquier evento predeterminado nuevo que pueda agregar.

1.en eso(CLAVE API, ID USUARIO OPCIONAL, {

2 Seguimiento predeterminado: verdadero,

3});

Seguimiento de visitas a la página

Cuando se establece config.defaultTracking.pageViews como verdadero, utiliza el comportamiento de seguimiento de vistas de página predeterminado. Esto envía un evento de vista de página en la inicialización y aparece en como [] Página vista.

1.en eso(CLAVE API, ID USUARIO OPCIONAL, {

2 Seguimiento predeterminado: {

3 Páginas vistas: verdadero,

4 },

5});

Configuración avanzada para el seguimiento de las visitas a la página

Utilice la configuración avanzada para tener un mejor control de cuándo el SDK envía eventos de vista de página.

Nombre Valor Descripción config.defaultTracking.pageViews.trackOn Opcional. “attribution” o () => boolean Proporciona control avanzado sobre cuándo se rastrean los eventos de vista de página.

Puede omitir o establecer el valor como indefinido y configurar los eventos de vista de página para que se rastreen en la inicialización.

Puede establecer el valor en “atribución” y configurar los eventos de visualización de página para que se rastreen solo cuando se rastrea la atribución web.

Puede establecer el valor de una función que devuelva un valor booleano (verdadero o falso) y configurar eventos de visualización de página para que se rastreen según sus criterios.

config.defaultTracking.pageViews.trackHistoryChanges Opcional. “pathOnly” o “all” Proporciona control avanzado para aplicaciones de página única sobre cuándo se rastrean las vistas de página.

Puede omitir o establecer el valor en “all” y configurar los eventos de visualización de página para que se realice un seguimiento de cualquier cambio de navegación en la URL dentro de su aplicación de página única. Por ejemplo: navegar desde /#company a /#blog.

Establezca el valor en “pathOnly” y configure los eventos de visualización de página para que se rastreen cuando se cambie la navegación a la ruta URL únicamente dentro de su aplicación de página única. Por ejemplo: navegar desde /company a /blog.

config.defaultTracking.pageViews.eventType Opcional. cadena Personalice el event_type para el evento de vista de página.

Por ejemplo, puedes configurar para que rastree las visitas a la página solo cuando la ruta URL contenga una determinada subcadena, por ejemplo, inicio.

1.en eso(CLAVE API, ID USUARIO OPCIONAL, {

2 Seguimiento predeterminado: {

3 Páginas vistas: {

4 seguimiento de: () => {

5 devolver ventana.ubicación.ruta.incluye('hogar');

6 },

7 },

8 },

9});

rastrea la siguiente información con eventos de vista de página.

Nombre Descripción Valor predeterminado event_type string. El tipo de evento para el evento de vista de página. Configurable a través de defaultTracking.pageViews.eventType o el complemento de enriquecimiento.
[] Página vista…