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à phần tải trả lời sau đây để tạo tài sản trên Roblox.Đối với thông tin về việc sử dụng API, xem hướng dẫn sử dụng useage.

Assets

https://apis.roblox.com/assets

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

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

Liệt kê tất cả các phiên bản của một tài sản cụ thể, với trang bị tùy chọn.

Tham Số

assetId string

ID độc đáo của tài sản.

Path
Bắt Buộc
maxPageSize number

Xác định số phiên bản tài sản cần bao gồm trong phản hồi. Các giá trị hợp lệ dao động từ 1 đến 50 (bao gồm). Mặc định là 8 khi không được cung cấp.

pageToken string

Một token cho pagination. 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 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

200 - OK
Phiên bản tài sản được liệt kê thành công.
Trả lại array<object>

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

Giới Hạn

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

Phiên bản tài sản quay lại

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

Quay lại một tài sản về phiên bản trước đặc biệt.

Cung cấp con đường phiên bản tài sản trong dữ liệu biểu mẫu.

Tham Số

assetId string

ID độc đáo của tài sản.

Path
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

200 - OK
Tài sản được cuộn lại thành công.
Trả lại object
creationContext object

Nội dung ngữ cảnh không thuộc phần nội dung tài sản, chẳng hạn như thông tin metadata và người tạo. Yêu cầu cho Tạo Tài sản .

moderationResult object

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

path string

Con đường tài nguyên trả về của phiên bản tài sản. Định dạng: assets/{assetId}/versions/{version} . Ví dụ: assets/2205400862/versions/1 .

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

Giới Hạn

Mỗi Khóa API: 100 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à metadata được cung cấp.

Bạn không thể thêm đối tượng SocialLink khi tạo một tài sản. Thay vào đó, sử dụng Cập nhật tài sản.

Cung cấp Tài sản, đường dẫn tập tin tài sản nhị phân, và loại nội dung trong dữ liệu biểu mẫu.

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 tháitạo.
Trả lại object
done boolean

Nếu false , hoạt động vẫn đang diễn ra. Nếu true , hoạt động đã hoàn thành.

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 ngẫu nhiên được serialize cùng với một @type mô tả loại tin nhắn serialize.

path string

Con đường tài nguyên được gán bởi máy chủ. Định dạng mặc định là operations/{operation_id} .

response object

Bao gồm một tin nhắn ngẫu nhiên được serialize cùng với một @type mô tả loại tin nhắn serialize.

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

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/{assetId}

Lấy lại nội dung tài sản và metadata cụ thể.

Tham Số

assetId string

ID độc đáo của tài sản.

Path
Bắt Buộc
readMask string

Các trường thuộc tính dữ liệu tài sản để lấy lại, bao gồm mô miêu tả, tên hiển thị, biểu tượng, liên kết xã hội và bản 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

200 - OK
Tài nguyên tài sản được lấy lại thành công.
Trả lại object
assetId number

ID độc đáo của tài sản. Yêu cầu cho Cập nhật tài sản .

assetType string

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

creationContext object

Nội dung ngữ cảnh không thuộc phần nội dung tài sản, chẳng hạn như thông tin metadata và người tạo. Yêu cầu cho Tạo Tài sản .

description string

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

displayName string

Tên hiển thị của tài sản. Yêu cầu cho Tạo tài sả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 sản.

path string

Con đường tài nguyên trả về của tài sản. Định dạng: assets/{assetId} . Ví dụ: assets/2205400862 .

previews array<object>

Một danh sách xem trước, mỗi với một con đường tài sản và văn bản thay thế. Xem trước phải là Hình ảnh tài sản.

revisionCreateTime string

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

revisionId string

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

socialLink object

Một liên kết mạng xã hội cho tài sản.Tối đa ba mỗi tài sản.Tên đối tượng có thể là bất kỳ trong số:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink >
  • twitchSocialLink >
  • discordSocialLink >
  • githubSocialLink >
  • robloxSocialLink >
  • guildedSocialLink >
  • devForumSocialLink >
    • >
Đối với ngữ pháp, xem yêu cầu mẫu dưới Cập nhật tài sản .

state string

Whether tài sản đang hoạt động hay được lưu trữ. Không xác định không được sử dụng.

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

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à dữ liệu được cung cấp, bao gồm mô miêu tả, tên hiển thị, biểu tượng, liên kết xã hội và bản xem trước.Hiện tại chỉ có thể cập nhật nội dung cơ thể cho Mô hình .Biểu tượng và Xem trước phải là Tài sản hình ảnh .Biểu tượng phải có kích thước vuông.

Cung cấp Tài sản, đường dẫn tập tin tài sản nhị phân, và loại nội dung trong dữ liệu biểu mẫu.

Tham Số

assetId string

ID độc đáo của tài sản.

Path
Bắt Buộc
updateMask string

Các trường thuộc tính 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à bản 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 tình trạng cập nhật / Trả về các trường metadata cập nhật.
Trả lại object
application/json
{"previews": [

  {"asset": "assets/123", "altText": "preview 1"},

  {"asset": "assets/456", "altText": "preview 2"}

]}
done boolean

