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/
Nom | Type | Requis | Description |
key | string | ✔ | Clé d'authentification du compte pour l'API Web de Steamworks. |
publishedfileid | uint64 | ✔ | Item à supprimer |
appid | uint32 | ✔ | Application à 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/
Nom | Type | Requis | Description |
key | string | ✔ | Clé d'authentification du compte pour l'API Web de Steamworks. |
query_type | uint32 | ✔ | IPublishedFileService#EPublishedFileQueryType |
page | uint32 | ✔ | Page actuelle. Limite actuelle maximale de 1 000. |
cursor | string | ✔ | Curseur 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. |
numperpage | uint32 | | Nombre de résultats par page à renvoyer (facultatif). |
creator_appid | uint32 | ✔ | Application ayant créé les fichiers. |
appid | uint32 | ✔ | Application consommant les fichiers. |
requiredtags | string | ✔ | Tag correspondants. Voir ci-dessous le paramètre match_all_tags. |
excludedtags | string | ✔ | Tags devant être ABSENTS sur un fichier publié afin de satisfaire la requête (facultatif). |
match_all_tags | bool | | Si true, alors tous les tags des items doivent être renseignés. Autrement, les items doivent comporter au moins un des tags. |
required_flags | string | ✔ | Marqueurs nécessaires devant être définis sur tout item renvoyé. |
omitted_flags | string | ✔ | Marqueurs ne devant pas être définis sur tout item renvoyé. |
search_text | string | ✔ | Texte correspondant au titre ou à la description de l'item. |
filetype | uint32 | ✔ | IPublishedFileService#EPublishedFileInfoMatchingFileType |
child_publishedfileid | uint64 | ✔ | Trouve tous les items faisant référence à l'item spécifié. |
days | uint32 | ✔ | Si query_type est k_PublishedFileQueryType_RankedByTrend, alors il s'agit du nombre de jours pour obtenir les votes pour [1,7]. |
include_recent_votes_only | bool | ✔ | Si 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_seconds | uint32 | | Permet de renvoyer des données périmées durant un nombre de secondes spécifié. |
language | int32 | | Langue 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. |
totalonly | bool | ✔ | Si true, ne renvoie que le nombre total de fichiers satisfaisant la requête (facultatif). |
ids_only | bool | ✔ | Si true, ne renvoie les ID des fichiers publiés que pour les fichiers satisfaisant la requête (facultatif). |
return_vote_data | bool | ✔ | Renvoie les données de vote. |
return_tags | bool | ✔ | Renvoie les tags dans les détails du fichier. |
return_kv_tags | bool | ✔ | Renvoie les tags de clés-valeurs dans les détails du fichier. |
return_previews | bool | ✔ | Renvoie les détails des images et vidéos d'aperçu dans les détails du fichier. |
return_children | bool | ✔ | Renvoie les ID des items enfants dans les détails du fichier. |
return_short_description | bool | ✔ | Remplit le champ short_description au lieu de file_description. |
return_for_sale_data | bool | ✔ | Le cas échéant, renvoie les informations de tarification. |
return_metadata | bool | | Remplit les métadonnées. |
return_playtime_stats | uint32 | ✔ | Renvoie 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
SetDeveloperMetadata
POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
Nom | Type | Requis | Description |
key | string | ✔ | Clé d'authentification de l'équipe d'édition pour l'API Web de Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
metadata | string | ✔ | |
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/
Nom | Type | Requis | Description |
key | string | ✔ | Clé d'authentification de l'équipe d'édition pour l'API Web de Steamworks. |
steamid | uint64 | ✔ | SteamID du compte. |
appid | uint32 | ✔ | |
expiration_time | uint32 | ✔ | Heure depuis l'époque Unix à laquelle le bannissement expire (réglez sur 0 pour supprimer le bannissement). |
reason | string | | Raison 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/
Nom | Type | Requis | Description |
key | string | ✔ | Clé d'authentification de l'équipe d'édition pour l'API Web de Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
banned | bool | ✔ | |
reason | string | ✔ | Raison 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/
Nom | Type | Requis | Description |
key | string | ✔ | Clé d'authentification de l'équipe d'édition pour l'API Web de Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
incompatible | bool | ✔ | |
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/
Nom | Type | Requis | Description |
key | string | ✔ | Clé d'authentification de l'équipe d'édition pour l'API Web de Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
add_tags | string | | Tags à ajouter. |
remove_tags | string | | Tags à 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é.
Nom | Valeur |
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
Comment un fichier partagé peut être demandé par QueryFile.
Nom | Valeur | Description |
k_PFI_MatchingFileType_Items | 0 | Articles. |
k_PFI_MatchingFileType_Collections | 1 | Collection d'articles du Workshop. |
k_PFI_MatchingFileType_Art | 2 | Création de fan. |
k_PFI_MatchingFileType_Videos | 3 | Vidéos. |
k_PFI_MatchingFileType_Screenshots | 4 | Captures d'écran. |
k_PFI_MatchingFileType_CollectionEligible | 5 | Articles pouvant faire partie d'une collection. |
k_PFI_MatchingFileType_Games | 6 | Non utilisé. |
k_PFI_MatchingFileType_Software | 7 | Non utilisé. |
k_PFI_MatchingFileType_Concepts | 8 | Non utilisé. |
k_PFI_MatchingFileType_GreenlightItems | 9 | Non utilisé. |
k_PFI_MatchingFileType_AllGuides | 10 | Guides. |
k_PFI_MatchingFileType_WebGuides | 11 | Guide Web Steam. |
k_PFI_MatchingFileType_IntegratedGuides | 12 | Guide d'application intégré. |
k_PFI_MatchingFileType_UsableInGame | 13 | |
k_PFI_MatchingFileType_Merch | 14 | Produits dérivés du Workshop destinés à recevoir un vote dans le but d'être vendus. |
k_PFI_MatchingFileType_ControllerBindings | 15 | Affectations de touches du Steam Controller. |
k_PFI_MatchingFileType_SteamworksAccessInvites | 16 | Usage interne. |
k_PFI_MatchingFileType_Items_Mtx | 17 | Items du Workshop pouvant être vendus en jeu. |
k_PFI_MatchingFileType_Items_ReadyToUse | 18 | Items du Workshop pouvant être utilisés immédiatement. |
k_PFI_MatchingFileType_WorkshopShowcase | 19 | |
k_PFI_MatchingFileType_GameManagedItems | 20 | Géré complètement par le jeu, pas par l'utilisateur ou l'utilisatrice, et non affiché sur le Web. |