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

Instance

データモデルインスタンスを表現します。

属性

pathstring

インスタンスのリソースパス。

形式: universes/{universe_id}/places/{place_id}/instances/{instance_id}.

hasChildrenboolean
出力のみ

インスタンスに子インスタンスがあるかどうか.

engineInstanceobject

インスタンスのプロパティ詳細.

ベース URL
https://apis.roblox.com
Instance リソース
{

  "path": "universes/123/places/123/instances/0123456789abcdef0123456789abcdef",

  "hasChildren": true,

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}

Instance

インスタンスを取得
ベータ版

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}

インスタンスとそのプロパティデータを取得する。

最大サポートされる応答データサイズは 500,000 バイトです。この制限を超えると、返された Operation は、エラーコードが 422 のエラー結果で完了します。

範囲
universe.place.instance:read
リクエストパスのパラメータ
universe_idstring
必須

ユニバースID。.

place_idstring
必須

プレースID。.

instance_idstring
必須

インスタンス ID。.

レスポンス

このメソッドは非同期で、操作の現在の状態を表す Operation を返します。このメソッドにはエンドポイントパスが含まれており、これをポーリングすることで実際の応答と該当するメタデータを取得することができます。長時間実行オペレーションについて詳しくは、ドキュメンテーション を参照してください。

以下のセクションでは、操作が完了したときに提供される応答とメタデータオブジェクトについて説明します。

レスポンスInstanceメタデータ

なし

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}' \

  -H 'x-api-key: {your-api-key}'

Instance

インスタンスを更新する
ベータ版

PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}

インスタンスのプロパティデータを更新する。

Script インスタンスのソースプロパティを更新するとき、最大サポートされるプロパティサイズは、UTF-8 エンコード後の 200,000バイトです

範囲
universe.place.instance:write
リクエストパスのパラメータ
universe_idstring
必須

ユニバースID。.

place_idstring
必須

プレースID。.

instance_idstring
必須

インスタンス ID。.

クエリのパラメータ
updateMaskstring

更新するフィールドのリスト。. この文字列は Timestamp としてフォーマットされています。

リクエスト本文Instance
レスポンス

このメソッドは非同期で、操作の現在の状態を表す Operation を返します。このメソッドにはエンドポイントパスが含まれており、これをポーリングすることで実際の応答と該当するメタデータを取得することができます。長時間実行オペレーションについて詳しくは、ドキュメンテーション を参照してください。

以下のセクションでは、操作が完了したときに提供される応答とメタデータオブジェクトについて説明します。

レスポンスInstanceメタデータ

なし

PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}?updateMask={string}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}'

Instance

インスタンスの子をリストする
ベータ版

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren

インスタンスの子をリストします。

最大サポートされる応答データサイズは 500,000 バイトです。この制限を超えると、返された Operation は、エラーコードが 422 のエラー結果で完了します。

範囲
universe.place.instance:read
リクエストパスのパラメータ
universe_idstring
必須

ユニバースID。.

place_idstring
必須

プレースID。.

instance_idstring
必須

インスタンス ID。.

クエリのパラメータ
maxPageSizenumber

返す子インスタンスの最大数。サービスはこの値より少なく返す可能性があります。指定されない場合、最大 200 個の子が返されます。最大値は 200 で、200 以上の値は 200 に強制変更されます。.

pageTokenstring

以前の ListInstanceChildrenRequest 呼び出しから受信されたページトークン。これを提供して、次のページを取得します。

ページをページ化するとき、ListInstanceChildrenRequest に提供された他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。.

レスポンス

このメソッドは非同期で、操作の現在の状態を表す Operation を返します。このメソッドにはエンドポイントパスが含まれており、これをポーリングすることで実際の応答と該当するメタデータを取得することができます。長時間実行オペレーションについて詳しくは、ドキュメンテーション を参照してください。

以下のセクションでは、操作が完了したときに提供される応答とメタデータオブジェクトについて説明します。

レスポンス

インスタンスの子のリストを返します。

instancesarray<Instance>

子インスタンスのリスト。.

nextPageTokenstring

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはありません。.

メタデータ

なし

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren?maxPageSize=100&pageToken={string}' \

  -H 'x-api-key: {your-api-key}'