Nếu false , hoạt động vẫn đang diễn ra. Nếu true , hoạt động đã hoàn thành.

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 ngẫu nhiên được serialize cùng với một @type mô tả loại tin nhắn serialize.

path string

Con đường tài nguyên được gán bởi máy chủ. Định dạng mặc định là operations/{operation_id} .

response object

Bao gồm một tin nhắn ngẫu nhiên được serialize cùng với một @type mô tả loại tin nhắn serialize.

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

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 phiê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

ID độc đáo của tài sả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

200 - OK
Phiên bản tài sản đã lấy lại thành công.
Trả lại object
creationContext object

Nội dung ngữ cảnh không thuộc phần nội dung tài sản, chẳng hạn như thông tin metadata và người tạo. Yêu cầu cho Tạo Tài sản .

moderationResult object

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

path string

Con đường tài nguyên trả về của phiên bản tài sản. Định dạng: assets/{assetId}/versions/{version} . Ví dụ: assets/2205400862/versions/1 .

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

Giới Hạn

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

Tài sản lưu trữ

POST /v1/assets/{assetId}:archive

Lưu trữ tài sản.Các tài sản được lưu trữ biến mất khỏi trang web và không còn có thể sử dụng hoặc hiển thị trong trải nghiệm Roblox, nhưng bạn có thể phục hồi chúng.

Tham Số

assetId string

ID độc đáo của tài sản.

Path
Bắt Buộc

Yêu Cầu

Archive Asset
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \

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

--header 'Content-Type: application/json'

Phản Hồi

200 - OK
Tài sản được lưu trữ thành công thành công.
Trả lại object
assetId number

ID độc đáo của tài sản. Yêu cầu cho Cập nhật tài sản .

assetType string

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

creationContext object

Nội dung ngữ cảnh không thuộc phần nội dung tài sản, chẳng hạn như thông tin metadata và người tạo. Yêu cầu cho Tạo Tài sản .

description string

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

displayName string

Tên hiển thị của tài sản. Yêu cầu cho Tạo tài sả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 sản.

path string

Con đường tài nguyên trả về của tài sản. Định dạng: assets/{assetId} . Ví dụ: assets/2205400862 .

previews array<object>

Một danh sách xem trước, mỗi với một con đường tài sản và văn bản thay thế. Xem trước phải là Hình ảnh tài sản.

revisionCreateTime string

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

revisionId string

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

socialLink object

Một liên kết mạng xã hội cho tài sản.Tối đa ba mỗi tài sản.Tên đối tượng có thể là bất kỳ trong số:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink >
  • twitchSocialLink >
  • discordSocialLink >
  • githubSocialLink >
  • robloxSocialLink >
  • guildedSocialLink >
  • devForumSocialLink >
    • >
Đối với ngữ pháp, xem yêu cầu mẫu dưới Cập nhật tài sản .

state string

Whether tài sản đang hoạt động hay được lưu trữ. Không xác định không được sử dụng.

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

Giới Hạn

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

Phục hồi tài sản

POST /v1/assets/{assetId}:restore

Phục hồi một tài sản đã lưu trữ.

Tham Số

assetId string

ID độc đáo của tài sản.

Path
Bắt Buộc

Yêu Cầu

Restore Asset
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \

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

--header 'Content-Type: application/json'

Phản Hồi

200 - OK
Tài sản được phục hồi thành công.
Trả lại object
assetId number

ID độc đáo của tài sản. Yêu cầu cho Cập nhật tài sản .

assetType string

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

creationContext object

Nội dung ngữ cảnh không thuộc phần nội dung tài sản, chẳng hạn như thông tin metadata và người tạo. Yêu cầu cho Tạo Tài sản .

description string

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

displayName string

Tên hiển thị của tài sản. Yêu cầu cho Tạo tài sả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 sản.

path string

Con đường tài nguyên trả về của tài sản. Định dạng: assets/{assetId} . Ví dụ: assets/2205400862 .

previews array<object>

Một danh sách xem trước, mỗi với một con đường tài sản và văn bản thay thế. Xem trước phải là Hình ảnh tài sản.

revisionCreateTime string

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

revisionId string

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

socialLink object

Một liên kết mạng xã hội cho tài sản.Tối đa ba mỗi tài sản.Tên đối tượng có thể là bất kỳ trong số:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink >
  • twitchSocialLink >
  • discordSocialLink >
  • githubSocialLink >
  • robloxSocialLink >
  • guildedSocialLink >
  • devForumSocialLink >
    • >
Đối với ngữ pháp, xem yêu cầu mẫu dưới Cập nhật tài sản .

state string

Whether tài sản đang hoạt động hay được lưu trữ. Không xác định không được sử dụng.

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

Giới Hạn

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

Nhận hoạt động

GET /v1/operations/{operationId}

Nhận kết quả của việc tạo hoặc cập nhật tài sản bằng ID hoạt động được trả về.Yêu cầu Đọc cho quyền API và tài sản:đọc cho ứng dụng OAuth 2.0.

Tham Số

operationId string

ID độc đáo của hoạt động.

