Rastrear sessões

Aprenda como rastrear sessões através do SDK do Braze.

Sobre o ciclo de vida da sessão

Uma sessão refere-se ao período de tempo em que o SDK do Braze rastreia a atividade do usuário em seu app após ser iniciado. Você também pode forçar uma nova sessão chamando o método changeUser().

• web
• android
• swift

Definindo inatividade

Entender como a inatividade é definida e medida é fundamental para gerenciar ciclos de vida de sessão de forma eficaz no SDK Web. Inatividade refere-se a um período durante o qual o SDK Web do Braze não detecta nenhum evento rastreado do usuário.

Como a inatividade é medida

O SDK Web rastreia a inatividade com base em eventos rastreados pelo SDK. O SDK mantém um temporizador interno que é redefinido cada vez que um evento rastreado é enviado. Se nenhum evento rastreado pelo SDK ocorrer dentro do período de tempo configurado, a sessão é considerada inativa e termina.

Para mais informações sobre como o ciclo de vida da sessão é implementado no SDK Web, veja o código-fonte de gerenciamento de sessão no repositório do Braze Web SDK no GitHub.

O que conta como atividade por padrão:

• Abrir ou atualizar o aplicativo web
• Interagir com elementos de UI impulsionados pelo Braze (como Mensagens no aplicativo ou Cartões de Conteúdo)
• Chamar métodos do SDK que enviam eventos rastreados (como eventos personalizados ou atualizações de atributos do usuário)

O que não conta como atividade por padrão:

• Alternar para uma guia de navegador diferente
• Minimizar a janela do navegador
• Eventos de foco ou desfoque do navegador
• Rolagem ou movimentos do mouse na página

Configuração de tempo limite de sessão

Por padrão, o SDK da Web considera uma sessão inativa após 30 minutos sem nenhum evento rastreado. Você pode personalizar esse limite ao inicializar o SDK usando o parâmetro sessionTimeoutInSeconds. Para detalhes sobre como configurar esse parâmetro, incluindo exemplos de código, veja Alterando o tempo limite de sessão padrão.

Exemplo: Entendendo cenários de inatividade

Considere o seguinte cenário:

1. Um usuário abre seu site, e o SDK inicia uma sessão chamando braze.openSession().
2. O usuário troca para uma guia de navegador diferente para visualizar outro site por 30 minutos.
3. Durante esse tempo, nenhum evento rastreado pelo SDK ocorre em seu site.
4. Após 30 minutos de inatividade, a sessão termina automaticamente.
5. Quando o usuário volta para a guia do seu site e aciona um evento do SDK (como visualizar uma página ou interagir com o conteúdo), uma nova sessão começa.

Rastreamento de inatividade personalizada

Se você precisar rastrear inatividade com base na visibilidade do navegador ou troca de guia, implemente ouvintes de eventos personalizados em seu código JavaScript. Use eventos do navegador, como visibilitychange, para detectar quando os usuários saem da sua página e envie manualmente eventos personalizados para a Braze ou chame braze.openSession() quando apropriado.

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 mais informações sobre o registro de eventos personalizados, consulte Registro de eventos personalizados. Para detalhes sobre o ciclo de vida da sessão e configuração de tempo limite, consulte Alterando o tempo limite de sessão padrão.

Inscrever-se para receber atualizações de sessões

Etapa 1: Inscrever-se para receber atualizações

Para se inscrever em atualizações de sessão, use o 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;
  }
}];

Etapa 2: Testar rastreamento de sessão (opcional)

Para testar o rastreamento de sessão, inicie uma sessão no seu dispositivo, depois abra o dashboard do Braze e procure o usuário relevante. No perfil do usuário, selecione Visão Geral das Sessões. Se as métricas forem atualizadas como esperado, o rastreamento de sessão está funcionando corretamente.

Alterando o tempo limite padrão da sessão

Você pode alterar a duração do tempo que passa antes que uma sessão expire automaticamente.

• 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;