ให้เมธอดเพิ่มเติมสำหรับโต้ตอบกับไอเท็มเวิร์กชอป Steam

ดูเกี่ยวกับอินเตอร์เฟซหลักได้ที่ ISteamRemoteStorage และ ICloudService

หมายเหตุ: นี่คืออินเตอร์เฟซให้บริการ การเรียกเมธอดในอินเตอร์เฟซนี้ควรใช้พารามิเตอร์ input_json

หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับวิธีใช้ Steamworks Web API โปรดอ่าน ภาพรวมของ Web API

Delete

ชื่อ	ประเภท	จำเป็นต้องใช้	คำอธิบาย
key	string	✔	คีย์การตรวจสอบสิทธิ์ของผู้ใช้ Steamworks Web API
publishedfileid	uint64	✔	ไอเท็มที่ต้องการลบ
appid	uint32	✔	แอปที่มีไอเท็มนั้น

ลบไอเท็ม

หมายเหตุ: การเรียกเมธอดนี้จำเป็นต้องใช้รหัส API ของผู้จัดจำหน่าย ดังนั้น จะต้องเรียก API นี้จากเซิร์ฟเวอร์ที่ปลอดภัย และไคลเอนต์จะไม่มีทางใช้งาน API นี้ได้โดยตรง!

QueryFiles

ชื่อ	ประเภท	จำเป็นต้องใช้	คำอธิบาย
key	string	✔	คีย์การตรวจสอบสิทธิ์ของผู้ใช้ Steamworks Web API
query_type	uint32	✔	IPublishedFileService#EPublishedFileQueryType
page	uint32	✔	หน้าเว็บในขณะนี้ ซึ่งมีขีดจำกัดที่ 1000
cursor	string	✔	เคอร์เซอร์จะกำหนดเลขหน้าผ่านผลลัพธ์ (ตั้งเป็น '*' สำหรับคำร้องขอแรก) ซึ่งเป็นที่นิยมใช้มากกว่าการใช้พารามิเตอร์ของหน้า เนื่องจากเป็นการช่วยให้คุณสามารถใช้การกำหนดเลขหน้าได้ลึกยิ่งขึ้น เมื่อถูกใช้ พารามิเตอร์ของหน้าจะถูกละเว้น ใช้ค่า "next_cursor" ที่ส่งกลับมาในการตอบสนอง เพื่อตั้งค่าคิวรี่ถัดไปเพื่อรับชุดผลลัพธ์ถัดไป
numperpage	uint32		(ตัวเลือกเสริม) จำนวนผลลัพธ์ที่จะคืนค่าต่อหนึ่งหน้า
creator_appid	uint32	✔	แอปที่สร้างไฟล์
appid	uint32	✔	แอปที่ใช้ไฟล์
requiredtags	string	✔	แท็กที่จะจับคู่ ดูพารามิเตอร์ match_all_tags ด้านล่าง
excludedtags	string	✔	(ตัวเลือกเสริม) แท็กที่จะต้องไม่ปรากฏในไฟล์ที่เผยแพร่ ถึงจะตรงตามเงื่อนไขของคิวรี่
match_all_tags	bool		ถ้ามีค่าเป็น true ไอเท็มจะต้องมีแท็กทั้งหมดที่ระบุ มิฉะนั้นจะต้องมีแท็กอย่างน้อย 1 แท็กที่กำหนด
required_flags	string	✔	ธงที่ต้องได้รับการตั้งค่าในไอเท็มใด ๆ ที่คืนกลับมา
omitted_flags	string	✔	ธงที่จะต้องไม่ได้รับการตั้งค่าในไอเท็มใด ๆ ที่คืนกลับมา
search_text	string	✔	ข้อความที่ต้องการค้นหาในชื่อหรือคำอธิบายของไอเท็ม
filetype	uint32	✔	IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileid	uint64	✔	ค้นหาไอเท็มทั้งหมดที่อ้างอิงไอเท็มที่ระบุ
days	uint32	✔	ถ้า query_type เป็น k_PublishedFileQueryType_RankedByTrend ค่านี้ คือ จำนวนวันที่เปิดรับคะแนนโหวต [1,7]
include_recent_votes_only	bool	✔	ถ้า query_type เป็น k_PublishedFileQueryType_RankedByTrend ให้จำกัดชุดผลลัพธ์เฉพาะกับไอเท็มที่มีคะแนนโหวตภายในช่วงวันที่กำหนด
cache_max_age_seconds	uint32		อนุญาตให้คืนข้อมูลที่เก่าแล้ว ตามจำนวนวินาทีที่ระบุ
language	int32		ภาษาที่ใช้ในการค้นหาและการรับผลลัพธ์ที่คืนมา ค่าเริ่มต้นคือภาษาอังกฤษ
required_kv_tags	{message}	✔	แท็กคีย์-ค่าที่จำเป็นต้องใช้ในการจับคู่
totalonly	bool	✔	(ตัวเลือกเสริม) ถ้ามีค่าเป็น true ให้คืนเฉพาะจำนวนไฟล์ทั้งหมดที่มีคุณสมบัติตรงกับคิวรี่นี้
ids_only	bool	✔	(ตัวเลือกเสริม) ถ้ามีค่าเป็น true ให้คืนเฉพาะไอดีไฟล์ที่เผยแพร่ หรือไฟล์ที่มีคุณสมบัติตรงกับคิวรี่นี้
return_vote_data	bool	✔	คืนข้อมูลการโหวต
return_tags	bool	✔	คืนแท็กในรายละเอียดของไฟล์
return_kv_tags	bool	✔	คืนแท็กคีย์-ค่าในรายละเอียดของไฟล์
return_previews	bool	✔	คืนรายละเอียดของรูปและวิดีโอตัวอย่างในรายละเอียดไฟล์
return_children	bool	✔	คืนไอดีของไอเท็มไชลด์ในรายละเอียดไฟล์
return_short_description	bool	✔	ป้อนข้อมูลในฟีลด์ short_description แทนที่จะป้อนใน file_description
return_for_sale_data	bool	✔	คืนข้อมูลราคา ถ้าเป็นไปได้
return_metadata	bool		ป้อนข้อมูลเมตา
return_playtime_stats	uint32	✔	คืนสถิติเวลาเล่นก่อนวันนี้ ตามจำนวนวันที่ระบุไว้

