Interfejs danych

*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 wiadomości i odpowiedzi, aby tworzyć zasoby na Roblox. Dla informacji o użyciu API, zobacz Przewodnik użytkownika.

Assets

https://apis.roblox.com/assets

Lista wersji zasobu

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

Lista wszystkich wersji określonego zasobu, z możliwością paginacji opcjonalnej.

Parametry

assetId string

Unikalny identyfikator zasobu.

Path
Wymagane
maxPageSize number

Określa liczbę wersji zasobów do uwzględnienia w odpowiedzi. Poprawne wartości wynoszą od 1 do 50 (łącznie). Domyślne wartości dla 8, gdy nie zostaną podane.

pageToken string

Token do paginacji. Wartość jest uzyskiwana z poprzedniego zapytania i umożliwia odzyskiwanie 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ź:

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

Do umożliwienia aplikacji OAuth 2.0 użycia tego punktu końcowego wymagane są następujące zakresy. Więcej informacji na temat rejestrowania aplikacji OAuth 2.0 można znaleźć w obszarze Rejestracja i omówienie aplikacji.

  • asset:read

Limity

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

Wersja zasobu do późniejszego zwrócenia

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

Przywróć jedną z zasobów do specyficznej poprzedniej wersji.

Parametry

assetId string

Unikalny identyfikator zasobu.

Path
Wymagane
assetVersion string

Droga wersji zasobu w formacie assets/{assetId}/versions/{versionNumber} .

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

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

Do umożliwienia aplikacji OAuth 2.0 użycia tego punktu końcowego wymagane są następujące zakresy. Więcej informacji na temat rejestrowania aplikacji OAuth 2.0 można znaleźć w obszarze Rejestracja i omówienie aplikacji.

  • asset:read

  • asset:write

Limity

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

Zdobądź zasób

GET /v1/assets

Odzyskaj szczegółowy materiał źródłowy i metadane.

Parametry

assetId

Unikalny identyfikator zasobu.

Path
Wymagane
readMask string

Pola metadanych zasobów do uzyskiwać, w tym opis, nazwa wyświetlanawyświetlaną, 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ź:

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

Do umożliwienia aplikacji OAuth 2.0 użycia tego punktu końcowego wymagane są następujące zakresy. Więcej informacji na temat rejestrowania aplikacji OAuth 2.0 można znaleźć w obszarze Rejestracja i omówienie aplikacji.

  • asset:read

Limity

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

Utwórz zasób

POST /v1/assets

Tworzy zasób z dostarczonym treścią i metadanymi.

Nie możesz dodać SocialLink obiektów podczas tworzenia zasobu. Zamiast tego użyj Aktualizuj zasób.

Parametry

request

Atrybuty zasobów do tworzenia lub aktualizacja. Wysyłaj dane w formie, jak pokazano poniżej w przykładzie wniosku.

FormData
Wymagane
fileContent string

Konfiguracja pliku źródłowego i jego wpisywaćtreści.格式: fileContent=@"/filepath/{File}";type={ContentType} . przykład: fileContent=@"/filepath/model.fbx";type=model/fbx . See Typy treści .

FormData
Wymagane

Żą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 statustworzenia.
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 dowolną seryalizowaną wiadomość wraz z @type , która opisuje typ serjalizowanej wiadomości.

path string

Zasadniczo droga zasobu serwera. Domyślnym formatem jest operations/{operation_id} .

response object

Zawiera dowolną seryalizowaną wiadomość wraz z @type , która opisuje typ 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

Do umożliwienia aplikacji OAuth 2.0 użycia tego punktu końcowego wymagane są następujące zakresy. Więcej informacji na temat rejestrowania aplikacji OAuth 2.0 można znaleźć w obszarze Rejestracja i omówienie aplikacji.

  • asset:read

  • asset:write

Limity

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

Aktualizuj zasoby

PATCH /v1/assets/{assetId}

Aktualizuje zasoby z dostępnymi treściami i metadanymi, w tym opis, nazwa wyświetlanawyświetlaną, ikona, linki społecznościowe i podglądy. Obecnie można aktualizować tylko treść ciała dla Modeli. Ikony i podglądy muszą być zasobami Obrazu. Ikony muszą mieć wymiary kваadratowe.

Parametry

request

Wyślij dane formularza, takie jak poniższe przykładowe wnioski.

FormData
Wymagane
fileContent string

Konfiguracja pliku źródłowego i jego wpisywaćtreści.格式: fileContent=@"/filepath/{File}";type={ContentType} . przykład: fileContent=@"/filepath/model.fbx";type=model/fbx . See Typy treści .

FormData
updateMask string

Pola metadanych zasobów do aktualizacja, w tym opis, nazwa wyświetlanawyświetlaną, ikona i podgląd. 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
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}\"'
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\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}
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 dowolną seryalizowaną wiadomość wraz z @type , która opisuje typ serjalizowanej wiadomości.

path string

Zasadniczo droga zasobu serwera. Domyślnym formatem jest operations/{operation_id} .

response object

Zawiera dowolną seryalizowaną wiadomość wraz z @type , która opisuje typ 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

Do umożliwienia aplikacji OAuth 2.0 użycia tego punktu końcowego wymagane są następujące zakresy. Więcej informacji na temat rejestrowania aplikacji OAuth 2.0 można znaleźć w obszarze Rejestracja i omówienie aplikacji.

  • asset:read

  • asset:write

