API zasobów
*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.
Możesz wysyłać i otrzymywać następujące żądania i pakiety odpowiedzi, aby tworzyć zasoby na Roblox.Aby uzyskać informacje o wykorzystaniu API, zobacz przewodnik użytkowania.
Assets
Wyświetl wersje zasobów
Wyświetl wszystkie wersje określonego zasobu z opcjonalną nawigacją.
Parametry
Unikalny identyfikator zasobu.
Określa liczbę wersji zasobów, które należy uwzględnić w odpowiedzi. Poprawne wartości wynoszą od 1 do 50 (włącznie). Domyślnie wynosi 8, gdy nie zostaną podane.
Token do paginacji. Wartość jest uzyskiwana z poprzedniego żądania i pozwala na odzyskanie następnej strony wersji zasobów.
Żądanie
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'
Odpowiedź:
Wymagane uprawnienia
Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.
Limity
Na klucz API: żądanie 100 co 60 s na adres IP
Wróć do wersji zasobu
Przywróć zasób do określonej poprzedniej wersji.
Podaj ścieżkę wersji zasobu w danych formularza.
Parametry
Unikalny identyfikator zasobu.
Żądanie
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions:rollback' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json' \
--data '{\"assetVersion\":\"assets/{assetId}/versions/{versionNumber}\"}'
Odpowiedź:
Wymagane uprawnienia
Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.
Limity
Na klucz API: żądanie 100 co 60 s na adres IP
Utwórz zasób
Tworzy zasób z dostarczonymi treściami i metadanymi.
Nie możesz dodać obiektów SocialLink podczas tworzenia zasobu. Zamiast tego użyj Aktualizuj zasób.
Dostarcz zasób, ścieżkę pliku binarnego, oraz typ treści w danych formularza.
Żądanie
curl --location --request POST 'https://apis.roblox.com/assets/v1/assets' \
--header 'x-api-key: {apiKey}' \
--form 'request="{
\"assetType\": \"Model\",
\"displayName\": \"Name\",
\"description\": \"This is a description\",
\"creationContext\": {
\"creator\": {
\"userId\": \"${userId}\"
}
}
}"' \
--form 'fileContent=@"/filepath/model.fbx";type=model/fbx'
Odpowiedź:
Wymagane uprawnienia
Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.
Limity
Na klucz API: żądanie 60 co 60 s na adres IP
Zdobądź zasób
Zbierz szczegółowe treści i metadane zasobów.
Parametry
Unikalny identyfikator zasobu.
Pola metadanych zasobów do uzyskiwać, w tym opis, nazwa wyświetlana, ikona, linki społecznościowe i podglądy. Przykłady: description%2CdisplayName , previews%2CtwitchSocialLink .
Żądanie
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}'
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \
--header 'x-api-key: {apiKey}'
Odpowiedź:
Wymagane uprawnienia
Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.
Limity
Na klucz API: żądanie 60 co 60 s na adres IP
Aktualizuj zasób
Aktualizuje zasób z dostarczonymi treściami i metadanymi, w tym opisem, nazwa wyświetlanawyświetlania, ikona, linkami społecznościowymi i podglądami.Obecnie można aktualizować tylko treść ciała dla modeli .Ikony i podglądy muszą być zasobami obrazowymi .Ikony muszą mieć kwadratowe wymiary.
Dostarcz zasób, ścieżkę pliku binarnego, oraz typ treści w danych formularza.
Parametry
Unikalny identyfikator zasobu.
Pola metadanych zasobów do aktualizacja, w tym opis, nazwa wyświetlana, ikona i podglądy. Przykłady: description%2CdisplayName , previews%2CtwitchSocialLink .
Żądanie
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": {assetId} }"' \
--form 'fileContent="@\"{file-path}\""'
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \
--header 'x-api-key: {apiKey}' \
--form 'request="{
\"assetType\": \"{assetType}\",
\"assetId\": {assetId},
\"displayName\": \"{new display name}\",
\"description\": \"{new description}\",
\"creationContext\": {
\"creator\": {
\"userId\": {userId}
},
\"expectedPrice\":{expectedPrice}
},
}"' \
--form 'fileContent=@\"{file-path}\"'
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=previews' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"previews\": [{\"asset\": \"assets/123\", \"altText\": \"Your alt text.\"}]}"'
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=twitchSocialLink%2CgithubSocialLink' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"twitchSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://twitch.tv/your-channel\"}, \"githubSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://github.com/your-repo\"}}"'
Odpowiedź:
Wymagane uprawnienia
Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.
Limity
Na klucz API: żądanie 60 co 60 s na adres IP
Otrzymaj wersję zasobu
Zbierz określoną wersję zasobu za pomocą ID zasobu i numeru wersji.
Parametry
Unikalny identyfikator zasobu.
Numer wersji.
Żądanie
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'
Odpowiedź:
Wymagane uprawnienia
Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.
Limity
Na klucz API: żądanie 100 co 60 s na adres IP
Zasób archiwalny
Przechowuje zasób.Zarchiwizowane zasoby znikają z witryny i nie są już dostępne ani widoczne w doświadczeniach Roblox, ale możesz je przywrócić przywrócić.
Parametry
Unikalny identyfikator zasobu.
Żądanie
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'
Odpowiedź:
Wymagane uprawnienia
Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.
Limity
Na klucz API: żądanie 100 co 60 s na adres IP
Przywróć zasób
Przywraca zarchiwizowany zasób.
Parametry
Unikalny identyfikator zasobu.
Żądanie
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'
Odpowiedź:
Wymagane uprawnienia
Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.
Limity
Na klucz API: żądanie 100 co 60 s na adres IP
Zdobądź operację
Zdobądź wynik tworzenia lub aktualizacji zasobu za pomocą powrotnego ID operacji.Wymaga Przeczytaj dla uprawnienia klucza API i przeczytaj zasób dla aplikacji OAuth 2.0.
Parametry
Unikalny identyfikator operacji.
Żądanie
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'
Odpowiedź:
Wymagane uprawnienia
Do wywołania tego punktu końcowego wymagane są następujące uprawnienia do kluczy API. Więcej informacji na temat generowania odpowiednich kluczy można znaleźć w obszarze Zarządzanie kluczami API.
Limity
Na klucz API: żądanie 100 co 60 s na adres IP
Obiekty
Następujące obiekty opisują ładunki, które są przyjmowane lub zwracane. Więcej informacji na temat tego, kiedy te obiekty są w użyciu, można znaleźć w poszczególnych punktach końcowych.
Any
Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.
Atrybuty
Typ zaserwowanej wiadomość.
Asset
Reprezentuje zasób.
Atrybuty
Unikalny identyfikator zasoby. Wymagany dla Aktualizacja zasobu.
wpisywaćzasobu. Może to być tylko Audio , Decal lub Model . Wymagany do tworzenia zasobu .
Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.
Opis zasobu. Ogranicz do 1000 znaków. Wymagany do tworzenia zasobu.
Nazwa wyświetlana zasobu. Wymagana do tworzenia zasobu.
Ścieżka zasobów dla ikona.
Wynik moderacji zasobu.
Powrócona ścieżka zasobu. Format: assets/{assetId} . Przykład: assets/2205400862 .
Lista podglądów, każdy z których ma ścieżkę zasobów i tekst alternatywny. Podglądy muszą być obrazami zasobami.
Data stworzenia czasopieczęcia obecnej rewizji.
ID wersji zasobu.Równoważne z versionNumber.Każda zmiana zasobu automatycznie komituje nową wersję.Format to ciągcałkowita.Przykład: 1 .
Link do mediów społecznościowych dla aktywa.Maksymalnie trzy na przedmiot.Nazwa obiektu może być dowolna z:
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink >
- twitchSocialLink >
- discordSocialLink >
- githubSocialLink >
- robloxSocialLink >
- guildedSocialLink >
- devForumSocialLink > >
Czy zasób jest aktywny czy archiwizowany. Nieokreślone nie jest używane.
AssetVersion
Wersja zasobu.
Atrybuty
Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.
Wynik moderacji zasobu.
Powrócona ścieżka zasobu wersji aktywa. Format: assets/{assetId}/versions/{version} . Przykład: assets/2205400862/versions/1 .
CreationContext
Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.
Atrybuty
Reprezentuje twórca.
Oczekiwana opłata za przesłanie zasobów w Robux. Gdy rzeczywista cena jest większa niż oczekiwana, operacja kończy się błędem 400.
Creator
Reprezentuje twórca.
Atrybuty
ID grupy. Wymagane, jeśli zasób jest własnością grupy.
ID użytkownika twórca. Wymagane, jeśli zasób jest własnością jednego użytkownika.
ModerationResult
Wynik moderacji zasobu.
Atrybuty
Stan moderacji aktywa. Może to być Reviewing , Rejected lub Approved .
Operation
Zasób ten reprezentuje długo biegnącą operację, która jest wynikiem wezwania API sieciowego.
Atrybuty
Jeśli false , operacja jest nadal w toku. Jeśli true , operacja jest zakończona.
Model błędu logicznego wyjaśniający status błędu.
Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.
Ścieżka zasobu przypisana serwerowi. Domyślny format to operations/{operation_id} .
Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.
Preview
Podgląd zasobu.
Atrybuty
Tekst alternatywny dla przedmiotu próbnego.
Ścieżka podglądu zasobu.
SocialLink
Link do mediów społecznościowych dla aktywa.Maksymalnie trzy na przedmiot.Nazwa obiektu może być dowolna z:
- facebookSocialLink
- twitterSocialLink
- youtubeSocialLink >
- twitchSocialLink >
- discordSocialLink >
- githubSocialLink >
- robloxSocialLink >
- guildedSocialLink >
- devForumSocialLink > >
Atrybuty
Opcjonalny tytuł dla łączyćdo mediów społecznościowych. Nie używany na Creator Hub.
URI dla łączyćdo mediów społecznościowych.Musi pasować do oczekiwanego formatu dla rodzaju łączyć.Na przykład tytuł dla obiektu twitchSocialLink musi mieć format https://twitch.tv/your-channel.
State
Czy zasób jest aktywny czy archiwizowany. Nieokreślone nie jest używane.
Atrybuty
Status
Model błędu logicznego wyjaśniający status błędu.
Atrybuty
Kod stanu HTTP.
Lista wiadomości zawierająca szczegóły błędu.
Komunikat o wiadomość.