In-App-Rezensionen einbinden (native App)

In diesem Leitfaden wird beschrieben, wie Sie In-App-Rezensionen mithilfe von nativem Code (C oder C++) in Ihre App einbinden. Wenn Sie Kotlin oder Java, Unity oder Unreal Engine verwenden, finden Sie separate Integrationsleitfäden.

Übersicht über das Native SDK

Das Play Core Native SDK ist Teil der Google Play Core-Bibliotheken. Das Play Core Native SDK enthält eine C-Headerdatei, review.h, die ReviewManager aus den Java-Bibliotheken für In-App-Rezensionen von Google Play umschließt. Mit dieser Headerdatei kann Ihre App die API direkt über den nativen Code aufrufen. Eine Übersicht über die verfügbaren öffentlichen Funktionen finden Sie in der Dokumentation zum nativen Modul für Play-Rezensionen.

ReviewManager_requestReviewFlow startet eine Anfrage, mit der die Informationen erfasst werden, die zum späteren Starten des In-App-Rezensionsprozesses erforderlich sind. Sie können das Ergebnis der Anfrage mit ReviewManager_getReviewStatus verfolgen. Weitere Informationen zu allen Status, die von ReviewManager_getReviewStatus zurückgegeben werden können, finden Sie unter ReviewErrorCode.

Sowohl die Anfrage- als auch die Startfunktion geben REVIEW_NO_ERROR zurück, wenn die Funktion erfolgreich ist.

Entwicklungsumgebung einrichten

Herunterladen Play Core Native SDK

Bevor Sie herunterladen können, müssen Sie den folgenden Nutzungsbedingungen zustimmen.

Nutzungsbedingungen

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

play-core-native-sdk-1.16.0.zip

  1. Führen Sie eine der folgenden Aktionen aus:

    • Installieren Sie Android Studio ab Version 4.0. Verwenden Sie die SDK Manager-UI, um die Android SDK-Plattformversion 10.0 (API-Level 29) zu installieren.
    • Installieren Sie die Android SDK-Befehlszeilentools und verwenden Sie sdkmanager, um die Android SDK-Plattformversion 10.0 (API-Level 29) zu installieren.
  2. Bereiten Sie Android Studio für die native Entwicklung vor, indem Sie mit dem SDK Manager die aktuelle Version von CMake und des Android Native Development Kit (NDK) installieren. Weitere Informationen zum Erstellen oder Importieren nativer Projekte finden Sie unter Erste Schritte mit dem NDK.

  3. Laden Sie die ZIP-Datei herunter und extrahieren Sie sie neben Ihrem Projekt.

    Downloadlink Größe SHA-256-Prüfsumme
    54,8 MB 008b8fedc6179a6dc6ccc21af75591afc7036f78f3d5559d844f1b923934fef0
  4. Aktualisieren Sie die Datei build.gradle Ihrer App wie unten gezeigt:

    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.6.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.6.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. Aktualisieren Sie die Dateien CMakeLists.txt Ihrer App wie unten gezeigt:

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

Datenerfassung

Das Play Core Native SDK kann versionsbezogene Daten erheben, damit Google das Produkt verbessern kann. Dazu gehören:

  • Paketname der App
  • Paketversion der App
  • Version des Play Core Native SDK

Diese Daten werden erhoben, wenn Sie Ihr App-Paket in die Play Console hochladen. Wenn Sie die Datenerhebung deaktivieren möchten, entfernen Sie den Import $playcoreDir/playcore-native-metadata.jar in der Datei „build.gradle“.

Die Datenerhebung im Zusammenhang mit Ihrer Nutzung des Play Core Native SDK und der Nutzung der erhobenen Daten durch Google ist unabhängig von der Erhebung von Bibliotheksabhängigkeiten, die in Gradle deklariert sind, wenn Sie Ihr App-Paket in die Play Console hochladen.

Nachdem Sie das Play Core Native SDK in Ihr Projekt eingebunden haben, fügen Sie in Dateien mit API-Aufrufen die folgende Zeile ein:

„review.h“ einbinden

Nachdem Sie das Play Core Native SDK in Ihr Projekt eingebunden haben, fügen Sie in Dateien mit API-Aufrufen die folgende Zeile ein:

#include "play/review.h"

Review API initialisieren

Wenn Sie die API verwenden möchten, müssen Sie sie zuerst initialisieren. Rufen Sie dazu die ReviewManager_init Funktion auf, wie im folgenden Beispiel mit android_native_app_glue.h gezeigt:

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

In-App-Rezensionsprozess anfordern

Folgen Sie der Anleitung zum Anfordern von In-App-Rezensionen, um geeignete Stellen im Nutzerprozess Ihrer App zu finden, an denen Sie den Nutzer um eine Rezension bitten können (z. B. nachdem ein Nutzer den Zusammenfassungsbildschirm am Ende eines Levels in einem Spiel geschlossen hat). Wenn Ihre App sich einem dieser Punkte nähert, rufen Sie ReviewManager_requestReviewFlow auf, um asynchron die Informationen anzufordern, die Ihre App zum Starten eines In-App-Rezensionsprozesses benötigt. Sie können den Fortschritt des ReviewManager_requestReviewFlow Vorgangs mit ReviewManager_getReviewStatus verfolgen, z. B. einmal pro Frame. Das kann einige Sekunden dauern. Sie sollten diesen Prozess also starten, bevor Ihre App den Punkt erreicht, an dem Sie den In-App-Rezensionsprozess anzeigen möchten.

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

Status verarbeiten und In-App-Rezensionsprozess starten

Wenn eine Anfrage gestartet wurde oder der In-App-Rezensionsprozess gestartet wird, können Sie den Status mit ReviewManager_getReviewStatus prüfen. So können Sie die Logik je nach API-Status definieren. Eine Möglichkeit besteht darin, den Status als globale Variable zu speichern und zu prüfen, ob der Status REVIEW_REQUEST_FLOW_COMPLETED ist, wenn der Nutzer eine bestimmte Aktion ausführt (z. B. auf die Schaltfläche „Nächstes Level“ in einem Spiel tippt), wie im folgenden Beispiel gezeigt:

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

Wenn der Status REVIEW_REQUEST_FLOW_COMPLETED ist und Ihre App bereit ist, starten Sie den In-App-Rezensionsprozess:

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

Nach dem Start des In-App-Rezensionsprozesses prüfen Sie weiterhin den Status auf Abschluss und fahren Sie mit dem App-Prozess fort. Eine gängige Methode hierfür ist das Befolgen des Spielschleife-Musters.

Kostenlose Ressourcen

Vergessen Sie nicht, Ressourcen freizugeben, indem Sie die ReviewManager_destroy Funktion aufrufen, sobald Ihre App die API nicht mehr verwendet (z. B. nachdem der In-App Rezensionsprozess abgeschlossen ist).

void ReviewManager_destroy();

Nächste Schritte

Testen Sie den In-App-Rezensionsprozess Ihrer App, um zu prüfen, ob die Integration ordnungsgemäß funktioniert.