Integracja opinii w aplikacji (natywna)

Z tego przewodnika dowiesz się, jak zintegrować opinie w aplikacji za pomocą kodu natywnego (C lub C++). W przypadku korzystania z Kotlin, Javy lub Unity dostępne są osobne przewodniki po integracji.

Omówienie natywnego pakietu SDK

Podstawowy pakiet SDK Google Play należy do grupy bibliotek podstawowych Google Play. Pakiet Play Core Native SDK zawiera plik nagłówka C (review.h), który opakowuje ReviewManager z bibliotek Java Play In-App Review. Ten plik nagłówka pozwala aplikacji wywoływać interfejs API bezpośrednio z kodu natywnego. Omówienie dostępnych funkcji publicznych znajdziesz w dokumentacji modułu natywnego Play Review.

ReviewManager_requestReviewFlow wysyła żądanie, które pozwala zebrać informacje niezbędne do późniejszego uruchomienia procesu sprawdzania aplikacji. Wynik żądania możesz śledzić za pomocą narzędzia ReviewManager_getReviewStatus. Więcej informacji o wszystkich stanach, które ReviewManager_getReviewStatus może zwrócić, znajdziesz w sekcji ReviewErrorCode.

Jeśli funkcja działa prawidłowo, funkcje żądania i uruchamiania zwracają wartość REVIEW_NO_ERROR.

Konfigurowanie środowiska programistycznego

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.14.0.zip

  1. Wykonaj jedną z tych czynności:

  2. Przygotuj Androida Studio do tworzenia aplikacji natywnych, korzystając z Menedżera SDK do zainstalowania najnowszych wersji CMake i Android Native Development Kit (NDK). Więcej informacji o tworzeniu i importowaniu projektów natywnych znajdziesz w artykule wprowadzającym do NDK.

  3. Pobierz plik ZIP i rozpakuj go razem z projektem.

    Link do pobierania Rozmiar Suma kontrolna SHA-256
    36 MiB 782a8522d937848c83a715c9a258b95a3ff2879a7cd71855d137b41c00786a5e

  4. Zaktualizuj plik build.gradle aplikacji, jak pokazano poniżej:

    Odlotowe

        // 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.0.0'
        implementation 'com.google.android.play:asset-delivery:2.0.0'
        implementation 'com.google.android.play:integrity:1.0.1'
        implementation 'com.google.android.play:review:2.0.0'

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

    Kotlin

    // 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.0.0")
    implementation("com.google.android.play:asset-delivery:2.0.0")
    implementation("com.google.android.play:integrity:1.0.1")
    implementation("com.google.android.play:review:2.0.0")

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

  5. Zaktualizuj pliki CMakeLists.txt aplikacji, jak pokazano poniżej:

    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
        ...)

Zbieranie danych

Aby umożliwić Google ulepszanie usługi, pakiet Play Core Native SDK może gromadzić dane dotyczące wersji, w tym:

  • Nazwa pakietu aplikacji
  • Wersja pakietu aplikacji
  • Wersja Core Native SDK w Google Play

Te dane będą zbierane, gdy prześlesz pakiet aplikacji do Konsoli Play. Aby zrezygnować z tego procesu zbierania danych, usuń import $playcoreDir/playcore-native-metadata.jar z pliku build.gradle.

Pamiętaj, że te zbieranie danych związane z korzystaniem przez Ciebie z Play Core Native SDK i wykorzystywanie przez Google zgromadzonych danych jest niezależne od zbierania przez Google zależności bibliotek zadeklarowanych w Gradle podczas przesyłania pakietu aplikacji do Konsoli Play.

Po zintegrowaniu z projektem natywnego pakietu Play Core umieść ten wiersz w plikach zawierających wywołania interfejsu API:

Dodaj review.h

Po zintegrowaniu z projektem pakietu Play Core Native SDK umieść ten wiersz w plikach zawierających wywołania interfejsu API:

#include "play/review.h"

Inicjowanie interfejsu Review API

Gdy chcesz użyć interfejsu API, musisz go najpierw zainicjować, wywołując funkcję ReviewManager_init w sposób przedstawiony w tym przykładzie utworzonym za pomocą 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.
  }
}

Poproś o proces sprawdzania w aplikacji

Postępuj zgodnie ze wskazówkami na temat tego, kiedy poprosić o sprawdzenie aplikacji, aby określić, w których miejscach w aplikacji użytkownik powinien poprosić o sprawdzenie (np. gdy zamknie ekran z podsumowaniem na końcu poziomu w grze). Gdy aplikacja zbliży się do jednego z tych punktów, wywołaj ReviewManager_requestReviewFlow, aby asynchronicznie poprosić o informacje potrzebne do uruchomienia procesu sprawdzania aplikacji. Śledź postęp operacji ReviewManager_requestReviewFlow, wywołując funkcję ReviewManager_getReviewStatus, np. po każdej klatce. Może to potrwać kilka sekund, więc musisz rozpocząć ten proces, zanim w aplikacji chcesz wyświetlić proces sprawdzania.

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.
}

Obsługa stanów i uruchamianie procesu sprawdzania aplikacji

Za każdym razem, gdy rozpocznie się prośba o przesłanie prośby lub rozpocznie się proces sprawdzania w aplikacji, możesz sprawdzić jej stan za pomocą narzędzia ReviewManager_getReviewStatus. Pozwala to zdefiniować logikę w zależności od stanu interfejsu API. Przykładem może być zachowanie stanu jako zmiennej globalnej i sprawdzenie, czy stan to REVIEW_REQUEST_FLOW_COMPLETED, gdy użytkownik wykona określone działanie (np. kliknie przycisk „Następny poziom” w grze), jak w tym przykładzie:

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;
}

Gdy stan aplikacji to REVIEW_REQUEST_FLOW_COMPLETED, a aplikacja jest gotowa, uruchom proces sprawdzania aplikacji:

// 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;
}

Po uruchomieniu procesu sprawdzania aplikacji sprawdzaj jej stan i kontynuuj proces sprawdzania. Popularnym sposobem rozwiązania tego problemu jest użycie wzorca pętli gry.

Bezpłatne materiały

Nie zapomnij zwolnić zasobów, wywołując funkcję ReviewManager_destroy, gdy Twoja aplikacja przestanie korzystać z interfejsu API (np. po zakończeniu procesu sprawdzania aplikacji).

void ReviewManager_destroy();

Dalsze kroki

Przetestuj proces sprawdzania aplikacji w aplikacji, aby sprawdzić, czy integracja działa prawidłowo.