Giver yderligere metoder til at interagere med Steam-værkstedsemner.
Se
ISteamRemoteStorage for at se den primære grænseflade og også
ICloudService.
BEMÆRK: Dette er en tjenestegrænseflade. Metoder i denne grænseflade bør kaldes med parameteren
input_json
.
Se
Web-API-oversigt for flere oplysninger om, hvordan du bruger Steamworks-web-API'en.
Delete
GET https://api.steampowered.com/IPublishedFileService/Delete/v1/
Navn | Type | Påkrævet | Beskrivelse |
key | string | ✔ | Steamworks-web-API – brugergodkendelsesnøgle |
publishedfileid | uint64 | ✔ | Emnet, som skal slettes |
appid | uint32 | ✔ | Applikationen, emnet hører til |
Sletter et emne.
BEMÆRK: Dette kald kræver en udgiver-API-nøgle for at bruge denne metode. Derfor
SKAL denne API kaldes fra en sikker server og må aldrig bruges direkte af klienter!
QueryFiles
GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
Navn | Type | Påkrævet | Beskrivelse |
key | string | ✔ | Steamworks-web-API – brugergodkendelsesnøgle. |
query_type | uint32 | ✔ | IPublishedFileService#EPublishedFileQueryType |
page | uint32 | ✔ | Aktuel side. I øjeblikket er der en øvre grænse på 1000. |
cursor | string | ✔ | Brug markør til at sideinddele gennem resultaterne (angiv som "*" til den første anmodning). Foretræk dette frem for at bruge sideparameteren, da det vil gøre det muligt for dig at beholde sidenummerering. Når dette bruges, vil sideparameteren blive ignoreret. Brug værdien "next_cursor", som returneres i svaret, til at konfigurere den næste forespørgsel for at hente det næste sæt resultater. |
numperpage | uint32 | | (Valgfrit) Antallet af resultater pr. side, som skal returneres. |
creator_appid | uint32 | ✔ | Applikation, som oprettede filerne |
appid | uint32 | ✔ | Applikation, som forbruger filerne |
requiredtags | string | ✔ | Tags, som skal matche. Se parameteren match_all_tags nedenfor |
excludedtags | string | ✔ | (Valgfrit) Tags, som IKKE må være til stede på en udgivet fil for at opfylde forespørgslen. |
match_all_tags | bool | | Hvis true, skal emnerne have alle de angivne tags, ellers skal de have mindst ét af taggene. |
required_flags | string | ✔ | Påkrævede flag, som skal angives på alle returnerede emner |
omitted_flags | string | ✔ | Flag, som ikke må være angivet på returnerede emner |
search_text | string | ✔ | Tekst, som skal matche emnets titel eller beskrivelse |
filetype | uint32 | ✔ | IPublishedFileService#EPublishedFileInfoMatchingFileType |
child_publishedfileid | uint64 | ✔ | Find alle emner, som refererer til det givne emne. |
days | uint32 | ✔ | Hvis query_type er k_PublishedFileQueryType_RankedByTrend, så er dette antallet af dage, der skal hentes stemmer for [1,7]. |
include_recent_votes_only | bool | ✔ | Hvis query_type er k_PublishedFileQueryType_RankedByTrend, skal resultatsættet begrænses til de emner, der har stemmer indenfor det givne daginterval |
cache_max_age_seconds | uint32 | | Tillader, at forældede data returneres for det angivne antal sekunder. |
language | int32 | | Sprog, der skal søges i, samt hvilket sprog der returneres. Standardindstilling er engelsk. |
required_kv_tags | {message} | ✔ | Påkrævet nøgleværditags, som der skal matches på. |
totalonly | bool | ✔ | (Valgfrit) Hvis true, returneres kun det samlede antal filer, der opfylder denne forespørgsel. |
ids_only | bool | ✔ | (Valgfrit) Hvis true, returneres kun de udgivne fil-ID'er, der opfylder denne forespørgsel. |
return_vote_data | bool | ✔ | Returnerer afstemningsdata |
return_tags | bool | ✔ | Returnerer tags i fildetaljerne |
return_kv_tags | bool | ✔ | Returnerer nøgleværditags i fildetaljerne |
return_previews | bool | ✔ | Returnerer detaljer om forhåndsvisningsbillede og -video i fildetaljerne |
return_children | bool | ✔ | Returnerer underordnede ID'er på emner i fildetaljerne |
return_short_description | bool | ✔ | Udfyld feltet short_description i stedet for file_description |
return_for_sale_data | bool | ✔ | Returnerer prisoplysninger, hvis de findes |
return_metadata | bool | | Udfyld metadataene |
return_playtime_stats | uint32 | ✔ | Returnerer statistik over spilletid for det angivne antal dage før i dag. |
Udfører en søgeforespørgsel for udgivne filer
SetDeveloperMetadata
POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
Navn | Type | Påkrævet | Beskrivelse |
key | string | ✔ | Steamworks-web-API – udgivergodkendelsesnøgle |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
metadata | string | ✔ | |
Angiver metadataene for en udvikler på den udgivne fil
BEMÆRK: Dette kald kræver en API-udgivernøgle for at bruge denne metode. Derfor
SKAL denne API kaldes fra en sikker server og må aldrig bruges direkte af klienter!
UpdateAppUGCBan
POST https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/
Navn | Type | Påkrævet | Beskrivelse |
key | string | ✔ | Steamworks-web-API – udgivergodkendelsesnøgle |
steamid | uint64 | ✔ | Brugerens Steam-ID |
appid | uint32 | ✔ | |
expiration_time | uint32 | ✔ | Unix-tidsstempel, når udelukkelsen udløber, 0 for at fjerne |
reason | string | | Grunden til, at spilleren blev udelukket. Vises for brugeren. |
Tilføjer/opdaterer/fjerner udelukkelsen af brugerskabt indhold i applikationen. Sæt expiration_time til 0 for at fjerne udelukkelsen.
BEMÆRK: Dette kald kræver en API-udgivernøgle for at bruge denne metode. Derfor
SKAL denne API kaldes fra en sikker server og må aldrig bruges direkte af klienter!
UpdateBanStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/
Navn | Type | Påkrævet | Beskrivelse |
key | string | ✔ | Steamworks-web-API – udgivergodkendelsesnøgle |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
banned | bool | ✔ | |
reason | string | ✔ | Grunden til, at spilleren blev udelukket. Kun synlig for administratorer. |
Opdaterer udelukkelsesstatussen på den udgivne fil
BEMÆRK: Dette kald kræver en API-udgivernøgle for at bruge denne metode. Derfor
SKAL denne API kaldes fra en sikker server og må aldrig bruges direkte af klienter!
UpdateIncompatibleStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/
Navn | Type | Påkrævet | Beskrivelse |
key | string | ✔ | Steamworks-web-API – udgivergodkendelsesnøgle |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
incompatible | bool | ✔ | |
Opdaterer inkompatibilitetsstatussen på den udgivne fil. Emner med "Incompatible" skjules fra fællesskabshubs og brugerprofiler, men kan stadig tilgås med et direkte link.
BEMÆRK: Dette kald kræver en API-udgivernøgle for at bruge denne metode. Derfor
SKAL denne API kaldes fra en sikker server og må aldrig bruges direkte af klienter!
UpdateTags
POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
Navn | Type | Påkrævet | Beskrivelse |
key | string | ✔ | Steamworks-web-API – udgivergodkendelsesnøgle |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
add_tags | string | | Tags, som skal tilføjes |
remove_tags | string | | Tags, som skal fjernes |
Opdaterer tags på den udgivne fil. Eksisterende tags fjernes ikke, medmindre de angives i parameteren
remove_tags
.
BEMÆRK: Dette kald kræver en API-udgivernøgle for at bruge denne metode. Denne API
SKAL kaldes fra en sikker server og må aldrig bruges direkte af klienter!
Enums
Disse er optællinger, som defineres til brug med ISteamRemoteStorage.
EPublishedFileQueryType
Måder, man kan forespørge brugerskabte emner.
Navn | Værdi |
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
Måder, en delt fil kan forespørges med QueryFile.
Navn | Værdier | Beskrivelse |
k_PFI_MatchingFileType_Items | 0 | Emner |
k_PFI_MatchingFileType_Collections | 1 | En samling af værkstedsemner |
k_PFI_MatchingFileType_Art | 2 | Illustrationer |
k_PFI_MatchingFileType_Videos | 3 | Videoer |
k_PFI_MatchingFileType_Screenshots | 4 | Skærmbilleder |
k_PFI_MatchingFileType_CollectionEligible | 5 | Emner, som kan lægges i en samling |
k_PFI_MatchingFileType_Games | 6 | Ubrugt |
k_PFI_MatchingFileType_Software | 7 | Ubrugt |
k_PFI_MatchingFileType_Concepts | 8 | Ubrugt |
k_PFI_MatchingFileType_GreenlightItems | 9 | Ubrugt |
k_PFI_MatchingFileType_AllGuides | 10 | Guider |
k_PFI_MatchingFileType_WebGuides | 11 | Steam-webguide |
k_PFI_MatchingFileType_IntegratedGuides | 12 | Applikationsintegreret guide |
k_PFI_MatchingFileType_UsableInGame | 13 | |
k_PFI_MatchingFileType_Merch | 14 | Værkstedsemner, som der skal stemmes om med henblik på salg |
k_PFI_MatchingFileType_ControllerBindings | 15 | Steam Controller-bindinger. |
k_PFI_MatchingFileType_SteamworksAccessInvites | 16 | Bruges internt |
k_PFI_MatchingFileType_Items_Mtx | 17 | Værkstedsemner, som kan sælges i spillet |
k_PFI_MatchingFileType_Items_ReadyToUse | 18 | Værkstedsemner, som spilleren kan bruge med det samme |
k_PFI_MatchingFileType_WorkshopShowcase | 19 | |
k_PFI_MatchingFileType_GameManagedItems | 20 | Administreres fuldstændigt af spillet, ikke brugeren, og vises ikke på nettet. |