Stellt zusätzliche Methoden zur Interaktion mit Objekten aus dem Steam-Workshop bereit.
Siehe
ISteamRemoteStorage für die primäre Schnittstelle sowie
ICloudService.
HINWEIS: Dies ist eine Service-Schnittstelle; Methoden in dieser Schnittstelle sollten mit dem Parameter
input_json
aufgerufen werden.
Für weitere Informationen zur Verwendung der Steamworks-Web-API lesen Sie bitte den Dokumentationsartikel
Web-API – Übersicht.
Löschen
GET https://api.steampowered.com/IPublishedFileService/Delete/v1/
Name | Typ | Erforderlich? | Beschreibung |
key | string | ✔ | Benutzer-Authentifizierungsschlüssel der Steamworks-Web-API. |
publishedfileid | uint64 | ✔ | Zu löschendes Objekt |
appid | uint32 | ✔ | Anwendung, zu der das Objekt gehört |
Löscht ein Objekt.
HINWEIS: Dieser Aufruf erfordert einen Publisher-API-Schlüssel, um diese Methode verwenden zu können. Daher
MUSS diese API von einem gesicherten Server aufgerufen und kann nie direkt von Clients verwendet werden.
QueryFiles
GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
Name | Typ | Erforderlich? | Beschreibung |
key | string | ✔ | Benutzer-Authentifizierungsschlüssel der Steamworks-Web-API |
query_type | uint32 | ✔ | IPublishedFileService#EPublishedFileQueryType |
page | uint32 | ✔ | Aktuelle Seite Zurzeit liegt die Obergrenze bei 1000. |
cursor | string | ✔ | Cursor zur Seitennummerierung durch die Ergebnisse (für die erste Abfrage auf „*“ setzen). Sie sollten dieses dem „page“-Parameter vorziehen, da er tiefe Seitennummerierung ermöglicht. Bei Verwendung wird der „page“-Parameter ignoriert. Verwenden Sie den zurückgegebenen Wert „next_cursor“ in der nächsten Abfrage, um den nächsten Satz von Ergebnissen zu erhalten. |
numperpage | uint32 | | (Optional) Die Anzahl der Ergebnisse, die pro Seite zurückgegeben werden sollen. |
creator_appid | uint32 | ✔ | Die Anwendung, von der die Dateien erstellt wurden. |
appid | uint32 | ✔ | Die Anwendung, von der die Dateien gebraucht werden. |
requiredtags | string | ✔ | Die anzuwendenden Tags Siehe „match_all_tags“-Parameter unten |
excludedtags | string | ✔ | (Optional) Tags, die bei einer veröffentlichten Datei NICHT vorhanden sein dürfen, um die Abfragekriterien zu erfüllen. |
match_all_tags | bool | | Bei „true“ müssen die Gegenstände über alle angegebenen Tags verfügen; andernfalls müssen Sie mindestens eins der Tags haben. |
required_flags | string | ✔ | Erforderliche Flags, die bei allen zurückgegebenen Gegenständen gesetzt sein müssen. |
omitted_flags | string | ✔ | Flags, die bei keinem der zurückgegebenen Gegenstände gesetzt sein dürfen. |
search_text | string | ✔ | Text, der im Titel oder in der Beschreibung des Gegenstands enthalten sein muss. |
filetype | uint32 | ✔ | IPublishedFileService#EPublishedFileInfoMatchingFileType |
child_publishedfileid | uint64 | ✔ | Findet alle Gegenstände, die auf den angegebenen Gegenstand verweisen. |
days | uint32 | ✔ | Wenn query_type mit k_PublishedFileQueryType_RankedByTrend übereinstimmt, ist dies die Anzahl von Tagen, für die Bewertungen für [1,7] abgerufen werden sollen. |
include_recent_votes_only | bool | ✔ | Wenn query_type mit k_PublishedFileQueryType_RankedByTrend übereinstimmt, dann wird der Ergebnissatz auf Gegenstände beschränkt, für die innerhalb des angegebenen Tagesbereichs Bewertungen vorliegen. |
cache_max_age_seconds | uint32 | | Erlaubt, für die angegebene Anzahl von Sekunden veraltete Daten zurückzugeben. |
language | int32 | | Sprache, in der gesucht und zurückgegeben werden soll. Standardeinstellung: Englisch. |
required_kv_tags | {message} | ✔ | Erforderliche Schlüsselwert-Tags, denen entsprochen werden muss. |
totalonly | bool | ✔ | (Optional) Bei „true“ wird nur die Gesamtzahl der Dateien zurückgegeben, die den Kriterien dieser Abfrage entsprechen. |
ids_only | include_played_free_games | ✔ | (Optional) Bei „true“ werden nur die IDs veröffentlichter Dateien zurückgegeben, die den Kriterien dieser Abfrage entsprechen. |
return_vote_data | include_played_free_games | ✔ | Gibt Bewertungsdaten zurück. |
return_tags | bool | ✔ | Gibt Tags in den Dateidetails zurück. |
return_kv_tags | include_played_free_games | ✔ | Gibt Schlüsselwert-Tags in den Dateidetails zurück. |
return_previews | include_played_free_games | ✔ | Gibt das Vorschaubild und Videodetails in den Dateidetails zurück. |
return_children | bool | ✔ | Gibt untergeordnete Gegenstand-IDs in den Dateidetails zurück. |
return_short_description | bool | ✔ | Füllt das Feld „short_description“ statt „file_description“ aus. |
return_for_sale_data | include_played_free_games | ✔ | Gibt Preisinformationen zurück, falls zutreffend. |
return_metadata | bool | | Liest die Metadaten ein. |
return_playtime_stats | uint32 | ✔ | Gibt Spielzeitstatistiken für die angegebene Anzahl von Tagen vor heute zurück. |
Führt eine Suchabfrage für veröffentlichte Dateien durch.
SetDeveloperMetadata
POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
Name | Typ | Erforderlich? | Beschreibung |
key | string | ✔ | Publisher-Authentifizierungsschlüssel der Steamworks-Web-API. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
metadata | string | ✔ | |
Setzt die Metadaten für einen Entwickler in die veröffentlichte Datei.
HINWEIS: This call requires a publisher API key to use this method. As such this API
MUST be called from a secure server, and can never be used directly by clients!
UpdateAppUGCBan
POST https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/
Name | Typ | Erforderlich? | Beschreibung |
key | string | ✔ | Publisher-Authentifizierungsschlüssel der Steamworks-Web-API. |
steamid | uint64 | ✔ | Die Steam-ID des Benutzers |
appid | uint32 | ✔ | |
expiration_time | uint32 | ✔ | Unix-Zeitstempel nach Ablauf des Ausschlusses, 0 zur Entfernung |
reason | string | | Gibt an, warum der Nutzer ausgeschlossen wurde. Wird dem Benutzer angezeigt. |
Fügt der Anwendung den UGC-Ausschluss hinzu, aktualisiert oder entfernt ihn. Setzen Sie expiration_time auf 0, um den Ausschluss aufzuheben.
HINWEIS: This call requires a publisher API key to use this method. As such this API
MUST be called from a secure server, and can never be used directly by clients!
UpdateBanStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/
Name | Typ | Erforderlich? | Beschreibung |
key | string | ✔ | Publisher-Authentifizierungsschlüssel der Steamworks-Web-API. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
banned | bool | ✔ | |
reason | String | ✔ | Grund, warum der Gegenstand ausgeschlossen wurde. Nur für Administratoren sichtbar. |
Aktualisiert den Ausschlussstatus in der veröffentlichten Datei.
HINWEIS: This call requires a publisher API key to use this method. As such this API
MUST be called from a secure server, and can never be used directly by clients!
UpdateIncompatibleStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/
Name | Typ | Erforderlich? | Beschreibung |
key | string | ✔ | Publisher-Authentifizierungsschlüssel der Steamworks-Web-API |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
incompatible | bool | ✔ | |
Aktualisiert den „inkompatibel“-Status in der veröffentlichten Datei. „Inkompatible“ Gegenstände werden vor dem Communityhub und Benutzerprofilen versteckt. Es kann allerdings noch immer über Direktverknüpfung darauf zugegriffen werden.
HINWEIS: This call requires a publisher API key to use this method. As such this API
MUST be called from a secure server, and can never be used directly by clients!
UpdateTags
POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
Name | Typ | Erforderlich? | Beschreibung |
key | string | ✔ | Publisher-Authentifizierungsschlüssel der Steamworks-Web-API. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
add_tags | string | | Hinzuzufügende Tags |
remove_tags | String | | Zu entfernende Tags |
Aktualisiert Tags der veröffentlichten Datei. Bestehende Tags werden nur dann entfernt, wenn sie im Parameter
remove_tags
angegeben sind.
HINWEIS: Dieser Aufruf erfordert einen Publisher-API-Schlüssel, um diese Methode verwenden zu können. Daher
MUSS diese API von einem gesicherten Server aufgerufen werden und kann nie direkt von Clients verwendet werden!
Aufzählungstypen
Dies sind Aufzählungstypen, die zur Verwendung mit ISteamRemoteStorage definiert sind.
EPublishedFileQueryType
Wege, auf denen Sie nach UGC-Artikel abfragen können.
Name | Value |
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
Die Art, auf der eine geteilte Datei von QueryFile abgefragt werden kann.
Name | Werte | Beschreibung |
k_PFI_MatchingFileType_Items | 0 | Artikel. |
k_PFI_MatchingFileType_Collections | 1 | Eine Sammlung von Workshop-Artikeln. |
k_PFI_MatchingFileType_Art | 2 | Artwork. |
k_PFI_MatchingFileType_Videos | 3 | Videos. |
k_PFI_MatchingFileType_Screenshots | 4 | Screenshots. |
k_PFI_MatchingFileType_CollectionEligible | 5 | Artikel, die einer Kollektion hinzugefügt werden können. |
k_PFI_MatchingFileType_Games | 6 | Nicht verwendet. |
k_PFI_MatchingFileType_Software | 7 | Nicht verwendet |
k_PFI_MatchingFileType_Concepts | 8 | Nicht verwendet |
k_PFI_MatchingFileType_GreenlightItems | 9 | Nicht verwendet |
k_PFI_MatchingFileType_AllGuides | 10 | Anleitungen. |
k_PFI_MatchingFileType_WebGuides | 11 | Steam-Web-Anleitung. |
k_PFI_MatchingFileType_IntegratedGuides | 12 | In die Anwendung integrierte Anleitung. |
k_PFI_MatchingFileType_UsableInGame | 13 | |
k_PFI_MatchingFileType_Merch | 14 | Workshop-Artikel, die bewertet werden sollen, mit dem Ziel, sie zu verkaufen |
k_PFI_MatchingFileType_ControllerBindings | 15 | Belegung des Steam Controllers. |
k_PFI_MatchingFileType_SteamworksAccessInvites | 16 | Intern verwendet. |
k_PFI_MatchingFileType_Items_Mtx | 17 | Workshop-Artikel, die im Spiel verkauft werden können. |
k_PFI_MatchingFileType_Items_ReadyToUse | 18 | Workshop-Gegenstände, die sofort vom Nutzer verwendet werden können. |
k_PFI_MatchingFileType_WorkshopShowcase | 19 | |
k_PFI_MatchingFileType_GameManagedItems | 20 | Gänzlich vom Spiel und nicht vom Benutzer verwaltet; nicht im Internet angezeigt. |