Événements de journaux


Ce guide vous explique comment consigner des événements dans votre application.

Analytics enregistre automatiquement certains événements pour vous. Vous n'avez donc pas besoin d'ajouter de code pour les recevoir. Si votre application doit collecter des données supplémentaires, vous pouvez consigner jusqu'à 500 types d'événements Analytics différents dans votre application. Le volume total d'événements enregistrés par votre application n'est pas limité. Notez que les noms des événements sont sensibles à la casse. Enregistrer deux événements dont les noms ne diffèrent que par la casse entraînera la création de deux événements distincts.

Avant de commencer

Assurez-vous d'avoir configuré votre projet et d'avoir accès à Analytics, comme décrit dans la section Premiers pas avec Analytics.

Événements de journaux

Une fois que vous avez créé une instance FirebaseAnalytics, vous pouvez l'utiliser pour consigner des événements à l'aide des méthodes log de la bibliothèque.

Événements prédéfinis

Pour vous aider à démarrer, le SDK Analytics définit un certain nombre d'événements recommandés qui sont communs à différents types d'applications, y compris les applications de commerce et d'e-commerce, de voyage et de jeux. Pour en savoir plus sur ces événements et savoir quand les utiliser, consultez la section Événements recommandés.

Vous trouverez les méthodes de journalisation pour les types d'événements recommandés dans la documentation de référence de l'API.

L'exemple suivant montre comment consigner un événement select_content:

await FirebaseAnalytics.instance.logSelectContent(
    contentType: "image",
    itemId: itemId,
);

Vous pouvez également consigner le même événement à l'aide de logEvent():

await FirebaseAnalytics.instance.logEvent(
    name: "select_content",
    parameters: {
        "content_type": "image",
        "item_id": itemId,
    },
);

Cela peut être utile si vous souhaitez spécifier des paramètres supplémentaires autres que les paramètres prescrits (obligatoires). Vous pouvez ajouter les paramètres suivants à n'importe quel événement:

  • Paramètres personnalisés: les paramètres personnalisés peuvent être utilisés comme dimensions ou métriques dans les rapports Analytics. Vous pouvez utiliser des dimensions personnalisées pour les données de paramètre d'événement non numériques et des métriques personnalisées pour toutes les données de paramètre mieux représentées numériquement. Une fois que vous avez enregistré un paramètre personnalisé à l'aide du SDK, enregistrez la dimension ou la métrique pour vous assurer que ces paramètres personnalisés apparaissent dans les rapports Analytics. Pour ce faire, accédez à Analytics > Événements > Gérer les définitions personnalisées > Créer des dimensions personnalisées.

    Les paramètres personnalisés peuvent être utilisés dans les définitions d'audience pouvant être appliquées à chaque rapport. Les paramètres personnalisés sont également inclus dans les données exportées vers BigQuery si votre application est associée à un projet BigQuery. Pour obtenir des exemples de requêtes et bien plus, consultez BigQuery Export pour Google Analytics 4.

  • Paramètre value: paramètre à usage général utile pour accumuler une métrique clé concernant un événement. Exemples : revenus, distance, temps et points.

  • Les noms de paramètres peuvent comporter jusqu'à 40 caractères. Ils doivent commencer par un caractère alphabétique et ne contenir que des caractères alphanumériques et des traits de soulignement. Les types de chaîne et de nombre sont acceptés. Les valeurs de paramètre de chaîne peuvent comporter jusqu'à 100 caractères. Les préfixes "firebase", "google" et "ga_" sont réservés et ne doivent pas être utilisés pour les noms de paramètres.

Événements personnalisés

Si votre application présente des besoins spécifiques non couverts par un type d'événement recommandé, vous pouvez enregistrer vos propres événements personnalisés, comme illustré dans cet exemple:

await FirebaseAnalytics.instance.logEvent(
    name: "share_image",
    parameters: {
        "image_name": name,
        "full_text": text,
    },
);

Définir les paramètres d'événement par défaut

Vous pouvez enregistrer des paramètres pour plusieurs événements à l'aide de setDefaultEventParameters(). Les paramètres par défaut sont associés à tous les événements futurs enregistrés.

Comme pour les paramètres personnalisés, enregistrez les paramètres d'événement par défaut pour vous assurer qu'ils apparaissent dans les rapports Analytics.

Les valeurs de paramètre valides sont "Chaîne" et "Nombre". Définir la valeur d'une clé sur null efface ce paramètre. Transmettre une valeur nulle efface tous les paramètres.

// Not supported on web
await FirebaseAnalytics.instance
  .setDefaultEventParameters({
    version: '1.2.3'
  });

Si un paramètre est spécifié dans la méthode logEvent() ou log, cette valeur est utilisée à la place de la valeur par défaut.

Pour effacer un paramètre par défaut, appelez la méthode setDefaultEventParameters() avec le paramètre défini sur null.

Afficher les événements dans le tableau de bord

Vous pouvez consulter des statistiques agrégées sur vos événements dans les tableaux de bord de la console Firebase. Ces tableaux de bord sont mis à jour régulièrement tout au long de la journée. Pour un test immédiat, utilisez la sortie logcat comme décrit dans la section précédente.

Vous pouvez accéder à ces données à partir du tableau de bord Événements de la console Firebase. Ce tableau de bord affiche les rapports sur les événements qui sont automatiquement créés pour chaque type d'événement distinct enregistré par votre application.