Seguimiento de sesiones

Aprende a realizar el seguimiento de las sesiones a través del SDK de Braze.

Acerca del ciclo de vida de la sesión

Una sesión se refiere al período de tiempo durante el cual el SDK de Braze realiza el seguimiento de la actividad de los usuarios en tu aplicación después de su inicio. También puedes forzar una nueva sesión llamando alchangeUser()método .

• web
• android
• swift

Definición de inactividad

Comprender cómo se define y se mide la inactividad es fundamental para gestionar eficazmente los ciclos de vida de las sesiones en el SDK Web. La inactividad se refiere al periodo durante el cual el SDK Web de Braze no detecta ningún evento de seguimiento del usuario.

Cómo se mide la inactividad

El SDK Web realiza el seguimiento de la inactividad basándose en los eventos rastreados por el SDK. El SDK mantiene un temporizador interno que se reinicia cada vez que se envía un evento de seguimiento. Si no se produce ningún evento rastreado por el SDK dentro del período de tiempo de espera configurado, la sesión se considera inactiva y finaliza.

Para obtener más información sobre cómo se implementa el ciclo de vida de la sesión en el SDK Web, consulta el código fuente de gestión de sesiones en el repositorio GitHub del SDK Web de Braze.

Lo que se considera actividad de forma predeterminada:

• Abrir o actualizar la aplicación web
• Interactuar con elementos de la interfaz de usuario impulsados por Braze (como mensajes dentro de la aplicación o Tarjetas de contenido)
• Llamar a métodos del SDK que envían eventos rastreados (como eventos personalizados o actualizaciones de atributos de usuario)

Lo que no se considera actividad de forma predeterminada:

• Cambiar a otra pestaña del navegador
• Minimizar la ventana del navegador
• Eventos de enfoque o desenfoque del navegador
• Desplazamiento o movimientos del ratón en la página

Configuración del tiempo de espera de la sesión

De forma predeterminada, el SDK Web considera que una sesión está inactiva tras 30 minutos sin eventos de seguimiento. Puedes personalizar este umbral al inicializar el SDK utilizando el parámetro sessionTimeoutInSeconds. Para obtener más información sobre cómo configurar este parámetro, incluidos ejemplos de código, consulta Cambiar el tiempo de espera predeterminado de la sesión.

Ejemplo: comprender los escenarios de inactividad

Considera el siguiente escenario:

1. Un usuario abre tu sitio web y el SDK inicia una sesión llamando a braze.openSession().
2. El usuario cambia a otra pestaña del navegador para ver otro sitio web durante 30 minutos.
3. Durante este tiempo, no se producen eventos de seguimiento del SDK en tu sitio web.
4. Tras 30 minutos de inactividad, la sesión finaliza automáticamente.
5. Cuando el usuario vuelve a la pestaña de tu sitio web y desencadena un evento del SDK (como ver una página o interactuar con el contenido), comienza una nueva sesión.

Seguimiento de la inactividad personalizada

Si necesitas realizar un seguimiento de la inactividad basándote en la visibilidad del navegador o el cambio de pestañas, implementa detectores de eventos personalizados en tu código JavaScript. Utiliza eventos del navegador como visibilitychange para detectar cuándo los usuarios abandonan tu página y envía manualmente eventos personalizados a Braze o llama a braze.openSession() cuando sea apropiado.

1
2
3
4
5
6
7
8
9
10
11
// Example: Track when user switches away from tab
document.addEventListener('visibilitychange', function() {
  if (document.hidden) {
    // User switched away - optionally log a custom event
    braze.logCustomEvent('tab_hidden');
  } else {
    // User returned - optionally start a new session and/or log an event
    // braze.openSession();
    braze.logCustomEvent('tab_visible');
  }
});

Para obtener más información sobre cómo registrar eventos personalizados, consulta Registrar eventos personalizados. Para obtener más información sobre el ciclo de vida de la sesión y la configuración del tiempo de espera, consulta Cambiar el tiempo de espera predeterminado de la sesión.

Suscribirse a las actualizaciones de la sesión

Paso 1: Suscribirse a las actualizaciones

Para suscribirte a las actualizaciones de la sesión, utiliza el método subscribeToSessionUpdates().

