Zapewnia dodatkowe metody interakcji z przedmiotami z Warsztatu Steam.

Zobacz też ISteamRemoteStorage, by poznać informacje o głównym interfejsie, oraz ICloudService.

UWAGA: jest to interfejs usługi, więc metody w nim muszą być wywoływane przy użyciu parametru input_json.

Aby dowiedzieć się więcej o korzystaniu z API webowych Steamworks, przejdź do omówienia API webowych.

Delete

Nazwa	Typ	Wymagane?	Opis
key	string	✔	Klucz autoryzacyjny użytkownika API webowych Steamworks.
publishedfileid	uint64	✔	Przedmiot do usunięcia.
appid	uint32	✔	Aplikacja, do której należy przedmiot.

Usuwa przedmiot.

UWAGA: to wywołanie wymaga, by klucz API wydawcy korzystał z tej metody. Z tego powodu to API MUSI zostać wywołane z zabezpieczonego serwera i nigdy nie może być bezpośrednio używane przez klienty!

QueryFiles

Nazwa	Typ	Wymagane?	Opis
key	string	✔	Klucz autoryzacyjny użytkownika API webowych Steamworks.
query_type	uint32	✔	IPublishedFileService#EPublishedFileQueryType
page	uint32	✔	Bieżąca strona. Maksymalny górny limit wynosi obecnie 1000.
cursor	string	✔	Kursor do stronicowania wyników (ustawiony na „*” dla pierwszego żądania). Zalecane jest używanie tego zamiast parametru strony, gdyż pozwoli ci to na przeprowadzanie głębokiego stronicowania. Przy korzystaniu z tej opcji parametr strony będzie ignorowany. Użyj wartości „next_cursor” zwróconej w odpowiedzi, by ustawić kolejne zapytanie do pobrania następnego zestawu wyników.
numperpage	uint32		Liczba wyników do zwrócenia na stronę (opcjonalnie).
creator_appid	uint32	✔	Aplikacja, która utworzyła pliki.
appid	uint32	✔	Aplikacja, która wykorzystuje pliki.
requiredtags	string	✔	Tagi do dopasowania. Zobacz parametr „match_all_tags” poniżej.
excludedtags	string	✔	Tagi, które NIE MOGĄ być obecne w opublikowanym pliku, by spełnić warunki tego zapytania (opcjonalnie).
match_all_tags	bool		Jeśli wartość to „true”, to przedmioty muszą zawierać wszystkie określone tagi, a w innym razie muszą zawierać przynajmniej jeden z tych tagów.
required_flags	string	✔	Wymagane flagi, które muszą być obecne na wszelkich zwracanych przedmiotach.
omitted_flags	string	✔	Flagi, które nie mogą być obecne na żadnych zwracanych przedmiotach.
search_text	string	✔	Tekst z nazwy lub opisu przedmiotu do dopasowania.
filetype	uint32	✔	IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileid	uint64	✔	Znajduje wszystkie przedmioty, które odwołują się do podanego.
days	uint32	✔	Jeżeli parametr „query_type” korzysta z wartości „k_PublishedFileQueryType_RankedByTrend” to wtedy będzie to liczba dni, dla których mają zostać pobrane głosy [1, 7].
include_recent_votes_only	bool	✔	Jeżeli parametr „query_type” korzysta z wartości „k_PublishedFileQueryType_RankedByTrend” to ogranicza to zestaw wyników tylko do przedmiotów, które otrzymały głosy w podanym zakresie dni.
cache_max_age_seconds	uint32		Zezwalaj na zwracanie nieaktualnych danych przez podaną liczbę sekund.
language	int32		Język, w którym ma zostać przeprowadzone wyszukiwanie oraz to, co jest zwracane. Domyślną wartością jest angielski.
required_kv_tags	{message}	✔	Wymagane tagi klucz-wartość do dopasowania.
totalonly	bool	✔	Jeśli wartość to „true”, zwraca tylko łączną liczbę plików spełniających warunki tego zapytania (opcjonalnie).
ids_only	bool	✔	Jeśli wartość to „true”, zwraca tylko ID opublikowanych plików spełniających warunki tego zapytania (opcjonalnie).
return_vote_data	bool	✔	Zwraca dane dotyczące głosów.
return_tags	bool	✔	Zwraca tagi zawarte w szczegółach pliku.
return_kv_tags	bool	✔	Zwraca tagi klucz-wartość zawarte w szczegółach pliku.
return_previews	bool	✔	Zwraca obraz podglądu i szczegóły dotyczące filmu zawarte w szczegółach pliku.
return_children	bool	✔	Zwraca ID podrzędnych przedmiotów zawarte w szczegółach pliku.
return_short_description	bool	✔	Uzupełnia pole „short_description” zamiast „file_description”.
return_for_sale_data	bool	✔	Zwraca informacje dotyczące wyceny, jeśli mają zastosowanie.
return_metadata	bool		Uzupełnij metadane.
return_playtime_stats	uint32	✔	Zwraca statystyki dotyczące czasu gry dla określonej liczby dni przed dzisiejszym.

Wykonuje zapytanie szukające dla opublikowanych plików.

SetDeveloperMetadata

Nazwa	Typ	Wymagane?	Opis
key	string	✔	Klucz autoryzacyjny wydawcy API webowych Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
metadata	string	✔

Ustawia metadane dla producenta na opublikowanym pliku.

