ZEPETO.Product

型 説明 baseresponse /#baseresponse レスポンスクラスの基底クラス。 baserequest /#baserequest レスポンスデータとしてジェネリック型 tresponse を受け取る baserequest クラス。 productlistresponse /#productlistresponse productlistresponse クラスは、api 呼び出しの結果と、取得した商品情報のリストを提供します。 productbaseresponse /#productbaseresponse 商品関連のレスポンスクラスの基底クラス。 productresponse /#productresponse productresponse クラスは、api 呼び出しの結果と、取得した商品情報を提供します。 purchaseresponse /#purchaseresponse productresponse クラスは、api 呼び出しの結果と、購入情報を提供します。 currencylistresponse /#currencylistresponse currencylistresponse クラスは、api 呼び出しの結果と、通貨情報のリストを提供します。 currencyresponse /#currencyresponse currencyresponse クラスは、api 呼び出しの結果と、通貨情報を提供します。 productrecord /#productrecord 商品情報。 currencyrecord /#currencyrecord 通貨情報。 itempackageunitrecord /#itempackageunitrecord アイテム商品パッケージに含まれる個々の商品の詳細。 currencypackageunitrecord /#currencypackageunitrecord 通貨商品パッケージに含まれる個々の通貨の詳細。 producttype /#producttype 商品タイプを表す列挙型。 purchasetype /#purchasetype 商品の購入タイプを表す列挙型。 productstatus /#productstatus 商品の状態を表す列挙型。 currencytype /#currencytype 通貨の種類を表す列挙型。 productservice /#productservice productservice は、world 内商品に関連する操作を管理します。 このサービスを通じて、プレイヤーは world 内商品の情報にアクセスし、購入を行うことができます。 productpurchasebutton /#productpurchasebutton world 内商品の購入ボタンの機能を管理するクラス。 producterror /#producterror 商品関連のリクエストが失敗した理由を示すエラーコード。 officialcurrencybalancerequest /#officialcurrencybalancerequest zepeto の公式通貨 (zem) の残高を取得するための非同期リクエストを表します。 baseresponse class レスポンスクラスの基底クラス。 プロパティ 名前 型 説明 issuccess boolean リクエストの成功状態を表します。正常に完了した場合は true が設定されます。 message string リクエストの結果を説明します。 baserequest class · extends baseapirequest レスポンスデータとしてジェネリック型 tresponse を受け取る baserequest クラス。 プロパティ 名前 型 説明 responsedata tresponse ジェネリック型 tresponse のレスポンスデータ。 productlistresponse class · extends productbaseresponse /#productbaseresponse productlistresponse クラスは、api 呼び出しの結果と、取得した商品情報のリストを提供します。 プロパティ 名前 型 説明 products productrecord\[] /#productrecord 商品情報のリスト。 productbaseresponse class · extends baseresponse /#baseresponse 商品関連のレスポンスクラスの基底クラス。 プロパティ 名前 型 説明 errorcode producterror /#producterror 失敗した商品リクエストのエラーコードを取得します。 productresponse class · extends productbaseresponse /#productbaseresponse productresponse クラスは、api 呼び出しの結果と、取得した商品情報を提供します。 プロパティ 名前 型 説明 product productrecord /#productrecord 商品情報。 purchaseresponse class · extends productbaseresponse /#productbaseresponse productresponse クラスは、api 呼び出しの結果と、購入情報を提供します。 プロパティ 名前 型 説明 userid string 購入を行ったプレイヤーのユーザー id。 productid string 購入した world 内商品の id。 price number 購入した world 内商品の価格。 receiptid string 購入のレシート id。 purchasedat date world 内商品を購入した日時。 currencylistresponse class · extends productbaseresponse /#productbaseresponse currencylistresponse クラスは、api 呼び出しの結果と、通貨情報のリストを提供します。 プロパティ 名前 型 説明 currencies currencyrecord\[] /#currencyrecord 通貨情報のリスト。 currencyresponse class · extends productbaseresponse /#productbaseresponse currencyresponse クラスは、api 呼び出しの結果と、通貨情報を提供します。 プロパティ 名前 型 説明 currency currencyrecord /#currencyrecord 通貨情報。 productrecord class 商品情報。 プロパティ 名前 型 説明 productid string 商品の id。 name string 商品名。 price number 商品の価格。 ispurchased boolean ユーザーがその商品を購入済みかどうかを示します。非消費型商品にのみ適用されます。 itempackageunits itempackageunitrecord\[] /#itempackageunitrecord producttype が itempackage の場合、商品に含まれるアイテム。 currencypackageunits currencypackageunitrecord\[] /#currencypackageunitrecord producttype が currencypackage の場合、商品に含まれる通貨。 producttype producttype /#producttype 商品の producttype を返します。 purchasetype purchasetype /#purchasetype 商品の purchasetype を返します。 productstatus productstatus /#productstatus 商品の productstatus を返します。 currencytype currencytype /#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 商品タイプを表す列挙型。 名前 値 説明 item 0 単一アイテムの商品。 itempackage 1 複数のアイテムを含むアイテム商品パッケージ。 currencypackage 2 複数の通貨を含む通貨商品パッケージ。 purchasetype enum 商品の購入タイプを表す列挙型。 名前 値 説明 consumable 0 消費型商品。 nonconsumable 1 非消費型商品。 productstatus enum 商品の状態を表す列挙型。 名前 値 説明 active 0 有効な状態。 inactive 1 無効な状態。 forbidden 2 利用期間の満了により禁止された状態。 currencytype enum 通貨の種類を表す列挙型。 名前 値 説明 officialcurrency 0 zepeto の公式通貨 (zem) usercurrency 1 world 内通貨。 productservice class productservice は、world 内商品に関連する操作を管理します。 このサービスを通じて、プレイヤーは world 内商品の情報にアクセスし、購入を行うことができます。 イベント 名前 型 説明 onpurchasecompleted (static) unityevent\<productrecord, purchaseresponse> world 内商品の購入が成功したときに発生するイベント。リスナーを追加でき、 productrecord （購入した商品の情報）と purchaseresponse （購入結果の情報）のインスタンスが引数として渡されます。 onpurchasefailed (static) unityevent\<productrecord, productbaseresponse> world 内商品の購入が失敗したときに発生するイベント。リスナーを追加でき、 productrecord （購入を試みた商品の情報）と purchaseresponse （失敗した購入結果の情報）のインスタンスが引数として渡されます。 メソッド getproductsasync static getproductsasync(productids string\[]) → baserequest\<productlistresponse> 指定された商品 id に基づいて、world 内商品のリストを非同期で取得するメソッドです。 パラメーター 型 説明 productids string\[] 取得する複数の商品の id。 戻り値 baserequest\<productlistresponse> /#baserequest — baserequest オブジェクト。非同期処理が完了すると、 responsedata プロパティから productlistresponse オブジェクトにアクセスできます。 getproductasync static getproductasync(productid string) → baserequest\<productresponse> 指定された商品 id に基づいて、world 内商品の情報を非同期で取得するメソッドです。 パラメーター 型 説明 productid string 取得する商品の id。 戻り値 baserequest\<productresponse> /#baserequest — baserequest オブジェクト。非同期処理が完了すると、 responsedata プロパティから productresponse オブジェクトにアクセスできます。 purchaseproductasync static purchaseproductasync(product productrecord, reason? string) → baserequest\<purchaseresponse> 指定された商品情報に基づいて、world 内商品の購入を非同期で行うメソッドです。 パラメーター 型 説明 product productrecord /#productrecord 購入する商品の productrecord インスタンス。 reason (省略可能) string 購入の説明。 戻り値 baserequest\<purchaseresponse> /#baserequest — baserequest オブジェクト。非同期処理が完了すると、 responsedata プロパティから purchaseresponse オブジェクトにアクセスできます。 purchaseproductasync static purchaseproductasync(productid string, reason? string) → baserequest\<purchaseresponse> 指定された商品 id に基づいて、world 内商品の購入を非同期で行うメソッドです。 パラメーター 型 説明 productid string 購入する商品の id。 reason (省略可能) string 購入の説明。 戻り値 baserequest\<purchaseresponse> /#baserequest — baserequest オブジェクト。非同期処理が完了すると、 responsedata プロパティから purchaseresponse オブジェクトにアクセスできます。 getcurrenciesasync static getcurrenciesasync() → baserequest\<currencylistresponse> 通貨のリストを取得する非同期メソッドです。 処理が完了すると通貨のリストが得られ、 responsedata プロパティから currencylistresponse オブジェクトにアクセスできます。 戻り値 baserequest\<currencylistresponse> /#baserequest getcurrencyasync static getcurrencyasync(currencyid string) → baserequest\<currencyresponse> 指定された商品 id に基づいて、world 内通貨の情報を非同期で取得するメソッドです。 パラメーター 型 説明 currencyid string 取得する通貨の id。 戻り値 baserequest\<currencyresponse> /#baserequest — baserequest オブジェクト。非同期処理が完了すると、 responsedata プロパティから currencyresponse オブジェクトにアクセスできます。 openpurchaseui static openpurchaseui(product productrecord) → void このメソッドは、world 内商品の購入 ui を開きます。 パラメーター 型 説明 product productrecord /#productrecord 購入する商品の productrecord インスタンス。 productpurchasebutton class world 内商品の購入ボタンの機能を管理するクラス。 プロパティ 名前 型 説明 productid string 購入可能な world 内商品の id を取得します。 product productrecord /#productrecord productid に紐づく world 内商品の情報を取得します。 メソッド setproductid setproductid(productid string) → void このボタンで購入できる world 内商品の id を設定します。 パラメーター 型 説明 productid string 商品の id。 producterror enum 商品関連のリクエストが失敗した理由を示すエラーコード。 名前 値 説明 unknown 1 エラー 不明なエラー。 networkerror 0 エラー 接続の切断や不安定な接続など、ネットワークに関連するエラー。 usercanceled 1 エラー リクエストがユーザーによってキャンセルされました。 productrefreshresponseerror 2 エラー リクエスト内の商品メタデータが無効です。 itempackageproductsresponseerror 3 エラー アイテム商品パッケージ内の 1 つ以上のアイテム情報の取得に失敗しました。 iapcarderror 4 エラー 通貨商品パッケージ内の 1 つ以上の通貨情報の取得に失敗しました。 productpricechanged 4001 エラー 商品の価格が一致しません。 productalreadypurchased 4002 エラー 商品はすでに購入済みです。 balanceofficialcurrencynotenough 4003 エラー 購入に必要な zepeto の公式通貨 (zem) の残高が不足しています。 balanceusercurrencynotenough 4004 エラー 購入に必要な world 内通貨の残高が不足しています。 productnotactive 4005 エラー 商品が有効ではありません。 invalidcreator 4006 エラー プレイヤーのユーザー id が world クリエイターのユーザー id と異なります。このエラーは unity エディターを使用する開発環境でのみ発生します。 officialcurrencybalancerequest class · extends baserequest\<balanceresponse> /#baserequest zepeto の公式通貨 (zem) の残高を取得するための非同期リクエストを表します。