イベントをロギングする

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

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

始める前に

Firebase 向け Google アナリティクスを使用するには、Firebase プロジェクトを作成してから、Firebase Unity SDK パッケージを Unity プロジェクトに追加する必要があります。

設定:

事前準備

Android

  • Unity 5.0 以降
  • Android NDK バージョン 10d 以降

iOS

  • Unity 5.0 以降
  • Xcode 8.0 以降

Unity プロジェクトをまだ用意していない場合は、いずれかのクイックスタート サンプルをダウンロードし、特定の Firebase 機能をお試しいただけます。クイックスタートを使用する場合は、次のステップでバンドル識別子が必要になるため、プロジェクト設定からバンドル識別子を忘れずに取得してください。

Firebase コンソールでアプリを設定する

アプリに Firebase を追加するには、Firebase プロジェクトと、アプリ用の Firebase 構成ファイルが必要です。

Firebase プロジェクトを作成するには:

  1. Firebase プロジェクトをまだ用意していない場合は、Firebase コンソールで Firebase プロジェクトを作成します。[プロジェクトを追加] をクリックします。モバイルアプリと関連付けられた既存の Google プロジェクトがある場合は、[プロジェクト名] プルダウン メニューから選択します。それ以外の場合は、プロジェクト名を入力して新しいプロジェクトを作成します。
  2. 省略可: プロジェクト ID を編集します。プロジェクトに一意の ID が自動的に付与され、データベース URL や Firebase Hosting サブドメインなどの一般公開される Firebase の機能で使用されます。特定のサブドメインを使用する場合は、この時点でプロジェクト ID を変更できます(後で変更できません)。
  3. 残りの設定手順に沿って操作した後、[プロジェクトを作成](または既存のプロジェクトを使用している場合は [Firebase を追加])をクリックして、プロジェクト用のリソースのプロビジョニングを開始します。通常、この処理には数分かかります。処理が完了すると、プロジェクトの概要が表示されます。

Android

  1. [Android アプリに Firebase を追加] をクリックし、設定手順に沿って操作します。既存の Google プロジェクトをインポートする場合、このステップは自動的に実行されることがあります。その場合は、構成ファイルをダウンロードするだけでかまいません。
  2. 求められたら、アプリのパッケージ名を入力します。必ずアプリで使用しているパッケージ名を入力してください。パッケージ名を設定できるのは、アプリを Firebase プロジェクトに追加するときだけです。
  3. 処理中に google-services.json ファイルをダウンロードします。このファイルは、いつでもダウンロードできます。
  4. 初期化コードを追加してアプリを実行すると、Firebase を正常にインストールしたという確認のメッセージが Firebase コンソールに送信されます。

iOS

  1. [iOS アプリに Firebase を追加] をクリックして設定手順に沿って操作します。既存の Google プロジェクトをインポートする場合、このステップは自動的に実行されることがあります。その場合は、構成ファイルをダウンロードするだけでかまいません。
  2. 求められたら、アプリのバンドル ID を入力します。必ずアプリで使用しているバンドル ID を入力してください。バンドル ID を設定できるのは、アプリを Firebase プロジェクトに追加するときだけです。
  3. 処理中に GoogleService-Info.plist ファイルをダウンロードします。このファイルは、いつでもダウンロードできます。
  4. 初期化コードを追加してアプリを実行すると、Firebase を正常にインストールしたという確認のメッセージが Firebase コンソールに送信されます。
  5. Firebase コンソールからダウンロードした GoogleService-Info.plist を、Unity プロジェクトの任意のフォルダにドラッグします。

アプリに Firebase Unity SDK を追加する

  1. Firebase Unity SDK をダウンロードします。
  2. [Assets] > [Import Package] > [Custom Package] メニュー項目を選択します。
  3. ダウンロードしておいた Firebase Unity SDK から FirebaseAnalytics.unitypackage パッケージをインポートします。
  4. [Import Unity Package] ウィンドウが表示されたら [Import] をクリックします。

SDK の初期化

Android の Firebase Unity SDK には Google Play 開発者サービスが必要であり、SDK を使用する前に最新版にしておく必要があります。次のコードをアプリケーションの先頭に追加して、SDK で他のメソッドを呼び出す前に Google Play 開発者サービスを確認し、必要であれば、Firebase Unity SDK で必要とされるバージョンに更新します。

Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWith(task => {
  var dependencyStatus = task.Result;
  if (dependencyStatus == Firebase.DependencyStatus.Available) {
    // Create and hold a reference to your FirebaseApp, i.e.
    //   app = Firebase.FirebaseApp.DefaultInstance;
    // where app is a Firebase.FirebaseApp property of your application class.

    // Set a flag here indicating that Firebase is ready to use by your
    // application.
  } else {
    UnityEngine.Debug.LogError(System.String.Format(
      "Could not resolve all Firebase dependencies: {0}", dependencyStatus));
    // Firebase Unity SDK is not safe to use here.
  }
});

