Интегрируйте обзоры в приложении (родные)

В этом руководстве описывается, как интегрировать обзоры внутри приложения в ваше приложение с помощью собственного кода (C или C++). Если вы используете Kotlin, Java или Unity , существуют отдельные руководства по интеграции.

Обзор собственного SDK

Play Core Native SDK является частью семейства библиотек Google Play Core . Play Core Native SDK включает заголовочный файл C, review.h , который обертывает ReviewManager из библиотек проверки в приложении Java Play. Этот файл заголовка позволяет вашему приложению вызывать API непосредственно из вашего собственного кода. Обзор доступных общедоступных функций см. в документации собственного модуля Play Review .

ReviewManager_requestReviewFlow запускает запрос, который собирает информацию, необходимую для последующего запуска потока проверки в приложении. Отследить результат запроса можно с помощью ReviewManager_getReviewStatus . Дополнительные сведения обо всех статусах, которые может возвращать ReviewManager_getReviewStatus , см. в ReviewErrorCode .

Функции запроса и запуска возвращают REVIEW_NO_ERROR , если функция завершилась успешно.

Настройте среду разработки

Download Play Core Native SDK

Before downloading, you must agree to the following terms and conditions.

Terms and Conditions

Last modified: September 24, 2020
  1. By using the Play Core Software Development Kit, you agree to these terms in addition to the Google APIs Terms of Service ("API ToS"). If these terms are ever in conflict, these terms will take precedence over the API ToS. Please read these terms and the API ToS carefully.
  2. For purposes of these terms, "APIs" means Google's APIs, other developer services, and associated software, including any Redistributable Code.
  3. “Redistributable Code” means Google-provided object code or header files that call the APIs.
  4. Subject to these terms and the terms of the API ToS, you may copy and distribute Redistributable Code solely for inclusion as part of your API Client. Google and its licensors own all right, title and interest, including any and all intellectual property and other proprietary rights, in and to Redistributable Code. You will not modify, translate, or create derivative works of Redistributable Code.
  5. Google may make changes to these terms at any time with notice and the opportunity to decline further use of the Play Core Software Development Kit. Google will post notice of modifications to the terms at https://developer.android.com/guide/playcore/license. Changes will not be retroactive.
Download Play Core Native SDK

play-core-native-sdk-1.15.0.zip

  1. Выполните одно из следующих действий:

    • Установите Android Studio версии 4.0 или выше. Используйте пользовательский интерфейс SDK Manager для установки платформы Android SDK версии 10.0 (уровень API 29).
    • Установите инструменты командной строки Android SDK и используйте sdkmanager для установки платформы Android SDK версии 10.0 (уровень API 29).

  2. Подготовьте Android Studio для собственной разработки с помощью диспетчера SDK , чтобы установить последнюю версию CMake и Android Native Development Kit (NDK). Дополнительные сведения о создании или импорте собственных проектов см. в разделе «Начало работы с NDK» .

  3. Загрузите zip-файл и извлеките его вместе с вашим проектом.

    Ссылка для скачивания Размер Контрольная сумма SHA-256
    37,7 МБ 91d24fcd04885f56e5c4ab1154e3ab71b3ef8d514f428876ee2a330a9e5b725b

  4. Обновите файл build.gradle вашего приложения, как показано ниже:

    классный 

        // App build.gradle

    plugins {
      id 'com.android.application'
    }

    // Define a path to the extracted Play Core SDK files.
    // If using a relative path, wrap it with file() since CMake requires absolute paths.
    def playcoreDir = file('../path/to/playcore-native-sdk')

    android {
        defaultConfig {
            ...
            externalNativeBuild {
                cmake {
                    // Define the PLAYCORE_LOCATION directive.
                    arguments "-DANDROID_STL=c++_static",
                              "-DPLAYCORE_LOCATION=$playcoreDir"
                }
            }
            ndk {
                // Skip deprecated ABIs. Only required when using NDK 16 or earlier.
                abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64'
            }
        }
        buildTypes {
            release {
                // Include Play Core Library proguard config files to strip unused code while retaining the Java symbols needed for JNI.
                proguardFile '$playcoreDir/proguard/common.pgcfg'
                proguardFile '$playcoreDir/proguard/gms_task.pgcfg'
                proguardFile '$playcoreDir/proguard/per-feature-proguard-files'
                ...
            }
            debug {
                ...
            }
        }
        externalNativeBuild {
            cmake {
                path 'src/main/CMakeLists.txt'
            }
        }
    }

    dependencies {
        // Import these feature-specific AARs for each Google Play Core library.
        implementation 'com.google.android.play:app-update:2.1.0'
        implementation 'com.google.android.play:asset-delivery:2.2.2'
        implementation 'com.google.android.play:integrity:1.4.0'
        implementation 'com.google.android.play:review:2.0.1'

        // Import these common dependencies.
        implementation 'com.google.android.gms:play-services-tasks:18.0.2'
        implementation files("$playcoreDir/playcore-native-metadata.jar")
        ...
    }

    Котлин

    // App build.gradle

