パラメータ

戻り値

タプル

バーチャル空間

Avatar

アセット

サンプルとプロジェクト

エンジン API

オープンクラウド API

Studio

解析

プラットフォーム

チュートリアル

クリエータープログラム

学習

コース

学ぶ

このメソッドは非同期で、操作の現在の状態を表す `Operation` を返します。このメソッドにはエンドポイントパスが含まれており、これをポーリングすることで実際の応答と該当するメタデータを取得することができます。長時間実行オペレーションについて詳しくは、[ドキュメンテーション]({longRunningOperationsLink})  を参照してください。
            
以下のセクションでは、操作が完了したときに提供される応答とメタデータオブジェクトについて説明します。

ベータエンドポイントが一般向けに使用できるようになりました。破壊的変更は可能ですがまれです。

これらのOpen Cloudドキュメンテーションページは2026年3月31日に削除され、その時点で、新しいOpen Cloudドキュメンテーションに自動的にリダイレクトされます。{linkStart}もっと詳しく{linkEnd}

これらの古いOpen Cloudページは2026年3月31日に削除され、リダイレクトされます。{linkStart}もっと詳しく{linkEnd}

実験的なエンドポイントは公開に向けて準備ができていますが、APIコントラクトが確定するにつれて、時折重大な変更が発生する可能性があります。

このエンドポイントは、APIキーを使って{httpServiceLinkStart}HttpService{httpServiceLinkEnd}を介してバーチャル空間内で呼び出すことができます。

このフィールドはリソースの作成時に設定できますがその後のリクエストでは変更することはできません。

この欄はリソースの作成時に設定できますがその後のリクエストでは変更することはできません。

このフィールドはリクエスト上で提供されることはあるかもしれませんが、応答に入ることはありません。

旧型の認証方式。利用可能な場合は、常にAPIキーまたはOAuth 2.0の使用をお勧めします。

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

呼び出しに認証を必要としません。通常、レート制限が大幅に低下します。利用可能な場合は、常にAPIキーまたはOAuth 2.0の使用をお勧めします。

各グループ化について、スキーマ内の次のフィールドの1つのみを提供する必要があります。残りは除外できます。

いつでも再度オプトインできます。{linkStart}ご意見・ご感想をお寄せください。{linkEnd}

表示されているのは古いドキュメントです。{linkStart}ご意見・ご感想をお寄せください。{linkEnd}

いつでもオプトアウトして元のリファレンスページに戻ることができます。{linkStart}ご意見・ご感想はこちらからお寄せください。{linkEnd}

表示されているのは改訂されたドキュメントです。{linkStart}ご意見・ご感想をお寄せください。{linkEnd}

このフィールドは応答に設定できますが、リクエストでは無視されます。

注意: トラフィックが集中する時間帯には、呼び出し回数制限が低くなる場合があります。一部のエンドポイントには、追加の呼び出し回数制限が適用されます。 [呼び出し回数制限について詳しく]({link})。

ユーザー1人またはグループ1つのすべてのAPI キーで1日あたりリクエスト {limit} 回

ユーザー1人またはグループ1つのすべてのAPI キーで1時間あたりリクエスト {limit} 回

ユーザー1人またはグループ1つのすべてのAPI キーで1分あたりリクエスト {limit} 回

ユーザー1人またはグループ1つのすべてのAPI キーで1秒あたりリクエスト {limit} 回

API キー所有者1人1分あたりリクエスト {limit} 回

アプリユーザー1人1日あたりリクエスト {limit} 回

アプリユーザー1人1時間あたりリクエスト {limit} 回

アプリユーザー1人1分間あたりリクエスト {limit} 回

アプリユーザー1人1秒あたりリクエスト {limit} 回

API キー所有者1人1秒あたりリクエスト {limit} 回

スコープは、認証情報が持つ権限を制御します。認証情報は、選択したスコープでサポートされているエンドポイントにのみアクセスできます。

安定したエンドポイントは本番環境に対応しており、その存続期間中に重大な変更が発生することはほとんどありません。

このターゲットを使用すると、選択した{requiredParts}へのキーのアクセスを制限できます

このターゲットを使用すると、選択した{requiredParts}と{optionalParts}へのキーのアクセスを制限できます

