Documentation Steamworks
Interface IPublishedFileService
Donne accès à d'autres méthodes pour interagir avec les articles du Workshop Steam.

Voir ISteamRemoteStorage pour l'interface principale, ainsi que ICloudService.

REMARQUE : il s'agit d'une interface de service. Les méthodes de cette interface doivent être appelées avec le paramètre input_json.

Pour plus d'informations sur l'utilisation de l'API Web de Steamworks, consultez la section Présentation de l'API Web.

Delete

GET https://api.steampowered.com/IPublishedFileService/Delete/v1/
NomTypeRequisDescription
keystringClé d'authentification du compte pour l'API Web de Steamworks.
publishedfileiduint64Item à supprimer
appiduint32Application à laquelle appartient l'item

Supprime un item.

REMARQUE : cet appel nécessite une clé d'API d'édition afin de pouvoir utiliser la méthode. Cette API doit donc OBLIGATOIREMENT être appelée depuis un serveur sécurisé. Elle ne doit jamais être utilisée directement par les clients !

QueryFiles

GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
NomTypeRequisDescription
keystringClé d'authentification du compte pour l'API Web de Steamworks.
query_typeuint32IPublishedFileService#EPublishedFileQueryType
pageuint32Page actuelle. Limite actuelle maximale de 1 000.
cursorstringCurseur pour la pagination des résultats (régler sur « * » pour la première requête). À favoriser plutôt que de modifier un paramètre de la page, car cela permet une pagination plus approfondie. Lorsque cette méthode est utilisée, le paramètre de la page sera ignoré. Utilise la valeur "next_cursor" renvoyée en réponse pour mettre en place la requête suivante qui demandera la prochaine série de résultats.
numperpageuint32Nombre de résultats par page à renvoyer (facultatif).
creator_appiduint32Application ayant créé les fichiers.
appiduint32Application consommant les fichiers.
requiredtagsstringTag correspondants. Voir ci-dessous le paramètre match_all_tags.
excludedtagsstringTags devant être ABSENTS sur un fichier publié afin de satisfaire la requête (facultatif).
match_all_tagsboolSi true, alors tous les tags des items doivent être renseignés. Autrement, les items doivent comporter au moins un des tags.
required_flagsstringMarqueurs nécessaires devant être définis sur tout item renvoyé.
omitted_flagsstringMarqueurs ne devant pas être définis sur tout item renvoyé.
search_textstringTexte correspondant au titre ou à la description de l'item.
filetypeuint32IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileiduint64Trouve tous les items faisant référence à l'item spécifié.
daysuint32Si query_type est k_PublishedFileQueryType_RankedByTrend, alors il s'agit du nombre de jours pour obtenir les votes pour [1,7].
include_recent_votes_onlyboolSi query_type est k_PublishedFileQueryType_RankedByTrend, alors l'ensemble des résultats sera limité aux items ayant reçu des votes dans l'intervalle de jours donné.
cache_max_age_secondsuint32Permet de renvoyer des données périmées durant un nombre de secondes spécifié.
languageint32Langue dans laquelle effectuer la recherche et renvoyer les résultats. Par défaut, cette langue est l'anglais.
required_kv_tags{message}Tags clé-valeur requis à faire correspondre.
totalonlyboolSi true, ne renvoie que le nombre total de fichiers satisfaisant la requête (facultatif).
ids_onlyboolSi true, ne renvoie les ID des fichiers publiés que pour les fichiers satisfaisant la requête (facultatif).
return_vote_databoolRenvoie les données de vote.
return_tagsboolRenvoie les tags dans les détails du fichier.
return_kv_tagsboolRenvoie les tags de clés-valeurs dans les détails du fichier.
return_previewsboolRenvoie les détails des images et vidéos d'aperçu dans les détails du fichier.
return_childrenboolRenvoie les ID des items enfants dans les détails du fichier.
return_short_descriptionboolRemplit le champ short_description au lieu de file_description.
return_for_sale_databoolLe cas échéant, renvoie les informations de tarification.
return_metadataboolRemplit les métadonnées.
return_playtime_statsuint32Renvoie les statistiques de temps de jeu pour le nombre renseigné de jours précédant aujourd'hui.

