データに基づく意思決定を支える、Google Analytics for Firebase のイベント送信

22.2K Views

September 13, 24

スライド概要

DroidKaigi 2024 で発表したスライドです。
https://2024.droidkaigi.jp/timetable/678050/

当日の発表動画
https://www.youtube.com/watch?v=Pi5qSRCHKyQ

高田晴彦

@tfandkusu

スライド一覧

Android Engineer at Kyash Inc.

またはPlayer版

埋め込む »CMSなどでJSが使えない場合

ダウンロード

ダウンロード(pdf - 4.04MB)

関連スライド

Google Analytics for Firebase のイベント送信 BigQuery への保存のされかたリレーショナルデータベースと同様にテーブルがあり、SQL で集計できる 1日1テーブル firebase-kyash.analytics_123456789.events_20240913 Google Cloud のプロジェクト名 ©2024 Kyash Inc. データセット名(自動付与) テーブル名（自動付与）後ろの8桁数字は日付 40

41.

Google Analytics for Firebase のイベント送信レコード 1回のイベント送信は 1レコードイベント名 event_name タイムスタンプ event_timestamp … screen_view 1721463361915024 … select_bank 1721463361915025 … kyc_top 1721463361915026 … マイクロ秒の UNIX 時間 ©2024 Kyash Inc. 41

42.

43.

Google Analytics for Firebase のイベント送信イベントパラメータの独特な保存形式ネストされた列 (= レコードの中に配列があるイメージ) イベントパラメータの value は型に合わせた列に格納 float_value double_value … event_name event_params. key event_params. value. string_value event_params. value. int_value … … reward_detail type daily null … id null 13 … SQL で取り出すときは UNNEST というキーワードを使う。あとで説明。 ※ イベントが発生した画面もイベントパラメータとして持っています。 ©2024 Kyash Inc. 43

44.

Google Analytics for Firebase のイベント送信アプリを使用している個人読み方は「スードウ」 … user_id user_pseudo_id … … 8736592 4f7a1e2b… … … 2941365 7c2d1e8f… … … 1721463 1d3e7c9a… … Firebase SDK の FirebaseAnalytics.setUserId メソッドで設定した文字列 ● ● 自動で設定同じデバイスの同じアプリはずっと同じ文字列 ※ 乱数で作ったデータです。実際のデータではありません。 ©2024 Kyash Inc. 44

45.

46.

Google Analytics for Firebase のイベント送信デバイスや OS の情報 … device. mobile_model_name device. operating_system device. operating_system_version … … Pixel 8 Pro Android Android 14 … … iPhone 15 Pro iOS iOS 17.5.1 … … Pixel 6a Android Android 13 … iOS / Android 別に人数を集計 minSdk を上げるに当たってサポート対象外になる人数を集計することができる。 ※ フィールドは一部抜粋 ©2024 Kyash Inc. 46

47.

Google Analytics for Firebase のイベント送信 BigQuery の SQL の例直近2週間で銀行選択画面を見た人数を iOS / Android 別に集計 ● SQL は長いので、今回は完璧な理解を目指さず、イメージだけ持ち帰って頂けると幸いです ○ ● この発表の主題は分析することでなく、イベントを送ること付録に参考資料を紹介しているので、必要に応じてご参照ください ©2024 Kyash Inc. 47

48.

Google Analytics for Firebase のイベント送信 OS と人数 SELECT device.operating_system AS os, COUNT(DISTINCT user_pseudo_id) AS count FROM テーブル名の日付部分は WHERE 句で _TABLE_SUFFIX を限定 firebase-kyash.analytics_153671808.events_*, UNNEST(event_params) AS p WHERE イベントパラメータは UNNEST で分解 _TABLE_SUFFIX BETWEEN FORMAT_DATE('%Y%m%d', DATE_SUB(CURRENT_DATE(), INTERVAL 14 DAY)) AND FORMAT_DATE('%Y%m%d', DATE_SUB(CURRENT_DATE(), INTERVAL 1 DAY)) AND event_name = 'screen_view' AND p.key='firebase_screen' AND event_name, key, value を限定 p.value.string_value='BankList' GROUP BY os ©2024 Kyash Inc. OS 別集計にする 48

