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

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

ภาพรวมของ Unity SDK

API การอัปเดตในแอปของ Play เป็นส่วนหนึ่งของตระกูล Play Core SDK ปลั๊กอิน Unity มีคลาส AppUpdateManager เพื่อจัดการการสื่อสารระหว่างแอปกับ Google Play API คุณต้องสร้างอินสแตนซ์คลาสนี้ก่อนจึงจะใช้คลาสนี้เพื่อจัดการการอัปเดตแอปได้

AppUpdateManager appUpdateManager = new AppUpdateManager();

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

OpenUPM-CLI

หากติดตั้ง OpenUPM CLI ไว้ คุณจะติดตั้งรีจิสทรี OpenUPM ได้ด้วยคำสั่งต่อไปนี้

openupm add com.google.play.appupdate

OpenUPM

  1. เปิดการตั้งค่าเครื่องมือจัดการแพ็กเกจโดยเลือกตัวเลือกเมนู Unity Edit > Project Settings > Package Manager

  2. เพิ่ม OpenUPM เป็นรีจิสทรีที่กำหนดขอบเขตลงในหน้าต่าง Package Manager โดยทำดังนี้

    Name: package.openupm.com
    URL: https://package.openupm.com
    Scopes: com.google.external-dependency-manager
      com.google.play.common
      com.google.play.core
      com.google.play.appupdate
    
  3. เปิดเมนูเครื่องมือจัดการแพ็กเกจโดยเลือกตัวเลือกเมนู Unity Window > Package Manager

  4. ตั้งค่าเมนูแบบเลื่อนลงขอบเขตผู้จัดการเพื่อเลือกรีจิสทรีของฉัน

  5. เลือกแพ็กเกจปลั๊กอิน Google Play Integrity สำหรับ Unity จากรายการแพ็กเกจ แล้วกดติดตั้ง

นำเข้าจาก GitHub

  1. ดาวน์โหลด .unitypackage เวอร์ชันล่าสุดจาก GitHub

  2. นำเข้าไฟล์ .unitypackage โดยเลือกตัวเลือกเมนู Unity Assets > Import package > Custom Package แล้วนำเข้ารายการทั้งหมด

ตรวจสอบความพร้อมใช้งานของการอัปเดต

ก่อนขออัปเดต ให้ตรวจสอบว่ามีอัปเดตที่พร้อมใช้งานสำหรับแอปของคุณหรือไม่ โดยใช้ AppUpdateManager เพื่อตรวจหาอัปเดตใน coroutine ดังนี้

IEnumerator CheckForUpdate()
{
  PlayAsyncOperation<AppUpdateInfo, AppUpdateErrorCode> appUpdateInfoOperation =
    appUpdateManager.GetAppUpdateInfo();

  // Wait until the asynchronous operation completes.
  yield return appUpdateInfoOperation;

  if (appUpdateInfoOperation.IsSuccessful)
  {
    var appUpdateInfoResult = appUpdateInfoOperation.GetResult();
    // Check AppUpdateInfo's UpdateAvailability, UpdatePriority,
    // IsUpdateTypeAllowed(), ... and decide whether to ask the user
    // to start an in-app update.
  }
  else
  {
    // Log appUpdateInfoOperation.Error.
  }
}

อินสแตนซ์ AppUpdateInfo ที่แสดงผลจะมีสถานะความพร้อมใช้งานของการอัปเดต หากการอัปเดตแอปอยู่ระหว่างดำเนินการ อินสแตนซ์จะรายงานสถานะของการอัปเดตที่อยู่ระหว่างดำเนินการด้วย

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

นอกจากการตรวจสอบว่ามีการอัปเดตพร้อมใช้งานหรือไม่ คุณอาจต้องตรวจสอบด้วยว่าเวลาผ่านไปนานเท่าใดแล้วนับตั้งแต่ที่ผู้ใช้ได้รับการแจ้งเตือนการอัปเดตผ่าน Play Store ครั้งล่าสุด ซึ่งจะช่วยให้คุณตัดสินใจได้ว่าควรเริ่มการอัปเดตแบบยืดหยุ่นหรือการอัปเดตทันที ตัวอย่างเช่น คุณอาจรอ 2-3 วันก่อนที่จะแจ้งให้ผู้ใช้ทราบด้วยการอัปเดตแบบยืดหยุ่น และรออีก 2-3 วันหลังจากนั้นก่อนที่จะกำหนดให้ต้องอัปเดตทันที

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

var stalenessDays = appUpdateInfoOperation.ClientVersionStalenessDays;

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

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"
  }]
}

ในโค้ดของแอป คุณสามารถตรวจสอบระดับความสำคัญของการอัปเดตที่ระบุได้โดยใช้ UpdatePriority ดังนี้

var priority = appUpdateInfoOperation.UpdatePriority;

เริ่มอัปเดต

หลังจากตรวจสอบแล้วว่ามีการอัปเดต คุณสามารถขออัปเดตได้โดยใช้ AppUpdateManager.StartUpdate() ก่อนขออัปเดต โปรดตรวจสอบว่าคุณมีออบเจ็กต์ AppUpdateInfo ที่เป็นข้อมูลล่าสุด นอกจากนี้ คุณยังต้องสร้างออบเจ็กต์ AppUpdateOptions เพื่อกำหนดค่าขั้นตอนการอัปเดตด้วย

ตัวอย่างต่อไปนี้จะสร้างออบเจ็กต์ AppUpdateOptions สำหรับขั้นตอนการอัปเดตทันที

// Creates an AppUpdateOptions defining an immediate in-app
// update flow and its parameters.
var appUpdateOptions = AppUpdateOptions.ImmediateAppUpdateOptions();

