รองรับการอัปเดตในแอป (เนทีฟ)

คู่มือนี้อธิบายวิธีรองรับการอัปเดตในแอปในแอปโดยใช้โค้ดแบบเนทีฟ (C หรือ C++) มีคู่มือแยกต่างหากสำหรับกรณีที่การติดตั้งใช้งานใช้ภาษาโปรแกรม Kotlin หรือภาษาโปรแกรม Java และกรณีที่การติดตั้งใช้งานใช้ Unity หรือ Unreal Engine

ภาพรวมของ Native SDK

Play Core Native SDK เป็นส่วนหนึ่งของตระกูล Play Core SDK Native SDK มีไฟล์ส่วนหัว C, app_update.h ซึ่งรวม AppUpdateManager จากไลบรารีการอัปเดตในแอปของ Java Play ไฟล์ส่วนหัวนี้ช่วยให้แอปของคุณ เรียก API สำหรับการอัปเดตในแอปได้โดยตรงจากโค้ดเนทีฟ

ตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์

ดาวน์โหลด Play Core Native SDK

คุณต้องยอมรับข้อกำหนดและเงื่อนไขต่อไปนี้ก่อนดาวน์โหลด

ข้อกำหนดและเงื่อนไข

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.15.3.zip

  1. เลือกดำเนินการอย่างหนึ่งดังต่อไปนี้

  2. เตรียม Android Studio สําหรับการพัฒนาแอปที่มาพร้อมเครื่องโดยใช้ SDK Manager เพื่อติดตั้ง CMake และ Android Native Development Kit (NDK) เวอร์ชันล่าสุด ดูข้อมูลเพิ่มเติมเกี่ยวกับการ สร้างหรือนำเข้าโปรเจ็กต์เนทีฟได้ที่ เริ่มต้นใช้งาน NDK

  3. ดาวน์โหลดไฟล์ ZIP แล้วแตกไฟล์ไว้ข้างๆ โปรเจ็กต์

    ลิงก์ดาวน์โหลด ขนาด ผลรวมตรวจสอบ SHA-256
    37.8 MiB 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 Native SDK อาจรวบรวมข้อมูลที่เกี่ยวข้องกับเวอร์ชันเพื่อให้ Google ปรับปรุงผลิตภัณฑ์ ซึ่งรวมถึง

  • ชื่อแพ็กเกจของแอป
  • เวอร์ชันแพ็กเกจของแอป
  • เวอร์ชันของ Play Core Native SDK

ระบบจะรวบรวมข้อมูลนี้เมื่อคุณอัปโหลดแพ็กเกจแอป ไปยัง Play Console หากต้องการเลือกไม่ใช้กระบวนการเก็บรวบรวมข้อมูลนี้ ให้นำ $playcoreDir/playcore-native-metadata.jar import ในไฟล์ build.gradle ออก

โปรดทราบว่าการเก็บรวบรวมข้อมูลนี้ที่เกี่ยวข้องกับการใช้ Play Core Native SDK และ การใช้ข้อมูลที่เก็บรวบรวมของ Google นั้นแยกกันและเป็นอิสระจากการ เก็บรวบรวมทรัพยากร Dependency ของไลบรารีที่ประกาศใน Gradle เมื่อคุณอัปโหลดแพ็กเกจแอป ไปยัง Play Console

หลังจากผสานรวม Play Core Native 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 ซึ่งคุณใช้เพื่อดึงข้อมูล เกี่ยวกับคำขออัปเดตได้ เช่น คุณอาจต้องการเรียกใช้ฟังก์ชันนี้ในทุก Game Loop จนกว่าจะแสดงผลลัพธ์ที่ไม่ใช่ Null สำหรับ 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 Store ซึ่งจะช่วยให้คุณตัดสินใจได้ว่าควรเริ่ม การอัปเดตที่ยืดหยุ่นหรือการอัปเดตทันที เช่น คุณอาจรอ 2-3 วัน ก่อนที่จะแจ้งให้ผู้ใช้ทราบเกี่ยวกับการอัปเดตที่ยืดหยุ่น และรออีก 2-3 วัน ก่อนที่จะกำหนดให้มีการอัปเดตทันที

ใช้ AppUpdateInfo_getClientVersionStalenessDays() เพื่อตรวจสอบจำนวนวันตั้งแต่มีการอัปเดตผ่าน Play Store ดังนี้ 

int32_t staleness_days = AppUpdateInfo_getClientVersionStalenessDays(info);

ตรวจสอบลำดับความสำคัญของการอัปเดต

