เอกสาร แหล่งข้อมูล ข่าวสารและอัปเดต ฝ่ายสนับสนุน
ภาษา
เอกสาร Steamworks
GetContexts/v0001
เอกสาร Steamworks > คุณสมบัติ > การบริการช่องเก็บของ Steam > ระบบเศรษฐกิจของ Steam > GetContexts/v0001
จะคืนค่าบริบท (context) ที่มีอยู่แล้ว ให้แก่ผู้ใช้ที่ระบุ

ถูกเรียกโดย: Support Tool, Trading UI, Inventory UI

เมธอด HTTP: GET

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

ชื่อประเภทที่ต้องการคำอธิบาย
keystring✔นี่คือ "คีย์เซิร์ฟเวอร์ทรัพยากรy" ที่คุณจัดไว้ให้ในการตั้งค่าระบบเศรษฐกิจของ Steam สำหรับแอปของคุณบนเว็บไซต์พันธมิตร
appiduint32✔ไอดีแอปประเภท 32 บิตของแอปพลิเคชันที่เกี่ยวข้องกับบริบทนั้น
steamiduint64✔ไอดี Steam ประเภท 64 บิตของผู้ใช้ที่จะคืนค่าบริบทกลับไปให้
parentuint64✔ไอดีประเภท 64 บิตของบริบทตัวแม่ (parent context) ที่จะคืนค่าลูก (children) กลับไปให้ หากพารามิเตอร์นี้มีค่าเป็น 0 ก็จะคืนค่าบริบทระดับรูทกลับมาให้
categorystring✔"history" หรือ "assets" หากถูกเรียกจากเครื่องมือสนับสนุน หากเรียกคำสั่งนี้จาก UI ของการแลกเปลี่ยนหรือช่องเก็บของ ค่าของหมวดหมู่ก็จะเป็น "trading" ซึ่งจะเป็นประโยชน์ หากคุณมีบริบทที่จะให้ความหมายเฉพาะเมื่อปรากฏขึ้นในบางหมวดหมู่เท่านั้น นอกจากนั้น ยังเป็นไปได้ว่าคำสั่งบริบทบางคำสั่งจะให้ความหมายเฉพาะเมื่ออยู่ในบางหมวดหมู่เท่านั้น ดังนั้นคุณจึงสามารถกรองได้ว่าคุณส่งคำสั่งใดบ้าง โดยอาศัยหมวดหมู่ หากคุณไม่รองรับการใช้งาน API สำหรับเครื่องมือสนับสนุน คุณก็สามารถปฏิบัติต่อหมวดหมู่ทั้งหมดในลักษณะเดียวกันได้
commandsbool✔ค่าเป็น True หากคำสั่งบริบทควรรวมอยู่ในเอาต์พุต
languagestring✔รหัสภาษาประเภท ISO639-1 พร้อมด้วยรหัสประเทศประเภท ISO 3166-1 alpha 2 ของภาษาที่จะส่งค่าสตริงกลับคืน ยกตัวอย่างเช่น en_US, de_DE, zh_CN และ ko_KR ค่าเริ่มต้น: en_US

คืนค่า

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

