記錄事件


本指南說明如何在應用程式中記錄事件。

事件可讓您深入瞭解應用程式中的活動,例如使用者動作、系統事件或錯誤。

Analytics 會自動記錄部分事件;您不必新增任何程式碼,就能接收事件。如果應用程式需要收集其他資料,您可以在應用程式中記錄最多 500 個不同的 Analytics 事件類型。應用程式記錄的事件總量沒有上限。請注意,事件名稱有區分大小寫,如果記錄兩個名稱只有大小寫不同的事件,系統會將其視為兩個不同的事件。

事前準備

請確保您已設定專案,並且可以按照「開始使用 Analytics」中的說明存取 Analytics

記錄事件

設定 FirebaseApp 例項後,您就可以開始使用 logEvent() 方法記錄事件。

為協助您開始使用,Analytics SDK 定義了多項建議事件,這些事件在不同類型的應用程式中都很常見,包括零售和電子商務、旅遊和遊戲應用程式。如要進一步瞭解這些事件,以及何時使用這些事件,請參閱「建議事件」一文。

您可以在 SwiftObjective-C 的常數參考資料中找到實作詳細資訊。

以下範例說明如何記錄建議的 kFIRSelectContent 事件:

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"
                                 }];

除了規定的參數外,您也可以在任何事件中加入下列參數:

  • 自訂參數:自訂參數可用於維度或指標Analytics報表。您可以使用自訂維度來呈現非數值的事件參數資料,並使用自訂指標來呈現任何以數字表示的參數資料。使用 SDK 記錄自訂參數後,請註冊維度或指標,確保這些自訂參數會顯示在 Analytics 報表中。方法則是:[Analytics] > [事件] > [管理自訂定義] > [建立自訂維度]

    您可以在目標對象定義中使用自訂參數,這些定義可套用至每份報表。如果應用程式已連結至 BigQuery 專案,則匯出至 BigQuery 的資料也會包含自訂參數。如要查看範例查詢和其他資訊,請參閱「Google Analytics 4 BigQuery Export」一文。

  • kFIRParameterValue 參數:kFIRParameterValue 是通用參數,可用於累積與事件相關的重要指標。例如收入、距離、時間和分數。

如果應用程式有特定需求,而建議的事件類型無法涵蓋這些需求,您可以記錄自訂事件,如下例所示:

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
                                 }];

設定預設事件參數

您可以使用 setDefaultEventParameters 記錄各事件的參數。預設參數會與日後記錄的所有事件建立關聯。

如同自訂參數,請註冊預設事件參數,確保這些自訂參數會顯示在 Analytics 報表中。

Swift

Analytics.setDefaultEventParameters([
  "level_name": "Caverns01",
  "level_difficulty": 4
])

Objective-C

[FIRAnalytics setDefaultEventParameters:
  @{
  @"level_name": "Caverns01",
  @"level_difficulty": @(4)
}];

如果在 logEvent() 方法中指定參數,系統會使用該值,而非預設值。

如要清除預設參數,請在參數設為 nil 時呼叫 setDefaultEventParameters 方法。

在 Xcode 偵錯主控台中查看事件

您可以啟用詳細記錄功能,監控 SDK 記錄的事件,以便確認事件是否正確記錄。這包括自動和手動記錄的事件。

您可以使用以下指令啟用詳細記錄功能:

  1. 在 Xcode 中,選取「Product」>「Schee」>「Edit scheme...」
  2. 在左選單中選取「執行」
  3. 選取「Arguments」分頁標籤。
  4. 在「Arguments Passed On Launch」部分中,新增 -FIRAnalyticsVerboseLoggingEnabled

下次執行應用程式時,事件會顯示在 Xcode 偵錯主控台中,協助您立即驗證事件是否已傳送。

在資訊主頁中查看事件

您可以在 Firebase 控制台的資訊主頁中查看事件的相關匯總統計資料。這些資訊主頁會在一天中定期更新。如要立即測試,請按照上一節所述使用 logcat 輸出內容。

您可以透過 Firebase 主控台的「事件資訊主頁存取這類資料。這個資訊主頁會顯示系統為應用程式記錄的每種不同事件類型自動建立的事件報表。