คิวรี่เพื่อค้นหาไฟล์ที่เผยแพร่

SetDeveloperMetadata

ชื่อ	ประเภท	ที่ต้องการ	คำอธิบาย
key	string	✔	คีย์การตรวจสอบสิทธิ์ของผู้จัดจำหน่าย Steamworks Web API
publishedfileid	uint64	✔
appid	uint32	✔
metadata	string	✔

ตั้งค่าเมทาเดตาสำหรับผู้พัฒนาให้กับไฟล์ที่เผยแพร่แล้ว

หมายเหตุ: การเรียกนี้ต้องอาศัยรหัส API ของผู้จัดจำหน่าย จึงจะใช้วิธีนี้ได้ ดังนั้น จะต้องเรียก API นี้จากเซิร์ฟเวอร์ที่ปลอดภัย และไคลเอนต์จะไม่มีทางใช้งาน API นี้ได้โดยตรง!

UpdateAppUGCBan

ชื่อ	ประเภท	ที่ต้องการ	คำอธิบาย
key	string	✔	คีย์การตรวจสอบสิทธิ์ของผู้จัดจำหน่าย Steamworks Web API
steamid	uint64	✔	ไอดี Steam ของผู้ใช้
appid	uint32	✔
expiration_time	string	✔	การประทับเวลา Unix เมื่อการแบนหมดอายุ, 0 เพื่อลบออก
reason	string		เหตุผลที่ผู้ใช้ถูกแบน จะแสดงให้ผู้ใช้เห็น

