Cung cấp thêm các phương thức để tương tác với vật phẩm Steam Workshop.

Xem ISteamRemoteStorage dùng cho interface chính, cũng như ICloudService.

LƯU Ý: Đây là interface dịch vụ, các phương thức trong interface này nên được gọi với tham số input_json.

Để biết thêm thông tin về cách sử dụng API Web Steamworks, vui lòng xem Tổng quan về Web API.

Delete

Tên	Loại	Bắt buộc	Mô tả
key	string	✔	API Web Steamworks - Khóa xác thực người dùng.
publishedfileid	uint64	✔	Vật phẩm cần xóa
appid	uint32	✔	App mà vật phẩm thuộc về

Xóa một vật phẩm.

LƯU Ý: Lệnh gọi này phải có khóa API từ nhà phát hành để dùng phương thức này. Vì vậy, API này PHẢI được gọi từ máy chủ bảo mật và không bao giờ được sử dụng trực tiếp bởi client!

QueryFiles

Tên	Loại	Bắt buộc	Mô tả
key	string	✔	API Web Steamworks - Khóa xác thực người dùng.
query_type	uint32	✔	IPublishedFileService#EPublishedFileQueryType
page	uint32	✔	Trang hiện tại. Giới hạn tối đa hiện tại là 1000.
cursor	string	✔	Con trỏ để phân trang kết quả (đặt là '*' cho yêu cầu đầu tiên). Ưu tiên dùng cách này thay vì tham số page, vì nó cho phép bạn phân trang chi tiết hơn. Khi sử dụng, tham số page sẽ bị phớt lờ. Dùng giá trị "next_cursor" trả về trong phản hồi để thiết lập truy vấn tiếp theo và nhận bộ kết quả kế tiếp.
numperpage	uint32		(Không bắt buộc) Số lượng kết quả mà mỗi trang trả về.
creator_appid	uint32	✔	App tạo ra các file
appid	uint32	✔	App dùng các file
requiredtags	string	✔	Các nhãn cần phải khớp. Xem tham số match_all_tags bên dưới
excludedtags	string	✔	(Không bắt buộc) Các nhãn KHÔNG được nằm trong file phát hành để thỏa truy vấn.
match_all_tags	bool		Nếu true, vật phẩm phải có toàn bộ nhãn được chỉ định, nếu không thì chúng phải có ít nhất một nhãn trong số đó.
required_flags	string	✔	Flag bắt buộc phải được đặt trên bất kỳ vật phẩm nào trả về
omitted_flags	string	✔	Flag bắt buộc phải không được đặt trên bất kỳ vật phẩm nào trả về
search_text	string	✔	Văn bản cần khớp trong tên hay mô tả của vật phẩm
filetype	uint32	✔	IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileid	uint64	✔	Tìm tất cả vật phẩm có liên kết với vật phẩm chỉ định.
days	uint32	✔	Nếu query_type là k_PublishedFileQueryType_RankedByTrend, thì đây là số ngày để nhận bầu chọn cho [1,7].
include_recent_votes_only	bool	✔	Nếu query_type là k_PublishedFileQueryType_RankedByTrend, thì giới hạn bộ kết quả để chỉ bao gồm vật phẩm có lượt bầu chọn trong khoảng ngày được chọn
cache_max_age_seconds	uint32		Cho phép trả về dữ liệu cũ trong số giây được chỉ định.
language	int32		Ngôn ngữ dùng để tìm kiếm, cũng như của kết quả trả về. Mặc định là English (tiếng Anh).
required_kv_tags	{message}	✔	Cần các nhãn có dạng khóa-giá trị để khớp.
totalonly	bool	✔	(Không bắt buộc) Nếu true, chỉ trả về tổng số file thỏa truy vấn này.
ids_only	bool	✔	(Không bắt buộc) Nếu true, chỉ trả về id file đã phát hành của các file thỏa truy vấn này.
return_vote_data	bool	✔	Trả về dữ liệu bầu chọn
return_tags	bool	✔	Trả về các nhãn trong chi tiết file
return_kv_tags	bool	✔	Trả về các nhãn có dạng khóa-giá trị trong chi tiết file
return_previews	bool	✔	Trả về ảnh xem trước và chi tiết video trong chi tiết file
return_children	bool	✔	Trả về id vật phẩm con trong chi tiết file
return_short_description	bool	✔	Điền vào trường short_description thay vì file_description
return_for_sale_data	bool	✔	Trả về thông tin giá, nếu phù hợp
return_metadata	bool		Điền metadata
return_playtime_stats	uint32	✔	Trả về số liệu thời gian chơi cho số ngày chỉ định trước ngày hôm nay.

Thực hiện truy vấn tìm kiếm cho các file đã phát hành

SetDeveloperMetadata

Tên	Loại	Bắt buộc	Mô tả
key	string	✔	API Web Steamworks - Khóa xác thực nhà phát hành.
publishedfileid	uint64	✔
appid	uint32	✔
metadata	string	✔

Đặt metadata cho nhà phát triển trên file đã phát hành

LƯU Ý: Lệnh gọi yêu cầu có khóa API từ nhà phát hành để dùng phương thức này. Vì vậy, API này PHẢI được gọi từ máy chủ bảo mật và không bao giờ được sử dụng trực tiếp bởi client!

UpdateAppUGCBan