plugins {
    id("com.android.application")
}

// Define a path to the extracted Play Core SDK files.
// If using a relative path, wrap it with file() since CMake requires absolute paths.
val playcoreDir = file("../path/to/playcore-native-sdk")

android {
    defaultConfig {
        ...
        externalNativeBuild {
            cmake {
                // Define the PLAYCORE_LOCATION directive.
                arguments += listOf("-DANDROID_STL=c++_static", "-DPLAYCORE_LOCATION=$playcoreDir")
            }
        }
        ndk {
            // Skip deprecated ABIs. Only required when using NDK 16 or earlier.
            abiFilters.clear()
            abiFilters += listOf("armeabi-v7a", "arm64-v8a", "x86", "x86_64")
        }
    }
    buildTypes {
        release {
            // Include Play Core Library proguard config files to strip unused code while retaining the Java symbols needed for JNI.
            proguardFile("$playcoreDir/proguard/common.pgcfg")
            proguardFile("$playcoreDir/proguard/gms_task.pgcfg")
            proguardFile("$playcoreDir/proguard/per-feature-proguard-files")
            ...
        }
        debug {
            ...
        }
    }
    externalNativeBuild {
        cmake {
            path = "src/main/CMakeLists.txt"
        }
    }
}

dependencies {
    // Import these feature-specific AARs for each Google Play Core library.
    implementation("com.google.android.play:app-update:2.1.0")
    implementation("com.google.android.play:asset-delivery:2.2.2")
    implementation("com.google.android.play:integrity:1.4.0")
    implementation("com.google.android.play:review:2.0.1")

    // Import these common dependencies.
    implementation("com.google.android.gms:play-services-tasks:18.0.2")
    implementation(files("$playcoreDir/playcore-native-metadata.jar"))
    ...
}

  5. Обновите файлы CMakeLists.txt вашего приложения, как показано ниже: 

    cmake_minimum_required(VERSION 3.6)

...

# Add a static library called “playcore” built with the c++_static STL.
include(${PLAYCORE_LOCATION}/playcore.cmake)
add_playcore_static_library()

// In this example “main” is your native code library, i.e. libmain.so.
add_library(main SHARED
        ...)

target_include_directories(main PRIVATE
        ${PLAYCORE_LOCATION}/include
        ...)

target_link_libraries(main
        android
        playcore
        ...)

Сбор данных

Play Core Native SDK может собирать данные, связанные с версией, чтобы Google мог улучшить продукт, в том числе:

  • Имя пакета приложения
  • Версия пакета приложения
  • Воспроизведение версии Core Native SDK

Эти данные будут собраны, когда вы загрузите пакет приложения в Play Console. Чтобы отказаться от этого процесса сбора данных, удалите импорт $playcoreDir/playcore-native-metadata.jar в файле build.gradle.

Обратите внимание: этот сбор данных, связанный с использованием вами Play Core Native SDK и использованием Google собранных данных, осуществляется отдельно и независимо от сбора зависимостей библиотек Google, объявленных в Gradle, когда вы загружаете пакет приложения в Play Console.

После интеграции Play Core Native SDK в свой проект добавьте в файлы следующую строку, содержащую вызовы API:

Включить обзор.h

