Oferă metode suplimentare pentru a interacționa cu articolele din atelierul Steam.
Consultă
ISteamRemoteStorage pentru interfața principală, precum și
ICloudService.
NOTĂ: aceasta este o interfață de serviciu, iar metodele din această interfață trebuie apelate folosind parametrul
input_json
.
Pentru mai multe informații despre cum poți utiliza API-ul web Steamworks, te rugăm să consulți documentația
Web API Overview.
Delete
GET https://api.steampowered.com/IPublishedFileService/Delete/v1/
Nume | Tip | Necesar | Descriere |
key | string | ✔ | Cheia de conectare a utilizatorului la API-ul web Steamworks. |
publishedfileid | uint64 | ✔ | Articolul care trebuie șters. |
appid | uint32 | ✔ | Aplicația căreia îi aparține articolul. |
Șterge un articol.
NOTĂ: acest apel necesită o cheie API de editor pentru a utiliza metoda aceasta. Drept urmare, acest API
TREBUIE să fie apelat de pe un server securizat și nu poate fi folosit niciodată direct de către clienți!
QueryFiles
GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
Nume | Tip | Necesar | Descriere |
key | string | ✔ | Cheia de conectare a utilizatorului la API-ul web Steamworks. |
query_type | uint32 | ✔ | IPublishedFileService#EPublishedFileQueryType |
page | uint32 | ✔ | Pagina curentă. Momentan există o limită superioară de 1.000. |
cursor | string | ✔ | Cursorul pentru paginarea rezultatelor (setat la „*” pentru prima solicitare). Este recomandată utilizarea acestui parametru în locul parametrului „page”, deoarece îți permite să efectuezi o paginare mai detaliată. Atunci când utilizezi acest parametru, parametrul „page” va fi ignorat. Folosește valoarea „next_cursor” returnată în răspuns pentru a configura următoarea interogare pentru a obține următorul set de rezultate. |
numperpage | uint32 | | (Opțional) Numărul de rezultate de returnat per pagină. |
creator_appid | uint32 | ✔ | ID-ul aplicației care a creat fișierele. |
appid | uint32 | ✔ | ID-ul aplicației care consumă fișierele. |
requiredtags | string | ✔ | Etichetele utilizate pentru filtrarea rezultatelor. Vezi parametrul match_all_tags de mai jos. |
excludedtags | string | ✔ | (Opțional) Etichetele care nu trebuie să fie incluse într-un fișier publicat pentru a îndeplini criteriile interogării. |
match_all_tags | bool | | Dacă este „true” (adevărat), articolele trebuie să includă toate etichetele specificate, în caz contrar trebuie să conțină cel puțin una dintre etichete. |
required_flags | string | ✔ | Marcaje obligatorii pentru articolele returnate. |
omitted_flags | string | ✔ | Marcaje care nu ar trebui să existe pentru articolele returnate. |
search_text | string | ✔ | Textul care trebuie inclus în titlul sau descrierea articolului. |
filetype | uint32 | ✔ | IPublishedFileService#EPublishedFileInfoMatchingFileType |
child_publishedfileid | uint64 | ✔ | Găsește toate articolele care fac referință la articolul specificat. |
days | uint32 | ✔ | Dacă parametrul „query_type” este „k_PublishedFileQueryType_RankedByTrend”, atunci acest parametru indică numărul de zile pentru care se obțin voturile, cuprins în intervalul [1, 7]. |
include_recent_votes_only | bool | ✔ | Dacă parametrul „query_type” este „k_PublishedFileQueryType_RankedByTrend”, atunci limitează setul de rezultate doar la articolele care au voturi pentru intervalul de zile specificat. |
cache_max_age_seconds | uint32 | | Permite datelor învechite să fie returnate pentru numărul de secunde specificat. |
language | int32 | | Limba în care are loc căutarea și în care se obțin rezultatele. În mod implicit, această limbă este engleza. |
required_kv_tags | {message} | ✔ | Etichetele cheie-valoare obligatorii care trebuie incluse. |
totalonly | bool | ✔ | (Opțional) Dacă este „true”, returnează doar numărul total de fișiere care satisfac această interogare. |
ids_only | bool | ✔ | (Opțional) Dacă este „true”, returnează doar ID-urile fișierelor publicate care satisfac această interogare. |
return_vote_data | bool | ✔ | Returnează datele de vot. |
return_tags | bool | ✔ | Returnează etichetele în detaliile fișierului. |
return_kv_tags | bool | ✔ | Returnează etichetele cheie-valoare în detaliile fișierului. |
return_previews | bool | ✔ | Returnează detaliile imaginii și videoclipului de previzualizare în detaliile fișierului. |
return_children | bool | ✔ | Returnează ID-urile articolelor descendente în detaliile fișierului. |
return_short_description | bool | ✔ | Completează câmpul „short_description” în locul câmpului „file_description”. |
return_for_sale_data | bool | ✔ | Returnează informațiile despre preț, dacă este cazul. |
return_metadata | bool | | Completează metadatele. |
return_playtime_stats | uint32 | ✔ | Returnează statistici despre timpul de joc pentru numărul de zile specificat, premergătoare zilei de azi. |
Efectuează o interogare de căutare pentru fișierele publicate.
SetDeveloperMetadata
POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
Nume | Tip | Necesar | Descriere |
key | string | ✔ | Cheia de conectare a editorului la API-ul web Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
metadata | string | ✔ | |
Setează metadatele unui dezvoltator în fișierul publicat.
NOTĂ: acest apel necesită o cheie API de editor pentru a utiliza metoda aceasta. Drept urmare, acest API
TREBUIE să fie apelat de pe un server securizat și nu poate fi folosit niciodată direct de către clienți!
UpdateAppUGCBan
POST https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/
Nume | Tip | Necesar | Descriere |
key | string | ✔ | Cheia de conectare a editorului la API-ul web Steamworks. |
steamid | uint64 | ✔ | ID-ul Steam al utilizatorului. |
appid | uint32 | ✔ | |
expiration_time | uint32 | ✔ | Marcajul temporal Unix la care interdicția expiră (dacă este setat cu valoarea „0”, interdicția este eliminată). |
reason | string | | Motivul pentru care utilizatorul a fost interzis. Va fi afișat utilizatorului. |
Adaugă, actualizează sau elimină o interdicție pentru un utilizator care a încărcat conținut în aplicație. Atribuie valoarea 0 parametrului „expiration_time” pentru a elimina interdicția.
NOTĂ: acest apel necesită o cheie API de editor pentru a utiliza metoda aceasta. Drept urmare, acest API
TREBUIE să fie apelat de pe un server securizat și nu poate fi folosit niciodată direct de către clienți!
UpdateBanStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/
Nume | Tip | Necesar | Descriere |
key | string | ✔ | Cheia de conectare a editorului la API-ul web Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
banned | bool | ✔ | |
reason | string | ✔ | Motivul pentru care articolul a fost interzis. Acesta este vizibil doar administratorilor. |
Actualizează starea interdicției pentru fișierul publicat.
NOTĂ: acest apel necesită o cheie API de editor pentru a utiliza metoda aceasta. Drept urmare, acest API
TREBUIE să fie apelat de pe un server securizat și nu poate fi folosit niciodată direct de către clienți!
UpdateIncompatibleStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/
Nume | Tip | Necesar | Descriere |
key | string | ✔ | Cheia de conectare a editorului la API-ul web Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
incompatible | bool | ✔ | |
Actualizează starea de incompatibilitate pentru fișierul publicat. Articolele „incompatibile” sunt ascunse din centrele comunitare și de pe profilurile utilizatorilor, dar pot fi accesate în continuare printr-un link direct.
NOTĂ: acest apel necesită o cheie API de editor pentru a utiliza metoda aceasta. Drept urmare, acest API
TREBUIE să fie apelat de pe un server securizat și nu poate fi folosit niciodată direct de către clienți!
UpdateTags
POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
Nume | Tip | Necesar | Descriere |
key | string | ✔ | Cheia de conectare a editorului la API-ul web Steamworks. |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
add_tags | string | | Etichetele care trebuie adăugate. |
remove_tags | string | | Etichetele care trebuie eliminate. |
Actualizează etichetele pentru fișierul publicat. Etichetele existente nu vor fi eliminate decât dacă sunt specificate în parametrul
remove_tags
.
NOTĂ: acest apel necesită o cheie API de editor pentru a utiliza metoda aceasta. Drept urmare, acest API
TREBUIE să fie apelat de pe un server securizat și nu poate fi folosit niciodată direct de către clienți!
Enumerări
Acestea sunt enumerări care sunt definite pentru a fi utilizate cu ISteamRemoteStorage.
EPublishedFileQueryType
Modalități prin care poți realiza o interogare pentru articolele create de utilizatori.
Nume | Valoare |
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
Modul în care un fișier partajat poate fi interogat de QueryFile.
Nume | Valoare | Descriere |
k_PFI_MatchingFileType_Items | 0 | Articole. |
k_PFI_MatchingFileType_Collections | 1 | O colecție de articole din atelier. |
k_PFI_MatchingFileType_Art | 2 | Ilustrații. |
k_PFI_MatchingFileType_Videos | 3 | Videoclipuri. |
k_PFI_MatchingFileType_Screenshots | 4 | Capturi de ecran. |
k_PFI_MatchingFileType_CollectionEligible | 5 | Articole care pot fi incluse într-o colecție. |
k_PFI_MatchingFileType_Games | 6 | Neutilizat. |
k_PFI_MatchingFileType_Software | 7 | Neutilizat. |
k_PFI_MatchingFileType_Concepts | 8 | Neutilizat. |
k_PFI_MatchingFileType_GreenlightItems | 9 | Neutilizat. |
k_PFI_MatchingFileType_AllGuides | 10 | Ghiduri. |
k_PFI_MatchingFileType_WebGuides | 11 | Ghid web Steam. |
k_PFI_MatchingFileType_IntegratedGuides | 12 | Ghid integrat al aplicației. |
k_PFI_MatchingFileType_UsableInGame | 13 | |
k_PFI_MatchingFileType_Merch | 14 | Produse din atelier care pot fi votate cu scopul de a ajunge să fie comercializate. |
k_PFI_MatchingFileType_ControllerBindings | 15 | Asocieri pentru Steam Controller. |
k_PFI_MatchingFileType_SteamworksAccessInvites | 16 | Uz intern. |
k_PFI_MatchingFileType_Items_Mtx | 17 | Articole din atelier care pot fi comercializate în joc. |
k_PFI_MatchingFileType_Items_ReadyToUse | 18 | Articole din atelier care pot fi utilizate imediat de către utilizator. |
k_PFI_MatchingFileType_WorkshopShowcase | 19 | |
k_PFI_MatchingFileType_GameManagedItems | 20 | Gestionate complet de către joc, nu de către utilizator, și nu sunt afișate pe web. |