場所公開 API は、Studio で Roblox への公開と同様の機能を提供し、追加の権限制御と連続リリースワークフローの自動化を提供します。この API を使用して、エクスペリエンスの既存の場所を新しいバージョンにアップデートし、パブリッシングワークフローを自動化するのに便利になります。たとえば、GitHub アクションからこの API を呼び出し、成功した統合テスト後にバイナリの場所ファイルを自動的に Roblox に押すことができます。
制限
- この API は HTTPS リクエストのみをサポートします。
- 場所公開 API は、特定のインスタンスタイプを更新しません。エクスペリエンスに EditableImage、EditableMesh、PartOperation、SurfaceAppearance、または BaseWrap インスタンスが含まれている場合は、修正後、Studioから公開します。
Roblox の場所
Roblox の経験は、1つの 開始場所 をユーザーの経験の入り口として、そして経験のテレポート可能な他の場所をオプションとして持つことができます。API を使用して、バージョン管理で始まる場所またはエクスペリエンスの他の場所を公開できます。
エクスペリエンスの既存の場所を更新する前に、場所の プレースID とエクスペリエンスの ユニバースID が必要です。 場所ID は場所を識別し、 宇宙ID はエクスペリエンスを識別します。経験が 1 場所しかなくても、それぞれがユニークです。
場プレースを公開する
エクスペリエンスの既存の場所を公開するには、場所公開 APIで:
クリエイターダッシュボード上で APIキーを作成 。以下の設定を行ってください:
- ユニバースプレース を アクセス権限 に追加します。
- 選択したエクスペリエンスに 書き込み 操作を追加します。
ユニバースID を取得して、場プレースを公開したい経験の宇宙を取得します。
ナビゲート to the クリエイターダッシュボード.
更アップデートしたい場所でエクスペリエンスを見つけます。
エクスペリエンスのサムネイルにカーソルを置き、 ⋯ ボタンをクリックし、 ユニバースIDをコピー を選択します。
更アップデートしたい場所の 場所ID を取得します。
- クリエイターダッシュボードの クリエーションページ に残り、ターゲットのエクスペリエンスのサムネイルをクリックします。
- 左側のナビゲーションメニューで、 場所 タブをクリックします。
- 更新したい場所を見つけて、サムネイルをクリックします。
- プレースID は、リダイレクトされた URLにあります。たとえば、URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure では、 プレースID は111111。
API キーを x-api-key ヘッダーの POST リクエストにAPIに追加します。次の 2つの例のリクエストは、Roblox XML 場所ファイル ( .rbxlx ) とバイナリ場所ファイル ( .rbxl ) を参照しています。
XML プレースファイルリクエスト$ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \--header 'x-api-key: <your-api-key>' \--header 'Content-Type: application/xml' \--data-binary @/home/placefiles/place1.rbxlxバイナリプレースファイルリクエスト$ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \--header 'x-api-key: <your-api-key>' \--header 'Content-Type: application/octet-stream' \--data-binary @/home/placefiles/place1.rbxlコマンドを実行するには、{universeId} と {placeId} を実際の ユニバースID と プレースID の経験と交換し、公開したい場所に配置します。
要求を正しく送信すると、次の形式で場所バージョン番号を含む成功応答体を受け取ります:
応答体の例{ "versionNumber": 7 }(オプション) Studio または クリエイターダッシュボード でアップロードを確認します。