คำตอบ:
  • result
    • success - True หากเมธอดประสบความสำเร็จ หากเซิร์ฟเวอร์ Asset คืนค่า false กลับมา ก็จะตั้งค่า error เป็นสตริงเพื่ออธิบายเหตุผลว่าเกิดอะไรขึ้น
    • error - สตริงอธิบายสาเหตุที่การเรียกนี้ล้มเหลว ข้อความดังกล่าวจะถูกบันทึกไว้ในรายการบันทึกความผิดพลาด ซึ่งจะสามารถใช้งานได้ใน แท็บระบบเศรษฐกิจ ในเว็บไซต์ของ Steamworks
    • contexts - อาร์เรย์ของบริบทที่เป็นลูก (children) ของแม่ (parent) ที่ได้ระบุไว้
      • id - ID ประเภท 64 บิตของบริบทในเกมนี้สำหรับ Steam ID นี้ รับข้อมูลเพิ่มเติมได้ที่ Context ID ของระบบเศรษฐกิจ Steam
      • name - ชื่อของบริบท จะถูกแสดงผลไปให้กับตัวแทนฝ่ายสนับสนุน ถ้า user_facing มีค่าเป็น true ก็จะแสดงผลให้ผู้ใช้ด้วย
      • nested - ถ้าเป็น true การเรียกไปยัง GetContexts ใช้บริบทนี้เป็นแม่ (parent) แล้วคืนรายการบริบทที่ไม่ว่างเปล่ากลับมาให้
      • asset_count - จำนวนของ Asset และสกุลเงินที่ผู้ใช้คนดังกล่าวครอบครองที่อยู่ในบริบทนี้ จำนวนจะถูกแสดงให้แก่ผู้ใช้ และหากว่าบริบทใดมีค่า asset_count เป็นศูนย์ก็จะซ่อนเอาไว้ไม่ให้ผู้ใช้เห็น
      • user_facing - หากว่ามีค่าเป็น true และบริบทมี Asset ก็จะแสดงผลออกมาใน Trade UI และ Inventory UI
      • commands - อาร์เรย์ของคำสั่งที่จะแสดงให้แก่บริบทนี้ในหน้าระบบเศรษฐกิจของเครื่องมือรองรับ กรุณาดูด้านล่างสำหรับข้อมูลเพิ่มเติมเกี่ยวกับคำสั่งเหล่านี้
    • alerts(ตัวเลือกเสริม) - อาร์เรย์ของคำแจ้งเตือนที่จะแสดงให้แก่เกมนี้ใน Trade UI และจะละเว้นโหนดนี้ไว้ในหมวดหมู่ที่ไม่ใช่ "การแลกเปลี่ยน"
      • text - สตริงที่ได้รับการแปลแล้วที่จะแสดงให้แก่เกมนี้ใน Trade UI
      • color(ตัวเลือกเสริม) - รหัสสีเป็นเลขฐาน 16 ของสีที่จะแสดงคำเตือนนี้
    • trade_permissions(ตัวเลือกเสริม) - ระดับสิทธิ์การแลกเปลี่ยนของผู้ใช้นี้ จะต้องมีค่าเป็นค่าใดค่าหนึ่งดังต่อไปนี้ NONE, RECEIVEONLY, SENDONLY, SENDONLY_FULLINVENTORY, หรือ FULL
      ผู้ใช้ที่มีค่าเป็น NONE จะไม่สามารถดำเนินการแลกเปลี่ยนอะไรได้เลยซึ่งรวมถึง Asset จากเกมนี้ด้วย ผู้ใช้ที่มีค่าเป็น RECEIVEONLY จะได้รับอนุญาตให้รับ Asset สำหรับเกมนี้ได้ แต่จะไม่สามารถเพิ่ม Asset ของตัวเองเข้าไปในการแลกเปลี่ยนได้ ผู้ใช้ที่มีค่าเป็น SENDONLY จะได้รับอนุญาตให้เพิ่ม Asset ตัวเองเข้าไปในการแลกเปลี่ยนได้ แต่จะไม่สามารถรับ Asset สำหรับเกมนี้ได้ ผู้ใช้ที่มีค่าเป็น SENDONLY_FULLINVENTORY จะถูกจำกัดสิทธิ์เทียบเท่ากับ SENDONLY แต่ว่าผู้ใช้จะได้รับการแจ้งเตือนถึงการจำกัดสิทธิ์นั้นว่ามีสาเหตุมาจากการที่ช่องเก็บของของตนเองสำหรับเกมดังกล่าวนั้นเต็ม ผู้ใช้ที่มีสิทธิ์เต็มจะสามารถนำไอเท็มของตนเองเข้าไปแลกเปลี่ยนในการแลกเปลี่ยนที่ถูกทำสัญลักษณ์ว่าให้แลกเปลี่ยนได้ และจะสามารถรับไอเท็มจากพันธมิตรของตนเองได้ และจะละเว้นโหนดนี้ไว้ในหมวดหมู่ที่ไม่ใช่ "การแลกเปลี่ยน". ค่าเริ่มต้นจะมีค่าเป็น: FULL.

คำสั่ง

