AndroidでAppsFlyerに送るイベントのパラメーターがnullになっていた問題に対応した
はじめに
みてねのCREグループでエンジニアをしているこすげです。
この記事では、AndroidアプリのKotlinコードでAppsFlyerに送信しているイベントのパラメーターが、not-nullであるはずなのに管理画面上でnullになってしまう問題に気がつき、対応したことについて書きました。
同じような問題に直面している人だったり、同じような実装をしている人の気づきになれたらいいなと思います。
前提知識
AppsFlyer
AppsFlyerは、モバイルアプリのインストールやイベントを計測・分析できるモバイル計測プラットフォームです。
ある広告経由からインストールしたユーザーがどのような行動をしているかを計測することができます。
対応することになったきっかけ
ある日、新規ユーザー獲得をKPIに置いているチームから「AppsFlyerに新しくイベントを送信するように実装してほしい」との依頼が来ました。
CREグループとしてもAppsFlyerの実装依頼は初めてで現状の把握もできていなかったため、iOS / Android共に既存のイベントが計測ができているかどうかの調査から進めることにしました。
そこでコードベースで調査したところ、依頼してきたチームがまとめていたドキュメントと少し食い違う部分が見つかりました。
それがイベント送信はされているけど、パラメーターがnullになってしまっていて、計上されていないという点でした。
コード上では、AppsFlyerに送信しているデータの型はnot-nullで、nullになり得ないはずでした。しかし、実際にAppsFlyerの管理画面で見るとnullになってしまっているという状態でした。
{
"key": "value",
"count": 3
}
みたいに送っているはずが、AppsFlyerの管理画面からレポートをダウンロードすると
{
"key": null,
"count": null
}
という状態になっていました。
ありえないけど、起きてしまっていること、そのパラメーターが計上できないと正確な数字が測れないこともあり、対応を進めることにしました。
調査した内容
どんなことを調査したのか書いていきます。
既存のそのほかのイベントでも同じようにvalueがnullになっているかどうか
今回気がついたイベント以外にもパラメーターを送っているイベントがあったので、それら全てがnullになっているのかどうかを調べました。
もしこれでnullになっていない場合は気がついたイベントを送信するところの問題として切り分けられるからです。
結果は全てのイベントのパラメーターのvalueがnullになっていました。
このイベントのパラメーターの値は文字列以外にもint, floatやbooleanなど様々な型で送っていましたが、全てnullになっていました。
どこの段階でnullになっているか
イベント送信するところの処理は以下のようになっています。
jsonをencodeしてdecodeしてるところが怪しいかなと思いつつ、上記の全てのpointでprint debugしましたが、どこの時点でもnullになっていませんでした。
イベント名とパラメーターをまとめたdata classは以下のようにしています(だいぶサンプルです)
@Serializable
data class EventData(
val eventName: String,
val params: JsonObject,
)
どこで見てもnullにはならないのですが、アプリのログを見るとAppsFlyerのSDKがHTTPリクエストを送信してるログではnullになっています。
xxx-xx-xx xx:xx:xx.xxx 1234-5678 AppsFlyer_6.16.2 com.example.development
I [Other] INAPP-11: preparing data: {"eventValue":"{\"key\":null,\"hoge\":null,\"fuga\":null}"}
AppsFlyerSDKのコードは公開されていないので、どのようなデコード処理をしているかわかりませんでした...。
ただAppsFlyerSDKに送るところまではしっかり情報が残っていることがわかったので、AppsFlyerSDKに渡すパラメーターを調整すれば良さそうなことがわかりました。
問題の原因
今回の問題の原因を深掘りすると、以下のようなことがわかりました。
-
JsonObject
はkotlin-serializationが定義する型で、Map<String, Any>
として取り扱えるように定義されている。 - AppsFlyerへイベントを通知するメソッドは
Map<String, Object>
を引数として受け取るように定義されている。 - アプリ内で用意している
params: JsonObject
をそのまま渡すと、AppsFlyerはJsonObject
型を知らないため、内部でマップを展開した際に値を復元できずnullになってしまっていた。
つまり、ライブラリが Object
型を受け取るようなメソッドの場合、Kotlinで定義している型が適切に渡せているかを確認する必要があるということです。
どういったデータを渡したらnullにならないか
これはすぐにわかりました。
以下のようにしたところ、nullになりませんでした。
appsFlyerLib.logEvent(context, data.eventName, mapOf("test_key" to "test_value"))
appsFlyerLibはAppsFlyerSDKが用意してくれているものですが、 logEvent をcallすることでログ送信ができます。
上記のように mapOf()
で渡したところ以下のようにログが出ました。
xxx-xx-xx xx:xx:xx.xxx 1234-5678 AppsFlyer_6.16.2 com.example.development
I [Other] INAPP-11: preparing data: {"eventValue":"{\"test_key\":\"test_value\"}"}
しっかり test_value
が送られていることがわかりました。
ちなみに appsFlyerLib
の logEvent
は以下のように型が定義されています。
public abstract void logEvent(Context var1, String var2, Map<String, Object> var3);
となると、アプリ内で用意してる val params: JsonObject
をそのまま渡すとnullにされてしまうのかな?と考え javaで言う java.util.Map<String, Object>
、kotlinで言う Map<String, Any>
に型変換すると良さそうなことがわかりました。
なので、JsonObject
を Map<String, Any>
に変換するコードを実装しました。
実装した内容
以下のように書きました。
import kotlinx.serialization.json.*
fun JsonObject.toAnyMap(): Map<String, Any> = this.mapValues { it.value.toAny() }
fun JsonElement.toAny(): Any = when (this) {
is JsonNull -> "null"
is JsonPrimitive -> when {
this.isString -> this.content
this.booleanOrNull != null -> this.boolean
this.intOrNull != null -> this.int
this.longOrNull != null -> this.long
this.doubleOrNull != null -> this.double
else -> this.content // fallback
}
is JsonObject -> this.mapValues { it.value.toAny() }
is JsonArray -> this.map { it.toAny() }
}
このようにして、以下のように渡すようにしました。
@Serializable
data class EventData(
val eventName: String,
val params: JsonObject,
)
fun logEvent(context: Context, data: EventData) {
appsFlyerLib.logEvent(context, data.eventName, data.params.toAnyMap())
}
これでログを確認したところ、無事送られていることが確認できました。
終わりに
計測周りの実装、一度対応して完了になることが多く、見直されることもあまり多くないと思います。
ただOSのアップデートや言語のバージョンアップ、ネイティブアプリ固有の複数言語(JavaとKotlin、Objective-CとSwift)の共存や暗黙的変換などなど何もしてないけど変わってしまうことも多いと思うので、しっかり計測した数字を見ていけるようにしていきたいと思います。
今回CREの立場からコードを触る際に、たくさん相談に乗ってくれたり実際にレビューで優しく教えてくれたAndroidエンジニアのみんなにとても感謝しています。
以上になります。
Discussion