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/
Nimi | Tyyppi | Pakollinen | Kuvaus |
key | string | ✔ | Steamworks-ohjelmointirajapintajulkaisijan varmennetunnus |
publishedfileid | uint64 | ✔ | Poistettava kohde |
appid | uint32 | ✔ | Sovellus, 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/
Nimi | Tyyppi | Pakollinen | Kuvaus |
key | string | ✔ | Steamworks-ohjelmointirajapintajulkaisijan varmennetunnus. |
query_type | uint32 | ✔ | IPublishedFileService#EPublishedFileQueryType |
page | uint32 | ✔ | Nykyinen sivu. Tällä hetkellä yläraja on 1 000. |
cursor | string | ✔ | Kursori 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. |
numperpage | uint32 | | (Valinnainen) Palautettavien tulosten määrä sivua kohden. |
creator_appid | uint32 | ✔ | Sovellus, joka loi tiedostot |
appid | uint32 | ✔ | Sovellus, joka käyttää tiedostoja |
requiredtags | string | ✔ | Vastaavat tunnisteet. Katso match_all_tags -parametri alla. |
excludedtags | string | ✔ | (Valinnainen) Tunnisteet, joita ei saa olla julkaistussa tiedostossa kyselyn täyttämiseksi. |
match_all_tags | bool | | Jos true (tosi), esineiden kaikki tunnisteet on oltava määritetty tai niissä on oltava ainakin yksi tunnisteista. |
required_flags | string | ✔ | Vaaditut liput, jotka on asetettava mihin tahansa palautettuun kohteeseen |
omitted_flags | string | ✔ | Liput, jotka eivät saa olla asetettuina mihinkään palautettuun kohteeseen |
search_text | string | ✔ | Kohteen otsikosta tai kuvauksesta löydyttävä teksti |
filetype | uint32 | ✔ | IPublishedFileService#EPublishedFileInfoMatchingFileType |
child_publishedfileid | uint64 | ✔ | Etsi kaikki kohteet, jotka viittaavat annettuun kohteeseen |
days | uint32 | ✔ | Jos query_type on k_PublishedFileQueryType_RankedByTrend, tämä on päivien lukumäärä, jolloin ääniä saadaan[1,7] |
include_recent_votes_only | bool | ✔ | Jos query_type on k_PublishedFileQueryType_RankedByTrend, tulos rajoittuu esineisiin, jotka ovat saaneet ääniä valitulla aikavälillä |
cache_max_age_seconds | uint32 | | Salli vanhentuneiden tietojen palauttaminen määritetyn sekuntimäärän osalta |
language | int32 | | Haun ja tulosten kieli. Oletuskielenä englanti. |
required_kv_tags | {message} | ✔ | Vaaditut käytettävät avaintunnistearvot |
totalonly | bool | ✔ | (Valinnainen) Jos true, palauta vain tämän kyselyn täyttävien tiedostojen kokonaismäärä |
ids_only | bool | ✔ | (Valinnainen) Jos true, palauta vain tämän kyselyn täyttävien julkaistujen tiedostojen tunnukset |
return_vote_data | bool | ✔ | Palauta äänestyksen tiedot |
return_tags | bool | ✔ | Palauta tunnisteet tiedoston yksityiskohdista |
return_kv_tags | bool | ✔ | Palauta avainarvojen tunnisteet tiedoston yksityiskohdista |
return_previews | bool | ✔ | Palauta esikatselukuvan ja -videon tiedot tiedoston yksityiskohdista |
return_children | bool | ✔ | Palauta alikohteiden tunnisteet tiedoston yksityiskohdista |
return_short_description | bool | ✔ | Täytä short_description-kenttä file_description-kentän sijasta |
return_for_sale_data | bool | ✔ | Palauta hintatiedot, jos sovellettavissa |
return_metadata | bool | | Täytä metatiedot |
return_playtime_stats | uint32 | ✔ | Palauta peliaikatilastot määritetylle päivien määrälle ennen tätä päivää |
Suorittaa julkaistujen tiedostojen hakukyselyn.
SetDeveloperMetadata
POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
Nimi | Tyyppi | Pakollinen | Kuvaus |
key | string | ✔ | Steamworks-ohjelmointirajapinnan julkaisijan varmennetunnus. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
metadata | string | ✔ | |
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/
Nimi | Tyyppi | Pakollinen | Kuvaus |
key | string | ✔ | Steamworks-ohjelmointirajapinnan julkaisijan varmennetunnus. |
steamid | uint64 | ✔ | Käyttäjän SteamID |
appid | uint32 | ✔ | |
expiration_time | string | ✔ | Unix-aikaleima, kun kielto vanhenee, 0 poistaa |
reason | string | | Syy, 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/
Nimi | Tyyppi | Pakollinen | Kuvaus |
key | string | ✔ | Steamworks-ohjelmointirajapinnan julkaisijan varmennetunnus. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
banned | bool | ✔ | |
reason | string | ✔ | Syy, 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/
Nimi | Tyyppi | Pakollinen | Kuvaus |
key | string | ✔ | Steamworks-ohjelmointirajapinnan julkaisijan varmennetunnus. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
incompatible | bool | ✔ | |
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/
Nimi | Tyyppi | Pakollinen | Kuvaus |
key | string | ✔ | Steamworks-ohjelmointirajapinnan julkaisijan varmennetunnus. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
add_tags | uint32 | | Lisättävät tunnisteet |
remove_tags | string | | Poistettavat 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öä.
Nimi | Arvo |
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
Tapa, jolla jaettu tiedosto voidaan pyytää kyselyllä QueryFile.
Nimi | Arvot | Kuvaus |
k_PFI_MatchingFileType_Items | 0 | Esineet |
k_PFI_MatchingFileType_Collections | 1 | Workshop-esinekokoelmat |
k_PFI_MatchingFileType_Art | 2 | Taideteokset |
k_PFI_MatchingFileType_Videos | 3 | Videot |
k_PFI_MatchingFileType_Screenshots | 4 | Kuvakaappaukset |
k_PFI_MatchingFileType_CollectionEligible | 5 | Esineet, jotka voidaan laittaa kokoelmaan |
k_PFI_MatchingFileType_Games | 6 | Käyttämätön. |
k_PFI_MatchingFileType_Software | 7 | Käyttämätön. |
k_PFI_MatchingFileType_Concepts | 8 | Käyttämätön. |
k_PFI_MatchingFileType_GreenlightItems | 9 | Käyttämätön. |
k_PFI_MatchingFileType_AllGuides | 10 | Oppaat |
k_PFI_MatchingFileType_WebGuides | 11 | Steamin verkko-opas |
k_PFI_MatchingFileType_IntegratedGuides | 12 | Sovelluksen integroitu opas |
k_PFI_MatchingFileType_UsableInGame | 13 | |
k_PFI_MatchingFileType_Merch | 14 | Workshop-tuotteet, joista on tarkoitus äänestää myyntiä varten |
k_PFI_MatchingFileType_ControllerBindings | 15 | Steam-ohjainmääritykset |
k_PFI_MatchingFileType_SteamworksAccessInvites | 16 | Käytetään sisäisesti |
k_PFI_MatchingFileType_Items_Mtx | 17 | Workshop-esineet, joita voidaan myydä pelin sisällä |
k_PFI_MatchingFileType_Items_ReadyToUse | 18 | Workshop-esineet, joita käyttäjä voi käyttää heti |
k_PFI_MatchingFileType_WorkshopShowcase | 19 | |
k_PFI_MatchingFileType_GameManagedItems | 20 | Pelin (ei käyttäjän) hallinnoima, ei näytetä verkossa |