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

https://apis.roblox.com/assets

Wyświetl wersje zasobów

GET /assets/v1/assets/{assetId}/versions

Wyświetl wszystkie wersje określonego zasobu z opcjonalną nawigacją.

Parametry

assetId string

Unikalny identyfikator zasobu.

Path
Wymagane
maxPageSize number

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.

pageToken string

Token do paginacji. Wartość jest uzyskiwana z poprzedniego żądania i pozwala na odzyskanie następnej strony wersji zasobów.

Żądanie

List Asset Versions

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'

Odpowiedź:

200 - OK
Wersje zasobów wymienione pomyślnie.
Zwraca: array<object>

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.

  • Odczyt

Limity

Na klucz API: żądanie 100 co 60 s na adres IP

Wróć do wersji zasobu

POST /assets/v1/assets/{assetId}/versions:rollback

Przywróć zasób do określonej poprzedniej wersji.

Podaj ścieżkę wersji zasobu w danych formularza.

Parametry

assetId string

Unikalny identyfikator zasobu.

Path
Wymagane

Żądanie

Rollback Asset Versions

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ź:

200 - OK
Zasób powrócono pomyślnie.
Zwraca: object
creationContext object

Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.

moderationResult object

Wynik moderacji zasobu.

path string

Powrócona ścieżka zasobu wersji aktywa. Format: assets/{assetId}/versions/{version} . Przykład: assets/2205400862/versions/1 .

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.

  • Odczyt

  • Zapis

Limity

Na klucz API: żądanie 100 co 60 s na adres IP

Utwórz zasób

POST /v1/assets

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

Create Asset

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ź:

200 - OK
Zwraca ID operacji do sprawdzenia statusu tworzenia.
Zwraca: object
done boolean

Jeśli false , operacja jest nadal w toku. Jeśli true , operacja jest zakończona.

error object

Model błędu logicznego wyjaśniający status błędu.

metadata object

Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.

path string

Ścieżka zasobu przypisana serwerowi. Domyślny format to operations/{operation_id} .

response object

Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.

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.

  • Odczyt

  • Zapis

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

Zdobądź zasób

GET /v1/assets/{assetId}

Zbierz szczegółowe treści i metadane zasobów.

Parametry

assetId string

Unikalny identyfikator zasobu.

Path
Wymagane
readMask string

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

Get Asset without readMask

curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}'
Get Asset with readMask

curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \
--header 'x-api-key: {apiKey}'

Odpowiedź:

200 - OK
Zasób zasobów odzyskany pomyślnie.
Zwraca: object
assetId number

Unikalny identyfikator zasoby. Wymagany dla Aktualizacja zasobu.

assetType string

wpisywaćzasobu. Może to być tylko Audio , Decal lub Model . Wymagany do tworzenia zasobu .

creationContext object

Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.

description string

Opis zasobu. Ogranicz do 1000 znaków. Wymagany do tworzenia zasobu.

displayName string

Nazwa wyświetlana zasobu. Wymagana do tworzenia zasobu.

icon string

Ścieżka zasobów dla ikona.

moderationResult object

Wynik moderacji zasobu.

path string

Powrócona ścieżka zasobu. Format: assets/{assetId} . Przykład: assets/2205400862 .

previews array<object>

Lista podglądów, każdy z których ma ścieżkę zasobów i tekst alternatywny. Podglądy muszą być obrazami zasobami.

revisionCreateTime string

Data stworzenia czasopieczęcia obecnej rewizji.

revisionId string

ID wersji zasobu.Równoważne z versionNumber.Każda zmiana zasobu automatycznie komituje nową wersję.Format to ciągcałkowita.Przykład: 1 .

socialLink object

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 >
  • >
Dla słownictwa patrz próbna prośba pod Aktualizuj zasób .

state string

Czy zasób jest aktywny czy archiwizowany. Nieokreślone nie jest używane.

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.

  • Odczyt

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

Aktualizuj zasób

PATCH /v1/assets/{assetId}

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

assetId string

Unikalny identyfikator zasobu.

Path
Wymagane
updateMask string

Pola metadanych zasobów do aktualizacja, w tym opis, nazwa wyświetlana, ikona i podglądy. Przykłady: description%2CdisplayName , previews%2CtwitchSocialLink .

Żądanie

Update Content Only and Create a New Version

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}\""'
Update Content and Metadata

Update a List of Previews

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.\"}]}"'
Update Social Links

Odpowiedź:

