Steamworks-dokumentaatio
IPublishedFileService -käyttöliittymä
Tarjoaa lisää keinoja vuorovaikutukseen Steam Workshop -luomusten kanssa.

Katso ensisijaiselle käyttöliittymälle ISteamRemoteStorage sekä ICloudService.

Huomaa: Tämä on palvelukäyttöliittymä, jonka menetelmiä tulee kutsua parametrilla input_json .

Lisätietoja Steamworks-verkko-ohjelmointirajapinnan käytöstä löytyy täältä: Verkko-ohjelmointirajapinnan yleiskatsaus.

Delete

GET https://api.steampowered.com/IPublishedFileService/Delete/v1/
NimiTyyppiPakollinenKuvaus
keystringSteamworks-ohjelmointirajapintajulkaisijan varmennetunnus
publishedfileiduint64Poistettava kohde
appiduint32Sovellus, johon kohde kuuluu

Poistaa kohteen.

HUOMAA: Kutsu vaatii julkaisijan API-avaimen menetelmän käyttämiseen. Sellaisenaan tämä API TÄYTYY kutsua suojatulta palvelimelta, eikä asiakasohjelma voi koskaan käyttää sitä suoraan.

QueryFiles

GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
NimiTyyppiPakollinenKuvaus
keystringSteamworks-ohjelmointirajapintajulkaisijan varmennetunnus.
query_typeuint32IPublishedFileService#EPublishedFileQueryType
pageuint32Nykyinen sivu. Tällä hetkellä yläraja on 1 000.
cursorstringKursori tulossivujen numerointiin ('*' ensimmäiselle pyynnölle). Käytä tätä sivun parametrin sijaan, koska tämä mahdollistaa edistyneen sivutuksen. Kun käytössä, sivuparametri ohitetaan. Käytä next_cursor-arvoa, joka palautettiin vastauksena seuraavan kyselyn asettamiseen saadaksesi seuraavat tulokset.
numperpageuint32(Valinnainen) Palautettavien tulosten määrä sivua kohden.
creator_appiduint32Sovellus, joka loi tiedostot
appiduint32Sovellus, joka käyttää tiedostoja
requiredtagsstringVastaavat tunnisteet. Katso match_all_tags -parametri alla.
excludedtagsstring(Valinnainen) Tunnisteet, joita ei saa olla julkaistussa tiedostossa kyselyn täyttämiseksi.
match_all_tagsboolJos true (tosi), esineiden kaikki tunnisteet on oltava määritetty tai niissä on oltava ainakin yksi tunnisteista.
required_flagsstringVaaditut liput, jotka on asetettava mihin tahansa palautettuun kohteeseen
omitted_flagsstringLiput, jotka eivät saa olla asetettuina mihinkään palautettuun kohteeseen
search_textstringKohteen otsikosta tai kuvauksesta löydyttävä teksti
filetypeuint32IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileiduint64Etsi kaikki kohteet, jotka viittaavat annettuun kohteeseen
daysuint32Jos query_type on k_PublishedFileQueryType_RankedByTrend, tämä on päivien lukumäärä, jolloin ääniä saadaan[1,7]
include_recent_votes_onlyboolJos query_type on k_PublishedFileQueryType_RankedByTrend, tulos rajoittuu esineisiin, jotka ovat saaneet ääniä valitulla aikavälillä
cache_max_age_secondsuint32Salli vanhentuneiden tietojen palauttaminen määritetyn sekuntimäärän osalta
languageint32Haun ja tulosten kieli. Oletuskielenä englanti.
required_kv_tags{message}Vaaditut käytettävät avaintunnistearvot
totalonlybool(Valinnainen) Jos true, palauta vain tämän kyselyn täyttävien tiedostojen kokonaismäärä
ids_onlybool(Valinnainen) Jos true, palauta vain tämän kyselyn täyttävien julkaistujen tiedostojen tunnukset
return_vote_databoolPalauta äänestyksen tiedot
return_tagsboolPalauta tunnisteet tiedoston yksityiskohdista
return_kv_tagsboolPalauta avainarvojen tunnisteet tiedoston yksityiskohdista
return_previewsboolPalauta esikatselukuvan ja -videon tiedot tiedoston yksityiskohdista
return_childrenboolPalauta alikohteiden tunnisteet tiedoston yksityiskohdista
return_short_descriptionboolTäytä short_description-kenttä file_description-kentän sijasta
return_for_sale_databoolPalauta hintatiedot, jos sovellettavissa
return_metadataboolTäytä metatiedot
return_playtime_statsuint32Palauta peliaikatilastot määritetylle päivien määrälle ennen tätä päivää

