支持应用内更新（原生）

本指南介绍了如何使用原生代码（C 或 C++）在应用中支持应用内更新。如果您使用 Kotlin 编程语言或 Java 编程语言实现，或者使用 Unity 或 Unreal Engine 实现，则有单独的指南。

原生 SDK 概览

Play Core 原生 SDK 是 Play Core SDK 系列的一部分。原生 SDK 包含一个 C 头文件 app_update.h，它封装了 Java Play 应用内更新库中的 AppUpdateManager。此头文件允许您的应用直接从原生代码调用应用内更新 API。

设置开发环境

下载 Play Core 原生 SDK

下载前，您必须同意以下条款和条件。

条款和条件

上次修改日期：2020 年 9 月 24 日
  1. 使用 Play Core 软件开发工具包即表示您同意这些条款以及 Google API 服务条款（“API 服务条款”）。如果这些条款与 API 服务条款发生冲突，则以这些条款为准。请仔细阅读这些条款和 API 服务条款。
  2. 就本条款而言，“API”指 Google 的 API、其他开发者服务以及相关软件，包括任何可再分发代码。
  3. “可再分发代码”指 Google 提供的调用 API 的目标代码或头文件。
  4. 在遵守本条款和 API 服务条款的前提下，您可以复制和分发可再分发代码，但仅限于将其作为您的 API 客户端的一部分。Google 及其许可方拥有可再分发代码中的所有权利、所有权和权益，包括任何及所有知识产权和其他专有权利。您不得修改、翻译或创作可再分发代码的衍生作品。
  5. Google 可随时更改这些条款，并会发出通知，您将有机会拒绝继续使用 Play Core 软件开发工具包。Google 将在 https://developer.android.com/guide/playcore/license 发布条款修改通知。更改不具有追溯力。
下载 Play Core 原生 SDK

play-core-native-sdk-1.15.3.zip

  1. 执行以下任一操作

  2. 使用 SDK 管理器安装最新版 CMake 和 Android 原生开发套件 (NDK)，为原生开发准备 Android Studio。如需了解有关创建或导入原生项目的更多信息，请参阅NDK 入门。

  3. 下载 zip 文件并将其解压到您的项目旁边。

    下载链接 大小 SHA-256 校验和
    37.8 兆字节 9db60185185342f28d2c278b60222333608c67bc022e458a25224eaea8c4c4b7

  4. 按如下所示更新应用的 build.gradle 文件

    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. 按如下所示更新应用的 CMakeLists.txt 文件

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

数据收集

Play Core 原生 SDK 可能会收集版本相关数据，以便 Google 改进产品，其中包括：

  • 应用软件包名称
  • 应用软件包版本
  • Play Core 原生 SDK 版本

当您将应用软件包上传到 Play 管理中心时，系统会收集此数据。要选择退出此数据收集过程，请移除 build.gradle 文件中的 $playcoreDir/playcore-native-metadata.jar 导入。

请注意，与您使用 Play Core 原生 SDK 相关的数据收集以及 Google 对所收集数据的使用，与您将应用软件包上传到 Play 管理中心时 Google 收集 Gradle 中声明的库依赖项是独立且分开的。

将 Play Core 原生 SDK 集成到您的项目后，请在包含 API 调用的文件中包含以下行：

#include "play/app_update.h"

初始化应用内更新 API

无论何时使用应用内更新 API，请首先通过调用 AppUpdateManager_init() 函数来初始化它，如以下使用 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.
  }
}

检查更新可用性

在请求更新之前，请检查您的应用是否有可用更新。AppUpdateManager_requestInfo() 会启动一个异步请求，收集启动应用内更新流程所需的必要信息。如果请求成功启动，该函数会返回 APP_UPDATE_NO_ERROR。

AppUpdateErrorCode error_code = AppUpdateManager_requestInfo()

if (error_code == APP_UPDATE_NO_ERROR) {
    // The request has successfully started, check the result using
    // AppUpdateManager_getInfo.
}

您可以使用 AppUpdateManager_getInfo() 跟踪请求的进行过程和结果。除了错误代码外，此函数还会返回一个 AppUpdateInfo 不透明结构，您可以使用它来检索有关更新请求的信息。例如，您可能希望在每个游戏循环中调用此函数，直到它为 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
   }
...
}

检查更新陈旧度

除了检查是否有可用更新外，您可能还需要检查自上次通过 Play 商店通知用户更新以来过了多长时间。这可以帮助您决定是启动灵活更新还是立即更新。例如，您可以等待几天再通过灵活更新通知用户，然后几天后再强制执行立即更新。

使用 AppUpdateInfo_getClientVersionStalenessDays() 检查更新通过 Play 商店可用以来经过的天数：

int32_t staleness_days = AppUpdateInfo_getClientVersionStalenessDays(info);

检查更新优先级

通过 Google Play Developer API，您可以设置每个更新的优先级。这允许您的应用决定向用户推荐更新的强烈程度。例如，考虑以下设置更新优先级的策略：

  • 次要界面改进：低优先级更新；不请求灵活更新也不请求立即更新。仅在用户不与您的应用交互时更新。
  • 性能改进：中优先级更新；请求灵活更新。
  • 关键安全更新：高优先级更新；请求立即更新。

