Unaffiliated

Home Documentation & Help
Steamworks Documentation
IPublishedFileService Interface
Provides additional methods for interacting with Steam Workshop items.

See ISteamRemoteStorage for the primary interface.

NOTE: This is a Service interface, methods in this interface should be called with the input_json parameter.

For more info on how to use the Steamworks Web API please see the Web API Overview.

QueryFiles

GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
query_typeuint32enumeration EPublishedFileQueryType in clientenums.h
pageuint32Current page
numperpageuint32(Optional) The number of results, per page to return.
creator_appiduint32App that created the files
appiduint32App that consumes the files
requiredtagsstringTags to match on. See match_all_tags parameter below
excludedtagsstring(Optional) Tags that must NOT be present on a published file to satisfy the query.
match_all_tagsboolIf true, then items must have all the tags specified, otherwise they must have at least one of the tags.
required_flagsstringRequired flags that must be set on any returned items
omitted_flagsstringFlags that must not be set on any returned items
search_textstringText to match in the item's title or description
filetypeuint32EPublishedFileInfoMatchingFileType
child_publishedfileiduint64Find all items that reference the given item.
daysuint32If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].
include_recent_votes_onlyboolIf query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given
cache_max_age_secondsuint32Allow stale data to be returned for the specified number of seconds.
languageint32Language to search in and also what gets returned. Defaults to English.
required_kv_tags{message}Required key-value tags to match on.
totalonlybool(Optional) If true, only return the total number of files that satisfy this query.
ids_onlybool(Optional) If true, only return the published file ids of files that satisfy this query.
return_vote_databoolReturn vote data
return_tagsboolReturn tags in the file details
return_kv_tagsboolReturn key-value tags in the file details
return_previewsboolReturn preview image and video details in the file details
return_childrenboolReturn child item ids in the file details
return_short_descriptionboolPopulate the short_description field instead of file_description
return_for_sale_databoolReturn pricing information, if applicable
return_metadataboolPopulate the metadata
return_playtime_statsuint32Return playtime stats for the specified number of days before today.

Performs a search query for published files

SetDeveloperMetadata

POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
publishedfileiduint64
appiduint32
metadatastring

Sets the metadata for a developer on the published file

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

UpdateTags

POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
publishedfileiduint64
appiduint32
add_tagsstring
remove_tagsstring

Updates tags on the published file

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!