API สําหรับสินทรัพย์

*เนื้อหานี้แปลโดยใช้ AI (เวอร์ชัน Beta) และอาจมีข้อผิดพลาด หากต้องการดูหน้านี้เป็นภาษาอังกฤษ ให้คลิกที่นี่

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

Assets

https://apis.roblox.com/assets

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

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

รายการเวอร์ชันทั้งหมดของสินทรัพย์บางรายการ พร้อมการจัดเรียงแบบอ่านต่อไป

พารามิเตอร์

assetId string

รหัสประจำตัวที่ไม่ซ้ำใครของสินทรัพย์

Path
จำเป็นต้องมี
maxPageSize number

ระบุจำนวนเวอร์ชันทรัพยากรที่จะรวมอยู่ในการตอบกลับ มีค่าเริ่มต้นจาก 1 ถึง 50 (รวมทั้ง) ส่วนค่าเริ่มต้นจะเป็น 8 เมื่อไม่ได้ระบุ

pageToken string

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

คำขอ

List Asset Versions

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

การตอบกลับ

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

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

  • อ่าน

แอปพลิเคชัน OAuth 2.0 ของคุณต้องมีขอบเขตต่อไปนี้เพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่การลงทะเบียนและการตรวจสอบแอป

  • asset:read

การจำกัด

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

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

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

สแน็ปแอสเซ็ตไปยังเวอร์ชันก่อนหน้าเฉพาะ

พารามิเตอร์

assetId string

รหัสประจำตัวที่ไม่ซ้ำใครของสินทรัพย์

Path
จำเป็นต้องมี
assetVersion string

เส้นทางรุ่นสมุดในรูปแบบ assets/{assetId}/versions/{versionNumber}

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

การตอบกลับ

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

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

  • อ่าน

  • เขียน

แอปพลิเคชัน OAuth 2.0 ของคุณต้องมีขอบเขตต่อไปนี้เพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่การลงทะเบียนและการตรวจสอบแอป

  • asset:read

  • asset:write

การจำกัด

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

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

GET /v1/assets

กู้เนื้อหาและตัวอนุญาตของสินทรัพย์เฉพาะ

พารามิเตอร์

assetId

รหัสประจำตัวที่ไม่ซ้ำใครของสินทรัพย์

Path
จำเป็นต้องมี
readMask string

ดึงข้อมูลตัวอย่าง: description%2CdisplayName , previews%2CtwitchSocialLink .

คำขอ

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

การตอบกลับ

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

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

  • อ่าน

แอปพลิเคชัน OAuth 2.0 ของคุณต้องมีขอบเขตต่อไปนี้เพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่การลงทะเบียนและการตรวจสอบแอป

  • asset:read

การจำกัด

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

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

POST /v1/assets

สร้างสินทรัพย์ด้วยเนื้อหาและเมทาดักที่ให้ไว้

คุณไม่สามารถเพิ่มวัตถุ SocialLink เมื่อคุณสร้างสินทรัพย์ได้ แทนที่โดยใช้ ปรับปรุงสินทรัพย์

พารามิเตอร์

request

อัปเดตส่งเป็นข้อมูลแบบฟอร์มเช่นที่แสดงด้านล่าง

FormData
จำเป็นต้องมี
fileContent string

เส้นทางไฟล์ข้อมูลแบบข้อมูลของคอนเทนเนอร์ พิมพ์ตัวอย่าง: fileContent=@"/filepath/{File}";type={ContentType} ดู fileContent=@"/filepath/model.fbx";type=model/fbx .

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

หาก false การดำเนินการยังคงดำเนินอยู่ หาก true การดำเนินการเสร็จสิ้น

error object

แบบผิดพลาดที่มีเหตุผลอธิบายสถานะข้อผิดพลาด

metadata object

ประกอบด้วยข้อความซีรีเซอร์แบบสุ่มที่มี @type ที่อธิบายประเภทของข้อความซีรีเซอร์

path string

เส้นทางทรัพยากรที่ได้รับการกำหนด รูปแบบปกติคือ operations/{operation_id}

response object

ประกอบด้วยข้อความซีรีเซอร์แบบสุ่มที่มี @type ที่อธิบายประเภทของข้อความซีรีเซอร์

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

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

  • อ่าน

  • เขียน

แอปพลิเคชัน OAuth 2.0 ของคุณต้องมีขอบเขตต่อไปนี้เพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่การลงทะเบียนและการตรวจสอบแอป

  • asset:read

  • asset:write