UWAGA: to wywołanie wymaga, by klucz API wydawcy korzystał z tej metody. Z tego powodu to API MUSI zostać wywołane z zabezpieczonego serwera i nigdy nie może być bezpośrednio używane przez klienty!

UpdateAppUGCBan

Nazwa	Typ	Wymagane?	Opis
key	string	✔	Klucz autoryzacyjny wydawcy API webowych Steamworks.
steamid	uint64	✔	ID Steam uzytkownika.
appid	uint32	✔
expiration_time	uint32	✔	Czas wygaśnięcia blokady w formacie uniksowym. Wpisz 0, by usunąć.
reason	string		Powód zablokowania użytkownika. Będzie wyświetlany użytkownikowi.

Dodaje/aktualizuje/usuwa blokadę użytkownika związaną z treściami tworzonymi przez społeczność dla aplikacji. Ustaw „expiration_time” na 0, by usunąć blokadę.

UWAGA: to wywołanie wymaga, by klucz API wydawcy korzystał z tej metody. Z tego powodu to API MUSI zostać wywołane z zabezpieczonego serwera i nigdy nie może być bezpośrednio używane przez klienty!

UpdateBanStatus

Nazwa	Typ	Wymagane?	Opis
key	string	✔	Klucz autoryzacyjny wydawcy API webowych Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
banned	bool	✔
reason	string	✔	Powód zablokowania przedmiotu. Widoczny tylko dla administratorów.

Aktualizuje status blokady na opublikowanym pliku.

UWAGA: to wywołanie wymaga, by klucz API wydawcy korzystał z tej metody. Z tego powodu to API MUSI zostać wywołane z zabezpieczonego serwera i nigdy nie może być bezpośrednio używane przez klienty!

UpdateIncompatibleStatus

Nazwa	Typ	Wymagane?	Opis
key	string	✔	Klucz autoryzacyjny wydawcy API webowych Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
incompatible	bool	✔

Aktualizuje status niezgodności na opublikowanym pliku. „Niezgodne” pliki są ukrywane z centrów społeczności i profili użytkowników, ale wciąż można uzyskać do nich dostęp, mając bezpośredni link.

UWAGA: to wywołanie wymaga, by klucz API wydawcy korzystał z tej metody. Z tego powodu to API MUSI zostać wywołane z zabezpieczonego serwera i nigdy nie może być bezpośrednio używane przez klienty!

UpdateTags

Nazwa	Typ	Wymagane?	Opis
key	string	✔	Klucz autoryzacyjny wydawcy API webowych Steamworks.
publishedfileid	uint64	✔
appid	uint32	✔
add_tags	string		Tagi do dodania.
remove_tags	string		Tagi do usunięcia.

Aktualizuje tagi na opublikowanym pliku. Istniejące tagi nie zostaną usunięte, chyba że zostaną określone w parametrze remove_tags.

UWAGA: to wywołanie wymaga, by klucz API wydawcy korzystał z tej metody. Z tego powodu to API MUSI zostać wywołane z zabezpieczonego serwera i nigdy nie może być bezpośrednio używane przez klienty!

Zmienne wyliczeniowe

Są to zmienne wyliczeniowe, które zostały zdefiniowane do wykorzystania z interfejsem ISteamRemoteStorage.

EPublishedFileQueryType

Sposoby, na jakie możesz przeszukiwać przedmioty tworzone przez społeczność.

Nazwa	Wartość
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

Sposób, w jaki udostępniony plik może zostać wyszukany poprzez „QueryFile”.

Nazwa	Wartości	Opis
k_PFI_MatchingFileType_Items	0	Przedmioty.
k_PFI_MatchingFileType_Collections	1	Kolekcja przedmiotów z warsztatu.
k_PFI_MatchingFileType_Art	2	Grafika.
k_PFI_MatchingFileType_Videos	3	Filmy.
k_PFI_MatchingFileType_Screenshots	4	Zrzuty ekranu.
k_PFI_MatchingFileType_CollectionEligible	5	Przedmioty, które mogą zostać umieszczone w kolekcji.
k_PFI_MatchingFileType_Games	6	Nieużywane.
k_PFI_MatchingFileType_Software	7	Nieużywane.
k_PFI_MatchingFileType_Concepts	8	Nieużywane.
k_PFI_MatchingFileType_GreenlightItems	9	Nieużywane.
k_PFI_MatchingFileType_AllGuides	10	Poradniki.
k_PFI_MatchingFileType_WebGuides	11	Poradnik Steam dostępny poprzez sieć.
k_PFI_MatchingFileType_IntegratedGuides	12	Poradnik zintegrowany z aplikacją.
k_PFI_MatchingFileType_UsableInGame	13
k_PFI_MatchingFileType_Merch	14	Gadżety w warsztacie, na które mają zostać oddane głosy, by wyłonić te, które trafią do sprzedaży.
k_PFI_MatchingFileType_ControllerBindings	15	Przypisania dla Steam Controllera.
k_PFI_MatchingFileType_SteamworksAccessInvites	16	Używane wewnętrznie.
k_PFI_MatchingFileType_Items_Mtx	17	Przedmioty z warsztatu, które mogą być sprzedawane w grze.
k_PFI_MatchingFileType_Items_ReadyToUse	18	Przedmioty z warsztatu, które mogą być natychmiastowo używane przez użytkownika.
k_PFI_MatchingFileType_WorkshopShowcase	19
k_PFI_MatchingFileType_GameManagedItems	20	Zarządzane całkowicie przez grę (nie użytkownika) i niewyświetlane w sieci.