เพิ่ม/อัปเดต/ลบการแบน UGC ของผู้ใช้ในแอป ตั้งค่า expiration_time = 0 เพื่อยกเลิกการแบน

หมายเหตุ: การเรียกนี้ต้องอาศัยรหัส API ของผู้จัดจำหน่าย จึงจะใช้วิธีนี้ได้ ดังนั้น จะต้องเรียก API นี้จากเซิร์ฟเวอร์ที่ปลอดภัย และไคลเอนต์จะไม่มีทางใช้งาน API นี้ได้โดยตรง!

UpdateBanStatus

ชื่อ	ประเภท	ที่ต้องการ	คำอธิบาย
key	string	✔	คีย์การตรวจสอบสิทธิ์ของผู้จัดจำหน่าย Steamworks Web API
publishedfileid	uint64	✔
appid	uint32	✔
banned	bool	✔
reason	string	✔	เหตุผลที่ไอเท็มถูกแบน เฉพาะผู้ดูแลระบบเท่านั้นที่มองเห็น

อัปเดตสถานะการแบนให้กับไฟล์ที่เผยแพร่แล้ว

หมายเหตุ: การเรียกนี้ต้องอาศัยรหัส API ของผู้จัดจำหน่าย จึงจะใช้วิธีนี้ได้ ดังนั้น จะต้องเรียก API นี้จากเซิร์ฟเวอร์ที่ปลอดภัย และไคลเอนต์จะไม่มีทางใช้งาน API นี้ได้โดยตรง!

UpdateIncompatibleStatus

ชื่อ	ประเภท	จำเป็นต้องใช้	คำอธิบาย
key	string	✔	คีย์การตรวจสอบสิทธิ์ของผู้จัดจำหน่าย Steamworks Web API
publishedfileid	uint64	✔
appid	uint32	✔
incompatible	bool	✔

อัปเดตสถานะที่เข้ากันไม่ได้ให้กับไฟล์ที่เผยแพร่แล้ว รายการที่ "เข้ากันไม่ได้" จะซ่อนไว้ไม่ให้เห็นในศูนย์กลางชุมชนและโปรไฟล์ผู้ใช้ แต่ยังคงเข้าถึงได้จากลิงก์โดยตรง

หมายเหตุ: การเรียกนี้ต้องอาศัยรหัส API ของผู้จัดจำหน่าย จึงจะใช้วิธีนี้ได้ ดังนั้น จะต้องเรียก API นี้จากเซิร์ฟเวอร์ที่ปลอดภัย และไคลเอนต์จะไม่มีทางใช้งาน API นี้ได้โดยตรง!

UpdateTags

ชื่อ	ประเภท	ที่ต้องการ	คำอธิบาย
key	string	✔	คีย์การตรวจสอบสิทธิ์ของผู้จัดจำหน่าย Steamworks Web API
publishedfileid	uint64	✔
appid	uint32	✔
add_tags	uint32		แท็กที่ต้องการเพิ่ม
remove_tags	string		แท็กที่ต้องการลบ

อัปเดตแท็กให้กับไฟล์ที่เผยแพร่แล้ว ห้ามลบแท็กที่มีอยู่แล้วออก ยกเว้นจะระบุไว้ในพารามิเตอร์ remove_tags

หมายเหตุ: การเรียกนี้ต้องอาศัยรหัส API ของผู้จัดจำหน่าย จึงจะใช้เมธอดนี้ได้ ดังนั้น จะต้องเรียก API นี้จากเซิร์ฟเวอร์ที่ปลอดภัย และไคลเอนต์จะไม่มีทางใช้งาน API นี้ได้โดยตรง!

อีนิวเมอเรต

ค่าเหล่านี้คืออีนิวเมอเรตที่นิยามไว้เพื่อใช้กับ ISteamRemoteStorage

EPublishedFileQueryType

วิธีที่คุณสามารถคิวรี่หารายการ UGC

