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: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

รุ่นสมุดกลับ

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: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

รับสินทรัพย์

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: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

สร้างสินทรัพย์

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
กลับรหัสการปฏิบัติการเพื่อตรวจสอบสถานะการสร้าง
ส่งคืน object
done boolean
error object
metadata object
path string
response object

สิทธิ์ที่ต้องมี

  • อ่าน
  • เขียน
  • asset:read
  • asset:write

การจำกัด

ต่อคีย์ API: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

อัปเดตทรัพยากร

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

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
กลับรหัสการดำเนินการเพื่อตรวจสอบสถานะการปรับปรุง / กลับรหัสโคลนและข้อมูลเมทาดาตา
ส่งคืน 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: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

รับเวอร์ชันสินทรัพย์

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: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

รับการดำเนินการ

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: 60 คำขอทุกๆ 60 วินาทีต่อที่อยู่ IP

วัตถุ

วัตถุต่อไปนี้ใช้บรรยายเพย์โหลดที่ยอมรับหรือส่งคืน ดูข้อมูลเพิ่มเติมว่าจะใช้วัตถุเหล่านี้ตอนไหนที่ Endpoint แต่ละจุด

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