記錄事件


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

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

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() 方法中指定參數,系統會使用該值,而非預設值。

如要清除預設參數,請呼叫 setDefaultEventParameters 方法,並將參數設為 nil

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

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

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

  1. 在 Xcode 中,依序選取「Product」>「Scheme」>「Edit scheme...」
  2. 在左選單中選取「Run」
  3. 選取「Arguments」分頁標籤。
  4. 在「Arguments Passed On Launch」部分中,加入 -FIRAnalyticsVerboseLoggingEnabled

下次執行應用程式時,Xcode 偵錯控制台會顯示事件,方便您立即確認事件是否已傳送。

在資訊主頁中查看活動

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

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