การจำกัด

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

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

PATCH /v1/assets/{assetId}

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

พารามิเตอร์

request

ส่งข้อมูลรูปแบบเช่นคำขอตัวอย่างต่อไปนี้

FormData
จำเป็นต้องมี
fileContent string

เส้นทางไฟล์ข้อมูลแบบข้อมูลของคอนเทนเนอร์ พิมพ์ตัวอย่าง: fileContent=@"/filepath/{File}";type={ContentType} ดู fileContent=@"/filepath/model.fbx";type=model/fbx .

FormData
updateMask string

ข้อมูลแท็กติดตั้งสินทรัพย์ รวมถึงคำอธิบาย ชื่อแสดงผล ไอคอน และข้อมูลตัวอย่าง ตัวอย่าง: description%2CdisplayName , previews%2CtwitchSocialLink .

คำขอ

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

หาก false การดำเนินการยังคงดำเนินอยู่ หาก true การดำเนินการเสร็จสิ้น

error object

แบบผิดพลาดที่มีเหตุผลอธิบายสถานะข้อผิดพลาด

metadata object

ประกอบด้วยข้อความซีรีเซอร์แบบสุ่มที่มี @type ที่อธิบายประเภทของข้อความซีรีเซอร์

path string

เส้นทางทรัพยากรที่ได้รับการกำหนด รูปแบบปกติคือ operations/{operation_id}

response object

ประกอบด้วยข้อความซีรีเซอร์แบบสุ่มที่มี @type ที่อธิบายประเภทของข้อความซีรีเซอร์

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

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

  • อ่าน

  • เขียน

แอปพลิเคชัน OAuth 2.0 ของคุณต้องมีขอบเขตต่อไปนี้เพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่การลงทะเบียนและการตรวจสอบแอป

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

การตอบกลับ

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

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

  • อ่าน

แอปพลิเคชัน OAuth 2.0 ของคุณต้องมีขอบเขตต่อไปนี้เพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่การลงทะเบียนและการตรวจสอบแอป

  • asset:read

การจำกัด

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

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

GET /v1/operations/{operationId}

รับผลการสร้างหรือปรับปรุงสินทรัพย์โดยการใช้รหัสการดำเนินการที่กลับมา ต้องการ อ่าน สำหรับการอนุญาตให้ API สำหรับการอ่าน OAuth 2.0 และ อ่าน สำหรับการอ่าน OAuth 2.0 สำหรับการอ่าน OAuth 2.

คำขอ

Get Operation

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

การตอบกลับ

200 - OK
ส่งคืน object
done boolean

หาก false การดำเนินการยังคงดำเนินอยู่ หาก true การดำเนินการเสร็จสิ้น

error object

แบบผิดพลาดที่มีเหตุผลอธิบายสถานะข้อผิดพลาด

metadata object

ประกอบด้วยข้อความซีรีเซอร์แบบสุ่มที่มี @type ที่อธิบายประเภทของข้อความซีรีเซอร์

path string

เส้นทางทรัพยากรที่ได้รับการกำหนด รูปแบบปกติคือ operations/{operation_id}

response object

ประกอบด้วยข้อความซีรีเซอร์แบบสุ่มที่มี @type ที่อธิบายประเภทของข้อความซีรีเซอร์

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

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

  • อ่าน

แอปพลิเคชัน OAuth 2.0 ของคุณต้องมีขอบเขตต่อไปนี้เพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่การลงทะเบียนและการตรวจสอบแอป

  • asset:read

การจำกัด

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

วัตถุ

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

Any

ประกอบด้วยข้อความซีรีเซอร์แบบสุ่มที่มี @type ที่อธิบายประเภทของข้อความซีรีเซอร์

คุณลักษณะ

@type string

ประเภทของข้อความซีรี่ยล

Asset

แทนที่สินทรัพย์

คุณลักษณะ

assetId number

รหัสประจำตัวที่ไม่ซ้ำใครของสินทรัพย์ ต้องการสำหรับ ปรับปรุงสินทรัพย์

assetType string

ประเภทสื่อ สามารถเป็นเฉพาะ Audio เท่านั้น Decal หรือ Model ต้องการสำหรับ 1> สร้างสื่อประเภทนี้1>

creationContext object