• web
• android
• swift
• react native

1
2
3
4
5
6
7
8
Braze.getInstance(this).subscribeToSessionUpdates(new IEventSubscriber<SessionStateChangedEvent>() {
  @Override
  public void trigger(SessionStateChangedEvent message) {
    if (message.getEventType() == SessionStateChangedEvent.ChangeType.SESSION_STARTED) {
      // A session has just been started
    }
  }
});

1
2
3
4
5
Braze.getInstance(this).subscribeToSessionUpdates { message ->
  if (message.eventType == SessionStateChangedEvent.ChangeType.SESSION_STARTED) {
    // A session has just been started
  }
}

1
2
3
4
5
6
7
8
9
10
11
// This subscription is maintained through a Braze cancellable, which will observe changes until the subscription is cancelled.
// You must keep a strong reference to the cancellable to keep the subscription active.
// The subscription is canceled either when the cancellable is deinitialized or when you call its `.cancel()` method.
let cancellable = AppDelegate.braze?.subscribeToSessionUpdates { event in
  switch event {
  case .started(let id):
    print("Session \(id) has started")
  case .ended(let id):
    print("Session \(id) has ended")
  }
}

1
2
3
4
5
6
7
8
for await event in braze.sessionUpdatesStream {
  switch event {
  case .started(let id):
    print("Session \(id) has started")
  case .ended(let id):
    print("Session \(id) has ended")
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// This subscription is maintained through a Braze cancellable, which will observe changes until the subscription is cancelled.
// You must keep a strong reference to the cancellable to keep the subscription active.
// The subscription is canceled either when the cancellable is deinitialized or when you call its `.cancel()` method.
BRZCancellable *cancellable = [AppDelegate.braze subscribeToSessionUpdates:^(BRZSessionEvent * _Nonnull event) {
  switch (event.state) {
    case BRZSessionStateStarted:
      NSLog(@"Session %@ has started", event.sessionId);
      break;
    case BRZSessionStateEnded:
      NSLog(@"Session %@ has ended", event.sessionId);
      break;
    default:
      break;
  }
}];

Paso 2: Probar el seguimiento de sesiones (opcional)

Para probar el seguimiento de sesiones, inicia una sesión en tu dispositivo, luego abre el panel de Braze y busca al usuario correspondiente. En su perfil de usuario, selecciona Resumen de sesiones. Si las métricas se actualizan según lo esperado, el seguimiento de sesiones funciona correctamente.

Cambiar el tiempo de espera predeterminado de la sesión

Puedes cambiar el tiempo que transcurre antes de que una sesión caduque automáticamente.

• web
• android
• swift
• react native

1
2
// Sets the session timeout to 15 minutes instead of the default 30
braze.initialize('YOUR-API-KEY-HERE', { sessionTimeoutInSeconds: 900 });

1
2
<!-- Sets the session timeout to 60 seconds. -->
<integer name="com_braze_session_timeout">60</integer>

1
2
3
4
5
6
7
8
// Sets the session timeout to 60 seconds
let configuration = Braze.Configuration(
  apiKey: "<BRAZE_API_KEY>",
  endpoint: "<BRAZE_ENDPOINT>"
)
configuration.sessionTimeout = 60;
let braze = Braze(configuration: configuration)
AppDelegate.braze = braze

1
2
3
4
5
6
7
// Sets the session timeout to 60 seconds
BRZConfiguration *configuration =
  [[BRZConfiguration alloc] initWithApiKey:brazeApiKey
                                  endpoint:brazeEndpoint];
configuration.sessionTimeout = 60;
Braze *braze = [[Braze alloc] initWithConfiguration:configuration];
AppDelegate.braze = braze;

Solución de problemas

El perfil de usuario tiene 0 sesiones

Un perfil de usuario puede tener 0 sesiones si el usuario fue creado fuera del SDK:

• Creado mediante la API REST: Si un usuario se crea a través del punto de conexión /users/track con un app_id en la solicitud, el perfil aparece asociado a esa aplicación pero no tiene datos de sesión porque el SDK nunca se inicializó para ese usuario.
• Creado mediante importación CSV: Si un usuario se importa a través de CSV sin valores para los campos de primera o última sesión, el perfil existe con 0 sesiones.