アプリをビルドする

Android

  1. [File] > [Build Settings] メニュー項目を選択します。
  2. [Platform] リストから [Android] を選択します。
  3. [Switch Platform] をクリックし、ターゲット プラットフォームとして [Android] を選択します。
  4. Unity ステータスバーの右下隅にあるスピナー(コンパイル中)アイコンが停止するまで待ちます。
  5. [Build and Run] をクリックします。

iOS

  1. [File] > [Build Settings] メニュー項目を選択します。
  2. [Platform] リストから [iOS] を選択します。
  3. [Switch Platform] をクリックし、ターゲット プラットフォームとして [iOS] を選択します。
  4. Unity ステータスバーの右下隅にあるスピナー(コンパイル中)アイコンが停止するまで待ちます。
  5. [Build and Run] をクリックします。

イベントをロギングする

Firebase.Analytics.FirebaseAnalytics モジュールを初期化すると、そのモジュールで LogEvent() メソッドを使ってイベントをロギングできるようになります。

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

推奨イベントの実装方法の詳細については、次の記事をご覧ください。

  • 推奨イベント: Event 定数のリストをご覧ください。
  • 既定のパラメータ: Parameters 定数のリストをご覧ください。

次に示す例では、推奨イベントである SELECT_CONTENT イベントを記録する方法を説明します。

    // Log an event with multiple parameters, passed as an array:

Firebase.Analytics.FirebaseAnalytics.LogEvent(
  Firebase.Analytics.FirebaseAnalytics.EventSelectContent,
  new Firebase.Analytics.Parameter[] {
      new Firebase.Analytics.Parameter(
        Firebase.Analytics.FirebaseAnalytics.ParameterItemId, id),
      new Firebase.Analytics.Parameter(
        Firebase.Analytics.FirebaseAnalytics.ParameterItemName, "name"),
      new Firebase.Analytics.Parameter(
        Firebase.Analytics.FirebaseAnalytics.UserPropertySignUpMethod, "Google"),
      new Firebase.Analytics.Parameter(
        "favorite_food", mFavoriteFood),
      new Firebase.Analytics.Parameter(
        "user_id", mUserId),
  }
);

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

  • カスタム パラメータ: カスタム パラメータはアナリティクス レポートには記載されませんが、ユーザーリストの定義の際にフィルタとして使用できます。定義したユーザーリストはあらゆるレポートに適用できます。アプリが BigQuery プロジェクトとリンクされている場合、カスタム パラメータは BigQuery にエクスポートされるデータにも含まれます。

  • VALUE パラメータ: VALUE はアナリティクス イベントに関連する主要な指標を蓄積するのに役立つ汎用のパラメータです。そのようなイベントにはたとえば収益、距離、時間、得点などがあります。

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

Firebase.Analytics.FirebaseAnalytics.LogEvent("custom_progress_event", "percent", 0.4f);

ログ出力でイベントを表示する

Android

Android Studio のデバッグログで詳細ログを有効にして、SDK によってイベントが正しく記録されているかどうかを確認することができます。対象となるのは、自動で記録されるイベントと手動で記録されるイベントの両方です。

詳細ログを有効にするには、次の一連の adb コマンドを入力します。

adb shell setprop log.tag.FA VERBOSE
adb shell setprop log.tag.FA-SVC VERBOSE
adb logcat -v time -s FA FA-SVC

このコマンドを入力すると Android Studio の logcat にイベントが表示され、イベントが送信されているかどうかを即座に確認することができます。

iOS

イベントはコンソールにロギングされるため、Xcode でアプリを実行しながら確認できます。

ダッシュボードでアナリティクス イベントを表示する

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

Firebase コンソールでこのデータにアクセスするには、次のように操作します。

  1. Firebase コンソールでプロジェクトを開きます。
  2. メニューで [アナリティクス] を選択し、アナリティクスのレポート ダッシュボードを表示します。

[イベント] タブには、アプリによってロギングされたアナリティクス イベントの種類ごとに自動的に作成されたイベント レポートが表示されます。アナリティクスのレポート ダッシュボードの詳細については、Firebase ヘルプセンターをご覧ください。

フィードバックを送信...

ご不明な点がありましたら、Google のサポートページをご覧ください。