Steamworks Documentation
Interfața IPublishedFileService
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/
NumeTipNecesarDescriere
keystringCheia de conectare a utilizatorului la API-ul web Steamworks.
publishedfileiduint64Articolul care trebuie șters.
appiduint32Aplicaț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/
NumeTipNecesarDescriere
keystringCheia de conectare a utilizatorului la API-ul web Steamworks.
query_typeuint32IPublishedFileService#EPublishedFileQueryType
pageuint32Pagina curentă. Momentan există o limită superioară de 1.000.
cursorstringCursorul 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.
numperpageuint32(Opțional) Numărul de rezultate de returnat per pagină.
creator_appiduint32ID-ul aplicației care a creat fișierele.
appiduint32ID-ul aplicației care consumă fișierele.
requiredtagsstringEtichetele utilizate pentru filtrarea rezultatelor. Vezi parametrul match_all_tags de mai jos.
excludedtagsstring(Opțional) Etichetele care nu trebuie să fie incluse într-un fișier publicat pentru a îndeplini criteriile interogării.
match_all_tagsboolDacă 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_flagsstringMarcaje obligatorii pentru articolele returnate.
omitted_flagsstringMarcaje care nu ar trebui să existe pentru articolele returnate.
search_textstringTextul care trebuie inclus în titlul sau descrierea articolului.
filetypeuint32IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileiduint64Găsește toate articolele care fac referință la articolul specificat.
daysuint32Dacă 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_onlyboolDacă 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_secondsuint32Permite datelor învechite să fie returnate pentru numărul de secunde specificat.
languageint32Limba î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.
totalonlybool(Opțional) Dacă este „true”, returnează doar numărul total de fișiere care satisfac această interogare.
ids_onlybool(Opțional) Dacă este „true”, returnează doar ID-urile fișierelor publicate care satisfac această interogare.
return_vote_databoolReturnează datele de vot.
return_tagsboolReturnează etichetele în detaliile fișierului.
return_kv_tagsboolReturnează etichetele cheie-valoare în detaliile fișierului.
return_previewsboolReturnează detaliile imaginii și videoclipului de previzualizare în detaliile fișierului.
return_childrenboolReturnează ID-urile articolelor descendente în detaliile fișierului.
return_short_descriptionboolCompletează câmpul „short_description” în locul câmpului „file_description”.
return_for_sale_databoolReturnează informațiile despre preț, dacă este cazul.
return_metadataboolCompletează metadatele.
return_playtime_statsuint32Returnează 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.
NOTĂ: deși poți realiza o interogare folosind parametrii „filetype” (IPublishedFileService#EPublishedFileInfoMatchingFileType), rezultatele vor conține o valoare „file_type”. Valoarea va corespunde cu una dintre valorile ISteamRemoteStorage#EWorkshopFileType

SetDeveloperMetadata

POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
NumeTipNecesarDescriere
keystringCheia de conectare a editorului la API-ul web Steamworks.
publishedfileiduint64
appiduint32
metadatastring

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/
NumeTipNecesarDescriere
keystringCheia de conectare a editorului la API-ul web Steamworks.
steamiduint64ID-ul Steam al utilizatorului.
appiduint32
expiration_timeuint32Marcajul temporal Unix la care interdicția expiră (dacă este setat cu valoarea „0”, interdicția este eliminată).
reasonstringMotivul 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/
NumeTipNecesarDescriere
keystringCheia de conectare a editorului la API-ul web Steamworks.
publishedfileiduint64
appiduint32
bannedbool
reasonstringMotivul 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/
NumeTipNecesarDescriere
keystringCheia de conectare a editorului la API-ul web Steamworks.
publishedfileiduint64
appiduint32
incompatiblebool

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/
NumeTipNecesarDescriere
keystringCheia de conectare a editorului la API-ul web Steamworks.
publishedfileiduint64
appiduint32
add_tagsstringEtichetele care trebuie adăugate.
remove_tagsstringEtichetele 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.

NumeValoare
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

Modul în care un fișier partajat poate fi interogat de QueryFile.

NumeValoareDescriere
k_PFI_MatchingFileType_Items0Articole.
k_PFI_MatchingFileType_Collections1O colecție de articole din atelier.
k_PFI_MatchingFileType_Art2Ilustrații.
k_PFI_MatchingFileType_Videos3Videoclipuri.
k_PFI_MatchingFileType_Screenshots4Capturi de ecran.
k_PFI_MatchingFileType_CollectionEligible5Articole care pot fi incluse într-o colecție.
k_PFI_MatchingFileType_Games6Neutilizat.
k_PFI_MatchingFileType_Software7Neutilizat.
k_PFI_MatchingFileType_Concepts8Neutilizat.
k_PFI_MatchingFileType_GreenlightItems9Neutilizat.
k_PFI_MatchingFileType_AllGuides10Ghiduri.
k_PFI_MatchingFileType_WebGuides11Ghid web Steam.
k_PFI_MatchingFileType_IntegratedGuides12Ghid integrat al aplicației.
k_PFI_MatchingFileType_UsableInGame13
k_PFI_MatchingFileType_Merch14Produse din atelier care pot fi votate cu scopul de a ajunge să fie comercializate.
k_PFI_MatchingFileType_ControllerBindings15Asocieri pentru Steam Controller.
k_PFI_MatchingFileType_SteamworksAccessInvites16Uz intern.
k_PFI_MatchingFileType_Items_Mtx17Articole din atelier care pot fi comercializate în joc.
k_PFI_MatchingFileType_Items_ReadyToUse18Articole din atelier care pot fi utilizate imediat de către utilizator.
k_PFI_MatchingFileType_WorkshopShowcase19
k_PFI_MatchingFileType_GameManagedItems20Gestionate complet de către joc, nu de către utilizator, și nu sunt afișate pe web.