49.

50.

Google Analytics for Firebase のイベント送信 BigQuery の集計に使えるツール表やグラフをチームで共有したいファネル分析スプレッドシート Google スプレッドシート (クラウド表計算ソフト) 1. 上部メニュー 2. データ 3. データコネクタ 4. BigQuery に接続 5. カスタムクエリを作成 6. SQL を入力することで数字を取り込める ©2024 Kyash Inc. 50

51.

52.

53.

54.

55.

56.

適切なイベント送信実装 - 画面遷移イベント送信画面遷移イベント送信 Activity クラス名が自動設定 iOS では ○○ViewController イベントパラメータ screen_class = BankListActivity イベント名 screen_view 任意に設定イベントパラメータ SDK に定数定義 screen_name = BankList イベントパラメータ名は BigQuery では firebase_screen_class, firebase_screen になる ©2024 Kyash Inc. 56

57.

58.

59.

60.

61.

62.

63.

https://firebase.google.com/docs/analytics/screenviews?hl=ja&_gl=1*u8yqht*_up*MQ..*_ga*MTUzMzQyODUzMi4xNzIxODM2MDcx*_ga_CW55HF8NVT*MTcyMTgzNjA3MS4xLjAuMTcyMTgzNjA3Ny4wLjAuMA..#manually_track_screens

64.

65.

