アセット 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}'

レスポンス

200 - OK
リストに成功してリソースバージョンが列挙されました。
以下を返す： array<object>

必要な権限

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

  • 読み取り

限度

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

戻りアセットバージョン

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

アセットを特定の前のバージョンにロールバックします。

フォームデータにアセットバージョンパスを提供します。

パラメータ

assetId string

アセットのユニークな識別子。

Path
必須

リクエスト

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

レスポンス

200 - OK
アセットが成功して戻されました。
以下を返す： object
creationContext object

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

moderationResult object

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

path string

アセットバージョンの返されたリソースパス。フォーマット: assets/{assetId}/versions/{version} . 例: assets/2205400862/versions/1 .

必要な権限

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

  • 読み取り

  • 書き込み

限度

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

アセットを作成

POST /v1/assets

提供されたコンテンツとメタデータでアセットを作成します。

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

フォームデータに アセット、バイナリアセットファイルパス、および コンテンツタイプ を提供します。

リクエスト

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

任意の serialize メッセージと、 serialized メッセージの種類を説明する @type を含みます。

path string

サーバーが割り当てたリソースパス。デフォルトの形式は operations/{operation_id} です。

response object

任意の serialize メッセージと、 serialized メッセージの種類を説明する @type を含みます。

必要な権限

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

  • 読み取り

  • 書き込み

限度

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

アセットを取得

GET /v1/assets/{assetId}

特定のアセットコンテンツとメタデータを取得する。

パラメータ

assetId string

アセットのユニークな識別子。

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

レスポンス

200 - OK
アセットリソースが正常に取得されました。
以下を返す： object
assetId number

アセットのユニークな識別子。アセットを更新する に必要。

assetType string

アセットタイプ。Audio、Decal、またはModelのみが可能です。アセットを作成するに必要です。

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 個。オブジェクト名は以下のいずれかになります：

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
シンタックスについては、「アセットの更新」のサンプルリクエストを参照してください： Update Asset 。

state string

アセットが有効かアーカイブか。未指定は使用されません。

必要な権限

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

  • 読み取り

限度

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

アセットを更新

PATCH /v1/assets/{assetId}

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

フォームデータに アセット、バイナリアセットファイルパス、および コンテンツタイプ を提供します。

パラメータ

assetId string

アセットのユニークな識別子。

Path
必須
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": [

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

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

]}
done boolean

If false 、操作はまだ進行中です。If true 、操作は完了します。

error object

エラー状況態を説明する論理エラーモデル。

metadata object

任意の serialize メッセージと、 serialized メッセージの種類を説明する @type を含みます。

path string

サーバーが割り当てたリソースパス。デフォルトの形式は operations/{operation_id} です。

response object

任意の serialize メッセージと、 serialized メッセージの種類を説明する @type を含みます。

必要な権限

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

  • 読み取り

  • 書き込み

限度

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

レスポンス

200 - OK
アセットバージョンが正常に取得されました。
以下を返す： object
creationContext object

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

moderationResult object

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

path string

アセットバージョンの返されたリソースパス。フォーマット: assets/{assetId}/versions/{version} . 例: assets/2205400862/versions/1 .

必要な権限

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

  • 読み取り

限度

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

アーカイブアセット

POST /v1/assets/{assetId}:archive

アセットをアーカイブします。アーカイブされたアセットは、ウェブサイトから消え、Roblox の経験では再利用できなくなり、表示できなくなりますが、復元することができます。

パラメータ

assetId string

アセットのユニークな識別子。

Path
必須

リクエスト

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

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

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

レスポンス

200 - OK
アセットが成功裏に保存されました。
以下を返す： object
assetId number

アセットのユニークな識別子。アセットを更新する に必要。

assetType string

アセットタイプ。Audio、Decal、またはModelのみが可能です。アセットを作成するに必要です。

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 個。オブジェクト名は以下のいずれかになります：

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
シンタックスについては、「アセットの更新」のサンプルリクエストを参照してください： Update Asset 。

state string

アセットが有効かアーカイブか。未指定は使用されません。

必要な権限

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

  • 読み取り

  • 書き込み

限度

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

