Questa guida descrive come supportare gli aggiornamenti in-app nella tua app utilizzando il codice nativo (C o C++). Esistono guide separate per i casi in cui l'implementazione utilizza il linguaggio di programmazione Kotlin o il linguaggio di programmazione Java e per i casi in cui l'implementazione utilizza Unity.
Panoramica dell'SDK nativo
L'SDK nativo della libreria di base Play fa parte della famiglia di SDK della libreria di base Play. L'SDK nativo include un file di intestazione C, app_update.h, che avvolge
AppUpdateManager
dalla libreria Java Play In-App Update. Questo file di intestazione consente alla tua app di chiamare l'API per gli aggiornamenti in-app direttamente dal codice nativo.
Configura l'ambiente di sviluppo
Scarica Play Core Native SDK
Prima di eseguire il download, devi accettare i seguenti termini e condizioni.
Termini e condizioni
Last modified: September 24, 2020- 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.
- For purposes of these terms, "APIs" means Google's APIs, other developer services, and associated software, including any Redistributable Code.
- “Redistributable Code” means Google-provided object code or header files that call the APIs.
- 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.
- 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.
Procedi in uno dei seguenti modi:
- Installa Android Studio versione 4.0 o successive. Utilizza l'interfaccia utente di SDK Manager per installare la versione 10.0 della piattaforma SDK per Android (livello API 29).
- Installa gli strumenti a riga di comando dell'SDK Android
e utilizza
sdkmanagerper installare la versione 10.0 della piattaforma SDK Android (livello API 29).
Prepara Android Studio per lo sviluppo nativo utilizzando SDK Manager per installare le ultime versioni di CMake e del Native Development Kit (NDK) per Android. Per ulteriori informazioni sulla creazione o sull'importazione di progetti nativi, consulta la sezione Guida introduttiva all'NDK.
Scarica il file ZIP ed estrailo insieme al progetto.
Link di download Dimensioni Checksum SHA-256 37,8 MiB 9db60185185342f28d2c278b60222333608c67bc022e458a25224eaea8c4c4b7 Aggiorna il file
build.gradledell'app come mostrato di seguito: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.2.2' 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.2.2") 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")) ... }
Aggiorna i file
CMakeLists.txtdell'app come mostrato di seguito: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 ...)
Raccolta dei dati
L'SDK nativo della libreria di base Play potrebbe raccogliere dati relativi alla versione per consentire a Google di migliorare il prodotto, tra cui:
- Nome del pacchetto dell'app
- Versione del pacchetto dell'app
- Versione dell'SDK nativo della libreria di base Play
Questi dati verranno raccolti quando carichi il pacchetto dell'app su Play Console. Per disattivare questa procedura di raccolta dei dati, rimuovi l'importazione di $playcoreDir/playcore-native-metadata.jar nel file build.gradle.
Tieni presente che questa raccolta di dati relativa al tuo utilizzo dell'SDK nativo Play Core e all'utilizzo da parte di Google dei dati raccolti è separata e indipendente dalla raccolta di dipendenze di libreria dichiarate in Gradle quando carichi il pacchetto dell'app su Play Console.
Dopo aver integrato l'SDK nativo della libreria di base Play nel tuo progetto, includi la seguente riga nei file che contengono chiamate API:
#include "play/app_update.h"
Inizializzare l'API di aggiornamento in-app
Ogni volta che utilizzi l'API di aggiornamento in-app, devi prima inizializzala chiamando la funzione
AppUpdateManager_init(), come mostrato nel seguente esempio creato con
android_native_app_glue.h:
void android_main(android_app* app) {
app->onInputEvent = HandleInputEvent;
AppUpdateErrorCode error_code =
AppUpdateManager_init(app->activity->vm, app->activity->clazz);
if (error_code == APP_UPDATE_NO_ERROR) {
// You can use the API.
}
}
Verificare la disponibilità di aggiornamenti
Prima di richiedere un aggiornamento, controlla se è disponibile un aggiornamento per la tua app.
AppUpdateManager_requestInfo()
avvia una richiesta asincrona che raccoglie le informazioni necessarie per avviare successivamente il flusso di aggiornamento in-app. La funzione restituisce APP_UPDATE_NO_ERROR se la richiesta viene avviata correttamente.
AppUpdateErrorCode error_code = AppUpdateManager_requestInfo()
if (error_code == APP_UPDATE_NO_ERROR) {
// The request has successfully started, check the result using
// AppUpdateManager_getInfo.
}
Puoi monitorare la procedura in corso e il risultato della richiesta utilizzando
AppUpdateManager_getInfo().
Oltre al codice di errore, questa funzione restituisce un
AppUpdateInfo
struttura opaca, che puoi utilizzare per recuperare informazioni sulla richiesta di atualização. Ad esempio, potresti chiamare questa funzione in ogni loop di gioco
fino a quando non restituisce un risultato non nullo per info:
AppUpdateInfo* info;
GameUpdate() {
// Keep calling this in every game loop until info != nullptr
AppUpdateErrorCode error_code = AppUpdateManager_getInfo(&info);
if (error_code == APP_UPDATE_NO_ERROR && info != nullptr) {
// Successfully started, check the result in the following functions
}
...
}
Controllare l'obsolescenza degli aggiornamenti
Oltre a verificare se è disponibile un aggiornamento, ti consigliamo di controllare anche quanto tempo è trascorso dall'ultima notifica di aggiornamento inviata all'utente tramite il Play Store. In questo modo, puoi decidere se avviare un aggiornamento flessibile o immediato. Ad esempio, potresti attendere qualche giorno prima di inviare una notifica all'utente con un aggiornamento flessibile e qualche giorno dopo prima di richiedere un aggiornamento immediato.
Utilizza
AppUpdateInfo_getClientVersionStalenessDays()
per controllare il numero di giorni dall'aggiornamento è diventato disponibile tramite il Play
Store:
int32_t staleness_days = AppUpdateInfo_getClientVersionStalenessDays(info);
Controllare la priorità dell'aggiornamento
L'API Google Play Developer ti consente di impostare la priorità di ogni aggiornamento. In questo modo, la tua app può decidere con quale insistenza consigliare un aggiornamento all'utente. Ad esempio, considera la seguente strategia per impostare la priorità di aggiornamento:
- Miglioramenti secondari all'interfaccia utente: aggiornamento a bassa priorità; non richiedere un aggiornamento flessibile né un aggiornamento immediato. Aggiorna solo quando l'utente non interagisce con la tua app.
- Miglioramenti delle prestazioni: aggiornamento con priorità media; richiedi un aggiornamento flessibile.
- Aggiornamento della sicurezza critico: priorità elevata; richiedi un aggiornamento immediato.
Per determinare la priorità, Google Play utilizza un valore intero compreso tra 0 e 5, dove 0 è il valore predefinito e 5 è la priorità più alta. Per impostare la priorità di un update, utilizza il campo inAppUpdatePriority in Edits.tracks.releases nell'API Google Play Developer. Tutte le versioni appena aggiunte nella release sono considerate della stessa priorità della release. La priorità può essere impostata solo durante l'implementazione di una nuova release e non può essere modificata in un secondo momento.
Imposta la priorità utilizzando l'API Google Play Developer, come descritto nella documentazione dell'API Google Play Developer.
Specifica la priorità dell'aggiornamento in-app nella risorsa
Edit.tracks
passata nel metodo
Edit.tracks: update. L'esempio seguente mostra il rilascio di un'app con codice di versione 88 e inAppUpdatePriority 5:
{ "releases": [{ "versionCodes": ["88"], "inAppUpdatePriority": 5, "status": "completed" }] }
Nel codice dell'app, puoi controllare il livello di priorità di un determinato aggiornamento utilizzando
AppUpdateInfo_getPriority():
int32_t priority = AppUpdateInfo_getPriority(info);
Avviare un aggiornamento
Dopo aver verificato che è disponibile un aggiornamento, puoi richiederlo utilizzando
AppUpdateManager_requestStartUpdate().
Prima di richiedere un aggiornamento, ottieni un oggetto AppUpdateInfo aggiornato e
crea un
oggetto
AppUpdateOptions
per configurare il flusso di aggiornamento. Un oggetto AppUpdateOptions definisce le opzioni per un flusso di aggiornamento in-app, incluso se l'aggiornamento deve essere flessibile o immediato.
L'esempio seguente crea un oggetto AppUpdateOptions per un flusso di aggiornamento flessibile:
// Creates an AppUpdateOptions configuring a flexible in-app update flow.
AppUpdateOptions* options;
AppUpdateErrorCode error_code = AppUpdateOptions_createOptions(APP_UPDATE_TYPE_FLEXIBLE, &options);
L'esempio seguente crea un oggetto AppUpdateOptions per un flusso di aggiornamento immediato:
// Creates an AppUpdateOptions configuring an immediate in-app update flow.
AppUpdateOptions* options;
AppUpdateErrorCode error_code = AppUpdateOptions_createOptions(APP_UPDATE_TYPE_IMMEDIATE, &options);
L'oggetto AppUpdateOptions contiene anche un campo AllowAssetPackDeletion
che definisce se l'aggiornamento è autorizzato a cancellare i pacchetti di asset in caso di spazio di archiviazione limitato del dispositivo. Per impostazione predefinita, questo campo è impostato su false, ma puoi utilizzare il metodo AppUpdateOptions_setAssetPackDeletionAllowed() per impostarlo su true:
bool allow = true;
AppUpdateErrorCode error_code = AppUpdateOptions_setAssetPackDeletionAllowed(options, allow);
Dopo aver creato un oggetto AppUpdateInfo aggiornato e un oggetto AppUpdateOptions configurato correttamente, chiama AppUpdateManager_requestStartUpdate() per richiedere in modo asincrono un flusso di aggiornamento, passando un'attività Android jobject come parametro finale.
AppUpdateErrorCode request_error_code =
AppUpdateManager_requestStartUpdate(info, options, app->activity->clazz);
Per liberare risorse, rilascia le istanze di AppUpdateInfo e
AppUpdateOptions di cui non hai più bisogno chiamando
AppUpdateInfo_destroy()
e
AppUpdateOptions_destroy(),
rispettivamente.
AppUpdateInfo_destroy(info);
AppUpdateOptions_destroy(options);
Per un flusso di aggiornamento immediato, Google Play mostra una pagina di conferma dell'utente. Quando l'utente accetta la richiesta, Google Play scarica e installa automaticamente l'aggiornamento in primo piano, quindi riavvia l'app con la versione aggiornata se l'installazione va a buon fine.
Per un flusso di aggiornamento flessibile, puoi continuare a richiedere oggetti AppUpdateInfo aggiornati per tenere traccia dello stato corrente dell'aggiornamento mentre l'utente continua a interagire con l'app. Al termine del download, devi attivare il completamento dell'aggiornamento chiamando AppUpdateManager_requestCompleteUpdate(), come mostrato nell'esempio seguente:
AppUpdateStatus status = AppUpdateInfo_getStatus(info);
if (status == APP_UPDATE_DOWNLOADED) {
AppUpdateErrorCode error_code = AppUpdateManager_requestCompleteUpdate();
if (error_code != APP_UPDATE_NO_ERROR)
{
// There was an error while completing the update flow.
}
}
Libera le risorse chiamando la funzione
AppUpdateManager_destroy()
dopo che l'app ha terminato di utilizzare l'API.
Gestione degli errori
Questa sezione descrive le soluzioni per gli errori comuni indicati da valori
AppUpdateErrorCode
specifici:
- Un codice di errore
-110, APP_UPDATE_INITIALIZATION_NEEDEDindica che l'API non è stata inizializzata correttamente. ChiamaAppUpdateManager_init()per inizializzare l'API. - Un codice di errore
-4, APP_UPDATE_INVALID_REQUESTindica che alcuni parametri della richiesta del flusso di aggiornamento non sono formattati correttamente. Verifica che gli oggettiAppUpdateInfoeAppUpdateOptionsnon siano null e che siano formattati correttamente. - Un codice di errore
-5, APP_UPDATE_UNAVAILABLEindica che non è disponibile alcun aggiornamento applicabile. Assicurati che la versione di destinazione abbia lo stesso nome del pacchetto, ID applicazione e chiave di firma. Se è disponibile un aggiornamento, svuota la cache dell'app e chiama di nuovoAppUpdateManager_requestAppUpdateInfo()per aggiornareAppUpdateInfo. - Un codice di errore
-6, APP_UPDATE_NOT_ALLOWEDindica che il tipo di aggiornamento indicato dall'oggettoAppUpdateOptionnon è consentito. Prima di avviare il flusso di aggiornamento, controlla se l'oggettoAppUpdateInfoindica che il tipo di aggiornamento è consentito.
Passaggi successivi
Esegui il test degli aggiornamenti in-app della tua app per verificare che l'integrazione funzioni correttamente.