Suorittaa julkaistujen tiedostojen hakukyselyn.
HUOMAA: Vaikka kysely lähetetään filetype-parametreilla (IPublishedFileService#EPublishedFileInfoMatchingFileType), tulokset sisältävät file_type-arvon. Tämä arvo vastaa ISteamRemoteStorage#EWorkshopFileType-arvoa.

SetDeveloperMetadata

POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
NimiTyyppiPakollinenKuvaus
keystringSteamworks-ohjelmointirajapinnan julkaisijan varmennetunnus.
publishedfileiduint64
appiduint32
metadatastring

Asettaa kehittäjän metatiedot julkaistuun tiedostoon.

HUOMAA: Kutsu vaatii julkaisijan API-avaimen menetelmän käyttämiseen. Sellaisenaan tämä API TÄYTYY kutsua suojatulta palvelimelta, eikä asiakasohjelma voi koskaan käyttää sitä suoraan.

UpdateAppUGCBan

POST https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/
NimiTyyppiPakollinenKuvaus
keystringSteamworks-ohjelmointirajapinnan julkaisijan varmennetunnus.
steamiduint64Käyttäjän SteamID
appiduint32
expiration_timestringUnix-aikaleima, kun kielto vanhenee, 0 poistaa
reasonstringSyy, miksi käyttäjä estettiin. Näytetään käyttäjälle.

Lisää, päivittää tai poistaa käyttäjän luoman sisällön estämisen sovelluksessa. Aseta vanhentumisaika nollaan (0) poistaaksesi kiellon.

HUOMAA: Kutsu vaatii julkaisijan API-avaimen menetelmän käyttämiseen. Sellaisenaan tämä API TÄYTYY kutsua suojatulta palvelimelta, eikä asiakasohjelma voi koskaan käyttää sitä suoraan.

UpdateBanStatus

POST https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/
NimiTyyppiPakollinenKuvaus
keystringSteamworks-ohjelmointirajapinnan julkaisijan varmennetunnus.
publishedfileiduint64
appiduint32
bannedbool
reasonstringSyy, miksi esine poistettiin. Näkyy vain ylläpitäjille.

Päivityksiä julkaistun tiedoston kiellon tilaan.

HUOMAA: Kutsu vaatii julkaisijan API-avaimen menetelmän käyttämiseen. Sellaisenaan tämä API TÄYTYY kutsua suojatulta palvelimelta, eikä asiakasohjelma voi koskaan käyttää sitä suoraan.

UpdateIncompatibleStatus

POST https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/
NimiTyyppiPakollinenKuvaus
keystringSteamworks-ohjelmointirajapinnan julkaisijan varmennetunnus.
publishedfileiduint64
appiduint32
incompatiblebool

Päivittää julkaistun tiedoston kiellon sopimattomuustilaan. Yhteensopimattomia esineitä on piilotettu yhteisökeskuksista ja käyttäjäprofiileista, mutta niihin pääsee suoraan linkkin avulla.

HUOMAA: Kutsu vaatii julkaisijan API-avaimen menetelmän käyttämiseen. Sellaisenaan tämä API TÄYTYY kutsua suojatulta palvelimelta, eikä asiakasohjelma voi koskaan käyttää sitä suoraan.

UpdateTags

POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
NimiTyyppiPakollinenKuvaus
keystringSteamworks-ohjelmointirajapinnan julkaisijan varmennetunnus.
publishedfileiduint64
appiduint32
add_tagsuint32Lisättävät tunnisteet
remove_tagsstringPoistettavat tunnisteet

Päivittää julkaistun tiedoston tunnisteet. Olemassa olevia tunnisteita ei poisteta, ellei niitä ole määritetty remove_tags-parametrissa.

HUOMAA! Kutsu vaatii julkaisijan API-avaimen menetelmän käyttämiseen. Sellaisenaan tämä API TÄYTYY kutsua suojatulta palvelimelta, eikä asiakasohjelma voi koskaan käyttää sitä suoraan.

Enums

Nämä ovat ISteamRemoteStorage-käyttöliittymässä käytettäväksi määritetyt luetellut tyypit.

EPublishedFileQueryType

Tapoja, joilla voi hakea käyttäjien luomaa sisältöä.

NimiArvo
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

Tapa, jolla jaettu tiedosto voidaan pyytää kyselyllä QueryFile.

NimiArvotKuvaus
k_PFI_MatchingFileType_Items0Esineet
k_PFI_MatchingFileType_Collections1Workshop-esinekokoelmat
k_PFI_MatchingFileType_Art2Taideteokset
k_PFI_MatchingFileType_Videos3Videot
k_PFI_MatchingFileType_Screenshots4Kuvakaappaukset
k_PFI_MatchingFileType_CollectionEligible5Esineet, jotka voidaan laittaa kokoelmaan
k_PFI_MatchingFileType_Games6Käyttämätön.
k_PFI_MatchingFileType_Software7Käyttämätön.
k_PFI_MatchingFileType_Concepts8Käyttämätön.
k_PFI_MatchingFileType_GreenlightItems9Käyttämätön.
k_PFI_MatchingFileType_AllGuides10Oppaat
k_PFI_MatchingFileType_WebGuides11Steamin verkko-opas
k_PFI_MatchingFileType_IntegratedGuides12Sovelluksen integroitu opas
k_PFI_MatchingFileType_UsableInGame13
k_PFI_MatchingFileType_Merch14Workshop-tuotteet, joista on tarkoitus äänestää myyntiä varten
k_PFI_MatchingFileType_ControllerBindings15Steam-ohjainmääritykset
k_PFI_MatchingFileType_SteamworksAccessInvites16Käytetään sisäisesti
k_PFI_MatchingFileType_Items_Mtx17Workshop-esineet, joita voidaan myydä pelin sisällä
k_PFI_MatchingFileType_Items_ReadyToUse18Workshop-esineet, joita käyttäjä voi käyttää heti
k_PFI_MatchingFileType_WorkshopShowcase19
k_PFI_MatchingFileType_GameManagedItems20Pelin (ei käyttäjän) hallinnoima, ei näytetä verkossa