Documentação do Steamworks
Interface IPublishedFileService
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/
NomeTipoObrigatórioDescrição
keystringChave de autenticação do usuário para a Web API do Steamworks.
publishedfileiduint64O item a excluir
appiduint32O 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/
NomeTipoObrigatórioDescrição
keystringChave de autenticação do usuário para a Web API do Steamworks.
query_typeuint32IPublishedFileService#EPublishedFileQueryType
pageuint32Página atual. Atualmente, há um limite máximo de 1000.
cursorstringCursor 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.
numperpageuint32(Opcional) Quantidade de resultados por página.
creator_appiduint32AppID criador dos arquivos.
appiduint32AppID consumidor dos arquivos.
requiredtagsstringMarcadores usados na filtragem de resultados. Consulte o parâmetro match_all_tags abaixo.
excludedtagsstring(Opcional) Marcadores usados na exclusão de resultados, i.é., itens com os marcadores aqui informados não serão retornados.
match_all_tagsboolSe 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_flagsstringIndicadores obrigatórios nos itens retornados.
omitted_flagsstringIndicadores que não devem existir nos itens retornados.
search_textstringTexto a buscar no título ou descrição dos itens.
filetypeuint32IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileiduint64Buscar todos os itens que fazem referência ao item informado.
daysuint32Se 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_onlyboolSe 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_secondsuint32Permite o retorno de dados recuperados até a quantidade de segundos informada atrás.
languageint32Idioma da busca e de retorno. Padrão: English (inglês).
required_kv_tags{message}Marcadores de chave e valor obrigatórios.
totalonlybool(Opcional) Se true, retorna apenas a quantidade de arquivos que correspondem à busca.
ids_onlybool(Opcional) Se true, retorna apenas os IDs dos arquivos publicados que correspondem à busca.
return_vote_databoolRetornar dados de votação?
return_tagsboolRetornar marcadores nos detalhes de cada arquivo?
return_kv_tagsboolRetornar marcadores de chave e valor nos detalhes de cada arquivo?
return_previewsboolRetornar detalhes das imagens e vídeos de pré-visualização nos detalhes de cada arquivo?
return_childrenboolRetornar IDs de itens-filho nos detalhes de cada arquivo?
return_short_descriptionboolRetornar o campo short_description em vez do campo file_description?
return_for_sale_databoolRetornar dados de preços, se aplicável?
return_metadataboolRetornar metadados?
return_playtime_statsuint32Retornar estatísticas de tempo de jogo nos últimos X dias?

Realiza uma busca por arquivos publicados.
AVISO: apesar de ser possível realizar a busca pelos parâmetros "filetype", (IPublishedFileService#EPublishedFileInfoMatchingFileType), os resultados conterão um valor "file_type". Esse valor corresponderá a um dos valores da enumeração ISteamRemoteStorage#EWorkshopFileType.

SetDeveloperMetadata

POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
publishedfileiduint64
appiduint32
metadatastring

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/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
steamiduint64O ID Steam do usuário.
appiduint32
expiration_timeuint32Horário, no formato de Era Unix, que o banimento termina. Passe o valor 0 para remover o banimento.
reasonstringMotivo 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/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
publishedfileiduint64
appiduint32
bannedbool
reasonstringMotivo 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/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
publishedfileiduint64
appiduint32
incompatiblebool

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/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
publishedfileiduint64
appiduint32
add_tagsuint32Marcadores a adicionar.
remove_tagsstringMarcadores 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.

NomeValor
k_PublishedFileQueryType_RankedByVote0
k_PublishedFileQueryType_RankedByPublicationDate1
k_PublishedFileQueryType_AcceptedForGameRankedByAcceptanceDate2
k_PublishedFileQueryType_RankedByTrend3
k_PublishedFileQueryType_FavoritedByFriendsRankedByPublicationDate4
k_PublishedFileQueryType_CreatedByFriendsRankedByPublicationDate5
k_PublishedFileQueryType_RankedByNumTimesReported6
k_PublishedFileQueryType_CreatedByFollowedUsersRankedByPublicationDate7
k_PublishedFileQueryType_NotYetRated8
k_PublishedFileQueryType_RankedByTotalUniqueSubscriptions9
k_PublishedFileQueryType_RankedByTotalVotesAsc10
k_PublishedFileQueryType_RankedByVotesUp11
k_PublishedFileQueryType_RankedByTextSearch12
k_PublishedFileQueryType_RankedByPlaytimeTrend13
k_PublishedFileQueryType_RankedByTotalPlaytime14
k_PublishedFileQueryType_RankedByAveragePlaytimeTrend15
k_PublishedFileQueryType_RankedByLifetimeAveragePlaytime16
k_PublishedFileQueryType_RankedByPlaytimeSessionsTrend17
k_PublishedFileQueryType_RankedByLifetimePlaytimeSessions18
k_PublishedFileQueryType_RankedByInappropriateContentRating19
k_PublishedFileQueryType_RankedByBanContentCheck20
k_PublishedFileQueryType_RankedByLastUpdatedDate21

EPublishedFileInfoMatchingFileType

A forma como um arquivo compartilhado pode ser consultado pelo QueryFile.

NomeValoresDescrição
k_PFI_MatchingFileType_Items0Itens.
k_PFI_MatchingFileType_Collections1Uma coleção de itens da Oficina.
k_PFI_MatchingFileType_Art2Arte.
k_PFI_MatchingFileType_Videos3Vídeos.
k_PFI_MatchingFileType_Screenshots4Capturas de tela.
k_PFI_MatchingFileType_CollectionEligible5Itens que podem ser colocados em uma coleção.
k_PFI_MatchingFileType_Games6Não usada.
k_PFI_MatchingFileType_Software7Não usado.
k_PFI_MatchingFileType_Concepts8Não usado.
k_PFI_MatchingFileType_GreenlightItems9Não usado.
k_PFI_MatchingFileType_AllGuides10Guias.
k_PFI_MatchingFileType_WebGuides11Guias Steam acessados pela web.
k_PFI_MatchingFileType_IntegratedGuides12Guias integrados ao aplicativo.
k_PFI_MatchingFileType_UsableInGame13
k_PFI_MatchingFileType_Merch14Mercadorias da Oficina, que podem receber votos com o propósito de virarem produtos físicos.
k_PFI_MatchingFileType_ControllerBindings15Configurações da Entrada Steam.
k_PFI_MatchingFileType_SteamworksAccessInvites16Valor usado internamente.
k_PFI_MatchingFileType_Items_Mtx17Itens da Oficina que podem ser vendidos no jogo.
k_PFI_MatchingFileType_Items_ReadyToUse18Itens da Oficina que podem ser usados diretamente por usuários.
k_PFI_MatchingFileType_WorkshopShowcase19
k_PFI_MatchingFileType_GameManagedItems20Itens gerenciados completamente pelo jogo, não pelo usuário. Não são exibidos na web.