Предоставляет дополнительные методы взаимодействия с предметами из мастерской Steam.
Основной интерфейс —
ISteamRemoteStorage, см. также
ICloudService.
Обратите внимание: это служебный интерфейс, поэтому методы в нём должны вызываться с помощью параметра
input_json
.
Дополнительная информация об использовании веб-API Steamworks доступна в разделе
Обзор веб-API.
Delete
GET https://api.steampowered.com/IPublishedFileService/Delete/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации пользователя. |
publishedfileid | uint64 | ✔ | Предмет, который нужно удалить. |
appid | uint32 | ✔ | Приложение, к которому относится предмет. |
Удаляет предмет.
Обратите внимание: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
QueryFiles
GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации пользователя. |
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, у предметов должны быть все указанные метки. В противном случае предметы должны иметь как минимум одну из них. |
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
POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
metadata | string | ✔ | |
Задаёт метаданные для разработчика в опубликованном файле.
Обратите внимание: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО нужно вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
UpdateAppUGCBan
POST https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
steamid | uint64 | ✔ | SteamID пользователя. |
appid | uint32 | ✔ | |
expiration_time | string | ✔ | Временная метка окончания блокировки в формате UNIX, 0 — для удаления. |
reason | uint64 | | Причина, по которой пользователь был заблокирован. Будет показана пользователю. |
Добавляет, обновляет или отменяет блокировку на пользовательские предметы в приложении. Чтобы отменить блокировку, для expiration_time выберите значение «0».
Обратите внимание: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО нужно вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
UpdateBanStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
banned | bool | ✔ | |
reason | string | ✔ | Причина, по которой предмет был заблокирован. Видят только администраторы. |
Обновляет статус блокировки в опубликованном файле.
Обратите внимание: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО нужно вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
UpdateIncompatibleStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/
Название | Тип | Обязательно? | Описание |
key | uint64 | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
incompatible | bool | ✔ | |
Обновляет статус несовместимости в опубликованном файле. «Несовместимые» предметы скрыты в центрах сообщества и профилях пользователей, но доступны по прямой ссылке.
Обратите внимание: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО нужно вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
UpdateTags
POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
add_tags | uint32 | | Метки, которые нужно добавить |
remove_tags | string | | Метки, которые нужно удалить |
Обновляет метки в опубликованном файле. Существующие метки не будут удалены, за исключением случаев, когда они указаны в параметре
remove_tags
.
Обратите внимание: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
Перечисления
Далее приведён список перечислений, которые определены для использования с ISteamRemoteStorage.
EPublishedFileQueryType
Как отправить запрос о пользовательских предметах.
Название | Значение |
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 | Управляется игрой, а не пользователем. Не показывается в сети. |