提供与 Steam 创意工坊物品交互的其他方法。

查看 ISteamRemoteStorage 以获取主要接口的相关信息，亦可同时查看 ICloudService。

注意： 注意：这是服务接口，此接口中的方法应使用 input_json 参数调用。

请参见 Web API 概览，进一步了解如何使用 Steamworks Web API。

Delete

名称	类型	是否必需	描述
key	string	✔	Steamworks Web API 用户验证密钥。
publishedfileid	uint64	✔	要删除的物品。
appid	uint32	✔	物品所属的应用。

删除物品。

注意： 此调用需要发行商 API 密钥以使用此方法。 因此，此 API 必须通过安全服务器调用，且绝不能由客户端直接调用！

QueryFiles

名称	类型	是否必需	描述
key	string	✔	Steamworks Web API 用户验证密钥。
query_type	uint32	✔	IPublishedFileService#EPublishedFileQueryType。
page	uint32	✔	当前页。 当前上限为 1000。
cursor	string	✔	用于给结果分页的游标（在第一个请求中将其设置为“*”）。 由于此参数允许您进行深度分页，请优先考虑使用此参数，而非“page”参数。 一经使用，“page”参数将被忽略。 使用在响应中返回的“next_cursor”值，设置下一个查询以获得下一组结果。
numperpage	uint32		（可选）每页返回的结果的数量。
creator_appid	uint32	✔	创建文件的应用。
appid	uint32	✔	使用文件的应用。
requiredtags	string	✔	要匹配的标签。 参见下文的 match_all_tags 参数。
excludedtags	string	✔	（可选）为满足查询条件而绝不能在已发布的文件里出现的标签。
match_all_tags	bool		若为 true，则物品必须有全部指定标签，否则必须至少有其中一个标签。
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，只返回满足此查询条件的已发布文件的 id。
return_vote_data	bool	✔	返回投票数据。
return_tags	bool	✔	返回文件详情中的标签。
return_kv_tags	bool	✔	返回文件详情中的键-值标签。
return_previews	bool	✔	返回文件详情中的预览图片和视频详情。
return_children	bool	✔	返回文件详情中的子物品 id。
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 必须通过安全服务器调用，且绝不能由客户端直接调用！

UpdateAppUGCBan

名称	类型	是否必需	描述
key	string	✔	Steamworks Web API 发行商验证密钥。
steamid	uint64	✔	用户的 SteamID。
appid	uint32	✔
expiration_time	uint32	✔	封禁到期时的 Unix 格式时间戳，0 为移除
reason	string		用户受到封禁的原因。 将会向用户显示。

添加/更新/移除用户在应用中的 UGC 封禁。 配置 expiration_time = 0 则移除封禁。

注意： 此调用需要发行商 API 密钥才能使用此方法。 因此，此 API 必须通过安全服务器调用，且绝不能由客户端直接调用！

UpdateBanStatus

名称	类型	是否必需	描述
key	string	✔	Steamworks Web API 发行商验证密钥。
publishedfileid	uint64	✔
appid	uint32	✔
banned	bool	✔
reason	string	✔	物品受到封禁的原因。 只对管理员可见。

更新已发布文件的封禁状态。

注意： 此调用需要发行商 API 密钥才能使用此方法。 因此，此 API 必须通过安全服务器调用，且绝不能由客户端直接调用！

UpdateIncompatibleStatus

名称	类型	是否必需	描述
key	string	✔	Steamworks Web API 发行商验证密钥。
publishedfileid	uint64	✔
appid	uint32	✔
incompatible	bool	✔

更新已发布文件的不兼容状态。 “不兼容”物品在社区中心和用户个人资料中隐藏，但仍旧可以通过直接链接访问。

注意： 此调用需要发行商 API 密钥才能使用此方法。 因此，此 API 必须通过安全服务器调用，且绝不能由客户端直接调用！

UpdateTags

名称	类型	是否必需	描述
key	string	✔	Steamworks Web API 发行商验证密钥。
publishedfileid	uint64	✔
appid	uint32	✔
add_tags	string		要添加的标签
remove_tags	string		要移除的标签

在已发布的文件上更新标签。 除非现有标签在 remove_tags 中明确指出，否则不会被移除。

注意： 此调用需要发行商 API 密钥才能使用此方法。 因此，此 API 必须通过安全服务器调用，且绝不能由客户端直接调用！

枚举

以下是经过定义，来与 ISteamRemoteStorage 一起使用的枚举。

EPublishedFileQueryType

查询 UCG 物品的可能方式。

名称	值
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 控制器绑定。
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	完全由游戏管理，不由用户管理，且不显示在网页上。