บริบทของการสร้างที่ไม่ใช่ส่วนหนึ่งของเนื้อหาสินทรัพย์ เช่น ข้อมูลเมทาดาต้าและข้อมูลผู้สร้าง ต้องการสำหรับ สร้างสินทรัพย์ .

description string

คำอธิบายของสินทรัพย์ จํากัดไว้ที่ 1000 ตัวอักษร ต้องการสําหรับ สร้างสินทรัพย์

displayName string

ชื่อแสดงของสินทรัพย์ ต้องการสำหรับ สร้างสินทรัพย์

icon string

เส้นทางทรัพยากรสำหรับไอคอน

moderationResult object

ผลการกรองของสินทรัพย์

path string

เส้นทางทรัพยากรที่กลับมาของสินทรัพย์ รูปแบบ: assets/{assetId} ตัวอย่าง: assets/2205400862

previews array<object>

รายการแสดงตัวอย่าง แต่ละรายการมีเส้นทางสินทรัพย์และข้อความ alt รายการแสดงตัวอย่างต้องเป็น รายการภาพ สินทรัพย์

revisionCreateTime string

เวลาที่สร้างของรุ่นปัจจุบัน

revisionId string

รหัสการเปลี่ยนแปลงของสินทรัพย์ เทียบเท่ากับ versionNumber รุ่นใหม่ของสินทรัพย์จะถูกส่งออกโดยอัตโนมัติ สตริงตัวอย่าง: 1 .

socialLink object

ลิงค์สื่อสังคมออนไลน์สำหร

CreationContext

บริบทของการสร้างที่ไม่ใช่ส่วนหนึ่งของเนื้อหาสินทรัพย์ เช่น ข้อมูลเมทาดาต้าและข้อมูลผู้สร้าง ต้องการสำหรับ สร้างสินทรัพย์ .

คุณลักษณะ

creator object

ครีเอเตอร์

จำเป็นต้องมี
expectedPrice number

คาดหวังค่าอัปโหลดสินทรัพย์ใน Robux เมื่อราคาที่เป็นไปตามที่คาดไว้มีการผิดพลาด 400 ครั้ง

Creator

ครีเอเตอร์

คุณลักษณะ

groupId number

รหัสกลุ่ม จำเป็นหากสินทรัพย์เป็นของกลุ่ม

userId number

ครีเอเตอร์ต้องการหากสินทรัพย์เป็นของผู้ใช้เดียว

ModerationResult

ผลการกรองของสินทรัพย์

คุณลักษณะ

moderationState string

สถานะการควบคุมของสินทรัพย์ สามารถเป็น MODERATION_STATE_REVIEWING หรือ MODERATION_STATE_REJECTED หรือ MODERATION_STATE_APPROVED

Operation

ทรัพยากรนี้เป็นตัวแทนของการดำเนินงานเวลานานซึ่งเป็นผลมาจากการโทร API เครือข่าย

คุณลักษณะ

done boolean

หาก false การดำเนินการยังคงดำเนินอยู่ หาก true การดำเนินการเสร็จสิ้น

error object

แบบผิดพลาดที่มีเหตุผลอธิบายสถานะข้อผิดพลาด

metadata object

ประกอบด้วยข้อความซีรีเซอร์แบบสุ่มที่มี @type ที่อธิบายประเภทของข้อความซีรีเซอร์

path string

เส้นทางทรัพยากรที่ได้รับการกำหนด รูปแบบปกติคือ operations/{operation_id}

response object

ประกอบด้วยข้อความซีรีเซอร์แบบสุ่มที่มี @type ที่อธิบายประเภทของข้อความซีรีเซอร์

Preview

การดูตัวอย่างสินทรัพย์

คุณลักษณะ

altText string

ข้อความที่แสดงตัวอย่างสําหรับสินทรัพย์

asset string

เส้นทางสร้างตัวอย่าง

ลิงค์สื่อสังคมออนไลน์สำหร

คุณลักษณะ

title string

ศูนย์กลางครีเอเตอร์

uri string

เชื่อมโยงเชื่อมโยงโดยปกติรหัสชื่อของวัตถุ twitchSocialLink จะต้องเป็นรูปแบบ https://twitch.tv/your-channel

Status

แบบผิดพลาดที่มีเหตุผลอธิบายสถานะข้อผิดพลาด

คุณลักษณะ

code number

รหัสสถานะ HTTP

details array<object>

รายการข้อความที่มีรายละเอียดข้อผิดพลาด

message string

ข้อความผิดพลาด