После интеграции Play Core Native SDK в ваш проект включите в файлы следующую строку, которая будет содержать вызовы API: 

#include "play/review.h"

Инициализируйте API обзора

Всякий раз, когда вы хотите использовать API, вы должны сначала его инициализировать, вызвав функцию ReviewManager_init , как показано в следующем примере, созданном с помощью android_native_app_glue.h : 

void android_main(android_app* app) {
  app->onInputEvent = HandleInputEvent;

  ReviewErrorCode error_code = ReviewManager_init(app->activity->vm, app->activity->clazz);
  if (error_code == REVIEW_NO_ERROR) {
    // You can use the API.
  }
}

Запросить процедуру проверки в приложении

Следуйте инструкциям о том, когда запрашивать обзоры в приложении , чтобы определить хорошие моменты в потоке пользователей вашего приложения и предложить пользователю написать отзыв (например, после того, как пользователь закрывает экран сводки в конце уровня в игре). Когда ваше приложение приблизится к одной из этих точек, вызовите ReviewManager_requestReviewFlow , чтобы асинхронно запросить информацию, необходимую вашему приложению для запуска потока проверки в приложении. Отслеживайте ход выполнения операции ReviewManager_requestReviewFlow , вызывая ReviewManager_getReviewStatus , например, один раз в каждом кадре. Это может занять до нескольких секунд, поэтому вам следует начать этот процесс до того, как ваше приложение достигнет точки, когда вы захотите отобразить процесс проверки внутри приложения. 

ReviewErrorCode error_code = ReviewManager_requestReviewFlow();
if (error_code == REVIEW_NO_ERROR) {
    // The request has successfully started, check the status using
    // ReviewManager_getReviewStatus.
} else {
    // Error such as REVIEW_PLAY_STORE_NOT_FOUND indicating that the in-app
    // review isn't currently possible.
}

Обработка статусов и запуск процесса проверки в приложении.

Всякий раз, когда запускается запрос или запускается поток проверки в приложении, вы можете проверить статус с помощью ReviewManager_getReviewStatus . Это позволяет определить логику в зависимости от статуса API. Один из способов решения этой проблемы — сохранить статус как глобальную переменную и проверять, является ли статус REVIEW_REQUEST_FLOW_COMPLETED когда пользователь выполняет определенное действие (например, нажимает кнопку «Следующий уровень» в игре), как показано в следующем примере. :

ReviewStatus status;
ReviewErrorCode error_code = ReviewManager_getReviewStatus(&status);
if (error_code != REVIEW_NO_ERROR) {
    // There was an error with the most recent operation.
    return;
}

switch (status) {
    case REVIEW_REQUEST_FLOW_PENDING:
        // Request is ongoing. The flow can't be launched yet.
        break;
    case REVIEW_REQUEST_FLOW_COMPLETED:
        // Request completed. The flow can be launched now.
        break;
    case REVIEW_LAUNCH_FLOW_PENDING:
        // The review flow is ongoing, meaning the dialog might be displayed.
        break;
    case REVIEW_LAUNCH_FLOW_COMPLETED:
        // The review flow has finished. Continue with your app flow (for
        // example, move to the next screen).
        break;
    default:
        // Unknown status.
        break;
}

Когда статус REVIEW_REQUEST_FLOW_COMPLETED и ваше приложение готово, запустите процесс проверки в приложении:

// This call uses android_native_app_glue.h.
ReviewErrorCode error_code = ReviewManager_launchReviewFlow(app->activity->clazz);
if (error_code != REVIEW_NO_ERROR) {
    // There was an error while launching the flow.
    return;
}

После запуска процесса проверки в приложении продолжайте проверять статус завершения и продолжайте работу с приложением. Распространенным способом решения этой проблемы является использование шаблона Game Loop .

Бесплатные ресурсы

Не забудьте освободить ресурсы, вызвав функцию ReviewManager_destroy после того, как ваше приложение завершит использование API (например, после завершения процесса проверки в приложении). 

void ReviewManager_destroy();

Следующие шаги

Проверьте процесс проверки вашего приложения внутри приложения , чтобы убедиться, что ваша интеграция работает правильно.