ZEPETO.Module.Shop
型 | 説明 |
|---|---|
ShopService は、World 内の ZEPETO ショップに関連する操作を可能にします。 このサービスにより、プレイヤーは所有アイテムやウィッシュリストのアイテムのサムネイル画像などのショップ情報にアクセスしたり、他のプレイヤーにギフトを送ったりできます。 | |
CategoryResponse クラスは、API 呼び出しの結果と、ZEPETO ショップのアイテムカテゴリー情報を提供します。 | |
ContentItemListResponse クラスは、API 呼び出しの結果と、取得したアイテムリストを提供します。 | |
アイテムカテゴリー。 | |
ContentItemResponse クラスは、API 呼び出しの結果と、アイテム情報を提供します。 | |
ギフト通知ポップアップに使用する背景タイプ。 | |
ItemGiftResponse クラスは、アイテムギフトの結果を提供します。 | |
ZEPETO ショップのアイテムカテゴリー情報。 | |
アイテムカテゴリー。 | |
enum |
ShopService
class
ShopService は、World 内の ZEPETO ショップに関連する操作を可能にします。 このサービスにより、プレイヤーは所有アイテムやウィッシュリストのアイテムのサムネイル画像などのショップ情報にアクセスしたり、他のプレイヤーにギフトを送ったりできます。
メソッド
DownloadItemThumbnail
static DownloadItemThumbnail(itemCode: string) → BaseRequest<TextureResponse>
アイテムのサムネイルを非同期で取得するメソッドです。
パラメーター | 型 | 説明 |
|---|---|---|
itemCode | string | アイテムコード |
戻り値: BaseRequest<TextureResponse> — BaseRequest オブジェクト。非同期処理が完了すると、responseData プロパティから TextureResponse オブジェクトにアクセスできます。
GetMyCategoryAsync
static GetMyCategoryAsync() → BaseRequest<CategoryResponse>
このメソッドは、ローカルプレイヤーのユーザーアカウントの ZEPETO ショップインベントリからアイテムカテゴリー情報を取得します。
戻り値: BaseRequest<CategoryResponse> — BaseRequest オブジェクト。非同期処理が完了すると、responseData プロパティから CategoryResponse オブジェクトにアクセスできます。
GetMyContentItemListAsync
static GetMyContentItemListAsync(itemKeyword: ItemKeyword, pageToken?: string) → BaseRequest<ContentItemListResponse>
アイテムカテゴリーごとのアイテムリストを非同期で取得するメソッドです。
パラメーター | 型 | 説明 |
|---|---|---|
itemKeyword | アイテムカテゴリー。 | |
pageToken (省略可能) | string | ページトークン。このメソッドを初めて呼び出す場合は、このパラメーターに null を指定します。 |
戻り値: BaseRequest<ContentItemListResponse> — BaseRequest オブジェクト。非同期処理が完了すると、responseData プロパティから ContentItemListResponse オブジェクトにアクセスできます。
GetContentItemAsync
static GetContentItemAsync(itemId: string) → BaseRequest<ContentItemResponse>
アイテム情報を非同期で取得するメソッドです。
パラメーター | 型 | 説明 |
|---|---|---|
itemId | string | アイテムコード。 |
戻り値: BaseRequest<ContentItemResponse> — BaseRequest オブジェクト。非同期処理が完了すると、responseData プロパティから ContentItemResponse オブジェクトにアクセスできます。
GetMyWishContentItemListAsync
static GetMyWishContentItemListAsync() → BaseRequest<ContentItemListResponse>
ローカルプレイヤーのユーザーアカウントの ZEPETO ショップウィッシュリストからアイテムリストを非同期で取得するメソッドです。
戻り値: BaseRequest<ContentItemListResponse> — BaseRequest オブジェクト。非同期処理が完了すると、responseData プロパティから ContentItemListResponse オブジェクトにアクセスできます。
CategoryResponse
class · extends BaseResponse
CategoryResponse クラスは、API 呼び出しの結果と、ZEPETO ショップのアイテムカテゴリー情報を提供します。
プロパティ
名前 | 型 | 説明 |
|---|---|---|
category | ZEPETO ショップのアイテムカテゴリー情報。 |
ContentItemListResponse
class · extends PlayBaasResponse
ContentItemListResponse クラスは、API 呼び出しの結果と、取得したアイテムリストを提供します。
プロパティ
名前 | 型 | 説明 |
|---|---|---|
items | Item[] | アイテムリスト。 |
nextPageToken | string | 項目が多数存在する場合、レスポンスに nextPageToken が含まれ、続きのアイテムリストを取得できます。残りの項目がない場合、nextPageToken は null になります。 |
ItemKeyword
enum
アイテムカテゴリー。
名前 | 値 |
|---|---|
all | 0 |
hair | 1 |
onepiece | 2 |
top | 3 |
outwear | 4 |
pants | 5 |
skirt | 6 |
socks | 7 |
footwear | 8 |
headwear | 9 |
eyewear | 10 |
jewelry | 11 |
makeup | 12 |
accessory | 13 |
bodyfigure | 14 |
animal | 15 |
none | 16 |
ContentItemResponse
class · extends PlayBaasResponse
ContentItemResponse クラスは、API 呼び出しの結果と、アイテム情報を提供します。
プロパティ
名前 | 型 | 説明 |
|---|---|---|
item | Item | アイテム。 |
GiftBackgroundType
enum
ギフト通知ポップアップに使用する背景タイプ。
名前 | 値 |
|---|---|
Type01 | 1 |
Type02 | 2 |
Type03 | 3 |
Type04 | 4 |
ItemGiftResponse
class · extends PurchaseBaseResponse
ItemGiftResponse クラスは、アイテムギフトの結果を提供します。
プロパティ
名前 | 型 | 説明 |
|---|---|---|
zem | number | ギフト送信完了後の、ローカルプレイヤーのユーザーアカウントに残っている ZEM 残高。 |
coin | number | ギフト送信完了後の、ローカルプレイヤーのユーザーアカウントに残っているコイン残高。 |
CategoryInfo
class
ZEPETO ショップのアイテムカテゴリー情報。
プロパティ
名前 | 型 | 説明 |
|---|---|---|
displayName | string | ショップインベントリタブのローカライズ済み表示名。 |
categories | インベントリタブ配下のアイテムカテゴリーリスト。 |
Category
class
アイテムカテゴリー。
プロパティ
名前 | 型 | 説明 |
|---|---|---|
displayName | string | アイテムカテゴリーのローカライズ済み表示名。 |
keyword | アイテムカテゴリーを表す列挙型。 |
ItemRequestType
enum
名前 | 値 |
|---|---|
Purchase | 0 |
Gift | 1 |