記錄事件

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

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

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
])

目標-C

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

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

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

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

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

您可以按照下列方式啟用詳細記錄功能:

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

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

在資訊主頁中查看事件

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

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