資產 API

*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。

Assets

https://apis.roblox.com/assets

列出資產版本

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

參數

assetId string
Path
需要
maxPageSize number
pageToken string

請求

List Asset Versions
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \

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

回應

需要權限

  • 讀取
  • asset:read

限制

每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求

滾回資產版本

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

參數

assetId string
Path
需要
assetVersion string
FormData
需要

請求

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}\"}'

回應

需要權限

  • 讀取
  • 寫入
  • asset:read
  • asset:write

限制

每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求

取得資產

GET /v1/assets

參數

assetId
Path
需要
readMask string

請求

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}'

回應

需要權限

  • 讀取
  • asset:read

限制

每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求

創建資產

POST /v1/assets

參數

request
FormData
需要
fileContent string
FormData
需要

請求

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'

回應

200 - OK
返回操作 ID 以檢查創建狀態。
傳回： object
done boolean
error object
metadata object
path string
response object

需要權限

  • 讀取
  • 寫入
  • asset:read
  • asset:write

限制

每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求

更新資產

PATCH /v1/assets/{assetId}

參數

request
FormData
需要
fileContent string
FormData
updateMask string

請求

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

回應

200 - OK
返回運作ID以檢查更新狀態/ 返回已更新的元數據欄。
傳回： 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

需要權限

  • 讀取
  • 寫入
  • asset:read
  • asset:write

限制

每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求

取得資產版本

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

參數

assetId string
Path
需要
versionNumber string
Path
需要

請求

Get Asset Version
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \

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

回應

需要權限

  • 讀取
  • asset:read

限制

每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求

獲得操作

GET /v1/operations/{operationId}

請求

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

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

回應

200 - OK
傳回： object
done boolean
error object
metadata object
path string
response object

需要權限

  • 讀取
  • asset:read

限制

每個 API 金鑰：每個 IP 位址每 60 秒 60 個請求

物件

以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。

Any

特性

@type string

Asset

特性

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

特性

creator object
需要
expectedPrice number

Creator

特性

groupId number
userId number

ModerationResult

特性

moderationState string

Operation

特性

done boolean
error object
metadata object
path string
response object

Preview

特性

altText string
asset string

特性

title string
uri string

Status

特性

code number
details array<object>
message string