本指南向您展示如何在您的应用程序中记录事件。
事件可以让您深入了解您的应用中正在发生的事情,例如用户操作、系统事件或错误。
Analytics 会自动为您记录一些事件;您无需添加任何代码即可接收它们。如果您的应用需要收集额外数据,您可以在您的应用中记录多达 500 种不同的分析事件类型。您的应用记录的事件总量没有限制。请注意,事件名称区分大小写,记录两个名称仅大小写不同的事件将导致两个不同的事件。
在你开始之前
确保您已设置项目并且可以访问 Analytics,如开始使用 Analytics中所述。
记录事件
配置FirebaseApp
实例后,您可以开始使用logEvent()
方法记录事件。
为帮助您入门,Analytics SDK 定义了一些推荐事件,这些事件在不同类型的应用程序中很常见,包括零售和电子商务、旅游和游戏应用程序。要了解有关这些事件以及何时使用它们的更多信息,请参阅推荐事件。
您可以在Swift和Objective-C的常量参考中找到实现细节。
以下示例演示如何记录推荐的kFIRSelectContent
事件:
迅速
Analytics.logEvent(AnalyticsEventSelectContent, parameters: [ AnalyticsParameterItemID: "id-\(title!)", AnalyticsParameterItemName: title!, AnalyticsParameterContentType: "cont", ])
目标-C
[FIRAnalytics logEventWithName:kFIREventSelectContent parameters:@{ kFIRParameterItemID:[NSString stringWithFormat:@"id-%@", self.title], kFIRParameterItemName:self.title, kFIRParameterContentType:@"image" }];
除了规定的参数外,您还可以将以下参数添加到任何事件中:
自定义参数:自定义参数可用作Analytics 报告中的维度或指标。您可以为非数字事件参数数据使用自定义维度,为更好地以数字表示的任何参数数据使用自定义指标。使用 SDK 记录自定义参数后,注册维度或指标以确保这些自定义参数显示在 Analytics 报告中。通过以下方式执行此操作: Analytics > Events > Manage Custom Definitions > Create Custom Dimensions
自定义参数可用于可应用于每个报告的受众定义。如果您的应用链接到 BigQuery 项目,则自定义参数也包含在导出到 BigQuery的数据中。在Google Analytics 4 BigQuery Export中查找示例查询和更多内容。
kFIRParameterValue
参数:kFIRParameterValue
是一个通用参数,可用于累积与事件相关的关键指标。示例包括收入、距离、时间和积分。
如果您的应用程序具有推荐事件类型未涵盖的特定需求,您可以记录自己的自定义事件,如本例所示:
迅速
Analytics.logEvent("share_image", parameters: [ "name": name as NSObject, "full_text": text as NSObject, ])
目标-C
[FIRAnalytics logEventWithName:@"share_image" parameters:@{ @"name": name, @"full_text": text }];
设置默认事件参数
您可以使用setDefaultEventParameters
跨事件记录参数。默认参数与记录的所有未来事件相关联。
与自定义参数一样,注册默认事件参数以确保这些自定义参数出现在 Analytics 报告中。
迅速
Analytics.setDefaultEventParameters([
"level_name": "Caverns01",
"level_difficulty": 4
])
目标-C
[FIRAnalytics setDefaultEventParameters:
@{
@"level_name": "Caverns01",
@"level_difficulty": @(4)
}];
如果在logEvent()
方法中指定了参数,则使用该值而不是默认值。
要清除默认参数,请调用setDefaultEventParameters
方法并将参数设置为nil
。
在 Xcode 调试控制台中查看事件
您可以启用详细日志记录来监视 SDK 的事件日志记录,以帮助验证事件是否被正确记录。这包括自动和手动记录的事件。
您可以按如下方式启用详细日志记录:
- 在 Xcode 中,选择Product > Scheme > Edit scheme...
- 从左侧菜单中选择运行。
- 选择参数选项卡。
- 在启动时传递的参数部分中,添加
-FIRAnalyticsVerboseLoggingEnabled
。
下次运行您的应用程序时,您的事件将显示在 Xcode 调试控制台中,帮助您立即验证是否正在发送事件。
在仪表板中查看事件
您可以在 Firebase 控制台仪表板中查看有关事件的汇总统计信息。这些仪表板全天定期更新。对于即时测试,请使用上一节中所述的 logcat 输出。
您可以从 Firebase 控制台的事件仪表板访问此数据。此仪表板显示为您的应用程序记录的每种不同类型的事件自动创建的事件报告。