このガイドでは、アプリでイベントをロギングする方法について説明します。
アナリティクスでは、一部のイベントが自動的にロギングされるので、それらのイベントを受信するコードを追加する必要はありません。それ以外のデータをアプリで収集する場合は、最大 500 種類までのアナリティクス イベントをロギングできます。アプリで記録できるイベントの量に制限はありません。イベント名では大文字と小文字が区別されます。そのため、大文字と小文字の使い方だけが異なっている同じ名前の 2 つのイベントは、2 つの別個のイベントとしてロギングされます。
始める前に
プロジェクトをセットアップし、アナリティクスを使ってみるの説明に沿ってアナリティクスにアクセスできることを確認してください。
イベントをロギングする
FirebaseAnalytics インスタンスを作成したら、それを使用して、ライブラリの log メソッドを使ってイベントをロギングできます。
事前定義イベント
アナリティクス SDK には、小売、e コマース、旅行、ゲームなど、さまざまな種類のアプリでよく使われる推奨イベントが多数定義されており、すぐに使うことができます。これらのイベントの詳細と使い方については、推奨イベントをご覧ください。
推奨イベントタイプのログメソッドは、API リファレンスで確認できます。
次の例は、select_content イベントをロギングする方法を示しています。
await FirebaseAnalytics.instance.logSelectContent(
contentType: "image",
itemId: itemId,
);
あるいは、logEvent() を使用して同じイベントをロギングすることもできます。
await FirebaseAnalytics.instance.logEvent(
name: "select_content",
parameters: {
"content_type": "image",
"item_id": itemId,
},
);
これは、規定（必須）のパラメータ以外にもパラメータを指定する場合に便利です。次のパラメータは任意のイベントに追加できます。
カスタム パラメータ: カスタム パラメータは、アナリティクス レポートでディメンションまたは指標として使用できます。数値以外のイベント パラメータ データにはカスタム ディメンションを使用し、数値で表すのに適したパラメータ データにはカスタム指標を使用します。SDK を使ってカスタム パラメータをロギングした後、そのディメンションまたは指標を登録して、アナリティクス レポートにそのカスタム パラメータが表示されるようにします。これを行うには、[アナリティクス] > [イベント] > [カスタム定義を管理] > [カスタム ディメンションを作成] の順に選択します。
カスタム パラメータは、すべてのレポートに適用可能なオーディエンスの定義で使用できます。アプリが BigQuery プロジェクトとリンクされている場合、カスタム パラメータは BigQuery にエクスポートされるデータにも含まれます。Google アナリティクス 4 の BigQuery Export で、サンプルクエリなどの情報をご覧ください。
valueパラメータ: イベントに関連する主要な指標の収集に役立つ汎用パラメータです。そのような指標には、たとえば収益、距離、時間、得点などがあります。パラメータ名は、英数字とアンダースコアのみを使って最大 40 文字で指定し、先頭を英字にする必要があります。文字列型と数値型がサポートされています。文字列のパラメータ値は最大 100 文字です。「firebase」「google」「ga_」の接頭辞は予約されているため、パラメータ名に使用しないでください。
カスタム イベント
アプリに特殊なニーズがあり、推奨されるイベントの種類では収集できないデータを収集したい場合は、次の例で示すように独自のカスタム イベントをロギングできます。
await FirebaseAnalytics.instance.logEvent(
name: "share_image",
parameters: {
"image_name": name,
"full_text": text,
},
);
デフォルトのイベント パラメータを設定する
setDefaultEventParameters() を使用して、複数のイベントに共通するパラメータをロギングできます。
デフォルトのパラメータは、ロギングされる今後のすべてのイベントに関連付けられます。
カスタム パラメータと同様に、デフォルトのイベント パラメータを登録して、アナリティクス レポートに表示されるようにします。
有効なパラメータ値は文字列と数値です。キーの値を null に設定すると、そのパラメータがクリアされます。null 値を渡すことで、すべてのパラメータがクリアされます。
// Not supported on web
await FirebaseAnalytics.instance
.setDefaultEventParameters({
version: '1.2.3'
});
logEvent() または log メソッドでパラメータが指定されている場合は、デフォルトではなくその値が使用されます。
デフォルトのパラメータをクリアするには、パラメータを null に設定して setDefaultEventParameters() メソッドを呼び出します。
ダッシュボードでイベントを表示する
Firebase コンソールのダッシュボードでは、イベントに関する集約された統計情報を表示できます。これらのダッシュボードは、一日を通して定期的に更新されます。即座にテストを行いたい場合は、前のセクションで説明した logcat の出力を使用してください。
このデータにアクセスするには、Firebase コンソールの [イベント] ダッシュボードに移動します。このダッシュボードには、アプリによってロギングされたイベントの種類ごとに自動的に作成されたイベント レポートが表示されます。