เอกสาร Steamworks
QueryRefundAllowed/v0001
นี่จะถูกเรียกโดย Steam เวลาที่ผู้ใช้เข้าไปที่เว็บไซต์ช่วยเหลือ และพยายามหาข้อมูลเพิ่มเติมเกี่ยวกับการสั่งซื้อในเกม การตอบสนองจะรวมถึงสถานะปัจจุบันของไอเท็มดังกล่าวที่เกี่ยวข้องกับการสั่งซื้อ และข้อมูลว่าขณะนี้สามารถขอคืนเงินสำหรับแต่ละไอเท็มได้หรือไม่

ถูกเรียกโดย: การขอรับเงินคืนบน Steam

เมธอด HTTP: GET

พารามิเตอร์:

ชื่อประเภทที่ต้องการคำอธิบาย
keystringนี่คือ "คีย์เซิร์ฟเวอร์ทรัพยากรy" ที่คุณจัดไว้ให้ในการตั้งค่าระบบเศรษฐกิจของ Steam สำหรับแอปของคุณบนเว็บไซต์พันธมิตร
appiduint32ไอดีแอปประเภท 32 บิตของแอปพลิเคชันที่เกี่ยวข้องกับการสั่งซื้อนั้น ๆ ค่านี้จะเป็นไอดีแอปสำหรับเกมของคุณ
steamiduint64ไอดี Steam ประเภท 64 บิตของผู้ใช้ที่ดำเนินการสั่งซื้อ
languagestringรหัสภาษาประเภท ISO639-1 พร้อมด้วยรหัสประเทศประเภท ISO 3166-1 alpha 2 ของภาษาที่จะส่งค่าสตริงกลับคืน
ยกตัวอย่างเช่น: en_US, de_DE, zh_CN, และ ko_KR ค่าเริ่มต้น: en_US
orderiduint64ไอดีประเภท 64 บิตที่เป็นเอกลักษณ์สำหรับคำสั่งซื้อ นี่เป็น Order ID เดียวกันกับที่ได้มอบให้แก่เราในการเรียก ISteamMicroTxn/InitTxn

คืนค่า

เอาต์พุตจากเมธอดนี้ควรถูกเข้ารหัสไว้ในรูปแบบของ JSON

คำตอบ:
  • result
    • success - True หากเมธอดประสบความสำเร็จ หากเซิร์ฟเวอร์ Asset คืนค่า false กลับมา ก็จะตั้งค่า error เป็นสตริงเพื่ออธิบายเหตุผลว่าเกิดอะไรขึ้น
    • error - สตริงอธิบายสาเหตุที่การเรียกนี้ล้มเหลว ข้อความดังกล่าวจะถูกบันทึกไว้ในรายการบันทึกความผิดพลาด ซึ่งจะสามารถใช้งานได้ใน แท็บระบบเศรษฐกิจ ในเว็บไซต์ของ Steamworks
    • assets - อาร์เรย์ของแต่ละรายการที่ได้สั่งซื้อไป
      • itemtypeid - หมายเลข Game ID ของไอเท็ม นี่คือ itemid ที่ได้รับมาจากการเรียก ISteamMicroTxn/InitTxn
      • allow_refund - จะต้องมีค่าเป็น true ยกเว้นว่าไอเท็มที่สั่งซื้อไปนั้นได้ถูกใช้ไปแล้ว ถูกดัดแปลงแก้ไข หรือถูกโอนถ่ายไปให้ผู้อื่นแล้ว
      • in_inventory - หากผู้ใช้ที่ดำเนินการสั่งซื้อยังเป็นเจ้าของไอเท็มดังกล่าวอยู่ ก็จะมีค่าเป็น true
      • bundle - หากไอเท็มที่ผู้ใช้ได้สั่งซื้อมานั้นเป็นไอเท็มที่อยู่ในชุดรวมที่มีไอเท็มอื่นอยู่ ให้ตั้งค่านี้เป็น true แล้วจากนั้นให้บรรจุไอเท็มที่มาจากชุดรวมนั้นให้เป็นรายการข้อมูลถัดไปในอาร์เรย์ assets
      • current_state - สตริงที่เขียนเป็นภาษามนุษย์ ระบุสถานะปัจจุบันของไอเท็มชิ้นดังกล่าว จะแสดงสตริงนี้ให้ผู้ใช้เห็น และถ้าหากเป็นไปได้ก็ควรแปลด้วย และยิ่งมีความชัดเจนมากเท่าไหร่ก็ยิ่งดีเท่านั้น โดยเฉพาะเวลาที่ allow_refundมีค่าเป็น false ซึ่งสามารถจะใส่เป็นอะไรก็ได้อย่างเช่น "ไอเท็มชิ้นดังกล่าวนี้ถูกใช้เพื่อประดิษฐ์ไอเท็มอื่นไปแล้วในวันที่ 25 มีนาคม 2015" หรือ "ไอเท็มชิ้นดังกล่าวอยู่ในช่องเก็บของของคุณ"
      • item_name - ชื่อของไอเท็ม จะแสดงสตริงนี้ให้ผู้ใช้เห็น และถ้าหากเป็นไปได้ก็ควรแปลด้วย
      • amount - จำนวนของไอเท็มชิ้นนี้ที่ถูกสั่งซื้อไป ไอเท็มทุกชิ้นจะต้องมี id ที่เหมือนกัน (จะไม่มีความจำเป็นต้องใช้ หากเกมของคุณไม่ให้การรองรับ API ระบบเศรษฐกิจของ Steam) หากมีการสั่งซื้อหลายไอเท็ม แต่มีค่า id แตกต่างกัน ก็ให้รวมรายการต่าง ๆ เข้าด้วยกันในอาร์เรย์ ทรัพยากร แทนที่จะใช้ช่องข้อมูลจำนวนนี้

        หมายเหตุ: ช่องข้อมูลต่อไปนี้ใช้เฉพาะในกรณีที่เกมของคุณรองรับ API ระบบเศรษฐกิจของเราบน Steam เท่านั้น
      • id - assetid หรือ currencyid ของไอเท็มที่ได้มอบให้แก่ผู้ใช้
      • contextid - contextid ที่กำหนดให้ไอเท็ม
      • currency - True ถ้า id อ้างถึง currencyid
      • class - อาร์เรย์ของตัวระบุคลาสของ Asset ที่ได้นิยามค่าเอาไว้ตามเกม ซึ่งควรมีคลาสเดียวกันกับที่ จะส่งคืนค่ามาให้ 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 } }