Suivre les sessions

Découvrez comment suivre les sessions à l’aide du SDK de Braze.

À propos du cycle de vie de la session

Une session désigne la période pendant laquelle le SDK Braze suit l’activité des utilisateurs dans votre application après son lancement. Vous pouvez également forcer une nouvelle session en appelant lachangeUser()méthode.

• web
• android
• swift

Définition de l’inactivité

Comprendre comment l’inactivité est définie et mesurée est essentiel pour gérer efficacement les cycles de vie des sessions dans le SDK Web. L’inactivité désigne une période pendant laquelle le SDK Web de Braze ne détecte aucun événement suivi de la part de l’utilisateur.

Comment l’inactivité est-elle mesurée ?

Le SDK Web surveille l’inactivité en fonction des événements suivis par le SDK. Le SDK gère un minuteur interne qui se réinitialise à chaque envoi d’un événement suivi. Si aucun événement suivi par le SDK ne se produit pendant la période d’expiration configurée, la session est considérée comme inactive et prend fin.

Pour en savoir plus sur l’implémentation du cycle de vie des sessions dans le SDK Web, consultez le code source de gestion des sessions dans le dépôt GitHub du SDK Web de Braze.

Ce qui est considéré comme une activité par défaut :

• Ouverture ou actualisation de l’application web
• Interaction avec les éléments d’interface générés par Braze (tels que les messages in-app ou les cartes de contenu)
• Appel de méthodes du SDK qui envoient des événements suivis (tels que des événements personnalisés ou des mises à jour d’attributs utilisateur)

Ce qui n’est pas considéré comme une activité par défaut :

• Passer à un autre onglet du navigateur
• Réduire la fenêtre du navigateur
• Événements de focus ou de perte de focus du navigateur
• Défilement ou mouvements de la souris sur la page

Configuration du délai d’expiration de la session

Par défaut, le SDK Web considère qu’une session est inactive après 30 minutes sans aucun événement suivi. Vous pouvez personnaliser ce seuil lors de l’initialisation du SDK à l’aide du paramètre sessionTimeoutInSeconds. Pour plus de détails sur la configuration de ce paramètre, y compris des exemples de code, consultez la section Modifier le délai de session par défaut.

Exemple : comprendre les scénarios d’inactivité

Prenons le scénario suivant :

1. Un utilisateur accède à votre site web et le SDK démarre une session en appelant braze.openSession().
2. L’utilisateur passe à un autre onglet du navigateur pour consulter un autre site web pendant 30 minutes.
3. Pendant cette période, aucun événement suivi par le SDK ne se produit sur votre site web.
4. Après 30 minutes d’inactivité, la session prend automatiquement fin.
5. Lorsque l’utilisateur revient sur l’onglet de votre site web et déclenche un événement SDK (comme la consultation d’une page ou l’interaction avec du contenu), une nouvelle session commence.

Suivi de l’inactivité personnalisée

Si vous avez besoin de suivre l’inactivité en fonction de la visibilité du navigateur ou du changement d’onglet, implémentez des écouteurs d’événements personnalisés dans votre code JavaScript. Utilisez les événements du navigateur tels que visibilitychange pour détecter le moment où les utilisateurs quittent votre page, et envoyez manuellement des événements personnalisés à Braze ou appelez braze.openSession() lorsque c’est approprié.

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');
  }
});

Pour en savoir plus sur la journalisation des événements personnalisés, consultez la section Journaliser des événements personnalisés. Pour plus d’informations sur le cycle de vie des sessions et la configuration des délais d’expiration, consultez la section Modifier le délai de session par défaut.

S’abonner aux mises à jour de session

Étape 1 : S’abonner aux mises à jour

Pour vous abonner aux mises à jour de session, utilisez la méthode 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;
  }
}];

Étape 2 : Tester le suivi de session (facultatif)

Pour tester le suivi des sessions, démarrez une session sur votre appareil, puis ouvrez le tableau de bord de Braze et recherchez l’utilisateur concerné. Dans son profil utilisateur, sélectionnez Aperçu des sessions. Si les indicateurs se mettent à jour comme prévu, le suivi de session fonctionne correctement.

Modifier le délai de session par défaut

Vous pouvez modifier le délai qui s’écoule avant qu’une session ne se termine automatiquement.

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

Résolution des problèmes

Le profil utilisateur affiche 0 session

Un profil utilisateur peut afficher 0 session si l’utilisateur a été créé en dehors du SDK :

• Créé via l’API REST : Si un utilisateur est créé via l’endpoint /users/track avec un app_id dans la requête, le profil apparaît associé à cette application mais ne contient aucune donnée de session, car le SDK n’a jamais été initialisé pour cet utilisateur.
• Créé par import CSV : Si un utilisateur est importé via CSV sans valeurs pour les champs de première ou dernière session, le profil existe avec 0 session.