ターゲットタイプは、認証情報が権限を持つリソースを制限するために使用されます。アカウントが追加のリソースに対する権限を持っている場合でも、選択されたリソースのみが実行されます。一部のスコープにはターゲットパーツがありません。この場合、関連するすべてのリソースを実行できます。

ユーザー所有のAPIキーの場合、ユニバーストップレベルパーツを選択する必要はありません。この場合、APIキーは、適切なグループ権限を持つすべてのユーザー所有のバーチャル空間とグループ所有のバーチャル空間にアクセスできます。

APIキーまたはOAuth 2.0認証を必要とするエンドポイントでは、「試してみる」はまだサポートされていません

安全のため、リスクの高い操作ではCookie認証が無効になっています。

重大なリスクのエンドポイントは非常に機密性が高く、安全のため「試してみる」は無効になっています

注：認証ヘッダーはこのコードサンプルには含まれていません。このコマンドを機能させるには、認証ヘッダーの追加が必要となる場合があります。

重要なデータを変更または削除できる高リスクのエンドポイントです。テストの際は細心の注意を払ってください。

このAPIエンドポイントは高リスクに分類されており、公開済みデータまたはユーザーアカウントに影響を与える可能性があります。

高リスクAPIへの認証済みリクエストは、元に戻せない変更を加える可能性があります。続行する前に、リクエストパラメータを注意深く確認してください。

Cookie認証を使用するにはログインしてください

データを取得する低リスクのエンドポイントです。一般的に、テストしても安全です。

データを変更する中程度のリスクのエンドポイントです。変更が永続的なものになる可能性があるため、重要でないアカウントで慎重にテストしてください。

お持ちのアカウントを保護するには、他のソースからのテキストをここに貼り付けたり、このページから他の人に情報を送信したりしないでください。

実際のアカウント認証情報を使用して、公開済みAPIエンドポイントをテストしようとしています。

行おうとしているAPI呼び出しの影響を理解している場合にのみ、続行してください。テストの前にAPIドキュメントを注意深く確認してください。

API呼び出しは、認証されたセッションを使用して行われます

アカウントまたはデータに影響を与える可能性のある実際のAPI呼び出しです

レート制限とその他のAPI制限が適用されます

一部の操作では、データが変更または削除される場合があります

このエンドポイントは、以下の推奨代替エンドポイントに置き換えられました。

このエンドポイントを呼び出すには、次のスコープが必要です。適切なキーの生成に関する詳細は、[APIキーの管理]({apiKeyReferenceDocLink})を参照してください。

キーの生成に関する詳細は、[APIキーの管理]({apiKeyReferenceDocLink})を参照してください。

次のエンドポイントは、ベースのURLに相対するパスで使用できます。

