このガイドでは、アプリでイベントをログに記録する方法について説明します。
イベントは、ユーザー アクション、システム イベント、エラーなど、アプリで何が起こっているかについての洞察を提供します。
Analytics は自動的にいくつかのイベントを記録します。それらを受け取るためにコードを追加する必要はありません。アプリで追加のデータを収集する必要がある場合は、アプリで最大 500 の異なる Analytics イベントタイプをログに記録できます。アプリがログに記録するイベントの総量に制限はありません。イベント名は大文字と小文字が区別されることに注意してください。名前の大文字と小文字が異なる 2 つのイベントをログに記録すると、2 つの異なるイベントが発生することに注意してください。
あなたが始める前に
プロジェクトをセットアップし、Analytics の使用開始の説明に従って Analytics にアクセスできることを確認してください。
ログイベント
FirebaseApp
インスタンスを構成したら、 logEvent()
メソッドを使用してイベントのログ記録を開始できます。
開始を支援するために、Analytics SDK では、小売、e コマース、旅行、ゲームなど、さまざまな種類のアプリに共通する推奨イベントが多数定義されています。これらのイベントの詳細と使用時期については、推奨イベントを参照してください。
実装の詳細については、 SwiftおよびObjective-Cの定数リファレンスを参照してください。
次の例は、推奨されるkFIRSelectContent
イベントをログに記録する方法を示しています。
迅速
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" }];
所定のパラメータに加えて、次のパラメータを任意のイベントに追加できます。
カスタム パラメータ: カスタム パラメータは、アナリティクス レポートのディメンションまたは指標として使用できます。数値以外のイベント パラメータ データにはカスタム ディメンションを使用し、数値でより適切に表現されたパラメータ データにはカスタム指標を使用できます。 SDK を使用してカスタム パラメータを記録したら、ディメンションまたは指標を登録して、これらのカスタム パラメータが Analytics レポートに表示されるようにします。これを行う方法: [分析] > [イベント] > [カスタム定義の管理] > [カスタム ディメンションの作成]
カスタム パラメータは、すべてのレポートに適用されるオーディエンス定義で使用できます。アプリが BigQuery プロジェクトにリンクされている場合、カスタム パラメータはBigQuery にエクスポートされるデータにも含まれます。 Google アナリティクス 4 BigQuery Exportで、サンプル クエリなどを見つけてください。
kFIRParameterValue
パラメーター:kFIRParameterValue
は、イベントに関連する重要なメトリックを蓄積するのに役立つ汎用パラメーターです。例には、収益、距離、時間、およびポイントが含まれます。
推奨されるイベント タイプでは対応できない特定のニーズがアプリケーションにある場合は、次の例に示すように、独自のカスタム イベントをログに記録できます。
迅速
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 レポートに表示されるようにします。
迅速
Analytics.setDefaultEventParameters([
"level_name": "Caverns01",
"level_difficulty": 4
])
Objective-C
[FIRAnalytics setDefaultEventParameters:
@{
@"level_name": "Caverns01",
@"level_difficulty": @(4)
}];
logEvent()
メソッドでパラメータが指定されている場合、デフォルトの代わりにその値が使用されます。
デフォルトのパラメーターをクリアするには、パラメーターをnil
に設定してsetDefaultEventParameters
メソッドを呼び出します。
Xcode デバッグ コンソールでイベントを表示する
詳細ログを有効にして、SDK によるイベントのログを監視し、イベントが適切にログに記録されていることを確認できます。これには、自動的に記録されたイベントと手動で記録されたイベントの両方が含まれます。
次のように詳細ログを有効にできます。
- Xcode で、[製品] > [スキーム] > [スキームの編集... ] を選択します。
- 左側のメニューから [実行] を選択します。
- 引数タブを選択します。
- [起動時に渡される引数] セクションで、
-FIRAnalyticsVerboseLoggingEnabled
を追加します。
次回アプリを実行すると、イベントが Xcode デバッグ コンソールに表示されるため、イベントが送信されていることをすぐに確認できます。
ダッシュボードでイベントを表示する
Firebase コンソール ダッシュボードで、イベントに関する集計統計を表示できます。これらのダッシュボードは、1 日を通して定期的に更新されます。すぐにテストするには、前のセクションで説明した logcat 出力を使用します。
このデータには、Firebase コンソールのイベントダッシュボードからアクセスできます。このダッシュボードには、アプリによって記録されたイベントの種類ごとに自動的に作成されるイベント レポートが表示されます。