2.0.0
General
RuStore In-app Review SDK prompts the user to rate your app and leave feedback on RuStore without exiting the app.
Rating and feedback user scenarios may be run at any time throughout the user’s path in your app. The user can rate your app from 1 to 5 and leave feedback. Feedback is optional.
Implementation example
Check out the application example to learn how to properly integrate the Feedback SDK.
User scenario example
Prerequisites
For rating and feedback SDK to operate correctly, the following conditions need to be met:
- Android 7.0 or later.
- The current version of RuStore is installed on the user's device.
- User is authorized in RuStore.
App mus be published in RuStore .
When to ask for feedback
Use the tips below to decide when to ask the user to rate and leave feedback: (See below
-
Start the process once the user has been using your app for long enough.
-
Avoid starting it too often as this will impair your app’s user experience and limit the use or SDK ratings.
-
Avoid using calls to action like “Rate App” button as the user could have already reached the process starting limit.
-
Your app should not ask the user any questions before the start or while the process is running, including their opinion (“Do you like the app?”) or predictive questions (“Would you give this app 5 stars?”).
Design recommendations
Use the tips below to decide how to integrate the process:
-
Display the process as is, without any intervention or modification of existing design, including size, opacity, shape and other properties.
-
Add nothing on top or on sides of the process.
-
The process should open on top of all layers. Don’t close the process after starting. The process will close by itself after an express action by the user.
Connecting to project
To get started, you need to download the RuStore Review SDK and import it to your project (Assets > Import Package > Custom Package). Dependencies are added automatically using the External Dependency Manager (included in SDK).
Minimum API level must be set to at least 24. Application minification (ProGuard/R8) is currently not supported, it must be disabled in the project settings (File > Build Settings > Player Settings > Publishing Settings > Minify).
Working with user ratings
Getting started with user ratings
To work with reviews, you need to create RuStoreReviewManager
using RuStoreReviewManagerFactory
.
RuStoreReviewManager.Instance.Init();
Preparing to launch app evaluation
CallRequestReviewFlow()
in advance before calling LaunchReviewFlow()
, to prepare necessary information to display. ReviewInfo
has a lifetime — about five minutes.
RuStoreReviewManager.Instance.RequestReviewFlow(
onFailure: (error) => {
/ Handle error
},
onSuccess: () => {
/ Handle success
});
- If
onSuccess
, response is received, save ReviewInfo locally to callLaunchReviewFlow
. later. - If
onFailure
is received, displaying the error to the user is not recommended because the user didn’t start this process.
Launching app evaluation
To run the feedback form in your app, call theLaunchReviewFlow()
method using the previously obtained ReviewInfo
.
RuStoreReviewManager.Instance.LaunchReviewFlow(
onFailure: (error) => {
/ Handle error
},
onSuccess: () => {
/ Handle success
});
onSuccess
or onFailure
to proceed with the application.
After completing the feedback form, regardless of the outcome (onSuccess
or onFailure
), it is not recommended to display any additional forms related to assessment and feedback.
If called frequently, launchReviewFlow
will not display the feedback window to the user, as the allowed display is regulated by RuStore.
Errors processing
public class RuStoreError {
public string name;
public string description;
}
name
— error name;description
— error description.
onFailure
.
RuStoreNotInstalledException
— RuStore is not installed on the user's device;RuStoreOutdatedException
— RuStore version installed on the user's device does not support this SDK;RuStoreUserUnauthorizedException
— user is not authorized in RuStore;RuStoreRequestLimitReached
— not enough time has passed since the process was last shown;RuStoreReviewExists
— this user has already rated your app;RuStoreInvalidReviewInfo
— problems withReviewInfo
;RuStoreException
— basic RuStore error from which other errors are inherited.