Limity

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

Zdobądź wersję zasobu

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

Odzyskaj określoną wersję zasobu poprzez ID zasobu i numer 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ź:

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

Do umożliwienia aplikacji OAuth 2.0 użycia tego punktu końcowego wymagane są następujące zakresy. Więcej informacji na temat rejestrowania aplikacji OAuth 2.0 można znaleźć w obszarze Rejestracja i omówienie aplikacji.

  • asset:read

Limity

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

Zdobądź Operację

GET /v1/operations/{operationId}

Zdobądź wynik tworzenia lub aktualizacji zasobu używając powrotnego ID operacji. Wymaga Przeczytaj dla uprawnień klucza API i Przeczytaj dla aplikacji OAuth 2.0.

Żądanie

Get Operation
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \

--header 'x-api-key: {apiKey}'

Odpowiedź:

200 - OK
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 dowolną seryalizowaną wiadomość wraz z @type , która opisuje typ serjalizowanej wiadomości.

path string

Zasadniczo droga zasobu serwera. Domyślnym formatem jest operations/{operation_id} .

response object

Zawiera dowolną seryalizowaną wiadomość wraz z @type , która opisuje typ 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

Do umożliwienia aplikacji OAuth 2.0 użycia tego punktu końcowego wymagane są następujące zakresy. Więcej informacji na temat rejestrowania aplikacji OAuth 2.0 można znaleźć w obszarze Rejestracja i omówienie aplikacji.

  • asset:read

Limity

Na klucz API: żądanie 60 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 dowolną seryalizowaną wiadomość wraz z @type , która opisuje typ serjalizowanej wiadomości.

Atrybuty

@type string

Typ serwowanej wiadomość.

Asset

Reprezentuje zasoby.

Atrybuty

assetId number

Unikalny identyfikator zasobu. Wymagany do Aktualizacja zasobu.

assetType string

wpisywaćzasobu. Może być tylko Audio, Decal, lub Model. Wymagane dla 2>Utwórz zasób2>.

creationContext object

Kontekst stworzenia, który nie jest częścią treści zasobu, takich jak metadane i informacje o twórcy. Wymagane dla Utwórz zasób .

description string

Opis zasobu. Ograniczony do 1000 znaków. Wymagane do Utwórz zasób .

displayName string

Imię wyświetlanego zasobu. Wymagane dla Utwórz zasób .

icon string

Droga zasobu dla ikona.

moderationResult object

Rezultat moderacji zasobu.

path string

Zwrócony ścieżka zasobów.格式: assetId . Przykład: assets/2205400862 .

previews array<object>

Lista podglądów, każdy z nich z zasobem ścieżki i alternatywnego tekstu. Podglądy muszą być zasobami Obrazu zasobów.

revisionCreateTime string

Czas utworzenia obecnej rewizji.

revisionId string

Id przeglądania zasobu. Równoznaczne z versionNumber . Każda zmiana zasobu automatycznie kommit nową wersję.格式 jest strungą ciąg. Przykład: 1 .

socialLink object

Przyciski mediów społecznościowych dla zasobu. Maksymalnie trzy dla każdego zasobu. Imię obiektu mo

CreationContext

Kontekst stworzenia, który nie jest częścią treści zasobu, takich jak metadane i informacje o twórcy. Wymagane dla Utwórz zasób .

Atrybuty

creator object

Reprezentuje twórca.

Wymagane
expectedPrice number

Oczekiwana opłata za wysyłanie zasobów w Robux. Gdy cena jest wyższa niż oczekiwano, operacja kończy się błędem 400.

Creator

Reprezentuje twórca.

Atrybuty

groupId number

ID Grupy. Wymagane, jeśli zasób należy do grupy.

userId number

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

ModerationResult

Rezultat moderacji zasobu.

Atrybuty

moderationState string

Stan moderacji zasobu. Może być MODERATION_STATE_REVIEWING, MODERATION_STATE_REJECTED lub MODERATION_STATE_APPROVED.

Operation

Ten przedmiot jest wynikiem długoterminowej operacji, która jest wynikiem wezwania API sieci.

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 dowolną seryalizowaną wiadomość wraz z @type , która opisuje typ serjalizowanej wiadomości.

path string

Zasadniczo droga zasobu serwera. Domyślnym formatem jest operations/{operation_id} .

response object

Zawiera dowolną seryalizowaną wiadomość wraz z @type , która opisuje typ serjalizowanej wiadomości.

Preview

Podgląd zasobów.

Atrybuty

altText string

Alt tekst dla zasobu podglądu.

asset string

Droga podglądowa zasobów.

Przyciski mediów społecznościowych dla zasobu. Maksymalnie trzy dla każdego zasobu. Imię obiektu mo

Atrybuty

title string

Opcjonalny tytuł dla łączyćdo mediów społecznościowych. Nie jest używany na hubie twórcy.

uri string

URL dla łączyćdo mediów społecznościowych. Musi zgadzać się z oczekiwanym formatem dla typu łączyć. Na przykład, tytuł dla obiektu twitchSocialLink musi być z formatu https://twitch.tv/your-channel .

Status

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

Atrybuty

code number

Kod kodHTTP.

details array<object>

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

message string

Wiadomość o wiadomość.