คู่มือนี้อธิบายวิธีรองรับการอัปเดตในแอปในแอปโดยใช้ Unreal Engine เรามีคำแนะนำแยกต่างหากสำหรับกรณีที่การติดตั้งใช้งานใช้ภาษาโปรแกรม Kotlin หรือภาษาโปรแกรม Java และกรณีที่การติดตั้งใช้งานใช้โค้ดแบบเนทีฟ (C/C++) หรือ Unity
ภาพรวม Unreal Engine SDK
Play In-App Updates API เป็นส่วนหนึ่งของกลุ่ม Play Core SDK API สำหรับ Unreal Engine มีคลาส UInAppUpdatesManager เพื่อจัดการการสื่อสารระหว่างแอปของคุณกับ Play API หลังจากส่งคำขอแล้ว แอปของคุณจะตรวจสอบสถานะของคำขอได้โดยใช้ EAppUpdateErrorCode
เวอร์ชัน Unreal Engine ที่รองรับ
ปลั๊กอินรองรับ Unreal Engine 5.0 และเวอร์ชันต่อๆ มาทั้งหมด
ตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์
ดาวน์โหลดปลั๊กอิน Play Unreal Engine จากที่เก็บ GitHub
คัดลอกโฟลเดอร์
GooglePlayไว้ในโฟลเดอร์Pluginsในโปรเจ็กต์ Unreal Engineเปิดโปรเจ็กต์ Unreal Engine แล้วคลิกแก้ไข → ปลั๊กอิน
ค้นหา Google Play แล้วเลือกช่องทำเครื่องหมายเปิดใช้
รีสตาร์ทโปรเจ็กต์เกมและทริกเกอร์บิลด์
เปิดไฟล์
Build.csของโปรเจ็กต์ แล้วเพิ่มโมดูลPlayInAppUpdatesลงในPublicDependencyModuleNames:using UnrealBuildTool; public class MyGame : ModuleRules { public MyGame(ReadOnlyTargetRules Target) : base(Target) { // ... PublicDependencyModuleNames.Add("PlayInAppUpdates"); // ... } }
ตรวจสอบความพร้อมใช้งานของการอัปเดต
ก่อนขออัปเดต ให้ตรวจสอบว่ามีอัปเดตที่พร้อมใช้งานสำหรับแอปของคุณหรือไม่ โดยใช้ UInAppUpdatesManager::RequestInfo เพื่อตรวจหาอัปเดต ดังนี้
MyClass.h
void MyClass::OnRequestInfoOperationCompleted(
EAppUpdateErrorCode ErrorCode,
UAppUpdateInfo* UpdateInfo)
{
// Check the resulting error code.
if (ErrorCode == EAppUpdateErrorCode::AppUpdate_NO_ERROR)
{
// Check AppUpdateInfo's UpdateAvailability, UpdatePriority,
// IsUpdateTypeAllowed(), ... and decide whether to ask the user
// to start an in-app update.
}
}
MyClass.cpp
void MyClass::CheckForUpdateAvailability()
{
// Create a delegate to bind the callback function.
FRequestInfoOperationCompletedDelegate Delegate;
// Bind the completion handler (OnRequestInfoOperationCompleted) to the delegate.
Delegate.BindDynamic(this, &MyClass::OnRequestInfoOperationCompleted);
// Initiate the request info operation, passing the delegate to handle the result.
GetGameInstance()
->GetSubsystem<UInAppUpdatesManager>()
->RequestInfo(Delegate);
}
อินสแตนซ์ UAppUpdateInfo ที่แสดงผลจะมีสถานะความพร้อมใช้งานของการอัปเดต
หากการอัปเดตแอปกำลังดำเนินการอยู่ อินสแตนซ์จะรายงานสถานะของการอัปเดตที่กำลังดำเนินการด้วย
ตรวจสอบความล้าสมัยของการอัปเดต
นอกจากการตรวจสอบว่ามีการอัปเดตพร้อมใช้งานหรือไม่ คุณอาจต้องตรวจสอบด้วยว่าเวลาผ่านไปนานเท่าใดแล้วนับตั้งแต่ที่ผู้ใช้ได้รับการแจ้งเตือนการอัปเดตผ่าน Play Store ครั้งล่าสุด ซึ่งจะช่วยให้คุณตัดสินใจได้ว่าควรเริ่มการอัปเดตแบบยืดหยุ่นหรือการอัปเดตทันที ตัวอย่างเช่น คุณอาจรอ 2-3 วันก่อนที่จะแจ้งให้ผู้ใช้ทราบด้วยการอัปเดตแบบยืดหยุ่น และรออีก 2-3 วันหลังจากนั้นก่อนที่จะกำหนดให้ต้องอัปเดตทันที
ใช้ UAppUpdateInfo:GetClientVersionStalenessDays เพื่อตรวจสอบจำนวนวันนับตั้งแต่การอัปเดตพร้อมใช้งานผ่าน Play Store
int32 ClientVersionStalenessDays = UpdateInfo->GetClientVersionStalenessDays();
ตรวจสอบลำดับความสำคัญของการอัปเดต
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"
}]
}
ในโค้ดของแอป คุณสามารถตรวจสอบระดับความสำคัญของการอัปเดตที่ระบุได้โดยใช้ UAppUpdateInfo::UpdatePriority ดังนี้
int32 Priority = UpdateInfo->GetPriority();
เริ่มอัปเดต
หลังจากยืนยันว่ามีการอัปเดตแล้ว คุณจะขออัปเดตได้โดยใช้ UInAppUpdatesManager::StartUpdate ก่อนขออัปเดต โปรดตรวจสอบว่าคุณมีออบเจ็กต์ UAppUpdateInfo ที่เป็นข้อมูลล่าสุด นอกจากนี้ คุณยังต้องสร้างออบเจ็กต์ UAppUpdateOptions เพื่อกำหนดค่าขั้นตอนการอัปเดตด้วย
ตัวอย่างต่อไปนี้จะสร้างออบเจ็กต์ UAppUpdateOptions สำหรับขั้นตอนการอัปเดตทันที
// Creates an UAppUpdateOptions defining an immediate in-app
// update flow and its parameters.
UAppUpdateOptions* Options = NewObject<UAppUpdateOptions>();
Options->CreateOptions(EAppUpdateType::AppUpdate_TYPE_IMMEDIATE);
ตัวอย่างต่อไปนี้จะสร้างออบเจ็กต์ UAppUpdateOptions สำหรับขั้นตอนการอัปเดตแบบยืดหยุ่น
// Creates an UAppUpdateOptions defining a flexible in-app
// update flow and its parameters.
UAppUpdateOptions* Options = NewObject<UAppUpdateOptions>();
Options->CreateOptions(EAppUpdateType::AppUpdate_TYPE_FLEXIBLE);
ออบเจ็กต์ UAppUpdateOptions ยังมีฟังก์ชัน IsAssetPackDeletionAllowed ที่แสดงผลว่าการอัปเดตได้รับอนุญาตให้ล้างAsset Packหรือไม่ในกรณีที่พื้นที่เก็บข้อมูลของอุปกรณ์มีจำกัด ระบบจะตั้งค่าช่องนี้เป็น false โดยค่าเริ่มต้น แต่คุณสามารถตั้งค่าช่องโดยใช้ UAppUpdateOptions::SetAssetPackDeletionAllowed เพื่อตั้งค่าเป็น true แทนได้ ดังนี้
// Sets the AssetPackDeletionAllowed field to true.
Options->SetAssetPackDeletionAllowed(true);
ขั้นตอนถัดไปจะขึ้นอยู่กับว่าคุณกำลังขออัปเดตแบบยืดหยุ่นหรืออัปเดตทันที
จัดการการอัปเดตแบบยืดหยุ่น
หลังจากมีออบเจ็กต์ UAppUpdateInfo ที่อัปเดตแล้วและออบเจ็กต์ UAppUpdateOptions ที่กำหนดค่าอย่างถูกต้อง คุณจะเรียกใช้ UInAppUpdatesManager::StartUpdate เพื่อขอขั้นตอนการอัปเดตได้
MyClass.h
void MyClass::OnStartUpdateOperationCompleted(EAppUpdateErrorCode ErrorCode)
{
// ...
}
MyClass.cpp
// .cpp
void MyClass::StartUpdate()
{
// Create a delegate to bind the callback function.
FUpdateOperationCompletedDelegate Delegate;
// Bind the completion handler (OnStartUpdateOperationCompleted) to the delegate.
Delegate.BindDynamic(this, &MyClass::OnStartUpdateOperationCompleted);
// Initiate the start update operation, passing the delegate to handle the result.
GetGameInstance()
->GetSubsystem<UInAppUpdatesManager>()
->StartUpdate(UpdateInfo, UpdateOptions, Delegate);
}
สำหรับขั้นตอนการอัปเดตที่ยืดหยุ่น คุณต้องทริกเกอร์การติดตั้งอัปเดตแอปหลังจากดาวน์โหลดเสร็จสมบูรณ์ โดยเรียกใช้ InAppUpdatesManager::CompleteUpdate ดังที่แสดงในตัวอย่างต่อไปนี้
MyClass.h
void MyClass::OnCompleteUpdateOperationCompleted(EAppUpdateErrorCode ErrorCode)
{
// ...
}
MyClass.cpp
void MyClass::CompleteFlexibleUpdate()
{
// Create a delegate to bind the callback function.
FUpdateOperationCompletedDelegate Delegate;
// Bind the completion handler (OnCompleteUpdateOperationCompleted) to the delegate.
Delegate.BindDynamic(this, &MyClass::OnCompleteUpdateOperationCompleted);
// Initiate the complete update operation, passing the delegate to handle the result.
GetGameInstance()
->GetSubsystem<UInAppUpdatesManager>()
->CompleteUpdate(UpdateInfo, UpdateOptions, Delegate);
}
จัดการการอัปเดตทันที
หลังจากมีออบเจ็กต์ UAppUpdateInfo ที่อัปเดตแล้วและออบเจ็กต์ UAppUpdateOptions ที่กำหนดค่าอย่างถูกต้อง คุณจะเรียกใช้ InAppUpdatesManager::StartUpdate เพื่อขอขั้นตอนการอัปเดตได้
MyClass.h
void MyClass::OnStartUpdateOperationCompleted(EAppUpdateErrorCode ErrorCode)
{
// ...
}
MyClass.cpp
void MyClass::StartUpdate()
{
// Create a delegate to bind the callback function.
FUpdateOperationCompletedDelegate Delegate;
// Bind the completion handler (OnStartUpdateOperationCompleted) to the delegate.
Delegate.BindDynamic(this, &MyClass::OnStartUpdateOperationCompleted);
// Initiate the start update operation, passing the delegate to handle the result.
GetGameInstance()
->GetSubsystem<UInAppUpdatesManager>()
->StartUpdate(UpdateInfo, UpdateOptions, Delegate);
}
สำหรับขั้นตอนการอัปเดตทันที Google Play จะแสดงกล่องโต้ตอบการยืนยันของผู้ใช้ เมื่อผู้ใช้ยอมรับคำขอ Google Play จะดาวน์โหลดและติดตั้งการอัปเดตโดยอัตโนมัติ จากนั้นจะรีสตาร์ทแอปเป็นเวอร์ชันที่อัปเดตหากติดตั้งสำเร็จ
การจัดการข้อผิดพลาด
ส่วนนี้จะอธิบายวิธีแก้ปัญหาสำหรับข้อผิดพลาดที่พบบ่อย
- หาก
UInAppUpdatesManager::StartUpdateแสดงข้อผิดพลาดAppUpdate_INVALID_REQUESTแสดงว่าUAppUpdateInfoไม่ถูกต้อง ตรวจสอบว่าออบเจ็กต์UAppUpdateInfoที่แสดงผลจากUInAppUpdatesManager::RequestInfoไม่ใช่ค่า Null ก่อนเริ่มขั้นตอนการอัปเดต - หาก
UInAppUpdatesManager::StartUpdateแสดงข้อผิดพลาดAppUpdate_NOT_ALLOWEDหมายความว่าออบเจ็กต์UAppUpdateOptionsระบุประเภทการอัปเดตที่ไม่อนุญาตสำหรับการอัปเดตที่พร้อมใช้งาน ตรวจสอบว่าออบเจ็กต์UAppUpdateInfoบ่งชี้ว่าประเภทการอัปเดตที่เลือกได้รับอนุญาตหรือไม่ก่อนเริ่มขั้นตอนการอัปเดต
ขั้นตอนถัดไป
ทดสอบการอัปเดตในแอปของแอปเพื่อยืนยันว่าการผสานรวมทำงานอย่างถูกต้อง