200 - OK
Zwraca ID operacji do sprawdzenia statusu aktualizacji / zwraca zaktualizowane pola metadanych.
Zwraca: object
application/json

{"previews": [
{"asset": "assets/123", "altText": "preview 1"},
{"asset": "assets/456", "altText": "preview 2"}
]}
done boolean

Jeśli false , operacja jest nadal w toku. Jeśli true , operacja jest zakończona.

error object

Model błędu logicznego wyjaśniający status błędu.

metadata object

Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.

path string

Ścieżka zasobu przypisana serwerowi. Domyślny format to operations/{operation_id} .

response object

Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.

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.

  • Odczyt

  • Zapis

Limity

Na klucz API: żądanie 60 co 60 s na adres IP

Otrzymaj wersję zasobu

GET /v1/assets/{assetId}/versions/{versionNumber}

Zbierz określoną wersję zasobu za pomocą ID zasobu i numeru wersji.

Parametry

assetId string

Unikalny identyfikator zasobu.

Path
Wymagane
versionNumber string

Numer wersji.

Path
Wymagane

Żądanie

Get Asset Version

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'

Odpowiedź:

200 - OK
Wersja zasobu odzyskana pomyślnie.
Zwraca: object
creationContext object

Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.

moderationResult object

Wynik moderacji zasobu.

path string

Powrócona ścieżka zasobu wersji aktywa. Format: assets/{assetId}/versions/{version} . Przykład: assets/2205400862/versions/1 .

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.

  • Odczyt

Limity

Na klucz API: żądanie 100 co 60 s na adres IP

Zasób archiwalny

POST /v1/assets/{assetId}:archive

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

assetId string

Unikalny identyfikator zasobu.

Path
Wymagane

Żądanie

Archive Asset

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'

Odpowiedź:

200 - OK
Zasób przechowany pomyślnie sukcesem.
Zwraca: object
assetId number

Unikalny identyfikator zasoby. Wymagany dla Aktualizacja zasobu.

assetType string

wpisywaćzasobu. Może to być tylko Audio , Decal lub Model . Wymagany do tworzenia zasobu .

creationContext object

Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.

description string

Opis zasobu. Ogranicz do 1000 znaków. Wymagany do tworzenia zasobu.

displayName string

Nazwa wyświetlana zasobu. Wymagana do tworzenia zasobu.

icon string

Ścieżka zasobów dla ikona.

moderationResult object

Wynik moderacji zasobu.

path string

Powrócona ścieżka zasobu. Format: assets/{assetId} . Przykład: assets/2205400862 .

previews array<object>

Lista podglądów, każdy z których ma ścieżkę zasobów i tekst alternatywny. Podglądy muszą być obrazami zasobami.

revisionCreateTime string

Data stworzenia czasopieczęcia obecnej rewizji.

revisionId string

ID wersji zasobu.Równoważne z versionNumber.Każda zmiana zasobu automatycznie komituje nową wersję.Format to ciągcałkowita.Przykład: 1 .

socialLink object

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 >
  • >
Dla słownictwa patrz próbna prośba pod Aktualizuj zasób .

state string

Czy zasób jest aktywny czy archiwizowany. Nieokreślone nie jest używane.

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.

  • Odczyt

  • Zapis

Limity

Na klucz API: żądanie 100 co 60 s na adres IP

Przywróć zasób

POST /v1/assets/{assetId}:restore

Przywraca zarchiwizowany zasób.

Parametry

assetId string

Unikalny identyfikator zasobu.

Path
Wymagane

Żądanie

Restore Asset

curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'

Odpowiedź:

200 - OK
Zasób odrestaurowany pomyślnie.
Zwraca: object
assetId number

Unikalny identyfikator zasoby. Wymagany dla Aktualizacja zasobu.

assetType string

wpisywaćzasobu. Może to być tylko Audio , Decal lub Model . Wymagany do tworzenia zasobu .

creationContext object

Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.

description string

Opis zasobu. Ogranicz do 1000 znaków. Wymagany do tworzenia zasobu.

displayName string

Nazwa wyświetlana zasobu. Wymagana do tworzenia zasobu.

icon string

Ścieżka zasobów dla ikona.

moderationResult object

Wynik moderacji zasobu.

path string

Powrócona ścieżka zasobu. Format: assets/{assetId} . Przykład: assets/2205400862 .

previews array<object>

Lista podglądów, każdy z których ma ścieżkę zasobów i tekst alternatywny. Podglądy muszą być obrazami zasobami.

