In-App-Überprüfungen einbinden (nativ)

In diesem Leitfaden wird beschrieben, wie Sie In-App-Rezensionen mithilfe von nativem Code (C oder C++) in Ihre App einbinden. Für die Verwendung von Kotlin oder Java bzw. Unity sind separate Integrationsanleitungen verfügbar.

Native SDK – Übersicht

Das Play Core Native SDK ist Teil der Google Play Core Library. Das Play Core Native SDK enthält die C-Headerdatei review.h, die ReviewManager aus den Java Play In-App-Rezensionsbibliotheken umschließt. Mithilfe dieser Headerdatei kann Ihre Anwendung die API direkt über Ihren nativen Code aufrufen. Eine Übersicht über die verfügbaren öffentlichen Funktionen finden Sie in der Dokumentation zu nativen Play-Review-Modulen.

ReviewManager_requestReviewFlow startet eine Anfrage, mit der die Informationen erfasst werden, die erforderlich sind, um später den In-App-Überprüfungsvorgang zu starten. Sie können das Ergebnis der Anfrage mit ReviewManager_getReviewStatus verfolgen. Weitere Informationen zu allen Status, die ReviewManager_getReviewStatus zurückgeben kann, finden Sie unter ReviewErrorCode.

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

Entwicklungsumgebung einrichten

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. Sie haben folgende Möglichkeiten:

    • Installieren Sie Android Studio Version 4.0 oder höher. Verwende die SDK Manager-UI, um Version 10.0 der Android SDK Platform (API-Level 29) zu installieren.
    • Installieren Sie die Android SDK-Befehlszeilentools und verwenden Sie sdkmanager, um Version 10.0 (API-Level 29) der Android SDK Platform zu installieren.
  2. Bereiten Sie Android Studio für die native Entwicklung vor. Installieren Sie dazu mit dem SDK Manager das neueste CMake- und Android Native Development Kit (NDK). Weitere Informationen zum Erstellen oder Importieren von nativen Projekten findest du unter Erste Schritte mit dem NDK.

  3. Lade die ZIP-Datei herunter und entpacke sie zusammen mit deinem Projekt.

    Downloadlink Größe SHA-256-Prüfsumme
    36 MiB 782a8522d937848c83a715c9a258b95a3ff2879a7cd71855d137b41c00786a5e
  4. Aktualisieren Sie die Datei build.gradle Ihrer App wie unten gezeigt:

    Cool

        // 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. Aktualisieren Sie die CMakeLists.txt-Dateien 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
            ...)
    

Datenerhebung

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

Diese Daten werden erhoben, wenn du dein App-Paket in die Play Console hochlädst. Wenn Sie diesen Datenerfassungsprozess deaktivieren möchten, entfernen Sie den Import $playcoreDir/playcore-native-metadata.jar in der Datei build.gradle.

Hinweis: Die Datenerhebung im Zusammenhang mit deiner Nutzung des Play Core Native SDK und der Nutzung der erhobenen Daten durch Google erfolgt separat und unabhängig von der Sammlung der Bibliotheksabhängigkeiten, die Google beim Hochladen deines App-Pakets in die Play Console in Gradle deklariert hat.

Nachdem du das Play Core Native SDK in dein Projekt eingebunden hast, füge die folgende Zeile in die Dateien ein, die API-Aufrufe enthalten:

"review.h" einschließen

Füge nach der Integration des Play Core Native SDK in dein Projekt die folgende Zeile in die Dateien ein, die API-Aufrufe enthalten:

#include "play/review.h"

Review API initialisieren

Wenn Sie die API verwenden möchten, müssen Sie sie zuerst initialisieren, indem Sie die Funktion ReviewManager_init aufrufen, 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-Überprüfungsprozess anfordern

Folge der Anleitung zum Anfordern von In-App-Rezensionen, um zu ermitteln, welche Punkte im Nutzerfluss deiner App sinnvoll sind und den Nutzer zu einer Überprüfung auffordern können, z. B. nachdem er die Zusammenfassung am Ende eines Levels in einem Spiel geschlossen hat. Wenn deine App an einem dieser Punkte geschlossen wird, kannst du ReviewManager_requestReviewFlow aufrufen, um asynchron die Informationen anzufordern, die deine App zum Starten eines In-App-Überprüfungsvorgangs benötigt. Überwachen Sie den Fortschritt des ReviewManager_requestReviewFlow-Vorgangs. Rufen Sie dazu ReviewManager_getReviewStatus auf, beispielsweise einmal pro Frame. Das kann einige Sekunden dauern. Du solltest den Vorgang also starten, bevor in deiner App der Punkt erreicht ist, an dem du den In-App-Überprüfungsvorgang anzeigen möchtest.

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 bearbeiten und In-App-Überprüfungsprozess starten

Sobald eine Anfrage begonnen oder der In-App-Überprüfungsprozess gestartet wird, kannst du den Status mit ReviewManager_getReviewStatus prüfen. So können Sie die Logik abhängig vom API-Status definieren. Eine Möglichkeit besteht darin, den Status als globale Variable beizubehalten und zu prüfen, ob der Status REVIEW_REQUEST_FLOW_COMPLETED ist, wenn der Nutzer eine bestimmte Aktion ausführt (z. B. durch Tippen auf die Schaltfläche „Nächstes Level“ in einem Spiel), 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 lautet und deine App bereit ist, starte den In-App-Überprüfungsvorgang:

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

Nachdem du den In-App-Überprüfungsvorgang gestartet hast, solltest du den Status weiterhin auf Fertigstellung prüfen und mit dem App-Ablauf fortfahren. Eine gängige Lösung hierfür ist das Spielschleifenmuster.

Kostenlose Ressourcen

Vergiss nicht, Ressourcen freizugeben, indem du die Funktion ReviewManager_destroy aufrufst, sobald deine App die API nicht mehr verwendet (z. B. nach Abschluss der In-App-Überprüfung).

void ReviewManager_destroy();

Nächste Schritte

Teste den In-App-Überprüfungsvorgang deiner App, um zu prüfen, ob die Integration korrekt funktioniert.