QueryRefundAllowed/v0001 （Steamworks 文獻庫）

Steamworks 文獻庫

QueryRefundAllowed/v0001

Steamworks 文獻庫 > 功能 > Steam 物品庫服務 > Steam 經濟體 > QueryRefundAllowed/v0001

這是當使用者在客服網站中希望取得更多有關一項遊戲內購買的資訊時，由 Steam 呼叫的函式。回應中包含一筆購買中所有物品目前的狀態，以及每款物品目前是否可退款的資訊。

呼叫方： Steam 退款

HTTP 方法： GET

參數：

名稱	型別	必要	說明
key	string	✔	此為在夥伴網站上，您在您應用程式的 Steam 經濟設定中提供的「資產伺服器金鑰」。
appid	uint32	✔	與購買關聯的應用程式的 32 位元 App ID。此為您遊戲的 App ID。
steamid	uint64	✔	購買者的 64 位元 Steam ID。
language	string	✔	指定傳回字串使用的 ISO639-1 語言碼加上 ISO 3166-1 alpha 2 國家碼。部分範例為：en_US、de_DE、zh_CN，和 ko_KR。預設：en_US。
orderid	uint64	✔	獨特的 64 位元訂單 ID。這與我們從 ISteamMicroTxn/InitTxn 呼叫得到的訂單 ID 是相同的。

傳回

此方法的輸出應以 JSON 格式編碼。

回應：

result
- success - 若方法成功，則為 True。如果資產伺服器傳回 False，則會將 error 設為說明其原因的字串。
- error - 說明呼叫失敗原因的字串。此訊息將儲存於錯誤紀錄中。錯誤紀錄位於 Steamworks 網站中的「經濟」分頁之下。
- assets - 已購買資產的陣列。
  - itemtypeid - 物品的遊戲 ID。此為我們從 ISteamMicroTxn/InitTxn 呼叫得到的 itemid 值。
  - allow_refund - 除非物品已被消耗、修改，或轉移，否則必須為 True。
  - in_inventory - 如果購買者仍擁有該物品，則為 True。
  - bundle - 如果使用者購買的物品其實為含有多項物品的組合包，將此設為 True，然後將組合包中其他物品列為 assets 陣列的下一項項目。
  - current_state - 人類可理解的物品目前狀態的字串。此字串會向使用者顯示，應盡可能在地化。內容越具體越好，尤其是 allow_refund 為 False 時。可以為「於 2015 年 3 月 25 日用於合成其他物品」或「在您的物品庫中」。
  - item_name - 物品名稱。此字串會向使用者顯示，應盡可能在地化。
  - amount - 此物品的購買數量。所有物品應有相同的 id（如果您的遊戲不支援 Steam 經濟體 API 則不適用）。如果購買了多個物品，但具不同的 id 值，那麼請將其做成多個項目加入 assets 陣列中，而非使用此 amount 欄位。
    
    備註： 以下欄位僅在您遊戲支援我們的 Steam 經濟體 API 時適用。
  - id - 給予使用者的物品的 currencyid 或 assetid。
  - contextid - 物品所在的 contextid。
  - currency - 如果 id 參考 currencyid，則為 True。
  - class - 遊戲定義的一組資產類別識別碼陣列。這應與 GetAssetClass/v0001 傳回的類別相同。

輸出範例

{ "result": { "assets": [ { "itemtypeid": 594, "contextid": 2, "currency": false, "amount": 1, "id": 3837860447, "class": [ { "name": "def_index", "value": "594" }, { "name": "flags", "value": "16" }, { "name": "origin", "value": "2", "instance": true }, { "name": "@tradable after date", "value": "1434493482", "instance": true } ] , "allow_refund": true, "in_inventory": true, "bundle": false, "current_state": "In your inventory", "item_name": "The Phlogistinator" }, { "itemtypeid": 214, "contextid": 2, "currency": false, "amount": 1, "id": 3837860448, "class": [ { "name": "def_index", "value": "214" }, { "name": "flags", "value": "16" }, { "name": "origin", "value": "2", "instance": true }, { "name": "@tradable after date", "value": "1434493482", "instance": true } ] , "allow_refund": true, "in_inventory": true, "bundle": false, "current_state": "In your inventory", "item_name": "The Powerjack" } ] , "success": true } }