revisionCreateTime string

Data stworzenia czasopieczęcia obecnej rewizji.

revisionId string

ID wersji zasobu.Równoważne z versionNumber.Każda zmiana zasobu automatycznie komituje nową wersję.Format to ciągcałkowita.Przykład: 1 .

socialLink object

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 >
  • >
Dla słownictwa patrz próbna prośba pod Aktualizuj zasób .

state string

Czy zasób jest aktywny czy archiwizowany. Nieokreślone nie jest używane.

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.

  • Odczyt

  • Zapis

Limity

Na klucz API: żądanie 100 co 60 s na adres IP

Zdobądź operację

GET /v1/operations/{operationId}

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

operationId string

Unikalny identyfikator operacji.

Path
Wymagane

Żądanie

Get Operation

curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'

Odpowiedź:

200 - OK
Wynik operacji odzyskany pomyślnie.
Zwraca: object
done boolean

Jeśli false , operacja jest nadal w toku. Jeśli true , operacja jest zakończona.

error object

Model błędu logicznego wyjaśniający status błędu.

metadata object

Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.

path string

Ścieżka zasobu przypisana serwerowi. Domyślny format to operations/{operation_id} .

response object

Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.

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.

  • Odczyt

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

@type string

Typ zaserwowanej wiadomość.

Asset

Reprezentuje zasób.

Atrybuty

assetId number

Unikalny identyfikator zasoby. Wymagany dla Aktualizacja zasobu.

assetType string

wpisywaćzasobu. Może to być tylko Audio , Decal lub Model . Wymagany do tworzenia zasobu .

creationContext object

Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.

description string

Opis zasobu. Ogranicz do 1000 znaków. Wymagany do tworzenia zasobu.

displayName string

Nazwa wyświetlana zasobu. Wymagana do tworzenia zasobu.

icon string

Ścieżka zasobów dla ikona.

moderationResult object

Wynik moderacji zasobu.

path string

Powrócona ścieżka zasobu. Format: assets/{assetId} . Przykład: assets/2205400862 .

previews array<object>

Lista podglądów, każdy z których ma ścieżkę zasobów i tekst alternatywny. Podglądy muszą być obrazami zasobami.

revisionCreateTime string

Data stworzenia czasopieczęcia obecnej rewizji.

revisionId string

ID wersji zasobu.Równoważne z versionNumber.Każda zmiana zasobu automatycznie komituje nową wersję.Format to ciągcałkowita.Przykład: 1 .

socialLink object

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 >
  • >
Dla słownictwa patrz próbna prośba pod Aktualizuj zasób .

state string

Czy zasób jest aktywny czy archiwizowany. Nieokreślone nie jest używane.

AssetVersion

Wersja zasobu.

Atrybuty

creationContext object

Kontekst tworzenia, który nie jest częścią treści zasobu, takie jak metadane i informacje o twórcy. Wymagany do tworzenia zasobu.

moderationResult object

Wynik moderacji zasobu.

path string

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

creator object

Reprezentuje twórca.

Wymagane
expectedPrice number

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

groupId number

ID grupy. Wymagane, jeśli zasób jest własnością grupy.

userId number

ID użytkownika twórca. Wymagane, jeśli zasób jest własnością jednego użytkownika.

ModerationResult

Wynik moderacji zasobu.

Atrybuty

moderationState string

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

done boolean

Jeśli false , operacja jest nadal w toku. Jeśli true , operacja jest zakończona.

error object

Model błędu logicznego wyjaśniający status błędu.

metadata object

Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.

path string

Ścieżka zasobu przypisana serwerowi. Domyślny format to operations/{operation_id} .

response object

Zawiera losową serjalizowaną wiadomość wraz z @type, która opisuje rodzaj serjalizowanej wiadomości.

Preview

Podgląd zasobu.

Atrybuty

altText string

Tekst alternatywny dla przedmiotu próbnego.

asset string

Ścieżka podglądu zasobu.

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 >
  • >
Dla słownictwa patrz próbna prośba pod Aktualizuj zasób .

Atrybuty

title string

Opcjonalny tytuł dla łączyćdo mediów społecznościowych. Nie używany na Creator Hub.

uri string

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

string (enum): "Unspecified", "Active", "Archived"

Status

Model błędu logicznego wyjaśniający status błędu.

Atrybuty

code number

Kod stanu HTTP.

details array<object>

Lista wiadomości zawierająca szczegóły błędu.

message string

Komunikat o wiadomość.