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

Universe

Roblox の経験を表現します。

属性

pathstring

宇宙のリソースパス。

形式: universes/{universe_id}.

createTimestring

出力のみ

宇宙が作成された時刻。. この文字列は Timestamp としてフォーマットされています。

updateTimestring

出力のみ

宇宙が最後に更新されたタイムスタンプ。. この文字列は Timestamp としてフォーマットされています。

displayNamestring

出力のみ

宇宙の名前。

このフィールドは、ルートの場所の名前を更新することで更新できます。.

descriptionstring

出力のみ

宇宙の説明。

このフィールドは、根の場所の説明を更新することで更新できます。.

以下のうちの一つの owner:

userstring

出力のみ

宇宙はユーザー所有です。.

groupstring

出力のみ

宇宙はグループ所有です。.

visibilityEnum<string>

出力のみ

宇宙が公開アクセス可能かどうか。

可能な値:

| 値 | 説明 | | --- | --- | | VISIBILITY_UNSPECIFIED | この値を使用して更新すると、バックエンドでエラーが発生します。| | 公開 | 宇宙は公開です。| | PRIVATE | 宇宙はプライベートです。宇宙の可視性がプライベトに設定されている場合、すべてのアクティブなプレイヤーがすべての実行中のサーバーからすぐに削除されます。|. 可能な値:

facebookSocialLinkobject

Facebook のソーシャルリンク。.

twitterSocialLinkobject

Twitter のソーシャルリンク。.

youtubeSocialLinkobject

Youtube のソーシャルリンク。.

twitchSocialLinkobject

Twitch のソーシャルリンク。.

discordSocialLinkobject

Discord のソーシャルリンク。.

robloxGroupSocialLinkobject

Roblox グループのソーシャルリンク。.

guildedSocialLinkobject

ギルデッドのソーシャルリンク。.

voiceChatEnabledboolean

エクスペリエンス内のユーザーに対して、ボイスチャットが有効かどうか。

この値を更新すると、アクティブなサーバーには影響しません。.

ageRatingEnum<string>

出力のみ

この宇宙の年齢評価。

可能な値:

| 値 | 説明 | | --- | --- | | AGE_RATING_UNSPECIFIED | 年齢評価は設定されていません。| | AGE_RATING_ALL | すべてのユーザーに対応。| | AGE_RATING_9_PLUS | 9歳以上のユーザーに対応。| | AGE_RATING_13_PLUS | 13歳以上のユーザーに対応。| | AGE_RATING_17_PLUS | 17歳以上のユーザーに対応。 |. 可能な値:

privateServerPriceRobuxnumber

プライベートサーバーの Robux 価格を表示します。

未設定の場合、この宇宙にはプライベートサーバーはサポートされません。

フィールドマスクを使用するときにのみ無効にできます。

ゼロに設定すると、すべての有効なプライベートサーバーが無効になります。

価格を変更すると、すべてのプライベートサーバーのサブスクリプションがキャンセルされます。.

desktopEnabledboolean

プレイヤーがデスクトップでエクスペリエンスに参加できるかどうか。.

mobileEnabledboolean

プレイヤーがモバイルでエクスペリエンスに参加できるかどうか。.

tabletEnabledboolean

プレイヤーがタブレットを介してエクスペリエンスに参加できるかどうか。.

consoleEnabledboolean

プレイヤーがコンソールを介してエクスペリエンスに参加できるかどうか。.

vrEnabledboolean

プレイヤーが VR を介してエクスペリエンスに参加できるかどうか。.

ベース URL

https://apis.roblox.com

Universe リソース

{
  "path": "universes/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "user": "string",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}

Universe

ユニバースを取得

GET /cloud/v2/universes/{universe_id}

指定された宇宙を取得します。

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

レスポンスUniverse

GET /cloud/v2/universes/{universe_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}' \
  -H 'x-api-key: {your-api-key}'

レスポンス

{
  "path": "universes/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "user": "string",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}

Universe

ユニバースを更新

PATCH /cloud/v2/universes/{universe_id}

指定された宇宙を更新します。

このメソッドは、更新されたすべてのフィールドを返すことを保証します。このメソッドはまた、全体のリソースを返すこともあります。

範囲

universe:write

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

クエリのパラメータ

updateMaskstring

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

リクエスト本文Universe

レスポンスUniverse

PATCH /cloud/v2/universes/{universe_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}?updateMask={string}' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}'

レスポンス

{
  "path": "universes/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "user": "string",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}

Universe

ユニバースメッセージを公開する
ベータ版

POST /cloud/v2/universes/{universe_id}:publishMessage

宇宙のライブサーバーにメッセージを公開します。

サーバーはメッセージサービスを介してメッセージを消費できます。

範囲

universe-messaging-service:publish

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

リクエスト本文

topicstring

メッセージを公開するトピック。.

messagestring

公開するメッセージ。.

POST /cloud/v2/universes/{universe_id}:publishMessage

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:publishMessage' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "topic": "my-topic",
  "message": "Hello, world!"
}'

Universe

ユニバースサーバーを再起動する

POST /cloud/v2/universes/{universe_id}:restartServers

新しいバージョンのエクスペリエンスが公開された場合、特定の宇宙のすべてのアクティブなサーバーを再起動します。エクスペリエンスのアップデートをリリースするのに使用します。

範囲

universe:write

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

リクエスト本文

レスポンス

POST /cloud/v2/universes/{universe_id}:restartServers

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:restartServers' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{}'

レスポンス

{}

Universe

属性

Universe

ユニバースを取得

Universe

ユニバースを更新

Universe

ユニバースメッセージを公開するベータ版

Universe

ユニバースサーバーを再起動する

ユニバースメッセージを公開する
ベータ版