资产 API
*此内容使用人工智能(Beta)翻译,可能包含错误。若要查看英文页面,请点按 此处。
您可以发送和接收以下请求和响应 payload 来在 Roblox 上创建资产。有关API的使用信息,请参阅使用指南。
Assets
列出资产版本
列出特定素材的所有版本,包括可选页数。
参数
素材的唯一标识。
指定要包含在响应中的资产版本数量。有效值范围为 1 到 50 (包括在内)。默认值为 8 ,当未提供时。
用于页面分割的代币。值从以前的请求中获得,可用于检索资产版本的下一页。
请求
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}/versions?pageToken=&maxPageSize=' \
--header 'x-api-key: {apiKey}'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
限制
每个 API 密钥:每个 IP 地址每 60 秒有 100 次请求
返回资产版本
将资产滚动到特定的以前版本。
在表单数据中提供资产版本路径。
参数
素材的唯一标识。
请求
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 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
限制
每个 API 密钥:每个 IP 地址每 60 秒有 100 次请求
创建资产
请求
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'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
限制
每个 API 密钥:每个 IP 地址每 60 秒有 60 次请求
获取资产
检索特定资产内容和元数据。
参数
素材的唯一标识。
要取回的资产元数据字段,包括描述、显示名称、标志、社交链接和预览。例如:description%2CdisplayName,previews%2CtwitchSocialLink。
请求
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \
--header 'x-api-key: {apiKey}'
curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \
--header 'x-api-key: {apiKey}'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
限制
每个 API 密钥:每个 IP 地址每 60 秒有 60 次请求
更新资产
参数
素材的唯一标识。
需要更新的资产元数据字段,包括描述、显示名称、标志和预览。例如:description%2CdisplayName , previews%2CtwitchSocialLink .
请求
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}\""'
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}\"'
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.\"}]}"'
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=twitchSocialLink%2CgithubSocialLink' \
--header 'x-api-key: {apiKey}' \
--form 'request="{\"assetId\": \"{assetId}\", \"twitchSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://twitch.tv/your-channel\"}, \"githubSocialLink\": {\"title\": \"Optional title\", \"uri\": \"https://github.com/your-repo\"}}"'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
限制
每个 API 密钥:每个 IP 地址每 60 秒有 60 次请求
获取资产版本
使用资产 ID 和版本号恢复特定资产版本。
参数
素材的唯一标识。
版本号。
请求
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetId}/versions/{versionNumber}' \
--header 'x-api-key: {apiKey}'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
限制
每个 API 密钥:每个 IP 地址每 60 秒有 100 次请求
归档资产
归档资产。归档的资产从网站消失,不再可用或可见于 Roblox 体验中,但您可以 恢复 它们。
参数
素材的唯一标识。
请求
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:archive' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
限制
每个 API 密钥:每个 IP 地址每 60 秒有 100 次请求
恢复资产
恢复已归档的素材。
参数
素材的唯一标识。
请求
curl --location 'https://apis.roblox.com/assets/v1/assets/{assetid}:restore' \
--header 'x-api-key: {apiKey}' \
--header 'Content-Type: application/json'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
限制
每个 API 密钥:每个 IP 地址每 60 秒有 100 次请求
获取操作
使用返回的操作 ID 获取资产创建或更新的结果。需要 阅读 API 钥匙权限和 素材:阅读 OAuth 2.0 应用程序。
参数
操作的唯一标识。
请求
curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \
--header 'x-api-key: {apiKey}'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
限制
每个 API 密钥:每个 IP 地址每 60 秒有 100 次请求
对象
下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点,以了解更多关于这些对象用途的信息。
Any
包含一个随机序列化消息以及一个 @type 描述序列化消信息类型的字符串。
属性
序列化消信息的类型。
Asset
代表一个资素材。
属性
素材的唯一标识。需要用于更新资产。
资产类输入。只能是 Audio , Decal , 或 Model . 需要用于 创建资产 。
不属于资产内容的创建上下文,例如元数据和创建者信息。需要用于创建资产。
素材的描述。限于 1000 个字符。需要用于 创建资产 。
素材的显示名称。需要用于创建资产。
标志的资源路径。
素材的审核结果。
素材的返回资源路径。格式:assets/{assetId}。例如:assets/2205400862。
预览列表,每个预览都包含一个资产路径和替换文本。预览必须是 图像 资产。
当前版本的创建时间戳。
素材的版本 ID。等于 versionNumber .资产的每次更改都会自动提交新版本。格式是一个整数字符串。例子:1。
素材的社交媒体链接。每个素材最多三个。对象名称可以是任何: > > > > > > > > > > > > > > > 对于语法,请参阅更新资产下的样本请求。
资产是否激活或归档。未指定的不会被使用。
AssetVersion
一个资产版本。
属性
不属于资产内容的创建上下文,例如元数据和创建者信息。需要用于创建资产。
素材的审核结果。
资产版本的返回资源路径。格式:assets/{assetId}/versions/{version}。例如:assets/2205400862/versions/1。
CreationContext
不属于资产内容的创建上下文,例如元数据和创建者信息。需要用于创建资产。
属性
代表一个创建创作者。
在 Robux 中预期的资产上传费用。当实际价格超出预期时,操作以 400 错误失败。
Creator
代表一个创建创作者。
属性
组 ID。如果资产属于集团,则必须填写。
用户 ID 是创作者建者。如果资产是个人所有的,则必须使用。
ModerationResult
素材的审核结果。
属性
素材的审核状态。可以是 Reviewing , Rejected , 或 Approved .
Operation
该资源代表一个长时间运行的操作,该操作是网络 API 调用的结果。
属性
如果 false , 操作仍在进行中。如果 true , 操作已完成。
描述错误状态的逻辑错误模型。
包含一个随机序列化消息以及一个 @type 描述序列化消信息类型的字符串。
服务器分配的资源路径。默认格式为 operations/{operation_id} 。
包含一个随机序列化消息以及一个 @type 描述序列化消信息类型的字符串。
Preview
资产预览。
属性
预览资产的替换素材。
预览资产路径。
SocialLink
素材的社交媒体链接。每个素材最多三个。对象名称可以是任何: > > > > > > > > > > > > > > > 对于语法,请参阅更新资产下的样本请求。
属性
社交媒体关联接的可选标题。在创作者中心不使用。
社交媒体关联接的 URI。必须与关联接类型的期望格式匹配。例如,一个 twitchSocialLink 对象的标题必须为格式 https://twitch.tv/your-channel 。
State
资产是否激活或归档。未指定的不会被使用。
属性
Status
描述错误状态的逻辑错误模型。
属性
HTTP 状态代验证码。
一个列表包含错误详情的消息。
错误消信息。