ZEPETO.Product
ประเภท | คำอธิบาย |
|---|---|
คลาสพื้นฐานสำหรับคลาสการตอบกลับ | |
คลาส BaseRequest ที่รับชนิดเจเนอริก TResponse เป็นข้อมูลการตอบกลับ | |
คลาส ProductListResponse ให้ผลลัพธ์การเรียก API และรายการข้อมูลสินค้าที่ดึงมา | |
คลาสพื้นฐานสำหรับคลาสการตอบกลับที่เกี่ยวข้องกับสินค้า | |
คลาส ProductResponse ให้ผลลัพธ์การเรียก API และข้อมูลสินค้าที่ดึงมา | |
คลาส ProductResponse ให้ผลลัพธ์การเรียก API และข้อมูลการซื้อ | |
คลาส CurrencyListResponse ให้ผลลัพธ์การเรียก API และรายการข้อมูลสกุลเงิน | |
คลาส CurrencyResponse ให้ผลลัพธ์การเรียก API และข้อมูลสกุลเงิน | |
ข้อมูลสินค้า | |
ข้อมูลสกุลเงิน | |
รายละเอียดของสินค้าแต่ละรายการที่รวมอยู่ในแพ็กเกจสินค้าประเภทไอเทม | |
รายละเอียดของสกุลเงินแต่ละรายการที่รวมอยู่ในแพ็กเกจสินค้าประเภทสกุลเงิน | |
Enum ที่แสดงประเภทของสินค้า | |
Enum ที่แสดงประเภทการซื้อสินค้า | |
Enum ที่แสดงสถานะของสินค้า | |
Enum ที่แสดงประเภทของสกุลเงิน | |
ProductService จัดการการดำเนินการที่เกี่ยวข้องกับสินค้าภายใน World ผู้เล่นสามารถเข้าถึงข้อมูลสินค้าภายใน World และทำการซื้อผ่านบริการนี้ได้ | |
คลาสที่จัดการฟังก์ชันการทำงานของปุ่มซื้อสินค้าภายใน World | |
รหัสข้อผิดพลาดที่ระบุสาเหตุความล้มเหลวของคำขอที่เกี่ยวข้องกับสินค้า | |
แทนคำขอแบบอะซิงโครนัสสำหรับดึงยอดคงเหลือของสกุลเงินทางการของ ZEPETO (ZEM) |
BaseResponse
class
คลาสพื้นฐานสำหรับคลาสการตอบกลับ
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
isSuccess | boolean | แสดงสถานะความสำเร็จของคำขอ โดยจะเป็น true เมื่อดำเนินการสำเร็จ |
message | string | อธิบายผลลัพธ์ของคำขอ |
BaseRequest
class · extends BaseAPIRequest
คลาส BaseRequest ที่รับชนิดเจเนอริก TResponse เป็นข้อมูลการตอบกลับ
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
responseData | TResponse | ข้อมูลการตอบกลับของชนิดเจเนอริก TResponse |
ProductListResponse
class · extends ProductBaseResponse
คลาส ProductListResponse ให้ผลลัพธ์การเรียก API และรายการข้อมูลสินค้าที่ดึงมา
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
products | รายการข้อมูลสินค้า |
ProductBaseResponse
class · extends BaseResponse
คลาสพื้นฐานสำหรับคลาสการตอบกลับที่เกี่ยวข้องกับสินค้า
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
ErrorCode | ดึงรหัสข้อผิดพลาดของคำขอสินค้าที่ล้มเหลว |
ProductResponse
class · extends ProductBaseResponse
คลาส ProductResponse ให้ผลลัพธ์การเรียก API และข้อมูลสินค้าที่ดึงมา
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
product | ข้อมูลสินค้า |
PurchaseResponse
class · extends ProductBaseResponse
คลาส ProductResponse ให้ผลลัพธ์การเรียก API และข้อมูลการซื้อ
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
userId | string | ID ผู้ใช้ของผู้เล่นที่ทำการซื้อ |
productId | string | ID ของสินค้าภายใน World ที่ซื้อ |
price | number | ราคาของสินค้าภายใน World ที่ซื้อ |
receiptId | string | ID ใบเสร็จของการซื้อ |
purchasedAt | Date | วันและเวลาที่ซื้อสินค้าภายใน World |
CurrencyListResponse
class · extends ProductBaseResponse
คลาส CurrencyListResponse ให้ผลลัพธ์การเรียก API และรายการข้อมูลสกุลเงิน
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
currencies | รายการข้อมูลสกุลเงิน |
CurrencyResponse
class · extends ProductBaseResponse
คลาส CurrencyResponse ให้ผลลัพธ์การเรียก API และข้อมูลสกุลเงิน
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
currency | ข้อมูลสกุลเงิน |
ProductRecord
class
ข้อมูลสินค้า
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
productId | string | ID ของสินค้า |
name | string | ชื่อสินค้า |
price | number | ราคาสินค้า |
isPurchased | boolean | ระบุว่าผู้ใช้ได้ซื้อสินค้านี้แล้วหรือไม่ ใช้ได้เฉพาะกับสินค้าประเภทใช้แล้วไม่หมดไปเท่านั้น |
itemPackageUnits | ไอเทมที่รวมอยู่ในสินค้า หาก ProductType เป็น ItemPackage | |
currencyPackageUnits | สกุลเงินที่รวมอยู่ในสินค้า หาก ProductType เป็น CurrencyPackage | |
ProductType | คืนค่า ProductType ของสินค้า | |
PurchaseType | คืนค่า PurchaseType ของสินค้า | |
ProductStatus | คืนค่า ProductStatus ของสินค้า | |
CurrencyType | คืนค่าประเภทสกุลเงินที่ใช้ในการซื้อสินค้า | |
currencyId | string | คืนค่า ID ของสกุลเงินที่ใช้ในการซื้อสินค้า |
currencyName | string | คืนค่าชื่อของสกุลเงินที่ใช้ในการซื้อสินค้า |
เมธอด
GetCurrencySprite
GetCurrencySprite() → Sprite
คืนค่าภาพของสกุลเงินที่ใช้ในการซื้อสินค้า
ค่าที่คืนกลับ: Sprite
CurrencyRecord
class
ข้อมูลสกุลเงิน
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
currencyId | string | ID ของสกุลเงิน |
name | string | ชื่อสกุลเงิน |
isOfficialCurrency | boolean | ระบุว่าสกุลเงินนี้เป็นสกุลเงินทางการของ ZEPETO (ZEM) หรือสกุลเงินภายใน World |
ItemPackageUnitRecord
class
รายละเอียดของสินค้าแต่ละรายการที่รวมอยู่ในแพ็กเกจสินค้าประเภทไอเทม
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
productId | string | ID ของสินค้า |
itemName | string | ชื่อไอเทม |
quantity | bigint | จำนวนไอเทม |
CurrencyPackageUnitRecord
class
รายละเอียดของสกุลเงินแต่ละรายการที่รวมอยู่ในแพ็กเกจสินค้าประเภทสกุลเงิน
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
currencyId | string | ID ของสกุลเงิน |
currencyName | string | ชื่อสกุลเงิน |
quantity | bigint | จำนวนสกุลเงิน |
ProductType
enum
Enum ที่แสดงประเภทของสินค้า
ชื่อ | ค่า | คำอธิบาย |
|---|---|---|
Item | 0 | สินค้าแบบไอเทมเดี่ยว |
ItemPackage | 1 | แพ็กเกจสินค้าประเภทไอเทมที่ประกอบด้วยไอเทมหลายรายการ |
CurrencyPackage | 2 | แพ็กเกจสินค้าประเภทสกุลเงินที่ประกอบด้วยสกุลเงินหลายรายการ |
PurchaseType
enum
Enum ที่แสดงประเภทการซื้อสินค้า
ชื่อ | ค่า | คำอธิบาย |
|---|---|---|
Consumable | 0 | สินค้าแบบใช้แล้วหมดไป |
NonConsumable | 1 | สินค้าแบบใช้แล้วไม่หมดไป |
ProductStatus
enum
Enum ที่แสดงสถานะของสินค้า
ชื่อ | ค่า | คำอธิบาย |
|---|---|---|
Active | 0 | สถานะใช้งาน |
InActive | 1 | สถานะไม่ใช้งาน |
Forbidden | 2 | สถานะถูกห้ามใช้งานเนื่องจากหมดอายุการใช้งาน |
CurrencyType
enum
Enum ที่แสดงประเภทของสกุลเงิน
ชื่อ | ค่า | คำอธิบาย |
|---|---|---|
OfficialCurrency | 0 | สกุลเงินทางการของ ZEPETO (ZEM) |
UserCurrency | 1 | สกุลเงินภายใน World |
ProductService
class
ProductService จัดการการดำเนินการที่เกี่ยวข้องกับสินค้าภายใน World ผู้เล่นสามารถเข้าถึงข้อมูลสินค้าภายใน World และทำการซื้อผ่านบริการนี้ได้
อีเวนต์
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
OnPurchaseCompleted (static) | UnityEvent<ProductRecord, PurchaseResponse> | อีเวนต์ที่ถูกทริกเกอร์เมื่อซื้อสินค้าภายใน World สำเร็จ สามารถเพิ่ม listener ได้ โดยจะได้รับอินสแตนซ์ ProductRecord (ข้อมูลสินค้าที่ซื้อ) และ PurchaseResponse (ข้อมูลผลการซื้อ) เป็นอาร์กิวเมนต์ |
OnPurchaseFailed (static) | UnityEvent<ProductRecord, ProductBaseResponse> | อีเวนต์ที่ถูกทริกเกอร์เมื่อซื้อสินค้าภายใน World ไม่สำเร็จ สามารถเพิ่ม listener ได้ โดยจะได้รับอินสแตนซ์ ProductRecord (ข้อมูลสินค้าที่พยายามซื้อ) และ PurchaseResponse (ข้อมูลผลการซื้อที่ไม่สำเร็จ) เป็นอาร์กิวเมนต์ |
เมธอด
GetProductsAsync
static GetProductsAsync(productIds: string[]) → BaseRequest<ProductListResponse>
เมธอดแบบอะซิงโครนัสนี้ใช้ดึงรายการสินค้าภายใน World ตาม ID สินค้าที่ให้มา
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
productIds | string[] | ID ของสินค้าหลายรายการที่จะดึง |
ค่าที่คืนกลับ: BaseRequest<ProductListResponse> — อ็อบเจกต์ BaseRequest เมื่อกระบวนการแบบอะซิงโครนัสเสร็จสิ้น คุณจะสามารถเข้าถึงอ็อบเจกต์ ProductListResponse ได้ผ่านพร็อพเพอร์ตี้ responseData
GetProductAsync
static GetProductAsync(productId: string) → BaseRequest<ProductResponse>
เมธอดแบบอะซิงโครนัสนี้ใช้ดึงข้อมูลสินค้าภายใน World ตาม ID สินค้าที่ให้มา
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
productId | string | ID ของสินค้าที่จะดึง |
ค่าที่คืนกลับ: BaseRequest<ProductResponse> — อ็อบเจกต์ BaseRequest เมื่อกระบวนการแบบอะซิงโครนัสเสร็จสิ้น คุณจะสามารถเข้าถึงอ็อบเจกต์ ProductResponse ได้ผ่านพร็อพเพอร์ตี้ responseData
PurchaseProductAsync
static PurchaseProductAsync(product: ProductRecord, reason?: string) → BaseRequest<PurchaseResponse>
เมธอดแบบอะซิงโครนัสนี้ใช้ทำการซื้อสินค้าภายใน World ตามข้อมูลสินค้าที่ให้มา
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
product | อินสแตนซ์ ProductRecord ของสินค้าที่จะซื้อ | |
reason (ไม่บังคับ) | string | คำอธิบายสำหรับการซื้อ |
ค่าที่คืนกลับ: BaseRequest<PurchaseResponse> — อ็อบเจกต์ BaseRequest เมื่อกระบวนการแบบอะซิงโครนัสเสร็จสิ้น คุณจะสามารถเข้าถึงอ็อบเจกต์ PurchaseResponse ได้ผ่านพร็อพเพอร์ตี้ responseData
PurchaseProductAsync
static PurchaseProductAsync(productId: string, reason?: string) → BaseRequest<PurchaseResponse>
เมธอดแบบอะซิงโครนัสนี้ใช้ทำการซื้อสินค้าภายใน World ตาม ID สินค้าที่ให้มา
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
productId | string | ID ของสินค้าที่จะซื้อ |
reason (ไม่บังคับ) | string | คำอธิบายสำหรับการซื้อ |
ค่าที่คืนกลับ: BaseRequest<PurchaseResponse> — อ็อบเจกต์ BaseRequest เมื่อกระบวนการแบบอะซิงโครนัสเสร็จสิ้น คุณจะสามารถเข้าถึงอ็อบเจกต์ PurchaseResponse ได้ผ่านพร็อพเพอร์ตี้ responseData
GetCurrenciesAsync
static GetCurrenciesAsync() → BaseRequest<CurrencyListResponse>
เมธอดแบบอะซิงโครนัสสำหรับดึงรายการสกุลเงิน เมื่อดำเนินการเสร็จสิ้น จะได้รายการสกุลเงิน และคุณสามารถเข้าถึงอ็อบเจกต์ CurrencyListResponse ได้ผ่านพร็อพเพอร์ตี้ responseData
ค่าที่คืนกลับ: BaseRequest<CurrencyListResponse>
GetCurrencyAsync
static GetCurrencyAsync(currencyId: string) → BaseRequest<CurrencyResponse>
เมธอดแบบอะซิงโครนัสนี้ใช้ดึงข้อมูลสกุลเงินภายใน World ตาม ID สินค้าที่ให้มา
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
currencyId | string | ID ของสกุลเงินที่จะดึง |
ค่าที่คืนกลับ: BaseRequest<CurrencyResponse> — อ็อบเจกต์ BaseRequest เมื่อกระบวนการแบบอะซิงโครนัสเสร็จสิ้น คุณจะสามารถเข้าถึงอ็อบเจกต์ CurrencyResponse ได้ผ่านพร็อพเพอร์ตี้ responseData
OpenPurchaseUI
static OpenPurchaseUI(product: ProductRecord) → void
เมธอดนี้ใช้เปิด UI การซื้อสินค้าภายใน World
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
product | อินสแตนซ์ ProductRecord ของสินค้าที่จะซื้อ |
ProductPurchaseButton
class
คลาสที่จัดการฟังก์ชันการทำงานของปุ่มซื้อสินค้าภายใน World
พร็อพเพอร์ตี้
ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
productId | string | รับ ID ของสินค้าภายใน World ที่พร้อมให้ซื้อ |
product | ดึงข้อมูลสินค้าภายใน World ที่เชื่อมโยงกับ productId |
เมธอด
SetProductId
SetProductId(productId: string) → void
กำหนด ID ของสินค้าภายใน World ที่สามารถซื้อได้ผ่านปุ่มนี้
พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
productId | string | ID ของสินค้า |
ProductError
enum
รหัสข้อผิดพลาดที่ระบุสาเหตุความล้มเหลวของคำขอที่เกี่ยวข้องกับสินค้า
ชื่อ | ค่า | คำอธิบาย |
|---|---|---|
Unknown | -1 | ข้อผิดพลาด: ข้อผิดพลาดที่ไม่ทราบสาเหตุ |
NetworkError | 0 | ข้อผิดพลาด: ข้อผิดพลาดที่เกี่ยวข้องกับปัญหาเครือข่าย รวมถึงการหลุดการเชื่อมต่อหรือการเชื่อมต่อที่ไม่เสถียร |
UserCanceled | 1 | ข้อผิดพลาด: คำขอถูกยกเลิกโดยผู้ใช้ |
ProductRefreshResponseError | 2 | ข้อผิดพลาด: เมตาดาต้าของสินค้าในคำขอไม่ถูกต้อง |
ItemPackageProductsResponseError | 3 | ข้อผิดพลาด: ไม่สามารถดึงข้อมูลไอเทมหนึ่งรายการหรือมากกว่าในแพ็กเกจสินค้าประเภทไอเทมได้ |
IAPCardError | 4 | ข้อผิดพลาด: ไม่สามารถดึงข้อมูลสกุลเงินหนึ่งรายการหรือมากกว่าในแพ็กเกจสินค้าประเภทสกุลเงินได้ |
ProductPriceChanged | 4001 | ข้อผิดพลาด: ราคาสินค้าไม่ตรงกัน |
ProductAlreadyPurchased | 4002 | ข้อผิดพลาด: สินค้านี้ถูกซื้อไปแล้ว |
BalanceOfficialCurrencyNotEnough | 4003 | ข้อผิดพลาด: ยอดคงเหลือสกุลเงินทางการของ ZEPETO (ZEM) ไม่เพียงพอสำหรับการซื้อ |
BalanceUserCurrencyNotEnough | 4004 | ข้อผิดพลาด: ยอดคงเหลือสกุลเงินภายใน World ไม่เพียงพอสำหรับการซื้อ |
ProductNotActive | 4005 | ข้อผิดพลาด: สินค้าไม่ได้อยู่ในสถานะใช้งาน |
InvalidCreator | 4006 | ข้อผิดพลาด: ID ผู้ใช้ของผู้เล่นไม่ตรงกับ ID ผู้ใช้ของผู้สร้าง World ข้อผิดพลาดนี้เกิดขึ้นเฉพาะในสภาพแวดล้อมสำหรับการพัฒนาที่ใช้ Unity editor เท่านั้น |
OfficialCurrencyBalanceRequest
class · extends BaseRequest<BalanceResponse>
แทนคำขอแบบอะซิงโครนัสสำหรับดึงยอดคงเหลือของสกุลเงินทางการของ ZEPETO (ZEM)