Steamworks-Dokumentation
IPublishedFileService-Schnittstelle
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/
NameTypErforderlich?Beschreibung
keystringBenutzer-Authentifizierungsschlüssel der Steamworks-Web-API.
publishedfileiduint64Zu löschendes Objekt
appiduint32Anwendung, 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/
NameTypErforderlich?Beschreibung
keystringBenutzer-Authentifizierungsschlüssel der Steamworks-Web-API
query_typeuint32IPublishedFileService#EPublishedFileQueryType
pageuint32Aktuelle Seite Zurzeit liegt die Obergrenze bei 1000.
cursorstringCursor 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.
numperpageuint32(Optional) Die Anzahl der Ergebnisse, die pro Seite zurückgegeben werden sollen.
creator_appiduint32Die Anwendung, von der die Dateien erstellt wurden.
appiduint32Die Anwendung, von der die Dateien gebraucht werden.
requiredtagsstringDie anzuwendenden Tags Siehe „match_all_tags“-Parameter unten
excludedtagsstring(Optional) Tags, die bei einer veröffentlichten Datei NICHT vorhanden sein dürfen, um die Abfragekriterien zu erfüllen.
match_all_tagsboolBei „true“ müssen die Gegenstände über alle angegebenen Tags verfügen; andernfalls müssen Sie mindestens eins der Tags haben.
required_flagsstringErforderliche Flags, die bei allen zurückgegebenen Gegenständen gesetzt sein müssen.
omitted_flagsstringFlags, die bei keinem der zurückgegebenen Gegenstände gesetzt sein dürfen.
search_textstringText, der im Titel oder in der Beschreibung des Gegenstands enthalten sein muss.
filetypeuint32IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileiduint64Findet alle Gegenstände, die auf den angegebenen Gegenstand verweisen.
daysuint32Wenn 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_onlyboolWenn 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_secondsuint32Erlaubt, für die angegebene Anzahl von Sekunden veraltete Daten zurückzugeben.
languageint32Sprache, in der gesucht und zurückgegeben werden soll. Standardeinstellung: Englisch.
required_kv_tags{message}Erforderliche Schlüsselwert-Tags, denen entsprochen werden muss.
totalonlybool(Optional) Bei „true“ wird nur die Gesamtzahl der Dateien zurückgegeben, die den Kriterien dieser Abfrage entsprechen.
ids_onlyinclude_played_free_games(Optional) Bei „true“ werden nur die IDs veröffentlichter Dateien zurückgegeben, die den Kriterien dieser Abfrage entsprechen.
return_vote_datainclude_played_free_gamesGibt Bewertungsdaten zurück.
return_tagsboolGibt Tags in den Dateidetails zurück.
return_kv_tagsinclude_played_free_gamesGibt Schlüsselwert-Tags in den Dateidetails zurück.
return_previewsinclude_played_free_gamesGibt das Vorschaubild und Videodetails in den Dateidetails zurück.
return_childrenboolGibt untergeordnete Gegenstand-IDs in den Dateidetails zurück.
return_short_descriptionboolFüllt das Feld „short_description“ statt „file_description“ aus.
return_for_sale_datainclude_played_free_gamesGibt Preisinformationen zurück, falls zutreffend.
return_metadataboolLiest die Metadaten ein.
return_playtime_statsuint32Gibt Spielzeitstatistiken für die angegebene Anzahl von Tagen vor heute zurück.

Führt eine Suchabfrage für veröffentlichte Dateien durch.
NOTE: While you can query by the "filetype" parameters (IPublishedFileService#EPublishedFileInfoMatchingFileType), the results will contain a "file_type" value. That value will correspond to ISteamRemoteStorage#EWorkshopFileType

SetDeveloperMetadata

POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
NameTypErforderlich?Beschreibung
keystringPublisher-Authentifizierungsschlüssel der Steamworks-Web-API.
publishedfileiduint64
appiduint32
metadatastring

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/
NameTypErforderlich?Beschreibung
keystringPublisher-Authentifizierungsschlüssel der Steamworks-Web-API.
steamiduint64Die Steam-ID des Benutzers
appiduint32
expiration_timeuint32Unix-Zeitstempel nach Ablauf des Ausschlusses, 0 zur Entfernung
reasonstringGibt 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/
NameTypErforderlich?Beschreibung
keystringPublisher-Authentifizierungsschlüssel der Steamworks-Web-API.
publishedfileiduint64
appiduint32
bannedbool
reasonStringGrund, 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/
NameTypErforderlich?Beschreibung
keystringPublisher-Authentifizierungsschlüssel der Steamworks-Web-API
publishedfileiduint64
appiduint32
incompatiblebool

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/
NameTypErforderlich?Beschreibung
keystringPublisher-Authentifizierungsschlüssel der Steamworks-Web-API.
publishedfileiduint64
appiduint32
add_tagsstringHinzuzufügende Tags
remove_tagsStringZu 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.

NameValue
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

Die Art, auf der eine geteilte Datei von QueryFile abgefragt werden kann.

NameWerteBeschreibung
k_PFI_MatchingFileType_Items0Artikel.
k_PFI_MatchingFileType_Collections1Eine Sammlung von Workshop-Artikeln.
k_PFI_MatchingFileType_Art2Artwork.
k_PFI_MatchingFileType_Videos3Videos.
k_PFI_MatchingFileType_Screenshots4Screenshots.
k_PFI_MatchingFileType_CollectionEligible5Artikel, die einer Kollektion hinzugefügt werden können.
k_PFI_MatchingFileType_Games6Nicht verwendet.
k_PFI_MatchingFileType_Software7Nicht verwendet
k_PFI_MatchingFileType_Concepts8Nicht verwendet
k_PFI_MatchingFileType_GreenlightItems9Nicht verwendet
k_PFI_MatchingFileType_AllGuides10Anleitungen.
k_PFI_MatchingFileType_WebGuides11Steam-Web-Anleitung.
k_PFI_MatchingFileType_IntegratedGuides12In die Anwendung integrierte Anleitung.
k_PFI_MatchingFileType_UsableInGame13
k_PFI_MatchingFileType_Merch14Workshop-Artikel, die bewertet werden sollen, mit dem Ziel, sie zu verkaufen
k_PFI_MatchingFileType_ControllerBindings15Belegung des Steam Controllers.
k_PFI_MatchingFileType_SteamworksAccessInvites16Intern verwendet.
k_PFI_MatchingFileType_Items_Mtx17Workshop-Artikel, die im Spiel verkauft werden können.
k_PFI_MatchingFileType_Items_ReadyToUse18Workshop-Gegenstände, die sofort vom Nutzer verwendet werden können.
k_PFI_MatchingFileType_WorkshopShowcase19
k_PFI_MatchingFileType_GameManagedItems20Gänzlich vom Spiel und nicht vom Benutzer verwaltet; nicht im Internet angezeigt.