API tài sản

*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

Bạn có thể gửi và nhận các yêu cầu và trả lời sau đây để tạo các tài nguyên trên Roblox. Đối với thông tin về cách sử dụng API, hãy xem Hướng dẫn sử dụng.

Assets

https://apis.roblox.com/assets

Danh sách các phiên bản tài sản

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

Danh sách tất cả các phiên bản của một tài nguyên cụ thể, với sắp xếp tùy chọn.

Tham Số

assetId string

Nhận dạng độc nhất của tài nguyên.

Path
Bắt Buộc
maxPageSize number

Chỉ định số lượng bản phiên tài sản để bao gồm trong trả lời. Các giá trị hợp lệ có thể lớn hơn hoặc nhỏ hơn 1 (bao gồm). Mặc định là 8 khi không được cung cấp.

pageToken string

Một token cho trang bị. Giá trị được lấy từ một yêu cầu trước và cho phép lấy trang tiếp theo của các phiên bản tài sản.

Yêu Cầu

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

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

Phản Hồi

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Đọc

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem Đăng ký và đánh giá ứng dụng.

  • asset:read

Giới Hạn

Mỗi Khóa API: 60 yêu cầu mỗi 60 giây cho mỗi Địa Chỉ IP

Phiên bản Hoàn quyền

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

Quay lại một tài nguyên lên một phiên bản trước đó cụ thể.

Tham Số

assetId string

Nhận dạng độc nhất của tài nguyên.

Path
Bắt Buộc
assetVersion string

Con đường phiên bản tài sản trong dạng assets/{assetId}/versions/{versionNumber} .

FormData
Bắt Buộc

Yêu Cầu

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

Phản Hồi

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Đọc

  • Ghi

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem Đăng ký và đánh giá ứng dụng.

  • asset:read

  • asset:write

Giới Hạn

Mỗi Khóa API: 60 yêu cầu mỗi 60 giây cho mỗi Địa Chỉ IP

Nhận tài sản

GET /v1/assets

Lấy nội dung tài sản và thẻ tên cụ thể.

Tham Số

assetId

Nhận dạng độc nhất của tài nguyên.

Path
Bắt Buộc
readMask string

Các trường dữ liệu tài sản để lấy, bao gồm mô miêu tả, tên hiển thị, biểu tượng, tên mạng xã hội và trước khi xem trước. Ví dụ: description%2CdisplayName , previews%2CtwitchSocialLink .

Yêu Cầu

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

Phản Hồi

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Đọc

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem Đăng ký và đánh giá ứng dụng.

  • asset:read

Giới Hạn

Mỗi Khóa API: 60 yêu cầu mỗi 60 giây cho mỗi Địa Chỉ IP

Tạo tài sản

POST /v1/assets

Tạo một tài sản với nội dung và thẻ tên cung cấp.

Bạn không thể thêm SocialLink 对象 khi bạn tạo một tài nguyên. Thay vào đó, hãy sử dụng Cập nhật tài nguyên .

Tham Số

request

Các thuộc tính tài sản để tạo hoặc cập nhật. Gửi dữ liệu hình dạng như yêu cầu mẫu dưới đây cho thấy.

FormData
Bắt Buộc
fileContent string

Các bước thiết lập trong phần mềm quản lý phiên bản; Cách sử dụng: fileContent = @"/fe/model.fbx"; type = model/fe/model;fileContent=@"/filepath/model.fbx";type=model/fbxfileContent = @"/fe/model.fbx"; type = model/fe/model; 1> fileContent = @"/fe/model.fbx"; type = model

FormData
Bắt Buộc

Yêu Cầu

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'

Phản Hồi

200 - OK
Trả về ID Hoạt động để kiểm tra tình trạng tạo trạng thái.
Trả lại object
done boolean

Nếu false , thao tác vẫn đang tiến trình. Nếu true , thao tác đã hoàn tất.

error object

Mô hình lỗi logic giải thích tình trạng tháilỗi.

metadata object

Bao gồm một tin nhắn serial bất kì cùng với một @type mô tả kiểu của tin nhắn serial.

path string

Đường dẫn tài nguyên đã được giao cho máy chủ. Biểu tượng mặc định là operations/{operation_id} .

response object

Bao gồm một tin nhắn serial bất kì cùng với một @type mô tả kiểu của tin nhắn serial.

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Đọc

  • Ghi

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem Đăng ký và đánh giá ứng dụng.

  • asset:read

  • asset:write

Giới Hạn