ชื่อ	ค่า
k_PublishedFileQueryType_RankedByVote	0
k_PublishedFileQueryType_RankedByPublicationDate	1
k_PublishedFileQueryType_AcceptedForGameRankedByAcceptanceDate	2
k_PublishedFileQueryType_RankedByTrend	3
k_PublishedFileQueryType_FavoritedByFriendsRankedByPublicationDate	4
k_PublishedFileQueryType_CreatedByFriendsRankedByPublicationDate	5
k_PublishedFileQueryType_RankedByNumTimesReported	6
k_PublishedFileQueryType_CreatedByFollowedUsersRankedByPublicationDate	7
k_PublishedFileQueryType_NotYetRated	8
k_PublishedFileQueryType_RankedByTotalUniqueSubscriptions	9
k_PublishedFileQueryType_RankedByTotalVotesAsc	10
k_PublishedFileQueryType_RankedByVotesUp	11
k_PublishedFileQueryType_RankedByTextSearch	12
k_PublishedFileQueryType_RankedByPlaytimeTrend	13
k_PublishedFileQueryType_RankedByTotalPlaytime	14
k_PublishedFileQueryType_RankedByAveragePlaytimeTrend	15
k_PublishedFileQueryType_RankedByLifetimeAveragePlaytime	16
k_PublishedFileQueryType_RankedByPlaytimeSessionsTrend	17
k_PublishedFileQueryType_RankedByLifetimePlaytimeSessions	18
k_PublishedFileQueryType_RankedByInappropriateContentRating	19
k_PublishedFileQueryType_RankedByBanContentCheck	20
k_PublishedFileQueryType_RankedByLastUpdatedDate	21

EPublishedFileInfoMatchingFileType

วิธีที่สามารถใช้ QueryFile เพื่อคิวรี่หาไฟล์ที่แบ่งปันไปแล้วได้

ชื่อ	ค่า	คำอธิบาย
k_PFI_MatchingFileType_Items	0	รายการ
k_PFI_MatchingFileType_Collections	1	ชุดสะสมผลงานเวิร์กชอป
k_PFI_MatchingFileType_Art	2	อาร์ตเวิร์ก
k_PFI_MatchingFileType_Videos	3	วิดีโอ
k_PFI_MatchingFileType_Screenshots	4	ภาพหน้าจอ
k_PFI_MatchingFileType_CollectionEligible	5	ผลงานที่ไม่สามารถบรรจุไว้ในชุดสะสมได้
k_PFI_MatchingFileType_Games	6	ไม่ได้ใช้
k_PFI_MatchingFileType_Software	7	ไม่ได้ใช้
k_PFI_MatchingFileType_Concepts	8	ไม่ได้ใช้
k_PFI_MatchingFileType_GreenlightItems	9	ไม่ได้ใช้
k_PFI_MatchingFileType_AllGuides	10	คำแนะนำ
k_PFI_MatchingFileType_WebGuides	11	คำแนะนำเกี่ยวกับเว็บไซต์ Steam
k_PFI_MatchingFileType_IntegratedGuides	12	คำแนะนำในตัวแอปพลิเคชัน
k_PFI_MatchingFileType_UsableInGame	13
k_PFI_MatchingFileType_Merch	14	สินค้าในเวิร์กชอปที่จะต้องได้รับการโหวตเพื่อวางจำหน่าย
k_PFI_MatchingFileType_ControllerBindings	15	การกำหนดปุ่ม Steam Controller
k_PFI_MatchingFileType_SteamworksAccessInvites	16	สำหรับใช้ภายในเท่านั้น
k_PFI_MatchingFileType_Items_Mtx	17	ผลงานเวิร์กชอปที่วางจำหน่ายในเกมได้
k_PFI_MatchingFileType_Items_ReadyToUse	18	ผลงานเวิร์กชอปที่ผู้ใช้นำไปใช้ได้ทันที
k_PFI_MatchingFileType_WorkshopShowcase	19
k_PFI_MatchingFileType_GameManagedItems	20	เกมจะจัดการได้เองทั้งหมด โดยไม่ต้องอาศัยผู้ใช้ และไม่ปรากฏบนเว็บ