Steamworks-dokumentation
IPublishedFileService-grænseflade
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/
NavnTypePåkrævetBeskrivelse
keystringSteamworks-web-API – brugergodkendelsesnøgle
publishedfileiduint64Emnet, som skal slettes
appiduint32Applikationen, 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/
NavnTypePåkrævetBeskrivelse
keystringSteamworks-web-API – brugergodkendelsesnøgle.
query_typeuint32IPublishedFileService#EPublishedFileQueryType
pageuint32Aktuel side. I øjeblikket er der en øvre grænse på 1000.
cursorstringBrug 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.
numperpageuint32(Valgfrit) Antallet af resultater pr. side, som skal returneres.
creator_appiduint32Applikation, som oprettede filerne
appiduint32Applikation, som forbruger filerne
requiredtagsstringTags, som skal matche. Se parameteren match_all_tags nedenfor
excludedtagsstring(Valgfrit) Tags, som IKKE må være til stede på en udgivet fil for at opfylde forespørgslen.
match_all_tagsboolHvis true, skal emnerne have alle de angivne tags, ellers skal de have mindst ét af taggene.
required_flagsstringPåkrævede flag, som skal angives på alle returnerede emner
omitted_flagsstringFlag, som ikke må være angivet på returnerede emner
search_textstringTekst, som skal matche emnets titel eller beskrivelse
filetypeuint32IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileiduint64Find alle emner, som refererer til det givne emne.
daysuint32Hvis query_type er k_PublishedFileQueryType_RankedByTrend, så er dette antallet af dage, der skal hentes stemmer for [1,7].
include_recent_votes_onlyboolHvis query_type er k_PublishedFileQueryType_RankedByTrend, skal resultatsættet begrænses til de emner, der har stemmer indenfor det givne daginterval
cache_max_age_secondsuint32Tillader, at forældede data returneres for det angivne antal sekunder.
languageint32Sprog, 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å.
totalonlybool(Valgfrit) Hvis true, returneres kun det samlede antal filer, der opfylder denne forespørgsel.
ids_onlybool(Valgfrit) Hvis true, returneres kun de udgivne fil-ID'er, der opfylder denne forespørgsel.
return_vote_databoolReturnerer afstemningsdata
return_tagsboolReturnerer tags i fildetaljerne
return_kv_tagsboolReturnerer nøgleværditags i fildetaljerne
return_previewsboolReturnerer detaljer om forhåndsvisningsbillede og -video i fildetaljerne
return_childrenboolReturnerer underordnede ID'er på emner i fildetaljerne
return_short_descriptionboolUdfyld feltet short_description i stedet for file_description
return_for_sale_databoolReturnerer prisoplysninger, hvis de findes
return_metadataboolUdfyld metadataene
return_playtime_statsuint32Returnerer statistik over spilletid for det angivne antal dage før i dag.

Udfører en søgeforespørgsel for udgivne filer
BEMÆRK: Du kan lave forespørgsler ud fra "filetype"-parametrene (IPublishedFileService#EPublishedFileInfoMatchingFileType), men resultatet vil indeholde en "file_type"-værdi. Værdien svarer til ISteamRemoteStorage#EWorkshopFileType.

SetDeveloperMetadata

POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
NavnTypePåkrævetBeskrivelse
keystringSteamworks-web-API – udgivergodkendelsesnøgle
publishedfileiduint64
appiduint32
metadatastring

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/
NavnTypePåkrævetBeskrivelse
keystringSteamworks-web-API – udgivergodkendelsesnøgle
steamiduint64Brugerens Steam-ID
appiduint32
expiration_timeuint32Unix-tidsstempel, når udelukkelsen udløber, 0 for at fjerne
reasonstringGrunden 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/
NavnTypePåkrævetBeskrivelse
keystringSteamworks-web-API – udgivergodkendelsesnøgle
publishedfileiduint64
appiduint32
bannedbool
reasonstringGrunden 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/
NavnTypePåkrævetBeskrivelse
keystringSteamworks-web-API – udgivergodkendelsesnøgle
publishedfileiduint64
appiduint32
incompatiblebool

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/
NavnTypePåkrævetBeskrivelse
keystringSteamworks-web-API – udgivergodkendelsesnøgle
publishedfileiduint64
appiduint32
add_tagsstringTags, som skal tilføjes
remove_tagsstringTags, 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.

NavnVærdi
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

Måder, en delt fil kan forespørges med QueryFile.

NavnVærdierBeskrivelse
k_PFI_MatchingFileType_Items0Emner
k_PFI_MatchingFileType_Collections1En samling af værkstedsemner
k_PFI_MatchingFileType_Art2Illustrationer
k_PFI_MatchingFileType_Videos3Videoer
k_PFI_MatchingFileType_Screenshots4Skærmbilleder
k_PFI_MatchingFileType_CollectionEligible5Emner, som kan lægges i en samling
k_PFI_MatchingFileType_Games6Ubrugt
k_PFI_MatchingFileType_Software7Ubrugt
k_PFI_MatchingFileType_Concepts8Ubrugt
k_PFI_MatchingFileType_GreenlightItems9Ubrugt
k_PFI_MatchingFileType_AllGuides10Guider
k_PFI_MatchingFileType_WebGuides11Steam-webguide
k_PFI_MatchingFileType_IntegratedGuides12Applikationsintegreret guide
k_PFI_MatchingFileType_UsableInGame13
k_PFI_MatchingFileType_Merch14Værkstedsemner, som der skal stemmes om med henblik på salg
k_PFI_MatchingFileType_ControllerBindings15Steam Controller-bindinger.
k_PFI_MatchingFileType_SteamworksAccessInvites16Bruges internt
k_PFI_MatchingFileType_Items_Mtx17Værkstedsemner, som kan sælges i spillet
k_PFI_MatchingFileType_Items_ReadyToUse18Værkstedsemner, som spilleren kan bruge med det samme
k_PFI_MatchingFileType_WorkshopShowcase19
k_PFI_MatchingFileType_GameManagedItems20Administreres fuldstændigt af spillet, ikke brugeren, og vises ikke på nettet.