この文字列は [Timestamp](/cloud/reference/types#fieldmask) としてフォーマットされています。

JSON 値は、 `null`、 `boolean`、 `string`、 `number`、 `array`、 `object` にはできません。

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

OAuth 2.0アプリケーションの登録方法の詳細については、[アプリの登録とレビュー]({oauth2ReferenceDocLink})を参照してください。

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

このエンドポイントを呼び出すには、次のスコープが必要です。

リソースパス

この文字列は [Timestamp](/cloud/reference/types#timestamp) としてフォーマットされています。

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

非推奨

オープンクラウド参照の改良バージョンを表示しています。

オープンクラウド参照の新バージョンからオプトアウトしました。

広告請求アカウントを表示します。

広告キャンペーンとその成果を表示します。

広告キャンペーンを作成、更新、管理します。

これであなたのアセットについての情報を表示できるようになります。

これでRobloxにアセットをアップロードしたり、アップデートしたりできます。

これにより、ご利用のアカウントがアクセス可能なすべての項目（グループおよびバーチャル空間を含む）とアセットに関して、アセット権限を表示できるようになります。

これは、すべての対象（グループやバーチャル空間を含む）とアカウントがアクセスできるアセットにアセット権限を付与します。

これにより、あなたに代わって行われるアバター自動設定ジョブの状況と結果を表示できるようになります。

これにより、あなたに代わって行われるアバター自動設定ジョブを作成および管理できるようになります。

ユーザー所有のバッジを更新する能力を付与。

あなたのEコマースアイテムについての情報を表示できるようにします。

これにより、同期済みのEコマースアイテムを変更できるようになります。

あなたのEコマース事業者コネクションについての情報を閲覧できるようにします。

これでEコマース事業者コネクションを編集できるようになります。

これでクリエーターストアの製品に関する情報を表示できます。

これでクリエーターストアの製品に関する情報を変更できます。

これにより、クリエーターストアの保存に関する情報を表示できます。

これにより、クリエーターストアの保存に関する情報を変更できます。

あなたの代わりにデータストアを作成する権限を付与します。

あなたに代わってデータストアを削除する権限を付与します。

データストアの一覧を読み取る権限を付与します。

データストアのスナップショットを撮る権限を付与します。

データストアに入力内容を作成する権限を付与します。

データストアの特定の入力内容に削除用の印をつける権限を付与します。

データストアの入力内容一覧にアクセスする権限を付与します。

データストアの特定の入力内容を読み取る権限を付与します。

入力内容の値、属性、ユーザーを更新する権限を付与します。

データストアの入力内容の修正記録を削除する権限を付与します。

データストアの入力内容一覧の修正記録にアクセスする権限を付与します。

データストアの入力内容の修正記録を読み込む権限を付与します。

許可されたユーザーの開発者製品の環境設定詳細を閲覧するアクセス権を付与。

許可されたユーザーの開発者製品を編集するアクセス権を付与。

あなたのユニバースの環境についての情報を表示できるようにします。

これであなたのユニバースの環境を編集できるようにします。

許可されたユーザーのゲームパスの設定詳細を閲覧するアクセス権を付与。

許可されたユーザーのゲームパスを編集するアクセス権を付与。

アカウントのコミュニティ情報を表示する権限を付与します。

アカウントのコミュニティ情報を管理するためのアクセス権を付与します。

あなたコミュニティについての情報を表示できるようにします。

これでお持ちのアカウントのコミュニティ参加リクエストと低ランクのコミュニティメンバーの役割への更新を管理できるようになります。

インスタンスのプロパティデータを表示できます。

インスタンスのプロパティデータを変更できます（現在はスクリプトのみをサポートしています）。

これであなたの持ち物についての情報を表示できるようになります。

ユーザーアセット管理のアクセス権を付与。

あなたのバッジ管理へのアクセス権を付与。

バッジ管理とRobuxの使用管理機能へのアクセス権を付与。

承認済みユーザーのバッジを更新する権限を付与します。

あなたの開発者製品の管理機能へのアクセス権を付与。

通知をオンにしているバーチャル空間についての情報を読むアクセス権を付与します。

あなたに代わって通知をオンまたはオフにするアクセス権を付与します。

あなたのパス管理へのアクセス権を付与。

あなたのコミュニティ管理へのアクセス権を付与。

コミュニティ情報を読む権限を付与。

コミュニティ管理権限を付与。

多言語化テーブルの読み込みと書き込みへのアクセス権を付与

あなたが所有するすべてのバーチャル空間に関するチーム共同制作管理へのアクセス権を付与。

あなたのバーチャル空間の管理機能と、関連する特定の情報へのアクセス権を付与。（例：多言語化の情報）

バーチャル空間の多言語化情報を読むアクセス権を付与。

バーチャル空間の多言語化設定を変更するためのアクセス権を付与。

あなたのユーザーアカウントへのアクセス権を付与。

ユーザーの多言語化設定を変更するアクセス権を付与。

関連するプレースのLuau実行タスクのステータス、ログ、結果を表示できます。

関連するプレースに対して、新しいLuau実行タスクを作成できます。

ユニバース内のすべてのデータ構造を非同期的にフラッシュするためのアクセス権を付与。

新しいキューアイテムを作成するためのアクセス権を付与。

キューの先頭から読み取りアイテムを破棄するためのアクセス権を付与。

キューの先頭からアイテムを読み取るためのアクセス権を付与。

メモリストアアイテムを読み込むためのアクセス権を付与。

マップアイテムを読み込むためのアクセス権を付与。

マップアイテムの作成、更新、削除へのアクセス権を付与。

これでユーザーに代わってメッセージを公開する権限を与えることができます。

これでバーチャル空間からユーザーに通知を送信できるようになります。

（非推奨）順序付けられたデータストア内のエントリのリストを読み込むためのアクセス権を付与。

（非推奨）順序付けられたデータストアに新しいエントリーを作成するためのアクセス権を付与。

順序付けられたデータストアからのリストエントリーへのアクセス権を付与。

順序付けられたデータストアにエントリーを作成するためのアクセス権を付与。

これであなたのバーチャル空間に関連した秘密をリストアップできるようになります。

これであなたのバーチャル空間に関連した秘密を作成してアップデートできるようになります。

この権限を使用すると、評価ジョブを送信してジョブの結果を表示できます。

あなたの定期購入製品についての内容を読む権限を付与。

これにより、あなたに代わってサムネイル情報を読み取れるようになります。

ゲーム解析を読み取る能力を付与します。

プレース情報を読み取る能力を付与。

プレース情報を編集する能力を付与。

Robloxにバーチャル空間の新しいバージョンを公開する権限を付与します。

バーチャル空間の情報を読む能力を付与。

承認済みユーザーのバーチャル空間を編集する権限を付与します。

バーチャル空間内でのユーザー制限を表示できます。

バーチャル空間内でのユーザー制限が編集できるようになります。

これにより、ご利用のアカウントに送信された通知を表示できるようになります。

承認済みユーザーがプレミアム会員がどうかと認証済みかどうかを読み取る権限を付与します。

これで承認済みユーザーのSNSアカウントを閲覧できるようになります。

シングルサインオン機能を有効化。

これにより、あなたのプロフィール情報を読む権限が与えられます。

この関数は可能であればすぐに返しますが、値を返すまで呼び出したスレッドを返すことができます。

{linkStart}機能{linkEnd}について詳しくはこちらをご覧ください。

Robloxは現在、 {nameStart}名前{nameEnd} への対応と管理をしていません。

このエンドポイントは、Robloxによるサポートおよびメンテナンスの対象外となりました。

Robloxは現在、 この演算への対応と管理をしていません。

このメンバーはオブジェクトブラウザに表示されず、広く使用されることを意図していません。

このメンバーはコマンドバーからしかアクセスできません。スクリプトからこのメンバーにアクセスしようとするとエラーが発生します。

この関数は、それを呼び出したLuaスレッドを一時停止できません。

スクリプト内でこのメンバーにアクセスしようとするとエラーが発生します。Roblox Studio のプロパティ ウィンドウからこのメンバーにアクセスできる可能性があります。

このメンバーはRoblox Studioのオブジェクトブラウザには表示されません。

Instance.new コンストラクタを使用してこのクラスのインスタンスを作成できません。

Robloxは、このメンバーをサーバーとクライアント間の境界を超えて複製しません。

Luaコードはこのメンバーにアクセスできません。Roblox Studioのプロパティウィンドウから値を変更できるかもしれません。

このメンバーは、 OpenCloud Luau 実行タスクからアクセスできます。

このオブジェクトのレプリケーション動作は、所有しているプレイヤーによって異なります。

このメンバーには、コマンドバーとプラグインからしかアクセスできません。スクリプトからこのメンバーにアクセスしようとするとエラーが発生します。

このメンバーは読み取り専用です。このメンバーに書き込みを試みるとエラーが発生します。

このプロパティは読み取り専用で、同期されていないスレッドでも安全に読み取りできます。書き込みを試みるとエラーが発生します。

このエンドポイントに代わる、別のエンドポイントを利用可能です。

このメンバーは CoreScript でしかアクセスできません。

Roblox CoreScripts のみがこのメンバーにアクセスでき、Players は使用できません。

複数のスレッドから安全にこのプロパティの読み取りと書き込みができます。

このクラスはトップレベルのシングルトンです。GetService 関数でこのクラスのインスタンスを回収します。

{link1Start}RunService:BindToSimulation(){link1End}を介してバインドされたコールバック内からアクセス可能です。ロールバックの対象となります。{link2Start}サーバー権限{link2End}を参照してください。

複数のスレッドがこのプロパティに書き込める可能性があるため、同期されていないスレッドから読み取るのは安全ではありません。

この関数は、結果を返すまで呼び出した Lua スレッドを一時停止します。他のスクリプトを中断することはありません。