Aporta métodos adicionales para interactuar con los artículos de Steam Workshop.

Consulta ISteamRemoteStorage para la interfaz principal, y también ICloudService.

NOTA: Esta es una interfaz de servicio, los métodos en esta interfaz deben llamarse con el parámetro: input_json.

Para obtener más información sobre cómo utilizar la Web de API de Steamworks, consulta el Descripción general de la Web de API.

Delete

Nombre	Tipo	Obligatorio	Descripción
key	string	✔	Clave de autenticación de usuario de la Web de API de Steamworks.
publishedfileid	uint64	✔	El artículo a eliminar.
appid	uint32	✔	Aplicación a la que pertenece el artículo.

Elimina un artículo.

NOTA: Esta llamada requiere una clave de API de editor para utilizar este método. Como tal, esta API DEBE ser llamada desde un servidor seguro y ¡nunca puede ser utilizada directamente por tus clientes!

QueryFiles

Nombre	Tipo	Obligatorio	Descripción
key	string	✔	Clave de autenticación de usuario de la Web de API de Steamworks.
query_type	uint32	✔	IPublishedFileService#EPublishedFileQueryType
page	uint32	✔	Página actual. Actualmente hay un límite de 1000.
cursor	string	✔	Cursor para paginar a través de los resultados (establecer '*' para la primera solicitud). Preferir esto sobre el uso del parámetro de página; ya que te permitirá hacer una paginación avanzada. Cuando se utiliza, el parámetro de la página será ignorado. Utiliza para obtener el siguiente conjunto de resultados el "next_cursor" valor devuelto en la respuesta para configurar la siguiente consulta.
numperpage	uint32		(Opcional) El número de resultados que se obtienen por página.
creator_appid	uint32	✔	Aplicación que crea los archivos.
appid	uint32	✔	Aplicación que consume los archivos.
requiredtags	string	✔	Etiquetas a coincidir. Ver el parámetro match_all_tags más abajo.
excludedtags	string	✔	Etiquetas que NO deben estar presentes en un archivo publicado para satisfacer la consulta (opcional).
match_all_tags	bool		Si es "true", los elementos deben tener todas las etiquetas especificadas, de lo contrario, deben tener al menos una de ellas.
required_flags	string	✔	Las marcas necesarias que deben establecerse para cualquier elemento devuelto.
omitted_flags	string	✔	Marcas que no deben establecerse para ninguno de los elementos devueltos.
search_text	string	✔	El texto para el que hay que buscar coincidencia en el título o la descripción del elemento.
filetype	uint32	✔	IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileid	uint64	✔	Encuentra todos los elementos que hacen referencia al elemento dado.
days	uint32	✔	Si query_type es k_PublishedFileQueryType_RankedByTrend, este es el número de días para obtener votos para [1,7].
include_recent_votes_only	bool	✔	Si query_type es k_PublishedFileQueryType_RankedByTrend, entonces limita el conjunto de resultados solo a los elementos que tienen votos dentro del rango de días dado.
cache_max_age_seconds	uint32		Permite devolver datos obsoletos para el número de segundos especificado.
language	int32		El idioma de búsqueda y de devolución. Será inglés por defecto.
required_kv_tags	{message}	✔	Las etiquetas clave-valor requeridas para buscar coincidencia.
totalonly	bool	✔	Si es "true", devuelve solo el número total de archivos que satisfagan esta consulta (opcional).
ids_only	bool	✔	Si es "true", devuelve solo los id. de archivos publicados que satisfagan esta consulta (opcional).
return_vote_data	bool	✔	Devolver los datos de voto.
return_tags	bool	✔	Devuelve las etiquetas en la información del archivo.
return_kv_tags	bool	✔	Devuelve las etiquetas clave-valor en la información del archivo.
return_previews	bool	✔	Devuelve detalles de la imagen y video de la vista previa en la información del archivo.
return_children	bool	✔	Devuelve los id. de elementos secundarios en los detalles del archivo.
return_short_description	bool	✔	Completa el campo short_description en lugar de file_description
return_for_sale_data	bool	✔	Devuelve información de precio, si fuese aplicable.
return_metadata	bool		Completar los metadatos.
return_playtime_stats	uint32	✔	Devuelve las estadísticas de tiempo de juego para el número especificado de días anteriores a la fecha de hoy.

Realiza una consulta de búsqueda para archivos publicados.

SetDeveloperMetadata

Nombre	Tipo	Obligatorio	Descripción
key	string	✔	Clave de autenticación de editor de la Web de API de Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
metadata	string	✔

Establece los metadatos para un desarrollador en el archivo publicado.

NOTA: Esta llamada requiere una clave de API de editor para utilizar este método. Por tanto, esta API DEBE llamarse desde un servidor seguro, ¡y los clientes jamás pueden usarla directamente!

