イベントをロギングする

このガイドでは、アプリでイベントをロギングする方法について説明します。

イベントは、ユーザー操作、システム イベント、エラーなど、アプリで起こっていることを把握するのに役立ちます。

アナリティクスでは、一部のイベントが自動的にロギングされるので、それらのイベントを受信するコードを追加する必要はありません。それ以外のデータをアプリで収集する場合は、最大 500 種類までのアナリティクス イベントをロギングできます。アプリで記録できるイベントの量に制限はありません。イベント名では大文字と小文字が区別されます。そのため、大文字と小文字の使い方だけが異なっている同じ名前の 2 つのイベントは、2 つの別個のイベントとしてロギングされます。

始める前に

プロジェクトをセットアップし、アナリティクスを使ってみるの説明に沿ってアナリティクスにアクセスできることを確認してください。

イベントをロギングする

FirebaseApp インスタンスを構成すると、logEvent() メソッドを使ってイベントをロギングできるようになります。

アナリティクス SDK には、小売、e コマース、旅行、ゲームなど、さまざまな種類のアプリでよく使われる推奨イベントが多数定義されており、すぐに使うことができます。これらのイベントの詳細と使い方については、推奨イベントをご覧ください。

実装方法の詳細については、Swift または Objective-C の定数リファレンスをご覧ください。

次の例は、推奨の kFIRSelectContent イベントをロギングする方法を示しています。

Swift

Analytics.logEvent(AnalyticsEventSelectContent, parameters: [
  AnalyticsParameterItemID: "id-\(title!)",
  AnalyticsParameterItemName: title!,
  AnalyticsParameterContentType: "cont",
])
ViewController.swift

Objective-C

[FIRAnalytics logEventWithName:kFIREventSelectContent
                    parameters:@{
                                 kFIRParameterItemID:[NSString stringWithFormat:@"id-%@", self.title],
                                 kFIRParameterItemName:self.title,
                                 kFIRParameterContentType:@"image"
                                 }];
ViewController.m

既定のパラメータのほかにも、次のパラメータをあらゆるイベントに追加できます。

  • カスタム パラメータ: カスタム パラメータは、アナリティクス レポートでディメンションまたは指標として使用できます。数値以外のイベント パラメータ データにはカスタム ディメンションを使用し、数値で表すのに適したパラメータ データにはカスタム指標を使用します。SDK を使ってカスタム パラメータをロギングしたら、そのディメンションまたは指標を登録して、アナリティクス レポートにそのカスタム パラメータが表示されるようにします。これを行うには、[アナリティクス] > [イベント] > [カスタム定義を管理] > [カスタム ディメンションを作成] の順に選択します。

    カスタム パラメータは、すべてのレポートに適用可能なオーディエンスの定義で使用できます。アプリが BigQuery プロジェクトとリンクされている場合、カスタム パラメータは BigQuery にエクスポートされるデータにも含まれます。Google アナリティクス 4 の BigQuery Export で、サンプルクエリなどの情報をご覧ください。

  • kFIRParameterValue パラメータ: kFIRParameterValue は、イベントに関連する主要な指標の収集に役立つ汎用パラメータです。そのような指標には、たとえば収益、距離、時間、得点などがあります。

アプリに特殊なニーズがあり、推奨されるイベントの種類では収集できないデータを収集したい場合は、次の例で示すように独自のカスタム イベントをロギングできます。

Swift

Analytics.logEvent("share_image", parameters: [
  "name": name as NSObject,
  "full_text": text as NSObject,
])
PatternTabBarController.swift

Objective-C

[FIRAnalytics logEventWithName:@"share_image"
                    parameters:@{
                                 @"name": name,
                                 @"full_text": text
                                 }];
PatternTabBarController.m

デフォルトのイベント パラメータを設定する

setDefaultEventParameters を使用して、複数のイベントに共通するパラメータをロギングできます。デフォルトのパラメータは、ロギングされる今後のすべてのイベントに関連付けられます。

カスタム パラメータと同様に、デフォルトのイベント パラメータを登録して、アナリティクス レポートにカスタム パラメータが表示されるようにします。

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]、[Scheme]、[Edit scheme] の順に選択します。
  2. 左側のメニューから [Run] を選択します。
  3. [Arguments] タブを選択します。
  4. [Arguments Passed On Launch] セクションで -FIRAnalyticsVerboseLoggingEnabled を追加します。

以後、アプリを実行すると Xcode のデバッグ コンソールにイベントが表示され、イベントが送信されているかどうかをすぐに確認できます。

ダッシュボードでイベントを表示する

Firebase コンソールのダッシュボードでは、イベントに関する集約された統計情報を表示できます。これらのダッシュボードは、一日を通して定期的に更新されます。即座にテストを行いたい場合は、前のセクションで説明した logcat の出力を使用してください。

このデータにアクセスするには、Firebase コンソールの [イベント] ダッシュボードに移動します。このダッシュボードには、アプリによってロギングされたイベントの種類ごとに自動的に作成されたイベント レポートが表示されます。