Integracja opinii w aplikacji (natywna)

Z tego przewodnika dowiesz się, jak zintegrować opinie w aplikacji za pomocą kodu natywnego (C lub C++). Jeśli używasz Kotlin lub Javy, Unity lub Unreal Engine, dostępne są osobne przewodniki po integracji.

Omówienie natywnego pakietu SDK

Pakiet SDK podstawowej biblioteki Play do aplikacji natywnych należy do rodziny podstawowych bibliotek Google Play. Pakiet SDK podstawowej biblioteki Play do aplikacji natywnych zawiera plik nagłówkowy C, review.h, który opakowuje ReviewManager z bibliotek Java Play do ocen w aplikacji. Ten plik nagłówkowy umożliwia aplikacji wywoływanie interfejsu API bezpośrednio z kodu natywnego. Aby zapoznać się z dostępnymi funkcjami publicznymi, przeczytaj dokumentację natywnego modułu opinii w Google Play.

ReviewManager_requestReviewFlow rozpoczyna żądanie, które zbiera informacje wymagane do późniejszego uruchomienia procesu opinii w aplikacji. Wynik żądania możesz śledzić za pomocą metody ReviewManager_getReviewStatus. Więcej informacji o wszystkich stanach, które może zwrócić ReviewManager_getReviewStatus, znajdziesz w ReviewErrorCode.

Zarówno funkcja żądania, jak i funkcja uruchamiania zwracają wartość REVIEW_NO_ERROR, jeśli działają prawidłowo.

Konfigurowanie środowiska programistycznego

Pobierz Play Core Native SDK

Przed pobraniem musisz zaakceptować poniższe warunki.

Warunki korzystania z usługi

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.
Pobierz Play Core Native SDK

play-core-native-sdk-1.15.3.zip

  1. Wykonaj jedną z tych czynności:

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

  3. Pobierz plik ZIP i rozpakuj go w tym samym folderze co projekt.

    Link do pobrania Rozmiar Suma kontrolna SHA-256
    37,8 MiB 9db60185185342f28d2c278b60222333608c67bc022e458a25224eaea8c4c4b7

  4. Zaktualizuj plik build.gradle aplikacji w sposób pokazany poniżej:

    Groovy

        // 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.3.0'
        implementation 'com.google.android.play:integrity:1.4.0'
        implementation 'com.google.android.play:review:2.0.2'

        // 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.1.0")
    implementation("com.google.android.play:asset-delivery:2.3.0")
    implementation("com.google.android.play:integrity:1.4.0")
    implementation("com.google.android.play:review:2.0.2")

    // 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 w sposób pokazany 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

Pakiet SDK podstawowej biblioteki Play do aplikacji natywnych może zbierać dane związane z wersją, aby umożliwić Google ulepszanie usługi. Dane te mogą obejmować:

  • Nazwa pakietu aplikacji
  • Wersja pakietu aplikacji
  • Wersja pakietu SDK podstawowej biblioteki Play do aplikacji natywnych

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

Pamiętaj, że zbieranie danych związanych z korzystaniem przez Ciebie z natywnego pakietu SDK Play Core i wykorzystywanie tych danych przez Google to proces odrębny i niezależny od zbierania przez Google zależności bibliotek zadeklarowanych w Gradle podczas przesyłania pakietu aplikacji do Konsoli Play.

Po zintegrowaniu pakietu SDK podstawowej biblioteki Play do aplikacji natywnych z projektem dodaj ten wiersz do plików zawierających wywołania interfejsu API:

Dołącz plik review.h

Po zintegrowaniu pakietu SDK podstawowej biblioteki Play do aplikacji natywnych z projektem dodaj ten wiersz do plików, które będą zawierać wywołania interfejsu API:

#include "play/review.h"

Inicjowanie interfejsu Review API

Za każdym razem, gdy chcesz użyć interfejsu API, musisz go najpierw zainicjować, wywołując funkcję ReviewManager_init, jak pokazano 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.
  }
}

Wysyłanie prośby o wyświetlenie prośby o opinię w aplikacji

Postępuj zgodnie z wytycznymi dotyczącymi momentów, w których warto prosić o opinie w aplikacji, aby określić odpowiednie punkty w ścieżce użytkownika, w których można poprosić go o opinię (np. po zamknięciu ekranu podsumowania na końcu poziomu w grze). Gdy aplikacja zbliży się do jednego z tych punktów, wywołaj funkcję ReviewManager_requestReviewFlow, aby asynchronicznie poprosić o informacje potrzebne do uruchomienia procesu oceny w aplikacji. Monitoruj postęp ReviewManager_requestReviewFlowoperacji, wywołując ReviewManager_getReviewStatus, na przykład raz na klatkę. Może to potrwać kilka sekund, więc rozpocznij ten proces, zanim aplikacja osiągnie punkt, w którym chcesz wyświetlić prośbę o opinię.

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 w aplikacji

Gdy tylko rozpocznie się prośba lub uruchomi się proces sprawdzania w aplikacji, możesz sprawdzić stan za pomocą metody ReviewManager_getReviewStatus. Dzięki temu możesz zdefiniować logikę w zależności od stanu interfejsu API. Jednym ze sposobów jest przechowywanie stanu jako zmiennej globalnej i sprawdzanie, czy stan jest REVIEW_REQUEST_FLOW_COMPLETED, gdy użytkownik wykona określone działanie (np. kliknie przycisk „Następny poziom” w grze), jak pokazano 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 to REVIEW_REQUEST_FLOW_COMPLETED, a aplikacja jest gotowa, uruchom proces sprawdzania w 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 oceniania w aplikacji sprawdzaj, czy został on zakończony, i kontynuuj korzystanie z aplikacji. Częstym sposobem na rozwiązanie tego problemu jest zastosowanie wzorca pętli gry.

Bezpłatne materiały

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

void ReviewManager_destroy();

Dalsze kroki

Przetestuj przepływ opinii w aplikacji, aby sprawdzić, czy integracja działa prawidłowo.