为了确定优先级，Google Play 使用 0 到 5 之间的整数值，其中 0 为默认值，5 为最高优先级。要设置更新的优先级，请使用 Google Play Developer API 中 Edits.tracks.releases 下的 inAppUpdatePriority 字段。发布中所有新添加的版本都与该发布具有相同的优先级。优先级只能在新版本发布时设置，之后无法更改。

如Play 开发者 API 文档中所述，使用 Google Play Developer API 设置优先级。在传递给 Edit.tracks: update 方法的 Edit.tracks 资源中指定应用内更新优先级。以下示例演示了发布版本代码为 88 且 inAppUpdatePriority 为 5 的应用：

{
  "releases": [{
      "versionCodes": ["88"],
      "inAppUpdatePriority": 5,
      "status": "completed"
  }]
}

在您的应用代码中，您可以使用 AppUpdateInfo_getPriority() 检查给定更新的优先级：

int32_t priority = AppUpdateInfo_getPriority(info);

启动更新

确认有可用更新后，您可以使用 AppUpdateManager_requestStartUpdate() 请求更新。在请求更新之前，获取最新的 AppUpdateInfo 对象并创建一个 AppUpdateOptions 对象来配置更新流程。AppUpdateOptions 对象定义了应用内更新流程的选项，包括更新应该是灵活的还是立即的。

以下示例为灵活更新流程创建了一个 AppUpdateOptions 对象：

// Creates an AppUpdateOptions configuring a flexible in-app update flow.
AppUpdateOptions* options;
AppUpdateErrorCode error_code = AppUpdateOptions_createOptions(APP_UPDATE_TYPE_FLEXIBLE, &options);

以下示例为立即更新流程创建了一个 AppUpdateOptions 对象：

// Creates an AppUpdateOptions configuring an immediate in-app update flow.
AppUpdateOptions* options;
AppUpdateErrorCode error_code = AppUpdateOptions_createOptions(APP_UPDATE_TYPE_IMMEDIATE, &options);

AppUpdateOptions 对象还包含一个 AllowAssetPackDeletion 字段，该字段定义在设备存储空间有限的情况下，更新是否允许清除素材资源包。此字段默认为 false，但您可以使用 AppUpdateOptions_setAssetPackDeletionAllowed() 方法将其设置为 true：

bool allow = true;
AppUpdateErrorCode error_code = AppUpdateOptions_setAssetPackDeletionAllowed(options, allow);

在您获得最新的 AppUpdateInfo 对象和正确配置的 AppUpdateOptions 对象后，调用 AppUpdateManager_requestStartUpdate() 以异步请求更新流程，并将 Android Activity jobject 作为最后一个参数传入。

AppUpdateErrorCode request_error_code =
AppUpdateManager_requestStartUpdate(info, options, app->activity->clazz);

为了释放资源，通过分别调用 AppUpdateInfo_destroy() 和 AppUpdateOptions_destroy() 来释放不再需要的 AppUpdateInfo 和 AppUpdateOptions 实例。

AppUpdateInfo_destroy(info);
AppUpdateOptions_destroy(options);

对于立即更新流程，Google Play 会显示用户确认页面。当用户接受请求时，Google Play 会在前台自动下载并安装更新，如果安装成功，则会将应用重启到更新后的版本。

对于灵活更新流程，您可以持续请求最新的 AppUpdateInfo 对象，以便在用户继续与应用交互时跟踪当前更新状态。下载成功完成后，您必须通过调用 AppUpdateManager_requestCompleteUpdate() 来触发更新的完成，如以下示例所示：

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

在您的应用使用完 API 后，通过调用 AppUpdateManager_destroy() 函数来释放资源。

错误处理

本节介绍了针对特定 AppUpdateErrorCode 值指示的常见错误的解决方案：

  • 错误代码 -110, APP_UPDATE_INITIALIZATION_NEEDED 表示 API 未成功初始化。调用 AppUpdateManager_init() 来初始化 API。
  • 错误代码 -4, APP_UPDATE_INVALID_REQUEST 表示更新流程请求的某些参数格式不正确。请检查以确保 AppUpdateInfo 和 AppUpdateOptions 对象不为空且格式正确。
  • 错误代码 -5, APP_UPDATE_UNAVAILABLE 表示没有适用的更新可用。请确保目标版本具有相同的软件包名称、应用 ID 和签名密钥。如果有可用更新，请清除应用的缓存并再次调用 AppUpdateManager_requestAppUpdateInfo() 以刷新 AppUpdateInfo。
  • 错误代码 -6, APP_UPDATE_NOT_ALLOWED 表示 AppUpdateOption 对象指示的更新类型不被允许。在启动更新流程之前，请检查 AppUpdateInfo 对象是否指示该更新类型被允许。

后续步骤

测试您应用的内嵌式更新以验证您的集成是否正常工作。