Google Play In-App Review APIを簡単に使うためのライブラリを作成してみた

Google Play In-App Review API によって、Androidでもアプリ内からレビューの投稿ができるようになったので、レビューUIの表示をサポートするライブラリを作成しました。

GitHub - ReviewPromptManager

要件

Android 5.0 以上

使い方

インストール

moduleのbuild.gradleに以下の依存を追加してください。

implementation 'jp.hitting.review-manager:review-manager:0.0.1'

設定

Applicationクラスにて daysUntilPrompt と usesUntilPrompt を設定してください。

• daysUntilPrompt: レビューUIを表示するまでに必要な経過日数
• usesUntilPrompt: レビューUIを表示するまでに必要な起動回数
• IS_DEV: Google Play In-App Review APIの仕様で、Play Storeに公開したアプリでないとレビューUIを表示できないため、開発中は IS_DEV をtrueにしてください。
  • テスト方法はこちらを参考にしてください。
• DEBUG: trueにすると daysUntilPrompt や usesUntilPrompt に関わらず、必ずレビューUIが表示されます。

class MyApplication: Application() {
    override fun onCreate() {
        super.onCreate()

        ReviewPromptManager.daysUntilPrompt = 1
        ReviewPromptManager.usesUntilPrompt = 10
//        ReviewPromptManager.IS_DEV = true
//        ReviewPromptManager.DEBUG = true
    }
}

起動情報の記録

一番初めに表示されるActivityのonCreateで launched(Context) を呼び出してください。

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    ReviewPromptManager.launched(this)
}

レビューUIの表示

レビューUIを表示したいところで、 showReviewPrompt(Activity, PromptListener?) を呼び出してください。

以下の条件をすべて満たす場合にレビューUIが表示されます。

• 初回起動からの経過日数 >= daysUntilPrompt
• 起動回数 >= usesUntilPrompt

また、PromptListenerを引数に渡せば、レビューUI表示フロー完了時、成功時、失敗時にそれぞれのメソッドが呼び出されます。

interface PromptListener {
    fun onComplete()
    fun onSuccess()
    fun onFailure(e: Exception)
}

今後

今後は重要イベントのカウントに応じてレビューUIを表示できるようにする等の実装をしていきたいと思います。

参考

• 【Android】In-App Review APIを使ってレビュー機能をサクッと作ろう