アセット API

*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、こちらをクリックしてください。

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キー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

ロールバックアセットバージョン

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キー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

アセットを取得

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キー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

アセットを作成

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

作成ステータスをチェックするためのオペレーション ID を返します。

以下を返す： object

done boolean

error object

metadata object

path string

response object

その他のステータスコード

必要な権限

読み取り
書き込み

asset:read
asset:write

限度

各APIキー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

アセットを更新

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

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

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

レスポンス

200 - OK

更新ステータスをチェックするためのオペレーション ID を返します/更新されたメタデータフィールドを返します。

以下を返す： 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キー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

アセットバージョンを取得

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キー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

オペレーションを取得

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キー：各IPアドレスにつき 60 回のリクエストが 60 秒ごとに送信されます

オブジェクト

以下のオブジェクトは、受け入れられたか返されたペイロードの説明です。これらのオブジェクトがいつ使用されるかについて詳しくは、各エンドポイントを参照してください。

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

SocialLink

属性

title string

uri string

Status

属性

code number

details array<object>

message string