Google Play Developer API ช่วยให้คุณกำหนดลำดับความสำคัญของการอัปเดตแต่ละรายการได้ ซึ่งจะช่วยให้แอปตัดสินใจได้ว่าจะแนะนำให้อัปเดตแก่ผู้ใช้มากน้อยเพียงใด ตัวอย่างเช่น ลองใช้กลยุทธ์ต่อไปนี้ในการกำหนดลำดับความสำคัญของการอัปเดต

  • การปรับปรุง UI เล็กน้อย: อัปเดตลำดับความสำคัญต่ำ ไม่ขอทั้งการอัปเดตที่ยืดหยุ่น และการอัปเดตทันที อัปเดตเฉพาะเมื่อผู้ใช้ไม่ได้โต้ตอบกับแอป
  • การปรับปรุงประสิทธิภาพ: อัปเดตระดับปานกลาง ขออัปเดตที่ยืดหยุ่น ได้
  • การอัปเดตความปลอดภัยที่สำคัญ: อัปเดตลำดับความสำคัญสูง ขอให้อัปเดตทันที

Google Play จะใช้ค่าจำนวนเต็มระหว่าง 0 ถึง 5 เพื่อกำหนดลำดับความสำคัญ โดย 0 เป็นค่าเริ่มต้นและ 5 เป็นลำดับความสำคัญสูงสุด หากต้องการตั้งค่าลำดับความสำคัญสำหรับการอัปเดต ให้ใช้ฟิลด์ inAppUpdatePriority ในส่วน Edits.tracks.releases ใน Google Play Developer API เวอร์ชันที่เพิ่มใหม่ทั้งหมดในรุ่นจะถือว่ามีลำดับความสำคัญเดียวกับรุ่น คุณจะตั้งค่าลำดับความสำคัญได้เมื่อ เปิดตัวรุ่นใหม่เท่านั้น และจะเปลี่ยนแปลงในภายหลังไม่ได้

ตั้งค่าลำดับความสำคัญโดยใช้ Google Play Developer API ตามที่อธิบายไว้ในเอกสารประกอบของ Play Developer API ระบุลำดับความสำคัญของการอัปเดตในแอปในทรัพยากร Edit.tracks ที่ส่งผ่านในเมธอด Edit.tracks: update ตัวอย่างต่อไปนี้แสดงการเผยแพร่แอปที่มีรหัสเวอร์ชัน 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 jobject เป็นพารามิเตอร์สุดท้าย

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

หากต้องการเพิ่มพื้นที่ว่างในทรัพยากร ให้ปล่อยอินสแตนซ์ของ AppUpdateInfo และ AppUpdateOptions ที่คุณไม่ต้องการใช้แล้วโดยเรียกใช้ AppUpdateInfo_destroy() และ AppUpdateOptions_destroy() ตามลำดับ

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

เพิ่มพื้นที่ว่างในทรัพยากรโดยเรียกใช้ฟังก์ชัน AppUpdateManager_destroy() หลังจากที่แอปใช้ API เสร็จแล้ว

การจัดการข้อผิดพลาด

ส่วนนี้จะอธิบายวิธีแก้ปัญหาข้อผิดพลาดที่พบบ่อยซึ่งระบุโดยค่าAppUpdateErrorCodeที่เฉพาะเจาะจง

  • รหัสข้อผิดพลาด -110, APP_UPDATE_INITIALIZATION_NEEDED แสดงว่า API เริ่มต้นไม่สำเร็จ เรียกใช้ AppUpdateManager_init() เพื่อ เริ่มต้น API
  • รหัสข้อผิดพลาด -4, APP_UPDATE_INVALID_REQUEST แสดงว่าพารามิเตอร์บางรายการของคำขอโฟลว์การอัปเดตมีรูปแบบไม่ถูกต้อง ตรวจสอบว่าออบเจ็กต์ AppUpdateInfo และ AppUpdateOptions ไม่เป็นค่าว่างและมีการจัดรูปแบบอย่างถูกต้อง
  • รหัสข้อผิดพลาด -5, APP_UPDATE_UNAVAILABLE แสดงว่าไม่มี การอัปเดตที่เกี่ยวข้อง ตรวจสอบว่าเวอร์ชันเป้าหมายมีชื่อแพ็กเกจ รหัสแอปพลิเคชัน และคีย์การลงนามเดียวกัน หากมีการอัปเดตพร้อมใช้งาน ให้ล้างแคชของแอปแล้วโทรAppUpdateManager_requestAppUpdateInfo()อีกครั้งเพื่อรีเฟรชAppUpdateInfo
  • รหัสข้อผิดพลาด -6, APP_UPDATE_NOT_ALLOWED แสดงว่าไม่อนุญาตให้ใช้ประเภทการอัปเดต ที่ระบุโดยออบเจ็กต์ AppUpdateOption ตรวจสอบว่าออบเจ็กต์ AppUpdateInfoระบุว่าอนุญาตประเภทการอัปเดตหรือไม่ก่อน เริ่มขั้นตอนการอัปเดต

ขั้นตอนถัดไป

ทดสอบการอัปเดตในแอปของแอปเพื่อยืนยันว่าการผสานรวมทำงานได้อย่างถูกต้อง