UpdateAppUGCBan

Nombre	Tipo	Obligatorio	Descripción
key	string	✔	Clave de autenticación de editor de la Web de API de Steamworks.
steamid	uint64	✔	Id. de Steam del usuario
appid	uint32	✔
expiration_time	uint32	✔	Marca de tiempo de Unix de la expiración del bloqueo; 0 para eliminar.
reason	string		Razón por la que el usuario fue bloqueado. Se le mostrará al usuario.

Agrega, actualiza o elimina el bloqueo de contenido generado por los usuarios de un usuario en la aplicación. Establece expiration_time = 0 para eliminar el bloqueo.

NOTA: Esta llamada requiere una clave de API de editor para utilizar este método. Por tanto, esta API DEBE llamarse desde un servidor seguro, ¡y los clientes jamás pueden usarla directamente!

UpdateBanStatus

Nombre	Tipo	Obligatorio	Descripción
key	string	✔	Clave de autenticación de editor de la Web de API de Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
banned	bool	✔
reason	string	✔	Razón por la que el artículo fue bloqueado. Solo visible para los administradores.

Actualiza el estado de bloqueo en el archivo publicado.

NOTA: Esta llamada requiere una clave de API de editor para utilizar este método. Como tal, esta API DEBE ser llamada desde un servidor seguro y ¡nunca debe ser usada directamente desde un equipo cliente!

UpdateIncompatibleStatus

Name	Tipo	Obligatorio	Descripción
key	string	✔	Clave de autenticación de editor de la Web de API de Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
incompatible	bool	✔

Actualiza el estado de incompatibilidad en el archivo publicado. Los artículos "incompatibles" están ocultos en los puntos de encuentro y los perfiles de los usuarios, pero aún se puede acceder a ellos mediante un enlace directo.

NOTA: Esta llamada requiere una clave de API de editor para utilizar este método. Por tanto, esta API DEBE llamarse desde un servidor seguro, ¡y los clientes jamás pueden usarla directamente!

UpdateTags

Nombre	Tipo	Obligatorio	Descripción
key	string	✔	Clave de autenticación de editor de la Web de API de Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
add_tags	string		Etiquetas para agregar.
remove_tags	string		Etiquetas para eliminar.

Actualiza las etiquetas en el archivo publicado. Las etiquetas existentes no se eliminarán a menos que se especifiquen en el parámetro remove_tags.

NOTA: Esta llamada requiere una clave de API de editor para utilizar este método. Por tanto, esta API DEBE llamarse desde un servidor seguro, ¡y los clientes jamás pueden usarla directamente!

Enums

Estas son las enumeraciones definidas para usarse con ISteamRemoteStorage.

EPublishedFileQueryType

Maneras en que puedes consultar artículos de CGU.

Nombre	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

Forma en que un archivo compartido puede consultarse con QueryFile.

Nombre	Valor	Descripción
k_PFI_MatchingFileType_Items	0	Artículos.
k_PFI_MatchingFileType_Collections	1	Una colección de elementos de Workshop.
k_PFI_MatchingFileType_Art	2	Material gráfico.
k_PFI_MatchingFileType_Videos	3	Videos.
k_PFI_MatchingFileType_Screenshots	4	Capturas de pantalla.
k_PFI_MatchingFileType_CollectionEligible	5	Los artículos pueden colocarse dentro de una colección.
k_PFI_MatchingFileType_Games	6	Sin usar.
k_PFI_MatchingFileType_Software	7	Sin usar.
k_PFI_MatchingFileType_Concepts	8	Sin usar.
k_PFI_MatchingFileType_GreenlightItems	9	Sin usar.
k_PFI_MatchingFileType_AllGuides	10	Guías.
k_PFI_MatchingFileType_WebGuides	11	Guía web de Steam.
k_PFI_MatchingFileType_IntegratedGuides	12	Guía integrada en la aplicación.
k_PFI_MatchingFileType_UsableInGame	13
k_PFI_MatchingFileType_Merch	14	Artículos de Workshop sobre los que se puede votar a efectos de venta.
k_PFI_MatchingFileType_ControllerBindings	15	Configuraciones del Steam Controller.
k_PFI_MatchingFileType_SteamworksAccessInvites	16	Usado de forma interna.
k_PFI_MatchingFileType_Items_Mtx	17	Artículos de Workshop que pueden venderse en el juego.
k_PFI_MatchingFileType_Items_ReadyToUse	18	Artículos de Workshop que el usuario puede utilizar inmediatamente.
k_PFI_MatchingFileType_WorkshopShowcase	19
k_PFI_MatchingFileType_GameManagedItems	20	Lo gestiona completamente el juego, no el usuario, y no aparece en la web.