アセット API

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

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キー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 読み取り

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下のスコープが必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 アプリ登録とレビュー をごらんください。

  • asset:read

限度

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

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

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キー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 読み取り

  • 書き込み

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下のスコープが必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 アプリ登録とレビュー をごらんください。

  • asset:read

  • asset:write

限度

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

アセットを取得

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キー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 読み取り

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下のスコープが必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 アプリ登録とレビュー をごらんください。

  • asset:read

限度

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

アセットを作成

POST /v1/assets

指定されたコンテンツとメタデータを含むアセットを作成します。

アセットを作成するときは ソーシャルリンク オブジェクトを追加することはできません。代わりに アセットを更新 を使用してください。

パラメータ

request

アセットの属性を作成または更アップデートします。以下の例のように、フォームデータのように送信します。

FormData
必須
fileContent string

バイナリアセットファイルのパスとコンテンツタイプ。 形式: fileContent=@"/filepath/{File}";type={ContentType} タイプ: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
作成ステータスをチェックするためのオペレーション ID を返します。
以下を返す： object
done boolean

If false 、オペレーションはまだ進行中です。If true 、オペレーションは完了します。

error object

エラーステータスを説明する論理エラーモデル。

metadata object

型のシリアルメッセージの種類を記述する @type を含む任意の連続化されたメッセージを含みます。

path string

サーバーに割り当てられたリソースパス。デフォルトフォーマットは operations/{operation_id} です。

response object

型のシリアルメッセージの種類を記述する @type を含む任意の連続化されたメッセージを含みます。

必要な権限

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 読み取り

  • 書き込み

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下のスコープが必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 アプリ登録とレビュー をごらんください。

  • asset:read

  • asset:write

限度

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

アセットを更新

PATCH /v1/assets/{assetId}

提供されたコンテンツとメタデータを更新し、説詳細、表示名、アイコン、ソーシャルリンク、プレビューなどを含みます。現在、モデルのみを更新できます。アイコン、プレビューは2>画像2>アセットでなければなりません。5>正方形のディメンション5>が必要です。

パラメータ

request

次の例のリクエストのようなフォームデータを送信します。

FormData
必須
fileContent string

バイナリアセットファイルのパスとコンテンツタイプ。 形式: fileContent=@"/filepath/{File}";type={ContentType} タイプ: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
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

レスポンス

200 - OK
更新ステータスをチェックするためのオペレーション ID を返します/更新されたメタデータフィールドを返します。
以下を返す： object
application/json
{\"previews\": [\n    {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n    {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}
done boolean

If false 、オペレーションはまだ進行中です。If true 、オペレーションは完了します。

error object

エラーステータスを説明する論理エラーモデル。

metadata object

型のシリアルメッセージの種類を記述する @type を含む任意の連続化されたメッセージを含みます。

path string

サーバーに割り当てられたリソースパス。デフォルトフォーマットは operations/{operation_id} です。

response object

型のシリアルメッセージの種類を記述する @type を含む任意の連続化されたメッセージを含みます。

必要な権限

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 読み取り

  • 書き込み

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下のスコープが必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 アプリ登録とレビュー をごらんください。

  • asset:read

  • asset:write

限度

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

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

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

アセット ID とバージョン番号で特定のアセットバージョンを取得します。

パラメータ

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キー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 読み取り

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下のスコープが必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 アプリ登録とレビュー をごらんください。

  • asset:read

限度

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

オペレーションを取得

GET /v1/operations/{operationId}

返されたオペレーション ID を使用してアセットの作成または更新の結果を取得します。API キーの許可については <a href="https://api.microchip.com/api/ documentation.md/read/">Read</a> が必要です。オープン アセット レイド のアプリについては <a href="https://api.microchip.com/api/documentation.md/read/">読む\ が必要です。

リクエスト

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

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

レスポンス

200 - OK
以下を返す： object
done boolean

If false 、オペレーションはまだ進行中です。If true 、オペレーションは完了します。

error object

エラーステータスを説明する論理エラーモデル。

metadata object

型のシリアルメッセージの種類を記述する @type を含む任意の連続化されたメッセージを含みます。

path string

サーバーに割り当てられたリソースパス。デフォルトフォーマットは operations/{operation_id} です。

response object

型のシリアルメッセージの種類を記述する @type を含む任意の連続化されたメッセージを含みます。

必要な権限

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 読み取り

あなたのOAuth 2.0 アプリケーションでこのエンドポイントを使用するには以下のスコープが必要です。OAuth 2.0 アプリケーションの登録方法についての情報は、 アプリ登録とレビュー をごらんください。

  • asset:read

限度

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

オブジェクト

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

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>

アセットパスとオルターテキストがある各プレビューのリスト。プレビューは 画像 アセットでなければなりません。

revisionCreateTime string

現在のレビューのタイムスタンプ。

revisionId string

アセットのリバーションID。 の versionNumber に相当します。 すべてのアセットの変更は自動的に新しいバージョンにコミットされます。 形式は整数の文字列です。例: 1 。

socialLink object

アセットに対するソーシャルメディアリンク。最大3つのアセットにつき最大3つ。オブジェク

CreationContext

アセットコンテンツの一部でない、メタデータやクリエーター情報などのクリエーションコンテキスト。アセットを作成する に必要。

属性

creator object

クリエイターを表示します。

必須
expectedPrice number

Robux のアセットアップロード料金を期待しています。実際の価格が期待した価格を上回ると、オペレーションが 400 エラーで失敗します。

Creator

クリエイターを表示します。

属性

groupId number

グループ ID。アセットがグループ所有の場合は必須です。

userId number

アセットが個クリエーターユーザー所有の場合は、ユーザーID が必要です。

ModerationResult

アセットのモデレーション結果。

属性

moderationState string

アセットのモデレーション状態。MODERATION_STATE_REVIEWING、MODERATION_STATE_REJECTED、またはMODERATION_STATE_APPROVED 。

Operation

このリソースは、ネットワーク API 呼び出しの結果である長く実行されるオペレーションを表します。

属性

done boolean

If false 、オペレーションはまだ進行中です。If true 、オペレーションは完了します。

error object

エラーステータスを説明する論理エラーモデル。

metadata object

型のシリアルメッセージの種類を記述する @type を含む任意の連続化されたメッセージを含みます。

path string

サーバーに割り当てられたリソースパス。デフォルトフォーマットは operations/{operation_id} です。

response object

型のシリアルメッセージの種類を記述する @type を含む任意の連続化されたメッセージを含みます。

Preview

アセットプレビュー。

属性

altText string

プレビューアアセットのアルトテキスト。

asset string

プレビューアアセットパス。

アセットに対するソーシャルメディアリンク。最大3つのアセットにつき最大3つ。オブジェク

属性

title string

ソーシャルメディアリンクのオプションタイトル。クリエイターハブでは使用されていません。

uri string

ソーシャルメディアリンクの URL。期待される形式に対応する必要があります。たとえば、twitchSocialLink オブジェクトのタイトルは、https://twitch.tv/your-channel 形式でなければなりません。

Status

エラーステータスを説明する論理エラーモデル。

属性

code number

HTTP ステータスコード。

details array<object>

エラーの詳細を含むメッセージのリスト。

message string

エラーメッセージ。