Ce guide vous explique comment consigner des événements dans votre application.
Les événements fournissent des insights sur ce qui se passe dans votre application, comme les actions des utilisateurs, les événements système ou les erreurs.
Analytics enregistre automatiquement certains événements pour vous. Vous n'avez pas besoin d'ajouter de code pour les recevoir. Si votre application doit collecter des données supplémentaires, vous pouvez enregistrer jusqu'à 500 types d'événements Analytics différents dans votre application. Le volume total d'événements que votre application enregistre n'est pas limité. Notez que les noms d'événements sont sensibles à la casse et que la journalisation de deux événements dont les noms ne diffèrent que par la casse entraîne 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 l'instance FirebaseApp configurée, vous pouvez commencer à consigner des événements à l'aide de la méthode logEvent().
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 à quel moment les utiliser, consultez la section Événements recommandés.
Vous trouverez des informations détaillées sur l'implémentation dans la documentation de référence sur les constantes pour Swift et Objective-C.
L'exemple suivant montre comment consigner un événement kFIRSelectContent recommandé :
Swift
Analytics.logEvent(AnalyticsEventSelectContent, parameters: [ AnalyticsParameterItemID: "id-\(title!)", AnalyticsParameterItemName: title!, AnalyticsParameterContentType: "cont", ])
Objective-C
[FIRAnalytics logEventWithName:kFIREventSelectContent parameters:@{ kFIRParameterItemID:[NSString stringWithFormat:@"id-%@", self.title], kFIRParameterItemName:self.title, kFIRParameterContentType:@"image" }];
En plus des paramètres prescrits, 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 applicables à 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
kFIRParameterValue:kFIRParameterValueest un paramètre à usage général qui permet d'accumuler une métrique clé concernant un événement. Exemples : revenus, distance, durée et points.
Si votre application a des besoins spécifiques qui ne sont pas couverts par un type d'événement recommandé, vous pouvez enregistrer vos propres événements personnalisés, comme illustré dans l'exemple suivant:
Swift
Analytics.logEvent("share_image", parameters: [ "name": name as NSObject, "full_text": text as NSObject, ])
Objective-C
[FIRAnalytics logEventWithName:@"share_image" parameters:@{ @"name": name, @"full_text": text }];
Définir les paramètres d'événement par défaut
Vous pouvez enregistrer les paramètres pour les é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.
Swift
Analytics.setDefaultEventParameters([
"level_name": "Caverns01",
"level_difficulty": 4
])
Objective-C
[FIRAnalytics setDefaultEventParameters:
@{
@"level_name": "Caverns01",
@"level_difficulty": @(4)
}];
Si un paramètre est spécifié dans la méthode logEvent(), 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 nil.
Afficher les événements dans la console de débogage Xcode
Vous pouvez activer la journalisation détaillée pour surveiller la journalisation des événements par le SDK et vérifier ainsi que les événements sont consignés correctement. Cela inclut les événements enregistrés automatiquement et manuellement.
Vous pouvez activer la journalisation détaillée comme suit :
- Dans Xcode, sélectionnez Product > Scheme > Edit scheme (Produit > Schéma > Modifier le schéma).
- Sélectionnez Exécuter dans le menu de gauche.
- Sélectionnez l'onglet Arguments.
- Dans la section Arguments transmis lors du lancement, ajoutez
-FIRAnalyticsVerboseLoggingEnabled.
La prochaine fois que vous exécuterez votre application, vos événements s'afficheront dans la console de débogage Xcode, ce qui vous permettra de vérifier immédiatement qu'ils sont envoyés.
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.