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.

Assets

https://apis.roblox.com/assets

Lista wersji zasobu

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

Parametry

assetId string
Path
Wymagane
maxPageSize number
pageToken string

Żą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

  • Odczyt
  • 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

Parametry

assetId string
Path
Wymagane
assetVersion string
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

  • Odczyt
  • Zapis
  • asset:read
  • asset:write

Limity

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

Zdobądź zasób

GET /v1/assets

Parametry

assetId
Path
Wymagane
readMask string

Żą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

  • Odczyt
  • asset:read

Limity

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

Utwórz zasób

POST /v1/assets

Parametry

request
FormData
Wymagane
fileContent string
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
error object
metadata object
path string
response object

Wymagane uprawnienia

  • Odczyt
  • Zapis
  • asset:read
  • asset:write

Limity

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

Aktualizuj zasoby

PATCH /v1/assets/{assetId}

Parametry

request
FormData
Wymagane
fileContent string
FormData
updateMask string

Żą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
error object
metadata object
path string
response object

Wymagane uprawnienia

  • Odczyt
  • Zapis
  • 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}

Parametry

assetId string
Path
Wymagane
versionNumber string
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

  • Odczyt
  • asset:read

Limity

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

Zdobądź Operację

GET /v1/operations/{operationId}

Żą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
error object
metadata object
path string
response object

Wymagane uprawnienia

  • Odczyt
  • 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

Atrybuty

@type string

Asset

Atrybuty

assetId number
assetType string
creationContext object
description string
displayName string
icon string
moderationResult object
path string
previews array<object>
revisionCreateTime string
revisionId string
socialLink object

CreationContext

Atrybuty

creator object
Wymagane
expectedPrice number

Creator

Atrybuty

groupId number
userId number

ModerationResult

Atrybuty

moderationState string

Operation

Atrybuty

done boolean
error object
metadata object
path string
response object

Preview

Atrybuty

altText string
asset string

Atrybuty

title string
uri string

Status

Atrybuty

code number
details array<object>
message string