Effectue une requête de recherche de fichiers publiés
REMARQUE : même si vous pouvez faire une recherche selon les paramètres du « filetype » (IPublishedFileService#EPublishedFileInfoMatchingFileType), les résultats contiendront une valeur de « filetype ». La valeur correspondra à ISteamRemoteStorage#EWorkshopFileType.

SetDeveloperMetadata

POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
NomTypeRequisDescription
keystringClé d'authentification de l'équipe d'édition pour l'API Web de Steamworks.
publishedfileiduint64
appid uint32
metadatastring

Définit les métadonnées pour une équipe de développement sur le fichier publié.

REMARQUE : cet appel nécessite une clé d'API d'édition afin de pouvoir utiliser la méthode. Cette API doit donc OBLIGATOIREMENT être appelée depuis un serveur sécurisé. Elle ne doit jamais être utilisée directement par les clients !

UpdateAppUGCBan

POST https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/
NomTypeRequisDescription
keystringClé d'authentification de l'équipe d'édition pour l'API Web de Steamworks.
steamiduint64SteamID du compte.
appid uint32
expiration_timeuint32Heure depuis l'époque Unix à laquelle le bannissement expire (réglez sur 0 pour supprimer le bannissement).
reasonstringRaison du bannissement. Sera affichée à la personne concernée.

Ajoute, met à jour ou supprime un bannissement dans l'application. Indiquez « expiration_time = 0 » pour supprimer le bannissement.

REMARQUE : cet appel nécessite une clé d'API d'édition afin de pouvoir utiliser la méthode. Cette API doit donc OBLIGATOIREMENT être appelée depuis un serveur sécurisé. Elle ne doit jamais être utilisée directement par les clients !

UpdateBanStatus

POST https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/
NomTypeRequisDescription
keystringClé d'authentification de l'équipe d'édition pour l'API Web de Steamworks.
publishedfileiduint64
appid uint32
bannedbool
reasonstringRaison du bannissement de l'item. Visible uniquement des admin.

Met à jour le statut de bannissement du fichier publié.

REMARQUE : cet appel nécessite une clé d'API d'édition afin de pouvoir utiliser la méthode. Cette API doit donc OBLIGATOIREMENT être appelée depuis un serveur sécurisé. Elle ne doit jamais être utilisée directement par les clients !

UpdateIncompatibleStatus

POST https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/
NomTypeRequisDescription
keystringClé d'authentification de l'équipe d'édition pour l'API Web de Steamworks.
publishedfileiduint64
appiduint32
incompatiblebool

Met à jour le statut d'incompatibilité du fichier publié. Les items dits « incompatibles » sont cachés des hubs de la communauté et des profils utilisateurs, mais peuvent toujours être trouvés avec un lien direct.

REMARQUE : cet appel nécessite une clé d'API d'édition afin de pouvoir utiliser la méthode. Cette API doit donc OBLIGATOIREMENT être appelée depuis un serveur sécurisé. Elle ne doit jamais être utilisée directement par les clients !

UpdateTags

POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
NomTypeRequisDescription
keystringClé d'authentification de l'équipe d'édition pour l'API Web de Steamworks.
publishedfileiduint64
appid uint32
add_tagsstringTags à ajouter.
remove_tagsstringTags à supprimer.

Met à jour les tags du fichier publié. Les tags existants ne seront pas supprimés, à moins qu'ils ne soient spécifiés dans le paramètre remove_tags.

REMARQUE : cet appel nécessite une clé API d'édition afin de pouvoir utiliser la méthode. Cette API doit donc OBLIGATOIREMENT être appelée depuis un serveur sécurisé. Elle ne doit jamais être utilisée directement par les clients !

Énumérations

Voici les énumérations destinées à être utilisées avec ISteamRemoteStorage.

EPublishedFileQueryType

Comment vous pouvez demander des items faits par la communauté.

NomValeur
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

Comment un fichier partagé peut être demandé par QueryFile.

NomValeurDescription
k_PFI_MatchingFileType_Items0Articles.
k_PFI_MatchingFileType_Collections1Collection d'articles du Workshop.
k_PFI_MatchingFileType_Art2Création de fan.
k_PFI_MatchingFileType_Videos3Vidéos.
k_PFI_MatchingFileType_Screenshots4Captures d'écran.
k_PFI_MatchingFileType_CollectionEligible5Articles pouvant faire partie d'une collection.
k_PFI_MatchingFileType_Games6Non utilisé.
k_PFI_MatchingFileType_Software7Non utilisé.
k_PFI_MatchingFileType_Concepts8Non utilisé.
k_PFI_MatchingFileType_GreenlightItems9Non utilisé.
k_PFI_MatchingFileType_AllGuides10Guides.
k_PFI_MatchingFileType_WebGuides11Guide Web Steam.
k_PFI_MatchingFileType_IntegratedGuides12Guide d'application intégré.
k_PFI_MatchingFileType_UsableInGame13
k_PFI_MatchingFileType_Merch14Produits dérivés du Workshop destinés à recevoir un vote dans le but d'être vendus.
k_PFI_MatchingFileType_ControllerBindings15Affectations de touches du Steam Controller.
k_PFI_MatchingFileType_SteamworksAccessInvites16Usage interne.
k_PFI_MatchingFileType_Items_Mtx17Items du Workshop pouvant être vendus en jeu.
k_PFI_MatchingFileType_Items_ReadyToUse18Items du Workshop pouvant être utilisés immédiatement.
k_PFI_MatchingFileType_WorkshopShowcase19
k_PFI_MatchingFileType_GameManagedItems20Géré complètement par le jeu, pas par l'utilisateur ou l'utilisatrice, et non affiché sur le Web.