SDK отзывов и оценок для Defold (версия 1.0.1)

Общие сведения

RuStore In-app Review SDK предлагает пользователю оставить оценку и отзыв о вашем приложении в RuStore, не выходя из приложения.

Пользовательский сценарий оценки и отзыва может быть запущен в любое время на протяжении всего пути пользователя в вашем приложении. Пользователь может оценить ваше приложение по шкале от 1 до 5 и оставить отзыв. Отзыв является опциональным.

Пример реализации

Ознакомьтесь с приложением-примером чтобы узнать, как правильно интегрировать SDK отзывов и оценок.

Пример пользовательского сценария

Условия корректной работы SDK

Для работы SDK оценок и отзывов необходимо соблюдение следующих условий.

Приложение загружено в Консоль RuStore.

Важно

Подпись тестируемой сборки (например, debug) приложения должна совпадать с подписью сборки приложения, которая была загружена в консоль и прошла модерацию ранее (например, release).

ОС Android версии 7.0 или выше.
На устройстве пользователя установлена актуальная версия RuStore.
Пользователь авторизован в RuStore.
Приложение должно быть опубликовано в RuStore.

Когда запрашивать оценку и отзыв

Следуйте рекомендациям, чтобы решить, в какой момент запросить оценку и отзыв о приложении у пользователя (см. ниже).

Запускайте процесс после того, как пользователь достаточно использовал ваше приложение.
Не запускайте процесс слишком часто — это ухудшит опыт пользователя вашего приложения и ограничит использование SDK оценок.
Не используйте призывы к действию, например, кнопку «Оценить приложение» — пользователь уже мог исчерпать лимит запуска процесса.
Ваше приложение не должно задавать какие-либо вопросы пользователю перед запуском или во время процесса, в том числе вопросы об их мнении (например, «Вам нравится приложение?») или прогнозирующие вопросы (например, «Вы бы поставили этому приложению 5 звёзд?»).

Подключение в проект

Скопируйте проекты плагина и приложения-примера из официального репозитория RuStore на GitFlic.
Откройте в вашей IDE проект Android из папки extension_libraries.
Выполните сборку проекта командой gradle assemble. При успешном выполнении сборки в папках review_example/extension_rustore_review/lib/android и review_example/extension_rustore_core/lib/android будут созданы файлы:
- RuStoreDefoldReview.jar;
- RuStoreDefoldCore.jar.
Скопируйте папки review_example/extension_rustore_review и review_example/extension_rustore_core в корень вашего проекта.

Работа с оценками

Подготовка к работе с оценками

Перед вызовом методов библиотеки необходимо выполнить ее инициализацию. Для инициализации воспользуйтесь методом init().

Вызов метода init
function init(self)
    rustorereview.init()
end

Подготовка к запуску оценки приложения

Вызовите request_review_flow заранее, перед вызовом launch_review_flow, чтобы подготовить необходимую информацию для отображения экрана. Срок жизни ReviewInfo — около пяти минут.

Перед использованием метода необходимо единожды выполнить подписку на события:

on_request_review_flow_success;
on_request_review_flow_failure.

Подписка на события
function init(self)
    rustorecore.connect("rustore_request_review_flow_success", _request_review_flow_success)
    rustorecore.connect("rustore_request_review_flow_failure", _request_review_flow_failure)
 
    -- Инициализация rustorereview
end
 
function _request_review_flow_success(self, channel, value)

end
 
function _request_review_flow_failure(self, channel, value)
    local data = json.decode(value)
end

Вызов метода request_review_flow
rustorereview.request_review_flow()

Обратный вызов (callback) rustore_request_review_flow_failure возвращает строку JSON с информацией об ошибке. Структура ошибки описана в разделе Обработка ошибок.

信息

Список возможных ошибок

Запуск оценки приложения

Для запуска формы запроса оценки и отзыва о приложении у пользователя вызовите метод launch_review_flow(), используя ранее полученный ReviewInfo.

Перед использованием метода необходимо единожды выполнить подписку на события:

on_request_review_flow_success;
on_request_review_flow_failure.

Подписка на события
function init(self)
    rustorecore.connect("rustore_launch_review_flow_success", _launch_review_flow_success)
    rustorecore.connect("rustore_launch_review_flow_failure", _launch_review_flow_failure)
 
    -- Инициализация rustorereview
end
 
func _launch_review_flow_success(self, channel, value)
 
end
 
func _launch_review_flow_failure(self, channel, value)
    local data = json.decode(value)
end

Вызов метода launch_review_flow
rustorereview.launch_review_flow()

Дождитесь уведомления о завершении формы пользователем в rustore_launch_review_flow_success или rustore_launch_review_flow_failure, чтобы продолжить работу приложения.

Обратный вызов (callback) rustore_launch_review_flow_failure возвращает строку JSON с информацией об ошибке. Структура ошибки описана в разделе Обработка ошибок.

После завершения формы оценки вне зависимости от результата (success или failure) не рекомендуется отображать какие-либо дополнительные формы, связанные с оценкой и отзывом. Частый вызов launch_review_flow() не повлечёт за собой отображения формы оценки для пользователя, допустимое отображение регулируется на стороне RuStore.

信息

Список возможных ошибок

Обработка ошибок

Возникающие ошибки можно получить в событиях *_failure.

Структура ошибки

Обработка json ошибки
function _on_failure(self, channel, value)
    local data = json.decode(value)
	
    local message = data.detailMessage
end

detailMessage – описание ошибки.

Возможные ошибки

RuStoreNotInstalledException — на устройстве пользователя не установлен RuStore;
RuStoreOutdatedException — версия RuStore, установленная на устройстве пользователя, не поддерживает данный SDK;
RuStoreUserUnauthorizedException — пользователь не авторизован в RuStore;
RuStoreRequestLimitReached — с момента последнего отображения процесса прошло слишком мало времени;
RuStoreReviewExists — этот пользователь уже оценил ваше приложение;
RuStoreInvalidReviewInfo — проблемы с ReviewInfo;
RuStoreException — базовая ошибка RuStore, от которой наследуются остальные ошибки.

SDK отзывов и оценок для Defold (версия 1.0.1)

Общие сведения​

Пример реализации​

Пример пользовательского сценария​

Условия корректной работы SDK​

Когда запрашивать оценку и отзыв​

Рекомендации к дизайну​

Подключение в проект​

Работа с оценками​

Подготовка к работе с оценками​

Подготовка к запуску оценки приложения​

Запуск оценки приложения​

Обработка ошибок​