Path
Bắt Buộc

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
Kết quả hoạt động được lấy lại thành công.
Trả lại object
done boolean

Nếu false , hoạt động vẫn đang diễn ra. Nếu true , hoạt động đã hoàn thành.

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 ngẫu nhiên được serialize cùng với một @type mô tả loại tin nhắn serialize.

path string

Con đường tài nguyên được gán bởi máy chủ. Định dạng mặc định là operations/{operation_id} .

response object

Bao gồm một tin nhắn ngẫu nhiên được serialize cùng với một @type mô tả loại tin nhắn serialize.

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

Giới Hạn

Mỗi Khóa API: 100 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 ngẫu nhiên được serialize cùng với một @type mô tả loại tin nhắn serialize.

Thuộc Tính

@type string

Loại tin nhắn được serialize.

Asset

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

Thuộc Tính

assetId number

ID độc đáo của tài sản. Yêu cầu cho Cập nhật tài sản .

assetType string

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

creationContext object

Nội dung ngữ cảnh không thuộc phần nội dung tài sản, chẳng hạn như thông tin metadata và người tạo. Yêu cầu cho Tạo Tài sản .

description string

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

displayName string

Tên hiển thị của tài sản. Yêu cầu cho Tạo tài sả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 sản.

path string

Con đường tài nguyên trả về của tài sản. Định dạng: assets/{assetId} . Ví dụ: assets/2205400862 .

previews array<object>

Một danh sách xem trước, mỗi với một con đường tài sản và văn bản thay thế. Xem trước phải là Hình ảnh tài sản.

revisionCreateTime string

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

revisionId string

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

socialLink object

Một liên kết mạng xã hội cho tài sản.Tối đa ba mỗi tài sản.Tên đối tượng có thể là bất kỳ trong số:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink >
  • twitchSocialLink >
  • discordSocialLink >
  • githubSocialLink >
  • robloxSocialLink >
  • guildedSocialLink >
  • devForumSocialLink >
    • >
Đối với ngữ pháp, xem yêu cầu mẫu dưới Cập nhật tài sản .

state string

Whether tài sản đang hoạt động hay được lưu trữ. Không xác định không được sử dụng.

AssetVersion

Một phiên bản tài sản.

Thuộc Tính

creationContext object

Nội dung ngữ cảnh không thuộc phần nội dung tài sản, chẳng hạn như thông tin metadata và người tạo. Yêu cầu cho Tạo Tài sản .

moderationResult object

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

path string

Con đường tài nguyên trả về của phiên bản tài sản. Định dạng: assets/{assetId}/versions/{version} . Ví dụ: assets/2205400862/versions/1 .

CreationContext

Nội dung ngữ cảnh không thuộc phần nội dung tài sản, chẳng hạn như thông tin metadata và người tạo. Yêu cầu cho Tạo Tài sản .

Thuộc Tính

creator object

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

Bắt Buộc
expectedPrice number

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

Creator

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

Thuộc Tính

groupId number

ID Nhóm. Bắt buộc nếu tài sản là của nhóm.

userId number

ID Người nhà sáng tạocủa người tạo. Bắt buộc nếu tài sản là của cá nhân.

ModerationResult

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

Thuộc Tính

moderationState string

Tình trạng kiểm duyệt của tài sản. Có thể là Reviewing , Rejected , hoặc Approved .

Operation

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

Thuộc Tính

done boolean

Nếu false , hoạt động vẫn đang diễn ra. Nếu true , hoạt động đã hoàn thành.

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 ngẫu nhiên được serialize cùng với một @type mô tả loại tin nhắn serialize.

path string

Con đường tài nguyên được gán bởi máy chủ. Định dạng mặc định là operations/{operation_id} .

response object

Bao gồm một tin nhắn ngẫu nhiên được serialize cùng với một @type mô tả loại tin nhắn serialize.

Preview

Xem trước một tài sản.

Thuộc Tính

altText string

Văn bản thay thế cho tài sản xem trước.

asset string

Con đường tiền xem trước.

Một liên kết mạng xã hội cho tài sản.Tối đa ba mỗi tài sản.Tên đối tượng có thể là bất kỳ trong số:

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink >
  • twitchSocialLink >
  • discordSocialLink >
  • githubSocialLink >
  • robloxSocialLink >
  • guildedSocialLink >
  • devForumSocialLink >
    • >
Đối với ngữ pháp, xem yêu cầu mẫu dưới Cập nhật tài sả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 Trung tâm Nhà sáng tạo.

uri string

URI cho liên kết mạng xã hội.Phải phù hợp với định dạng mong đợi cho loại liên kết.Ví dụ, tiêu đề cho một đối tượng twitchSocialLink phải có định dạng https://twitch.tv/your-channel .

State

Whether tài sản đang hoạt động hay được lưu trữ. Không xác định không được sử dụng.

Thuộc Tính

string (enum): "Unspecified", "Active", "Archived"

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ã trạng mãHTTP.

details array<object>

Một danh sách các tin nhắn chứa chi tiết lỗi.

message string

Thông điệp tin nhắn.