アセットを復元する

POST /v1/assets/{assetId}:restore

アーカイブされたアセットを復元します。

パラメータ

assetId string

アセットのユニークな識別子。

Path
必須

リクエスト

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

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

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

レスポンス

200 - OK
アセットが正常に復元されました。
以下を返す： object
assetId number

アセットのユニークな識別子。アセットを更新する に必要。

assetType string

アセットタイプ。Audio、Decal、またはModelのみが可能です。アセットを作成するに必要です。

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 個。オブジェクト名は以下のいずれかになります：

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
シンタックスについては、「アセットの更新」のサンプルリクエストを参照してください： Update Asset 。

state string

アセットが有効かアーカイブか。未指定は使用されません。

必要な権限

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

  • 読み取り

  • 書き込み

限度

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

操作を取得

GET /v1/operations/{operationId}

返されたオペレーション IDを使用して、アセットの作成または更新の結果を取得します。API キー権限のために 読み取る と アセット:読む が OAuth 2.0 アプリに必要です。

パラメータ

operationId string

操作のユニークな識別子。

Path
必須

リクエスト

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

任意の serialize メッセージと、 serialized メッセージの種類を説明する @type を含みます。

path string

サーバーが割り当てたリソースパス。デフォルトの形式は operations/{operation_id} です。

response object

任意の serialize メッセージと、 serialized メッセージの種類を説明する @type を含みます。

必要な権限

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

  • 読み取り

限度

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

オブジェクト

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

Any

任意の serialize メッセージと、 serialized メッセージの種類を説明する @type を含みます。

属性

@type string

シリアルメッセージの種類。

Asset

アセットを表現します。

属性

assetId number

アセットのユニークな識別子。アセットを更新する に必要。

assetType string

アセットタイプ。Audio、Decal、またはModelのみが可能です。アセットを作成するに必要です。

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 個。オブジェクト名は以下のいずれかになります：

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
シンタックスについては、「アセットの更新」のサンプルリクエストを参照してください： Update Asset 。

state string

アセットが有効かアーカイブか。未指定は使用されません。

AssetVersion

アセットバージョン。

属性

creationContext object

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

moderationResult object

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

path string

アセットバージョンの返されたリソースパス。フォーマット: assets/{assetId}/versions/{version} . 例: assets/2205400862/versions/1 .

CreationContext

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

属性

creator object

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

必須
expectedPrice number

Robux での期待されるアセットアップロード料金。実際の価格が予想よりも高い場合、400エラーで操作が失敗します。

Creator

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

属性

groupId number

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

userId number

クリエイターのユーザーID。アセットが個人ユーザーが所有している場合は必須です。

ModerationResult

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

属性

moderationState string

アセットのモデレーション状態。Reviewing、Rejected、またはApprovedであることができます。

Operation

このリソースは、ネットワーク API 呼び出しの結果である長時間実行中の操作を表します。

属性

done boolean

If false 、操作はまだ進行中です。If true 、操作は完了します。

error object

エラー状況態を説明する論理エラーモデル。

metadata object

任意の serialize メッセージと、 serialized メッセージの種類を説明する @type を含みます。

path string

サーバーが割り当てたリソースパス。デフォルトの形式は operations/{operation_id} です。

response object

任意の serialize メッセージと、 serialized メッセージの種類を説明する @type を含みます。

Preview

アセットプレビュー。

属性

altText string

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

asset string

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

アセットのためのソーシャルメディアリンク。アセットごとに最大 3 個。オブジェクト名は以下のいずれかになります：

  • facebookSocialLink
  • twitterSocialLink
  • youtubeSocialLink
  • twitchSocialLink
  • discordSocialLink
  • githubSocialLink
  • robloxSocialLink
  • guildedSocialLink
  • devForumSocialLink
シンタックスについては、「アセットの更新」のサンプルリクエストを参照してください： Update Asset 。

属性

title string

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

uri string

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

State

アセットが有効かアーカイブか。未指定は使用されません。

属性

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

Status

エラー状況態を説明する論理エラーモデル。

属性

code number

HTTP ステータスコード。

details array<object>

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

message string

エラーメッセージ。