บริบท (Context) แต่ละบริบทจะมีคำสั่งต่างๆ ที่อนุญาตให้ตัวแทนฝ่ายสนับสนุนสามารถเข้ามาแก้ไขดัดแปลง Asset ของผู้ใช้ได้ ซึ่งทั้งหมดนี้จะปรากฏขึ้นมาเฉพาะในหน้าระบบเศรษฐกิจในเครื่องมือรองรับ โดยจะมีเอาไว้ใช้เพื่อปฏิบัติการต่างๆ เช่น การเพิ่มไอเท็มชิ้นใหม่ การโหลดบัญชีอีกครั้ง และการลบไอเท็ม เวลาที่คำสั่งถูกสั่งใช้งาน ก็จะมีการเรียก ContextCommand/v0001 คำสั่งแต่ละคำสั่งจะถูกกำหนดเอาไว้ตามรายละเอียดดังต่อไปนี้:
  • name - ชื่อของคำสั่ง จะแสดงเอาไว้ในเครื่องมือสนับสนุน และจะได้รับการส่งค่าคืนเมื่อมีการเรียกไปยัง ContextCommand
  • description - คำอธิบายว่าคำสั่งดังกล่าวนั้นจะดำเนินการอะไร จะแสดงเอาไว้ให้แก่ตัวแทนฝ่ายสนับสนุนในไดอะล็อกการยืนยัน
  • record_note -หากว่ามีค่าเป็น true จะมีการแจ้งเตือนไปยังตัวแทนฝ่ายสนับสนุนว่าให้บันทึกระเบียนประวัติเอาไว้ในประวัติการให้บริการสำหรับบัญชีดังกล่าวนั้น
    หากว่าคำสั่งไม่ทำให้เกิดการเปลี่ยนแปลงอะไรต่อข้อมูลของผู้ใช้ (เช่น คำสั่งที่สั่งให้โหลดผู้ใช้จากฐานข้อมูลอีกครั้ง เป็นต้น) ก็ควรจะคืนค่าเป็น false
    (ค่าเริ่มต้น: True)
  • asset_command(ตัวเลือกเสริม) - หากมีค่าเป็น true คำสั่งจะปรากฏขึ้นให้แก่ Asset แต่ละชิ้นในบริบท แทนที่จะปรากฏขึ้นมาบนบริบท
    หากตัวแทนฝ่ายสนับสนุนสั่งใช้คำสั่งนี้บน ก็จะเพิ่มอาร์กิวเมนต์ assetid ลงไปในการเรียกผลลัพธ์ไปยัง ContextCommand

  • options - อาร์เรย์ของตัวเลือกการแสดงผลในไดอะล็อกการยืนยัน
    • name - ชื่อของตัวเลือก
    • type - ประเภทของการควบคุมที่จะแสดงให้แก่ตัวเลือก ประเภทที่รองรับ คือ checkbox, dropdown, numeric, and type_picker
    • default - ค่าเริ่มต้นของตัวเลือกนี้ นี่คือค่า bool ของกล่องตัวเลือกทำเครื่องหมาย และชื่อของค่าของตัวเลือกเมนูเลื่อนลง
    • supervisor_only - จะมีค่าเป็น true หากจะให้แต่กลุ่มของตัวแทนฝ่ายสนับสนุนที่ถูกจำกัดเข้าถึงตัวเลือกนี้ได้ สำหรับตัวแทนอื่นๆ จะใช้งานค่าตั้งต้นแทน
    • values - อาร์เรย์ของค่าที่เป็นไปได้ของตัวเลือก dropdown จะไม่นำไปใช้งานกับตัวเลือกประเภทอื่นๆ
      • name - ชื่อของค่านี้ที่จะแสดงให้ตัวแทนฝ่ายสนับสนุนเห็น
      • value - ค่าที่จะส่งคืนเข้ามาใน ContextCommand หากว่าเลือกมาจากเมนูเลื่อนลง

    • types - อาร์เรย์ของประเภทที่จะแสดงผลในตัวเลือก type_picker จะไม่นำไปใช้งานกับตัวเลือกประเภทอื่นๆ
      • name - ชื่อของประเภท
      • value - ค่าที่จะส่งคืนมาให้แก่ประเภทนี้
      • icon_url - URL ของไอคอนที่จะแสดงถัดจากประเภทนี้ในการควบคุมตัวเลือก
      • tags - อาร์เรย์ของแท็กที่จะแสดงเอาไว้ใต้ชื่อในตัวเลือกประเภท

ข้อมูลเอาต์พุตตัวอย่าง

{ "result": { "success": true, "contexts": [ { "id": 2, "name": "Backpack", "nested": false, "commands": [ { "name": "Reload", "description": "Reload the user's information from the database.", "record_note": false }, { "name": "Delete All", "description": "Delete all of the user's items.", "options": [ { "name": "Delete Purchased Items", "type": "checkbox", "default": false } ] }, { "name": "Add Item", "description": "Adds an item for the user. Please don't set Quality, Particle Effect, or Level unless you know what you're doing.", "options": [ { "name": "Quality", "type": "dropdown", "default": "unique", "values": [ { "name": "Any", "value": "Any" }, { "name": "Normal", "value": "normal" }, { "name": "Genuine", "value": "rarity1" }, { "name": "Vintage", "value": "vintage" }, { "name": "Unusual", "value": "rarity4" } ] }, { "name": "Particle Effect", "type": "dropdown", "default": "none", "values": [ { "name": "None", "value": 0 }, { "name": "burningplayer_red", "value": 1 }, { "name": "burningplayer_flyingbits", "value": 2 } ] }, { "name": "Level", "type": "numeric", "default": 0 }, { "name": "Not Tradable", "type": "checkbox", "default": false }, { "name": "Not Usable In Crafting", "type": "checkbox", "default": false }, { "name": "Item Type", "type": "type_picker", "types": [ { "value": "The Kritzkrieg", "icon_url": "http://media.steampowered.com/apps/440/icons/c_overhealer.b5ed539b534216652b45694e19c78d2aaebcfe5e.png", "name": "Kritzkrieg", "tags": [ "Slot: secondary", "Used By: Medic" ] }, { "value": "The Blutsauger", "icon_url": "http://media.steampowered.com/apps/440/icons/c_leechgun.198c5a7943a16f08b5227f2e84d165c153ed0223.png", "name": "Blutsauger", "tags": [ "Slot: primary", "Used By: Medic" ] } ] } ] }, { "name": "Delete Item", "asset_command": true, "description": "Delete an item" } ] , "asset_count": 180, "user_facing": true }, { "id": 3, "name": "Recipes", "nested": false, "asset_count": 0, "user_facing": false } ] , "alerts": [ ] , "trade_permissions": "FULL" } }
Steamworks คือชุดเครื่องมือและบริการที่สร้างขึ้นโดย Valve ซึ่งจะช่วยคุณกำหนดค่า จัดการ และปฏิบัติการเกี่ยวกับเกมของคุณบน Steam