iOSでGoogle Analyticsへのイベント送信の実装と確認作業を効率化した話

こんにちは。システム部の大澤です。普段は北米版あすけんのiOSアプリを開発しています。今回はGoogle Analyticsに送信する行動ログのイベントの実装を効率化したことについてまとめました。

Google Analyticsとは

Google Analyticsはアプリの使用状況とユーザーエンゲージメントについて分析できる、無料のアプリ測定ソリューションです。 Google Analyticsは元々、WebのツールであったがFirebase Analyticsと統合されて、アプリも計測できるようになりました。北米版あすけんでは行動ログのイベントを計測するためにFirebaseのSDKを使って、Google Analyticsに送信しています。

行動ログとは

行動ログとは、ボタンのタップイベントや画面のPVなどがあります。 Firebaseを使うことで初期設定でもある程度の行動ログを計測できます。

[GA4] 自動的に収集されるイベント

細かいデータを分析するには独自に実装することが必要です。 Swiftでの実装例として、ボタンのタップイベントの下記のようになります。

import Firebase

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        title = "Test"
    }
    @IBAction func buttonTapped(_ sender: Any) {
        Analytics.logEvent("tap_button_event", parameters: [
            AnalyticsParameterItemID: "id-\(title!)",
            AnalyticsParameterItemName: title!
        ])
    }
}

移行前の実装フロー

f:id:techaskeninc:20211203121820p:plain

実装する人はGoogleスプレッドシートに追加、変更するイベントを追加。
- 主にドキュメントとして使用していた。
追加したイベントをiOSのプロジェクトで実装する。

課題

Googleスプレッドシートに定義されたものと同じものが実装される保証はない。
- スペルミスやコピーミスで意図しない実装になる可能性がある。
差分を追いづらい。
- Google スプレッドシートの変更履歴でも追うことができるが利便性はよくない。
バージョン管理の仕組みがない。
- Google スプレッドシートに仕組みはないので変更を戻したりするのが簡単ではない。

変更後のフロー

f:id:techaskeninc:20211203121935p:plain

行動ログの実装で必要な情報はGitHubで管理するように変更。
YAMLで実装するイベントを定義する。
YAMLの定義の仕方は移行前のGoogle スプレッドシートと同じにした。
スクリプトを使って、YAML -> CSVに変換して、ドキュメントとして利用する。(エンジニア以外の人も確認を容易にするため）
このタイミングでSpell checker、重複チェック、文字列の長さのチェックを行っている。収集と設定の上限
YAML -> JSONに変換し、JSONを元にして、Swiftのクラスを生成する。
quicktypeを使うことでJSON -> Swiftへ変換が容易にできます。
実装時に関係ないデータはこのタイミングで消している。
JSONを元に変換されたSwiftのクラスをSwift Package Managerを使って、配布する。
実装するプロジェクトでSwift Package Managerを使って追加する。それによって、プロジェクトで生成したSwiftのクラスの呼び出しが可能になる。

ここでは上記で作成したものをEventTrackerというフレームワークにして、Swift Package Managerで追加しました。例として、下記のような実装になります。

import Firebase
import EventTracker

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        title = "Test"
    }
    @IBAction func buttonTapped(_ sender: Any) {
        let result = EventTrackStore.shared.apply(request: FirebaseEvent.Get(keyPath: \.tapButtonEvent))
        Analytics.logEvent(result.eventName, parameters: [
            result.params.key.analyticsParameterItemID: "id-\(title!)",
            result.params.key.analyticsParameterItemName: title!
        ])
    }
}