Oferece métodos adicionais para interação com itens da Oficina Steam.
Consulte
ISteamRemoteStorage e
ICloudService para a interface principal.
AVISO: esta é uma interface de serviço; os métodos devem ser chamados com o parâmetro
input_json
.
Para mais informações sobre como usar a Web API do Steamworks, consulte a
Visão geral da Web API.
Delete
GET https://api.steampowered.com/IPublishedFileService/Delete/v1/
Nome | Tipo | Obrigatório | Descrição |
key | string | ✔ | Chave de autenticação do usuário para a Web API do Steamworks. |
publishedfileid | uint64 | ✔ | O item a excluir |
appid | uint32 | ✔ | O aplicativo ao qual o item pertence |
Exclui um item.
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
QueryFiles
GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
Nome | Tipo | Obrigatório | Descrição |
key | string | ✔ | Chave de autenticação do usuário para a Web API do Steamworks. |
query_type | uint32 | ✔ | IPublishedFileService#EPublishedFileQueryType |
page | uint32 | ✔ | Página atual. Atualmente, há um limite máximo de 1000. |
cursor | string | ✔ | Cursor para paginar pelos resultados (passe o valor '*' na primeira requisição). Aconselhamos usar este parâmetro no lugar do parâmetro page por permitir paginação detalhada. Quando definido, o parâmetro page será ignorado. Use o valor de "next_cursor" retornado na resposta para configurar a próxima consulta e recuperar o próximo conjunto de resultados. |
numperpage | uint32 | | (Opcional) Quantidade de resultados por página. |
creator_appid | uint32 | ✔ | AppID criador dos arquivos. |
appid | uint32 | ✔ | AppID consumidor dos arquivos. |
requiredtags | string | ✔ | Marcadores usados na filtragem de resultados. Consulte o parâmetro match_all_tags abaixo. |
excludedtags | string | ✔ | (Opcional) Marcadores usados na exclusão de resultados, i.é., itens com os marcadores aqui informados não serão retornados. |
match_all_tags | bool | | Se true, então o resultado conterá apenas itens que tenham todos os marcadores especificados; caso contrário, ter um marcador já é suficiente para o item ser retornado. |
required_flags | string | ✔ | Indicadores obrigatórios nos itens retornados. |
omitted_flags | string | ✔ | Indicadores que não devem existir nos itens retornados. |
search_text | string | ✔ | Texto a buscar no título ou descrição dos itens. |
filetype | uint32 | ✔ | IPublishedFileService#EPublishedFileInfoMatchingFileType |
child_publishedfileid | uint64 | ✔ | Buscar todos os itens que fazem referência ao item informado. |
days | uint32 | ✔ | Se query_type contiver o valor k_PublishedFileQueryType_RankedByTrend, então este parâmetro informa a quantidade de dias cujos votos contabilizar, dentro do intervalo [1,7]. |
include_recent_votes_only | bool | ✔ | Se query_type contiver o valor k_PublishedFileQueryType_RankedByTrend, então limitar o conjunto de resultados a itens que receberam votos no intervalo de dias informado. |
cache_max_age_seconds | uint32 | | Permite o retorno de dados recuperados até a quantidade de segundos informada atrás. |
language | int32 | | Idioma da busca e de retorno. Padrão: English (inglês). |
required_kv_tags | {message} | ✔ | Marcadores de chave e valor obrigatórios. |
totalonly | bool | ✔ | (Opcional) Se true, retorna apenas a quantidade de arquivos que correspondem à busca. |
ids_only | bool | ✔ | (Opcional) Se true, retorna apenas os IDs dos arquivos publicados que correspondem à busca. |
return_vote_data | bool | ✔ | Retornar dados de votação? |
return_tags | bool | ✔ | Retornar marcadores nos detalhes de cada arquivo? |
return_kv_tags | bool | ✔ | Retornar marcadores de chave e valor nos detalhes de cada arquivo? |
return_previews | bool | ✔ | Retornar detalhes das imagens e vídeos de pré-visualização nos detalhes de cada arquivo? |
return_children | bool | ✔ | Retornar IDs de itens-filho nos detalhes de cada arquivo? |
return_short_description | bool | ✔ | Retornar o campo short_description em vez do campo file_description? |
return_for_sale_data | bool | ✔ | Retornar dados de preços, se aplicável? |
return_metadata | bool | | Retornar metadados? |
return_playtime_stats | uint32 | ✔ | Retornar estatísticas de tempo de jogo nos últimos X dias? |
Realiza uma busca por arquivos publicados.
SetDeveloperMetadata
POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
Nome | Tipo | Obrigatório | Descrição |
key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
metadata | string | ✔ | |
Define os metadados de desenvolvedor em um arquivo publicado.
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
UpdateAppUGCBan
POST https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/
Nome | Tipo | Obrigatório | Descrição |
key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
steamid | uint64 | ✔ | O ID Steam do usuário. |
appid | uint32 | ✔ | |
expiration_time | uint32 | ✔ | Horário, no formato de Era Unix, que o banimento termina. Passe o valor 0 para remover o banimento. |
reason | string | | Motivo do banimento do usuário. Será exibido para o usuário. |
Adiciona, atualiza ou remove um banimento de envio de CGU do aplicativo por um usuário. Passe o valor 0 no parâmetro "expiration_time" para remover o banimento.
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
UpdateBanStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/
Nome | Tipo | Obrigatório | Descrição |
key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
banned | bool | ✔ | |
reason | string | ✔ | Motivo do banimento do item. Visível apenas a administradores. |
Atualiza o estado de banimento de um arquivo publicado.
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
UpdateIncompatibleStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/
Nome | Tipo | Obrigatório | Descrição |
key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
incompatible | bool | ✔ | |
Atualiza o estado de incompatibilidade de um arquivo publicado. Itens "incompatíveis" são ocultos da Central da Comunidade e do perfil de usuários, mas podem ser acessados por um link direto.
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
UpdateTags
POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
Nome | Tipo | Obrigatório | Descrição |
key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
add_tags | uint32 | | Marcadores a adicionar. |
remove_tags | string | | Marcadores a remover. |
Atualiza os marcadores de um arquivo publicado. Os marcadores existentes não serão removidos, a menos que sejam especificados no parâmetro
remove_tags
.
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
Enumerações
Estas são as enumerações definidas para uso com ISteamRemoteStorage.
EPublishedFileQueryType
Formas de consultar itens de CGU.
Nome | Valor |
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
A forma como um arquivo compartilhado pode ser consultado pelo QueryFile.
Nome | Valores | Descrição |
k_PFI_MatchingFileType_Items | 0 | Itens. |
k_PFI_MatchingFileType_Collections | 1 | Uma coleção de itens da Oficina. |
k_PFI_MatchingFileType_Art | 2 | Arte. |
k_PFI_MatchingFileType_Videos | 3 | Vídeos. |
k_PFI_MatchingFileType_Screenshots | 4 | Capturas de tela. |
k_PFI_MatchingFileType_CollectionEligible | 5 | Itens que podem ser colocados em uma coleção. |
k_PFI_MatchingFileType_Games | 6 | Não usada. |
k_PFI_MatchingFileType_Software | 7 | Não usado. |
k_PFI_MatchingFileType_Concepts | 8 | Não usado. |
k_PFI_MatchingFileType_GreenlightItems | 9 | Não usado. |
k_PFI_MatchingFileType_AllGuides | 10 | Guias. |
k_PFI_MatchingFileType_WebGuides | 11 | Guias Steam acessados pela web. |
k_PFI_MatchingFileType_IntegratedGuides | 12 | Guias integrados ao aplicativo. |
k_PFI_MatchingFileType_UsableInGame | 13 | |
k_PFI_MatchingFileType_Merch | 14 | Mercadorias da Oficina, que podem receber votos com o propósito de virarem produtos físicos. |
k_PFI_MatchingFileType_ControllerBindings | 15 | Configurações da Entrada Steam. |
k_PFI_MatchingFileType_SteamworksAccessInvites | 16 | Valor usado internamente. |
k_PFI_MatchingFileType_Items_Mtx | 17 | Itens da Oficina que podem ser vendidos no jogo. |
k_PFI_MatchingFileType_Items_ReadyToUse | 18 | Itens da Oficina que podem ser usados diretamente por usuários. |
k_PFI_MatchingFileType_WorkshopShowcase | 19 | |
k_PFI_MatchingFileType_GameManagedItems | 20 | Itens gerenciados completamente pelo jogo, não pelo usuário. Não são exibidos na web. |