Mỗi Khóa API: 60 yêu cầu mỗi 60 giây cho mỗi Địa Chỉ IP

Cập Nhật Tài Sản

PATCH /v1/assets/{assetId}

Cập nhật một tài sản với nội dung và thẻ tên cung cấp, bao gồm mô miêu tả, tên hiển thị, biểu tượng, liên kết mạng xã hội và xem trước. Hiện tại chỉ có thể cập nhật cơ thể nội dung cho Mô hình . Icons và Trước bao gồm những kích thước hộ

Tham Số

request

Gửi dữ liệu hình dạng như các yêu cầu sau đây.

FormData
Bắt Buộc
fileContent string

Các bước thiết lập trong phần mềm quản lý phiên bản; Cách sử dụng: fileContent = @"/fe/model.fbx"; type = model/fe/model;fileContent=@"/filepath/model.fbx";type=model/fbxfileContent = @"/fe/model.fbx"; type = model/fe/model; 1> fileContent = @"/fe/model.fbx"; type = model

FormData
updateMask string

Các trường dữ liệu tài sản để cập nhật, bao gồm mô miêu tả, tên hiển thị, biểu tượng và trước khi xem trước. Ví dụ: description%2CdisplayName , previews%2CtwitchSocialLink .

Yêu Cầu

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

Phản Hồi

200 - OK
Trả về ID hoạt động để kiểm tra trạng thái cập nhật / Trả về các trường dữ liệu cập nhật.
Trả lại object
application/json
{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}
done boolean

Nếu false , thao tác vẫn đang tiến trình. Nếu true , thao tác đã hoàn tất.

error object

Mô hình lỗi logic giải thích tình trạng tháilỗi.

metadata object

Bao gồm một tin nhắn serial bất kì cùng với một @type mô tả kiểu của tin nhắn serial.

path string

Đường dẫn tài nguyên đã được giao cho máy chủ. Biểu tượng mặc định là operations/{operation_id} .

response object

Bao gồm một tin nhắn serial bất kì cùng với một @type mô tả kiểu của tin nhắn serial.

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Đọc

  • Ghi

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem Đăng ký và đánh giá ứng dụng.

  • asset:read

  • asset:write

Giới Hạn

Mỗi Khóa API: 60 yêu cầu mỗi 60 giây cho mỗi Địa Chỉ IP

NhậnPhiên bản tài sản

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

Lấy một phiên bản tài sản cụ thể bằng ID tài sản và số phiên bản.

Tham Số

assetId string

Nhận dạng độc nhất của tài nguyên.

Path
Bắt Buộc
versionNumber string

Số phiên bản.

Path
Bắt Buộc

Yêu Cầu

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

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

Phản Hồi

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Đọc

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem Đăng ký và đánh giá ứng dụng.

  • asset:read

Giới Hạn

Mỗi Khóa API: 60 yêu cầu mỗi 60 giây cho mỗi Địa Chỉ IP

Nhận Operation

GET /v1/operations/{operationId}

Nhận kết quả của một tạo hoặc cập nhật tài sản bằng cách sử dụng ID hoạt động đã được trả lại. Yêu cầu Đọc đối với API key permission và tài sản:read đối với OAuth 2.0 apps.

Yêu Cầu

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

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

Phản Hồi

200 - OK
Trả lại object
done boolean

Nếu false , thao tác vẫn đang tiến trình. Nếu true , thao tác đã hoàn tất.

error object

Mô hình lỗi logic giải thích tình trạng tháilỗi.

metadata object

Bao gồm một tin nhắn serial bất kì cùng với một @type mô tả kiểu của tin nhắn serial.

path string

Đường dẫn tài nguyên đã được giao cho máy chủ. Biểu tượng mặc định là operations/{operation_id} .

response object

Bao gồm một tin nhắn serial bất kì cùng với một @type mô tả kiểu của tin nhắn serial.

Quyền Cần Có

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] (/cloud/auth/api-keys).

  • Đọc

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem Đăng ký và đánh giá ứng dụng.

  • asset:read

Giới Hạn

Mỗi Khóa API: 60 yêu cầu mỗi 60 giây cho mỗi Địa Chỉ IP

Đối Tượng

Các đối tượng sau đây mô tả payload được chấp nhận hoặc bị trả về. Xem từng điểm cuối để biết thêm thông tin về thời điểm sử dụng các đối tượng này.

Any

Bao gồm một tin nhắn serial bất kì cùng với một @type mô tả kiểu của tin nhắn serial.