Tên	Loại	Bắt buộc	Mô tả
key	string	✔	API Web Steamworks - Khóa xác thực nhà phát hành.
steamid	uint64	✔	SteamID của người dùng
appid	uint32	✔
expiration_time	uint32	✔	Mốc thời gian Unix khi lệnh cấm kết thúc, 0 để gỡ bỏ
reason	string		Lý do người dùng bị cấm. Sẽ được hiển thị tới người dùng.

Thêm/cập nhật/xóa lệnh cấm UGC của người dùng trong ứng dụng. Đặt expiration_time = 0 để gỡ bỏ lệnh cấm.

LƯU Ý: Lệnh gọi yêu cầu có khóa API từ nhà phát hành để dùng phương thức này. Vì vậy, API này PHẢI được gọi từ máy chủ bảo mật và không bao giờ được sử dụng trực tiếp bởi client!

UpdateBanStatus

Tên	Loại	Bắt buộc	Mô tả
key	string	✔	API Web Steamworks - Khóa xác thực nhà phát hành.
publishedfileid	uint64	✔
appid	uint32	✔
banned	bool	✔
reason	string	✔	Lý do vật phẩm bị cấm. Chỉ thấy được bởi quản trị viên.

Cập nhật trạng thái cấm trên file đã phát hành

LƯU Ý: Lệnh gọi yêu cầu có khóa API từ nhà phát hành để dùng phương thức này. Vì vậy, API này PHẢI được gọi từ máy chủ bảo mật và không bao giờ được sử dụng trực tiếp bởi client!

UpdateIncompatibleStatus

Tên	Loại	Bắt buộc	Mô tả
key	string	✔	API Web Steamworks - Khóa xác thực nhà phát hành.
publishedfileid	uint64	✔
appid	uint32	✔
incompatible	bool	✔

Cập nhật trạng thái không tương thích trên file đã phát hành. Vật phẩm "Incompatible" (không tương thích) được ẩn khỏi trung tâm cộng đồng và hồ sơ người dùng, nhưng vẫn có thể truy cập bằng đường dẫn trực tiếp.

LƯU Ý: Lệnh gọi yêu cầu có khóa API từ nhà phát hành để dùng phương thức này. Vì vậy, API này PHẢI được gọi từ máy chủ bảo mật và không bao giờ được sử dụng trực tiếp bởi client!

UpdateTags

Tên	Loại	Bắt buộc	Mô tả
key	string	✔	API Web Steamworks - Khóa xác thực nhà phát hành.
publishedfileid	uint64	✔
appid	uint32	✔
add_tags	string		Nhãn để thêm
remove_tags	string		Nhãn để gỡ bỏ

Cập nhật nhãn trên file đã phát hành. Các nhãn hiện có sẽ không bị gỡ bỏ, trừ khi được chỉ định trong tham số remove_tags.

LƯU Ý: Lệnh gọi này phải có khóa API từ nhà phát hành để dùng phương thức này. Vì vậy, API này PHẢI được gọi từ máy chủ bảo mật và không bao giờ được sử dụng trực tiếp bởi client!

Enum

Đây là các enum được định nghĩa để dùng với ISteamRemoteStorage.

EPublishedFileQueryType

Các cách để bạn truy vấn vật phẩm UGC.

Tên	Giá trị
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

Cách để một file được chia sẻ có thể được truy vấn bởi QueryFile.

Tên	Giá trị	Mô tả
k_PFI_MatchingFileType_Items	0	Vật phẩm.
k_PFI_MatchingFileType_Collections	1	Bộ sưu tập các vật phẩm Workshop.
k_PFI_MatchingFileType_Art	2	Tranh ảnh.
k_PFI_MatchingFileType_Videos	3	Video.
k_PFI_MatchingFileType_Screenshots	4	Ảnh chụp.
k_PFI_MatchingFileType_CollectionEligible	5	Vật phẩm có thể đưa vào trong bộ sưu tập.
k_PFI_MatchingFileType_Games	6	Không dùng.
k_PFI_MatchingFileType_Software	7	Không dùng
k_PFI_MatchingFileType_Concepts	8	Không dùng
k_PFI_MatchingFileType_GreenlightItems	9	Không dùng
k_PFI_MatchingFileType_AllGuides	10	Hướng dẫn.
k_PFI_MatchingFileType_WebGuides	11	Hướng dẫn web Steam.
k_PFI_MatchingFileType_IntegratedGuides	12	Hướng dẫn tích hợp với ứng dụng.
k_PFI_MatchingFileType_UsableInGame	13
k_PFI_MatchingFileType_Merch	14	Sản phẩm workshop được bầu chọn với mục đích đăng bán
k_PFI_MatchingFileType_ControllerBindings	15	Cách gán phím cho Steam Controller.
k_PFI_MatchingFileType_SteamworksAccessInvites	16	Được dùng nội bộ.
k_PFI_MatchingFileType_Items_Mtx	17	Vật phẩm workshop có thể bán trong trò chơi.
k_PFI_MatchingFileType_Items_ReadyToUse	18	Vật phẩm workshop có thể dùng được ngay bởi người dùng.
k_PFI_MatchingFileType_WorkshopShowcase	19
k_PFI_MatchingFileType_GameManagedItems	20	Quản lý hoàn toàn bởi trò chơi, không phải bởi người dùng, và không hiện trên web.