この記事の概要

Android用のレビューダイアログライブラリをオープンソースとして公開しました。

We published RMP-Appirater by open source.
RMP-Appirater is an Android library that will help remind users to review your app on the Google play.

はじめに

スマートフォンアプリエンジニアをやっていると、ビジネスサイドから「○○アプリみたいにアプリ起動した時にレビューダイアログを表示したい！」なんてことを言われることがあります。
そんなときには、ユーザにGoogle playへのレビュー投稿を促すオープンソースライブラリであるappirater-androidあたりを使って楽するのが定石なのですが……今回「ユーザが○○な状態で、かつ☓☓の条件をクリアしていて、その上で△△な操作を過去にしている時にレビューダイアログ表示してほしい」ということを言われちゃいまして、ダイアログの表示条件をプログラマブルにカスタムできるappirater-android的なライブラリを今回作成しました。

使い方

Githubのサイトからダウンロードした上でAndroid Studioにモジュールをインポートしていただくか、Mavenからダウンロードできます。

compile 'jp.co.recruit_mp:android-RMP-Appirater:1.0'

アプリ起動時に呼ばれるActivityの Activity#onCreate(Bundle) あたりに下記のコードを入れると評価ダイアログを表示します。

public class MainActivity extends ActionBarActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // ユーザがまだ評価をしておらず、かつダイアログから"No, Thanks"（"いいえ"）を選択していない場合に、
        // 評価ダイアログを表示します
        RmpAppirater.appLaunched(this);
    }
}

評価ダイアログを表示する条件をカスタムすることもできます。

public class MainActivity extends ActionBarActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        RmpAppirater.appLaunched(this,
            new RmpAppirater.ShowRateDialogCondition() {
                  @Override
                  public boolean isShowRateDialog(
                      long appLaunchCount, long appThisVersionCodeLaunchCount,
                      long firstLaunchDate, int appVersionCode,
                      int previousAppVersionCode, Date rateClickDate,
                      Date reminderClickDate, boolean doNotShowAgain) {
                          // ここでtrueを返すと評価ダイアログを表示します
                          // 
                          // パラメーター
                          // appLaunchCount                アプリの起動回数
                          // appThisVersionCodeLaunchCount このバージョンでのアプリの起動回数
                          // firstLaunchDate               初めて起動した日付
                          // appVersionCode                このアプリのVersionCode
                          // previousAppVersionCode        前回アプリを起動した際のVersionCode
                          // rateClickDate                 "Yes, Rate APPNAME"（"APPNAMEを評価する"）を選択した日付
                          // reminderClickDate             "Remind me later"（"後で見る"）を選択した日付
                          // doNotShowAgain                "No, Thanks"（"いいえ"）を選択している
                          
                          // ユーザがまだ評価をしておらず
                          // && かつダイアログから"No, Thanks"（"いいえ"）を選択していない
                          // && アプリの起動回数が5回以上
                          return (rateClickDate == null && !doNotShowAgain && appLaunchCount >= 5);
                }
            },
            // RmpAppirater.Optionsを指定すると、ダイアログのテキストをカスタムすることができます
            new RmpAppirater.Options(
                "Custom title",
                "Custom message",
                "Custom rate button text",
                "Custom rate later button text",
                "Custom cancel button text"));
    }
}

ライセンス

Apache License, Version 2.0のライセンスになります。

Copyright (C) 2015 Recruit Marketing Partners Co.,Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

さいごに

あと、不具合修正や改良、翻訳等ありましたら、リポジトリにどしどしプルリクエストいただけると嬉しいです。