ตัวอย่างต่อไปนี้จะสร้างออบเจ็กต์ AppUpdateOptions สำหรับขั้นตอนการอัปเดตแบบยืดหยุ่น

// Creates an AppUpdateOptions defining a flexible in-app
// update flow and its parameters.
var appUpdateOptions = AppUpdateOptions.FlexibleAppUpdateOptions();

ออบเจ็กต์ AppUpdateOptions ยังมีฟิลด์ AllowAssetPackDeletion ที่กำหนดว่าการอัปเดตได้รับอนุญาตให้ล้างAsset Packหรือไม่ในกรณีที่พื้นที่เก็บข้อมูลของอุปกรณ์มีจำกัด ช่องนี้จะตั้งค่าเป็น false โดยค่าเริ่มต้น แต่คุณสามารถส่งอาร์กิวเมนต์ allowAssetPackDeletion ที่ไม่บังคับไปยัง ImmediateAppUpdateOptions() หรือ FlexibleAppUpdateOptions() เพื่อตั้งค่าเป็น true แทนได้ ดังนี้

// Creates an AppUpdateOptions for an immediate flow that allows
// asset pack deletion.
var appUpdateOptions =
  AppUpdateOptions.ImmediateAppUpdateOptions(allowAssetPackDeletion: true);

// Creates an AppUpdateOptions for a flexible flow that allows asset
// pack deletion.
var appUpdateOptions =
  AppUpdateOptions.FlexibleAppUpdateOptions(allowAssetPackDeletion: true);

ขั้นตอนถัดไปจะขึ้นอยู่กับว่าคุณกำลังขอการอัปเดตแบบยืดหยุ่นหรือการอัปเดตทันที

จัดการการอัปเดตแบบยืดหยุ่น

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

IEnumerator StartFlexibleUpdate()
{
  // Creates an AppUpdateRequest that can be used to monitor the
  // requested in-app update flow.
  var startUpdateRequest = appUpdateManager.StartUpdate(
    // The result returned by PlayAsyncOperation.GetResult().
    appUpdateInfoResult,
    // The AppUpdateOptions created defining the requested in-app update
    // and its parameters.
    appUpdateOptions);

  while (!startUpdateRequest.IsDone)
  {
  // For flexible flow,the user can continue to use the app while
  // the update downloads in the background. You can implement a
  // progress bar showing the download status during this time.
  yield return null;
  }

}

สำหรับขั้นตอนการอัปเดตที่ยืดหยุ่น คุณต้องทริกเกอร์การติดตั้งอัปเดตแอปหลังจากดาวน์โหลดเสร็จสมบูรณ์ โดยเรียกใช้ AppUpdateManager.CompleteUpdate() ดังที่แสดงในตัวอย่างต่อไปนี้

IEnumerator CompleteFlexibleUpdate()
{
  var result = appUpdateManager.CompleteUpdate();
  yield return result;

  // If the update completes successfully, then the app restarts and this line
  // is never reached. If this line is reached, then handle the failure (e.g. by
  // logging result.Error or by displaying a message to the user).
}

จัดการการอัปเดตทันที

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

IEnumerator StartImmediateUpdate()
{
  // Creates an AppUpdateRequest that can be used to monitor the
  // requested in-app update flow.
  var startUpdateRequest = appUpdateManager.StartUpdate(
    // The result returned by PlayAsyncOperation.GetResult().
    appUpdateInfoResult,
    // The AppUpdateOptions created defining the requested in-app update
    // and its parameters.
    appUpdateOptions);
  yield return startUpdateRequest;

  // If the update completes successfully, then the app restarts and this line
  // is never reached. If this line is reached, then handle the failure (for
  // example, by logging result.Error or by displaying a message to the user).
}

สำหรับขั้นตอนการอัปเดตทันที Google Play จะแสดงกล่องโต้ตอบการยืนยันของผู้ใช้ เมื่อผู้ใช้ยอมรับคำขอ Google Play จะดาวน์โหลดและติดตั้งการอัปเดตโดยอัตโนมัติ จากนั้นจะรีสตาร์ทแอปเป็นเวอร์ชันที่อัปเดตหากติดตั้งสำเร็จ

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

ส่วนนี้จะอธิบายวิธีแก้ปัญหาสำหรับข้อผิดพลาดที่พบบ่อย

  • หาก StartUpdate() แสดง ArgumentNullException หมายความว่า AppUpdateInfo เป็น Null ตรวจสอบว่าออบเจ็กต์ AppUpdateInfo ที่แสดงผลจาก GetAppUpdateInfo() ไม่ใช่ค่า Null ก่อนเริ่มขั้นตอนการอัปเดต
  • หาก PlayAsyncOperation แสดงรหัสข้อผิดพลาด ErrorUpdateUnavailable ให้ตรวจสอบว่ามีแอปเวอร์ชันอัปเดตที่พร้อมใช้งานซึ่งมีรหัสแอปพลิเคชันและคีย์การรับรองเดียวกัน
  • หาก PlayAsyncOperation แสดงรหัสข้อผิดพลาด ErrorUpdateNotAllowed หมายความว่าออบเจ็กต์ AppUpdateOptions ระบุประเภทการอัปเดตที่ไม่อนุญาตสำหรับการอัปเดตที่มีอยู่ ตรวจสอบว่าออบเจ็กต์ AppUpdateInfo ระบุว่าอนุญาตให้อัปเดตประเภทที่เลือกหรือไม่ก่อนเริ่มขั้นตอนการอัปเดต

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

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