Google Analytics for Firebaseのデバッグモードで、アプリのイベント送信をリアルタイムに確認
Google Analytics for Firebaseには、アプリから送信されたイベントと、設定されたパラメータを確認するために、Debug View(デバッグビュー)という機能が存在します。
このDebug Viewを利用すると、お手元の端末で送信されたイベントをほぼリアルタイムに確認でき、要件定義どおりに各イベントが動作しているかを確認できます。しかし、このDebug Viewを利用するためには、Android、iOSアプリの両方で作業をする必要があります。
今回の記事では、Android、iOSアプリでGoogle Analytics for Firebaseのデバッグモードを有効化する手順と、Firebase Console(ファイヤーベースコンソール)でDebug Viewを利用する方法について解説します。
Androidアプリでデバッグモードを利用する
Android Studioをインストールする
Android Studioをインストールすると、コマンドプロンプトでadbコマンド※を利用できます。
- Android Studioは以下のリンクからダウンロード可能https://developer.android.com/studio?hl=ja
※adbコマンド(Android Debug Bridge)とは、端末とパソコンとの間で通信を行い、アプリのインストール、デバッグなどが可能になるコマンドラインツールです。 adbコマンドの詳細な利用方法は以下の開発者用ドキュメントをご確認ください。
- Android Debug Bridge(adb) | Android Developershttps://developer.android.com/studio/command-line/adb?hl=ja
Android Studioのインストール完了後、起動すると、初期設定が実施されます。
初期設定を完了すると、Android Studioが起動します。
初期設定完了後に上記の画面が表示され、Android Studioが利用可能な状態になります。
次に、adbコマンドがインストールされたディレクトリを確認します。
右下の[Configure]から、[SDK Manager]をクリックします。
[Android SDK Location]を確認すると、以下のディレクトリにadbコマンドを含むAndroid SDK Platform-Tools がインストールされていることが確認できます。
C:\Users\{Windowsのログインユーザー名}\AppData\Local\Android\Sdk\platform-tools
環境変数の設定
次に、環境変数を設定します。Android Studioをインストールした直後の場合、adbコマンドは以下のように実行します。
C:\Users\{ユーザー名}\AppData\Local\Android\Sdk\platform-tools\adb
毎回、adbコマンドがインストールされているディレクトリのパスを指定しての実行は手間がかかるため、環境変数に上記コマンドのディレクトリの部分(C:\Users\{ユーザー名}\AppData\Local\Android\Sdk\platform-tools\adb)を追加し、コマンド入力を簡略化します。環境変数の設定は以下のように、画面遷移すると表示できます。
- コントロールパネルを起動
- コントロールパネル内の[システムとセキュリティ]をクリック
- [システム]をクリック
- 画面左側の[システムの詳細設定]をクリック
- 詳細タブ内の[環境変数]をクリック
- [システム環境変数]から[Path]を選択し、[編集]ボタンをクリック
- [新規]をクリックし、adbコマンドがインストールされたディレクトリのパスを設定し、[OK]ボタンをクリック
以上で、コマンドプロンプトからadbコマンドを実行するための設定が完了しました。
コマンドプロンプトからデバッグモードを有効化する
コマンドプロンプトを実行し、以下のコマンドを実行することで、Android アプリのFirebase Analyticsのデバッグモードを有効化できます。
adb shell setprop debug.firebase.analytics.app {package_name}
{package_name}の箇所には、デバッグモードの動作確認を行うアプリに設定されたパッケージ名を指定します。パッケージ名は、Firebaseコンソールの[プロジェクトを設定]に登録されているアプリの一覧から確認できます。
下図は、サンプルで作成したプロジェクトの[プロジェクトを設定]を開いた状態です。[パッケージ名]に表示されている、jp.ayudante.firebaseappsamples がデバッグモードを有効化する際に利用するパッケージ名です。
動作確認が完了後、以下のコマンドを実行して、デバッグモードを無効化できます。
adb shell setprop debug.firebase.analytics.app .none.
Android アプリのデバッグモードを有効化する手順は以上です。
iOSでデバッグモードを利用する
アプリの開発環境がある実装担当者へデバッグモードを有効化したアプリの作成を依頼する
Androidアプリの場合、自身のPC上で作業をすることで、デバッグビューを利用できました。 しかし、iOSアプリの場合、アプリの開発環境Xcode上の設定を行う必要があり、デバッグビューの有効化の作業は、アプリの実装担当者に依頼することを推奨します。
XcodeでFirebase Analyticsのデバッグモードを有効化する設定
この部分は、アプリの実装担当者の方が行う作業を想定して書かせていただきます。Xcodeのソースが正常にコンパイルできることを確認し、デバッグモードを有効化するためにビルド設定を変更します。
[Product] > [Scheme] > [Edit Scheme]を選択
表示されたダイアログの Arguments Passed On Launchにて、以下の引数を設定する。
-FIRDebugEnabled
また、デバッグモードを無効化する場合、以下の引数を設定する。
-FIRDebugDisabled
実装担当者からデバッグモードを有効化したアプリを共有してもらう
デバッグモードを有効化したアプリを実装担当者から共有してもらいます。 実装担当者のPCに、検証に使用する端末を接続してXcodeからアプリをインストールします。
開発担当者にXcodeからアプリを端末へインストールする際、「端末のUDIDを教えて欲しい」と依頼される場合があります。UDIDとは端末を一意に識別するためのIDです。開発中は事前にUDIDによって特定した端末のみ、Xcodeからアプリをインストール、デバッグできます。
UDIDを確認する場合、iTunesが必要です。Windowsをご利用の場合、Microsoft Storeから入手してください。
iTunesのインストール後、端末をPCに接続します。
接続すると、iTunesから端末の情報を閲覧できます。
この画面上の、「シリアル番号」の部分を1回クリックすると、端末のUDIDを確認できます。
このUDIDをコピーし、実装担当者に共有します。実装担当者からアプリのインストール準備が整ったことを報告してもらったら、アプリがXcodeからインストール可能になります。
iOSアプリのデバッグモードを有効化する手順は以上です。
Firebase ConsoleのDebug Viewで動作確認する
Android、iOSアプリのデバッグモードを有効化した後、実際にFirebase ConsoleからDebugViewを確認し、イベントが意図した通りのパラメータで送信されているか確認します。
アプリのデバッグモードを有効化した後、アプリを起動します。 その状態で、Firebase ConsoleのDebug Viewを起動します。
左上の[デバッグに使用するデバイス]をクリックし、お手元の端末を選択します。
お手元の端末でボタンのタップや画面遷移を行うと、Debug View上に端末から送信されたイベントが数秒遅れて表示されます。
Firebase Analyticsで定義されているイベントと送信するパラメータ名とプロパティについては以下の表に記載されています。
今回は、Firebase Analyticsを実装したアプリのイベント送信を確認する、Debug Viewの利用方法について紹介しました。
デバッグモードを有効化するための手順で、マーケティング担当の方々には馴染みのないコマンドプロンプトの実行などがありましたが、不明な箇所が合った場合は、アプリの実装担当者に相談していただくことで解決できるのではないかと思います。
ソーシャルもやってます!