適切なイベント送信実装 - 画面遷移イベント送信 Fragment の画面遷移イベント送信実装例 fun Fragment.sendScreenEvent( analyticsEventSender: AnalyticsEventSender, screenName: String, ) { this.viewLifecycleOwner.lifecycle.addObserver( object : DefaultLifecycleObserver { override fun onResume(owner: LifecycleOwner) { // Firebase の SDK をラップしたメソッドを呼び出し analyticsEventSender.sendScreen(screenName) } }, ) } ©2024 Kyash Inc. 65

66.

適切なイベント送信実装 - 画面遷移イベント送信 Fragment の画面遷移イベント送信実装例 @AndroidEntryPoint class BankListFragment : Fragment() { @Inject lateinit var analyticsEventSender: AnalyticsEventSender } override fun onViewCreated( 文字列リテラルでの画面名指定 view: View, が気になるが、あとでより良い方法を紹介 savedInstanceState: Bundle?, ) { super.onViewCreated(view, savedInstanceState) sendScreenEvent(analyticsEventSender, “BankList”) } ©2024 Kyash Inc. 66

67.

[beta]

適切なイベント送信実装 - 画面遷移イベント送信

Compose の画面遷移イベント送信実装例
@Composable
書き方は公式ドキュメント
fun SendScreenEvent(
analyticsEventSender: AnalyticsEventSender, DisposableEffect: クリーン
アップが必要な作用
screenName: String,
を参考にした
) {
val owner = LocalLifecycleOwner.current
DisposableEffect(owner) {
val observer = LifecycleEventObserver { _, event ->
if (event == Lifecycle.Event.ON_RESUME) {
analyticsEventSender.sendScreen(screenName)
}
}
owner.lifecycle.addObserver(observer)
onDispose { owner.lifecycle.removeObserver(observer) }
}
}
©2024 Kyash Inc.

67

https://developer.android.com/develop/ui/compose/side-effects?hl=ja#disposableeffect

68.

適切なイベント送信実装 - 画面遷移イベント送信 Compose の画面遷移イベント送信実装例 @Composable fun BankListScreen( viewModel: BankListViewModel, analyticsEventSender: AnalyticsEventSender, ) { SendScreenEvent(analyticsEventSender, “BankList”) Scaffold(/* 略 */) { /* 略 */ } } ©2024 Kyash Inc. 68

69.

70.

71.

72.

適切なイベント送信実装 - ユーザID設定 Analytics のデータバックエンドのデータ … event_name user_id … user_id kyc subscription … kyc_top 36592 … 94007 true false … select_bank 41365 … 36592 false false … screen_view 21463 … 87148 true true user_id で結合して集計 ※ 乱数で作ったデータです。実際のデータではありません。 ©2024 Kyash Inc. 72

73.

74.

75.

適切なイベント送信実装 - ユーザID設定基本的な内容では🤔 ● setUserId メソッド呼び出しは、機能改修やリファクタリングが行われる中で、失われることがある ○ 実際そうなってしまったアプリを見たことがある ○ ユーザ登録やログインは開発初期に作られて、歴史があるアプリだと RxJava や AsyncTask など古い技術が使われていて、あるタイミングで大規模にリファクタリングが行われることが多い Firebase SDK へのユーザID設定を適切に実装することを開発メンバーが入れ替わっても途絶えず継承したい ©2024 Kyash Inc. 75

76.

77.

適切なイベント送信実装 - ユーザID設定これまでの話 1. 「データに基づく意思決定」の例 2. モバイルエンジニアがそれを「支える」ため最後の話適切に実装し続けるチームを作るにイベント送信に注力 3. 「Google Analytics for Firebase のイベント送信」の予備知識 4. 画面遷移イベント送信とユーザIDの設定自動化 GitHub Actions / コード生成 / detekt カスタムルール ©2024 Kyash Inc. 77

78.

79.

適切に実装し続けるチームを作るための自動化イベント送信実装の課題 1. 文字数制限やイベント名の種類数制限を超えたイベントを送信してしまう 2. iOS と Android でイベント名やイベントパラメータが違う 3. イベントの仕様が適切に共有されてない ○ 4. PdM など Analytics イベントを分析するすべての人が対象画面遷移イベント送信の実装が抜けたままリリースしてしまう ©2024 Kyash Inc. 79

80.

81.

https://support.google.com/analytics/answer/9267744

82.

83.

84.

85.

86.

87.

88.

89.

適切に実装し続けるチームを作るための自動化 Android 向け自動生成コード object AnalyticsEvent { Analytics に送る文字列 sealed class Screen( public val eventName: String, public val isConversionEvent: Boolean, ) { イベント名かイベントパラメータのvalueか (Firebase A/B Testing 利用、500種類制限回避) data object BankList : Screen("BankList", false) data object DepositSuccess : Screen("DepositSuccess", true) } // 続く } ©2024 Kyash Inc. 89

90.

適切に実装し続けるチームを作るための自動化 iOS 向け自動生成コード protocol AnalyticsEventScreen { var eventName: String { get } var isConversionEvent: Bool { get } protocol は Kotlin でいう interface } enum AnalyticsEvent { enum Screen { enum は名前空間としての利用 struct BankList : AnalyticsEventScreen { let eventName: String = "BankList" let isConversionEvent: Bool = false } } // 以下略 ©2024 Kyash Inc. 90

91.

[beta]

適切に実装し続けるチームを作るための自動化

画面内操作イベントの自動生成コード(Android)
object AnalyticsEvent {
sealed class Action(
val eventName: String,

パラメータを持てるようにしている

val eventParameters: Map<String, Any>,
val isConversionEvent: Boolean,
) {
// 次のページで紹介
}
}

©2024 Kyash Inc.

91

92.

適切に実装し続けるチームを作るための自動化画面内操作イベントの自動生成コード(Android) object BankList { 所属する画面 data class ClickBank( イベントパラメータの value val bankCode: String, ) : Action( 銀行選択画面で銀行がクリックされたら銀行コードと一緒にイベント送信 eventName = "BankListClickBank", eventParameters = mapOf("bank_code" to bankCode), 画面名 + 操作名で自動生成される isConversionEvent = false, ) } ©2024 Kyash Inc. 92

93.

適切に実装し続けるチームを作るための自動化イベント送信担当インターフェース(Android) interface AnalyticsEventSender { fun sendScreen(screen: AnalyticsEvent.Screen) fun sendAction(action: AnalyticsEvent.Action) } 未定義のイベントは送信できない ©2024 Kyash Inc. 93

94.

適切に実装し続けるチームを作るための自動化 - description: 銀行選択画面 YAML ファイル class: BankList value: BankList description は説明文 ● ● ● class, property は Swift / Kotlin 上での表現 value は Analytics に送信するイベント名 key は Analytics に送信するイベントパラメータの key 可読性と40文字制限の両立のために、違うものを設定することが可能 conversion は500種類制限のあるイベント名にするかのフラグ ©2024 Kyash Inc. conversion: false actions: - description: 銀行がクリックされた class: ClickBank value: ClickBack parameters: - description: 銀行コード property: bankCode key: bank_code type: string 94

95.

適切に実装し続けるチームを作るための自動化 KotlinPoet 使用イメージ ● ● SwiftPoet も同じような使用方法詳細は最後に紹介するサンプルコード参照生成するコード KotlinPoet /** * Analytics イベントクラス群 */ public object AnalyticsEvent { /* 次のページ */ } TypeSpec .objectBuilder("AnalyticsEvent") .addKdoc("Analytics イベントクラス群 ") .addType( /* ネストするクラスを追加 */ ).build() ©2024 Kyash Inc. 95

96.

97.

適切に実装し続けるチームを作るための自動化 KotlinPoet 使用イメージ KotlinPoet TypeSpec .objectBuilder("BankList") .addKdoc("銀行選択画面 ") .addModifiers(KModifier.DATA) // data object にする .superclass(ClassName(PACKAGE, "AnalyticsEvent").nestedClass("Screen")) // 親クラスのコンストラクタパラメータを設定 .addSuperclassConstructorParameter("%S", "BankList") .addSuperclassConstructorParameter("%L", false) .build() ©2024 Kyash Inc. 97

98.

99.

100.

101.

適切に実装し続けるチームを作るための自動化チェック対象の画面遷移イベント送信実装 // 1画面に1つの Screen で終わる Composable 関数 @Composable fun BankListScreen( viewModel: BankListViewModel, analyticsEventSender: AnalyticsEventSender, ) { // 画面遷移イベント送信を行う SendScreenEvent(analyticsEventSender, AnalyticsEvent.Screen.BankList) } Scaffold(/* 略 */) { /* 略 */ } チェック項目 Screen で終わる Composable 関数内で SendScreenEvent 関数が呼ばれている ©2024 Kyash Inc. 101

102.

適切に実装し続けるチームを作るための自動化 detekt カスタムルールを使用 detekt とはカスタムルール ● Kotlin 言語の静的コード解析ツール ● Kotlin で開発 ● 1関数が長すぎる、マジックナンバーを ● Android プロジェクトにカスタムルール ● 使っている等のコードの匂いを検出してレを追加する方法の参考文献ポートとして出力する ○ reviewdog でプルリクにコメント Detekt for Android— How To Make Your Own Custom Rule ● ©2024 Kyash Inc. 今回は実装のコアな部分を紹介 102

https://medium.com/@emrekoc/detekt-for-android-how-to-make-your-own-custom-rule-2861eb60e4ba

103.

104.

適切に実装し続けるチームを作るための自動化抽象構文木の閲覧方法 Android Studio で閲覧可能 PSI Viewer という機能を使う (PSI = Program Structure Interface) デフォルト設定ではアクセス出来ないので公式ガイドの Enabling Internal Mode を参考に有効化する抽象構文木を見たいファイルを開いて Tool → View PSI Structure of Current File ©2024 Kyash Inc. 104

105.

適切に実装し続けるチームを作るための自動化カスタムルールの実装コード(一部抜粋) class SendScreenEvent(config: Config) : Rule(config) { /** * 抽象構文木から関数定義を見つけたときに呼ばれる。 */ override fun visitNamedFunction(function: KtNamedFunction) { } /** * 抽象構文木から関数呼び出しを見つけたときに呼ばれる。 */ override fun visitCallExpression(expression: KtCallExpression) { } } ©2024 Kyash Inc. 105

106.

[beta]

適切に実装し続けるチームを作るための自動化

カスタムルールの実装コード(一部抜粋)
private var sendScreenEventIsCalled = false
override fun visitCallExpression(expression: KtCallExpression) {
super.visitCallExpression(expression)
expression.getCalleeExpressionIfAny().let { func ->
if (func?.text == "SendScreenEvent") {
// SendScreenEvent 関数呼び出しが見つかったらフラグを true にする

sendScreenEventIsCalled = true
}
}
}
©2024 Kyash Inc.

106

107.

[beta]

適切に実装し続けるチームを作るための自動化

カスタムルールの実装コード(一部抜粋)
override fun visitNamedFunction(function: KtNamedFunction) {
super.visitNamedFunction(function)

中身は
@Composable
アノテーションの確認

// Screen で終わる Composable 関数を見つけたら
if (function.name?.endsWith("Screen") == true && isComposable(function)) {
// 先ほどの SendScreenEvent 関数が呼ばれたフラグをチェック。
// false の場合は Issue として報告する。
// 階層が深い方が先に処理される - 関数定義よりも関数呼び出しのチェックの方が先に行われるので
// この実装で要件を満たせる。
if (!sendScreenEventIsCalled) {
report(CodeSmell(issue, Entity.from(function), REPORT_MESSAGE))
}
}
sendScreenEventIsCalled = false
}
©2024 Kyash Inc.

107

108.

109.

110.

111.

112.

113.

補足イベント送信実装抜けチェックに Konsist を使えるか検討 detekt カスタムルール Konsist 概要抽象構文木をチェックローカル単体テストで実行時型情報をチェックチェックできる項目多い少ない導入ハードル少し高い低い ● ● ● ©2024 Kyash Inc. カスタムルール専用モジュールを作成 XML ファイルによる設定抽象構文木に対する理解 ● konsist ライブラリ使ったローカル単体テストを追加 113

114.

補足 Konsist の使用例この import 文の存在をチェック import co.kyash.analytics.sendScreenEvent class BankListFragment : Fragment() { override fun onViewCreated( view: View, savedInstanceState: Bundle?, ) { super.onViewCreated(view, savedInstanceState) sendScreenEvent( analyticsEventSender, AnalyticsEvent.Screen.BankList ) } } ©2024 Kyash Inc. 114

115.

補足 Konsist の使用例 @Test fun checkScreenEventFromFragment() { Konsist.scopeFromProject() // プロジェクトすべてを対象 .files // Kotlin ファイルを列挙 .withNameEndingWith("Fragment") // Fragment で終わるファイルに限定 .assertTrue { // 条件に合致するか確認 it.imports.withName( "co.kyash.analytics.sendScreenEvent", ).isNotEmpty() // 画面遷移イベント送信拡張関数を import している } } // (ワイルドカードインポート不使用はフォーマッタで保証する ) ©2024 Kyash Inc. 115

116.

補足ソースコード ● イベント定義リポジトリ ○ ● iOS アプリリポジトリ ○ ● https://github.com/tfandkusu/ga913-ios detekt カスタムルールと Konsist の活用もこちら Android アプリリポジトリ ○ ● https://github.com/tfandkusu/ga913-yaml https://github.com/tfandkusu/ga913-android Kotlin Multiplatform によるイベント定義リポジトリ ○ ©2024 Kyash Inc. https://github.com/tfandkusu/ga913-kmp 116

117.

118.

119.

付録 BigQuery に保存された Analytics イベントを分析する SQL の解説リンク event_params フィールドの取り扱い方について、分かりやすく解説している記事を紹介します。 ● GoogleAnalytics 4 のイベントを BigQuery で集計する ● BigQuery の UNNEST 関数を使って GoogleAnalytics のデータを取得する方法 ©2024 Kyash Inc. 119

120.

121.

データに基づく意思決定を支える、Google Analytics for Firebase のイベント送信

高田 晴彦

関連スライド

Flutterアプリの安全な変化と拡大を支えるアーキテクチャと単体テスト

Flutter WebにHTML要素を貼る

Kotlin Multiplatform の SKIE を導入したら iOS アプリのビルド時間を増やしてしまったので減らしたい話

15年目の Android エンジニアがオススメする DroidKaigi 2024 のセッション3選！

ユーザ行動分析のためのイベント送信における iOS / Android 間の実装差異を防ぐオーバーレイデバッグ表示機能の紹介

猫でも分かるUnreal Engineの学び方 - 超初心者向け編 - 2023 v1.0

各ページのテキスト

高田晴彦