Thuộc Tính

@type string

Loại của thông điệp tin nhắn.

Asset

Đại diện cho tài sản.

Thuộc Tính

assetId number

Nhận dạng độc đáo của tài nguyên. Yêu cầu cho Cập nhật tài nguyên .

assetType string

đánh máytài nguyên. Chỉ có thể là Audio , Decal hoặc Model . Yêu cầu cho 1> Tạo tài nguyên1> .

creationContext object

Những khối nội dung không thuộc vào cấu hình của nội dung tài sản, chẳng hạn như dữ liệu métadữ và thông tin người tạo. Yêu cầu để Tạo tài sản .

description string

Mô tả tài sản. Giới hạn 1000 ký tự. Yêu cầu để Tạo tài sản .

displayName string

Tên hiển thị của tài nguyên. Yêu cầu cho Tạo tài nguyên .

icon string

Con đường tài nguyên cho biểu tượng.

moderationResult object

Kết quả kiểm duyệt của tài nguyên.

path string

Đường dẫn tài nguyên đã được trả lại của tài sản. Biểu tượng: assets/{assetId} . Ví dụ: assets/2205400862 .

previews array<object>

Một danh sách các bản xem trước, mỗi bản với một con đường tài sản và văn bản alt. Các bản xem trước phải là Image tài sản.

revisionCreateTime string

Thời gian tạo của bản hiện tại.

revisionId string

ID phiên bản của tài nguyên. Tương đương với versionNumber . Mọi thay đổi của tài nguyên đều tự động gửi một phiên bản mới. Biểu dạng là một chuỗi số. Ví dụ: 1 .

socialLink object

Một liên kết mạng xã hội cho tài nguyên. Tối đa ba mỗi tài n

CreationContext

Những khối nội dung không thuộc vào cấu hình của nội dung tài sản, chẳng hạn như dữ liệu métadữ và thông tin người tạo. Yêu cầu để Tạo tài sản .

Thuộc Tính

creator object

Đại diện một nhà sáng tạo.

Bắt Buộc
expectedPrice number

Phí tải tài nguyên được mong đợi trong Robux. Khi giá thực tế cao hơn dự kiến, hành động thất bại với một lỗi 400.

Creator

Đại diện một nhà sáng tạo.

Thuộc Tính

groupId number

ID Nhóm. Yêu cầu nếu tài sản thuộc sở hữu nhóm.

userId number

ID người dùng mà nhà sáng nhà sáng tạođã tạo. Yêu cầu nếu tài nguyên là của người dùng.

ModerationResult

Kết quả kiểm duyệt của tài nguyên.

Thuộc Tính

moderationState string

Tình trạng điều chỉnh của tài sản. Có thể là MODERATION_STATE_REVIEWING, MODERATION_STATE_REJECTED hoặc MODERATION_STATE_APPROVED.

Operation

Nguồn tài nguyên này đại diện cho một hoạt động chạy lâu dài là kết quả của một cuộc gọi API mạng.

Thuộc Tính

done boolean

Nếu false , thao tác vẫn đang tiến trình. Nếu true , thao tác đã hoàn tất.

error object

Mô hình lỗi logic giải thích tình trạng tháilỗi.

metadata object

Bao gồm một tin nhắn serial bất kì cùng với một @type mô tả kiểu của tin nhắn serial.

path string

Đường dẫn tài nguyên đã được giao cho máy chủ. Biểu tượng mặc định là operations/{operation_id} .

response object

Bao gồm một tin nhắn serial bất kì cùng với một @type mô tả kiểu của tin nhắn serial.

Preview

Một bản xem trước tài sản.

Thuộc Tính

altText string

Văn bản alt cho tài nguyên xem trước.

asset string

Con đường tài sản xem trước.

Một liên kết mạng xã hội cho tài nguyên. Tối đa ba mỗi tài n

Thuộc Tính

title string

Một tiêu đề tùy chọn cho liên kết mạng xã hội. Không được sử dụng trên Creator Hub.

uri string

URL cho liên kết mạng xã hội. Phải khớp nối dạng để loại liên kết. Ví dụ, tiêu đề cho một đối tượng twitchSocialLink phải là dạng https://twitch.tv/your-channel .

Status

Mô hình lỗi logic giải thích tình trạng tháilỗi.

Thuộc Tính

code number

Mã status HTTP.

details array<object>

Một danh sách các thông điệp mang chi tiết lỗi.

message string

Nhận thông báo tin nhắn.