Appirater-Android

A simple to integrate and easy to use application rater for Android apps.

How it works

You want users to rate your app on the play store. They are unlikely to do it even if they want to, so a prompt will remind them to rate and take them straight to the app's store page where they can rate it with the least effort.

User Interface

A dialog will prompt the user to rate the app on the app store. When the user:

chooses Yes, he is sent to the app's page on the app store
chooses Later, he will be reminded to rate the app at a later time
chooses No he doesn't want to rate at all so he won't be bothered again

How it looks like

Default Theme	Customised Theme

Logic

You should not prompt the users straight when they open the app to rate it, as this might annoy them and it could backfire in uninstall or negative rating. Also the users aren't ready to give a fair rating unless they had a chance to use the app.

Imagine you made a web browser. To maximise the chances for a fair rating, we should define some rules of when the user will be invited to rate. For example:

don't prompt until the app was opened at least 10 times
don't prompt in the first 3 days, and also until the user loaded at least 15 web pages
however if the user used the app intensively and loaded more than 30 pages, prompt can appear before 3 days
if the user was prompted before and he either went to the app store or he refused, don't bother again
if the user said he was going to rate later, don't prompt until 2 more days have passed

Usage

Initialisation

Call Appirater.init(context) before any Appirater operation, such as in your main Activity or Application. E.g.:

class MyApp : Application {
...
    override class onCreate() {
        super.onCreate()
        Appirater.init(
            this, // ApplicationContext
            appVersionCode, // your app version, optional, details below
            raterAnalytics // analytics callback, optional, details below
            )
        ...
    }
...
}

Param appVersionCode

You can tell AppiRater the current app version. If the app was recently updated, Appirater will reset the significant events count, so that it gives more chance to the user to rate based on the experience of the last version.

For example: if a bug was just fixed in the new version but the user has seen the bug in the previous version, he may wrongly leave a bad rating without seeing it was actually fixed.

It is recommended to use BuildConfig.VERSION_CODE to use this feature, but you can skip it.

Param raterAnalytics

You can implement a RaterAnalytics callback to be informed of all AppiRater activity.

In this callback you can log events to your desired system, such as Firebase Analytics, and then analyse later how successful is your rating system.

For example: if you don't get enough rating, using analytics you might discover that you set the number of significant events too high, and most users are never prompted to rate.

You can skip this parameter if not interested.

Launch

When a main/launcher Activity is run, you can consider this an app launch and a checkpoint where possibly the prompt will be shown:

class MainActivity : Activity {
...
    override class onCreate() {
        super.onCreate()
        Appirater.get.onLaunch()
        ...
    }
...
}

Events

When a relevant event occurs, that shows the user is using the app, such as viewing a web page if your app is a browser, you can record it anywhere in the app:

...
Appirater.get.onEvent()
...

Installation

From JitPack (recommended)

Add it in your root build.gradle at the end of repositories:

	allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

Add the dependency:

	dependencies {
	        implementation 'com.github.rumburake:appirater-android:2.2.0'
	}

As a compiled library

Download the appirater-android-release.aar and place it in your libs e.g. app/libs/appirater-android-release.aar

In your app/build.gradle add the module as a dependency:

 dependencies {
     [...]
     dependencies {
         implementation files('libs/appirater-android-release.aar')
     [...]
 }

As a sub-module

Check check out the project as a module in your project, e.g. in directory appirater-android

In your app/build.gradle add the module as a dependency:

 dependencies {
     [...]
     dependencies {
         implementation project(':appirater-android')
     [...]
 }

Customization

⚠️ At a minimum modify appirater_app_title to read the title of your app.

Settings

You can change any of these values below by re-defining it in a values XML file.

You can copy the res/values/appirater-settings.xml in to your project's /res/values/ folder and adjust the settings to your preference.

These are all the settings that can be configured via the XML file:

appirater_app_title: your app name
appirater_market_url: URL of your app store (default: Google Play)
- Google Play App Store = market://details?id=%s
- Amazon App Store = http://www.amazon.com/gp/mas/dl/android?p=%s
appirater_days_until_prompt: minimum days from initial launch until prompt to rate (default: 30)
appirater_launches_until_prompt: minimum launches until it prompts to rate (default: 15)
appirater_untimed_events_until_prompt: minimum events until it prompts to rate, regardless of time since launch (default: 15)
appirater_timed_events_until_prompt: minimum events until it prompts to rate, but only after the minimum days has passed (default: 15)
appirater_days_before_reminding: if user chose Later, minimum days before it prompts to rate again (default: 3)
appirater_test_mode: set this to true for testing the dialog at every launch (default: false)

Colors

You can change any of those values below by re-defining it in a colors XML file.

appirater_button_start_color: gradient start color for buttons
appirater_button_end_color: gradient end color for buttons
appirater_button_text_color: button text color
appirater_title_color: title, divider and contour color
appirater_message_color: text message color
appirater_background_color: the background color of the whole dialog

License

MIT/X11: http://opensource.org/licenses/MIT

This is originally forked from: https://github.com/kenyee/appirater-android ...which is a modified version of: https://github.com/drewjw81/appirater-android/

rumburake/appirater-android