*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.

Universe

Mewakili pengalaman Roblox.

Atribut

pathstring

Jalur sumber daya dari alam semesta.

Format: universes/{universe_id}.

createTimestring

Hanya Output

Stempel waktu ketika alam semesta dibuat. String ini diformat sebagai Timestamp.

updateTimestring

Hanya Output

Stempel waktu ketika alam semesta terakhir diperbarui. String ini diformat sebagai Timestamp.

displayNamestring

Hanya Output

Nama alam semesta.

Bidang ini dapat diperbarui dengan memperbarui nama tempat akar.

descriptionstring

Hanya Output

Deskripsi tentang alam semesta.

Bidang ini dapat diperbarui dengan memperbarui deskripsi tempat akar.

Salah satu dari yang berikut untuk owner:

userstring

Hanya Output

Alam semesta dimiliki oleh pengguna.

groupstring

Hanya Output

Alam semesta dimiliki kelompok.

visibilityEnum<string>

Hanya Output

Apakah alam semesta dapat diakses publik atau tidak.

Nilai yang mungkin:

| Nilai | Deskripsi | | --- | --- | | VISIBILITY_UNSPECIFIED | Pembaruan menggunakan nilai ini akan menyebabkan kesalahan di backend.| | PUBLIC | Alam semesta adalah publik.| | PRIBADI | Semesta adalah pribadi.Jika visibilitas alam semesta diatur ke PRIBADI, semua pemain aktif akan segera dihapus dari semua server yang berjalan. |. Nilai yang mungkin:

facebookSocialLinkobject

Tautkan sosial Facebook.

twitterSocialLinkobject

Tautan sosial Twitter.

youtubeSocialLinkobject

Tautan sosial Youtube.

twitchSocialLinkobject

Tautan sosial Twitter.

discordSocialLinkobject

Tautan sosial Discord.

robloxGroupSocialLinkobject

Tautan sosial grup Roblox.

guildedSocialLinkobject

Tautan sosial Guild.

voiceChatEnabledboolean

Apakah atau tidak obrolan suara diaktifkan untuk pengguna di Pengalaman.

Memperbarui nilai ini tidak akan memengaruhi server aktif.

ageRatingEnum<string>

Hanya Output

Peringkat usia dari alam semesta ini.

Nilai yang mungkin:

| Nilai | Deskripsi | | --- | --- | | AGE_RATING_UNSPECIFIED | Peringkat usia tidak ditetapkan.| | AGE_RATING_ALL | Didukung untuk semua pengguna.| | AGE_RATING_9_PLUS | Didukung untuk pengguna berusia 9 dan lebih.| | AGE_RATING_13_PLUS | Didukung untuk pengguna berusia 13 tahun dan lebih.| | AGE_RATING_17_PLUS | Didukung untuk pengguna berusia 17 tahun dan lebih. |. Nilai yang mungkin:

privateServerPriceRobuxnumber

Mewakili harga dalam Robux server pribadi.

Jika tidak diatur, server pribadi tidak didukung untuk alam semesta ini.

Hanya dapat dinonaktifkan saat menggunakan topeng bidang.

Mengatur ke nol akan menonaktifkan semua server pribadi aktif.

Mengubah harga akan membatalkan semua langganan server pribadi.

desktopEnabledboolean

Apakah pemain dapat bergabung dengan Pengalaman melalui Desktop atau tidak.

mobileEnabledboolean

Apakah pemain dapat bergabung dengan Pengalaman melalui Seluler atau tidak.

tabletEnabledboolean

Apakah pemain dapat bergabung dengan Pengalaman melalui Tablet atau tidak.

consoleEnabledboolean

Apakah pemain bisa bergabung dengan Pengalaman melalui Konsol atau tidak.

vrEnabledboolean

Apakah pemain dapat bergabung dengan Pengalaman melalui VR atau tidak.

Base URL

https://apis.roblox.com

Resource 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

Dapatkan Universe

GET /cloud/v2/universes/{universe_id}

Mendapatkan alam semesta yang ditentukan.

PermintaanParameter Jalur

universe_idstring

Diperlukan

ID alam semesta.

ResponsUniverse

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

Respons

{
  "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

Perbarui Universi

PATCH /cloud/v2/universes/{universe_id}

Memperbarui alam semesta yang ditentukan.

Metode ini dijamin untuk mengembalikan semua bidang yang diperbarui. Metode ini juga dapat mengembalikan sumber daya penuh.

Cakupan

universe:write

PermintaanParameter Jalur

universe_idstring

Diperlukan

ID alam semesta.

Parameter Kueri

updateMaskstring

Daftar bidang untuk diperbarui. String ini diformat sebagai FieldMask.

Request BodyUniverse

ResponsUniverse

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

Respons

{
  "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

Publikasikan Pesan Alam Semesta
Beta

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

Mempublikasikan pesan ke server langsung alam semesta.

Server dapat mengkonsumsi pesan melalui Layanan Pesan.

Cakupan

universe-messaging-service:publish

PermintaanParameter Jalur

universe_idstring

Diperlukan

ID alam semesta.

Request Body

topicstring

Topik di mana untuk mempublikasikan pesan.

messagestring

Pesan untuk dipublikasikan.

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

Mulai Ulang Server Univers

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

Memulai ulang semua server aktif untuk alam semesta tertentu jika dan hanya jika versi baru dari pengalaman telah dipublikasikan.Digunakan untuk merilis pembaruan pengalaman.

Cakupan

universe:write

PermintaanParameter Jalur

universe_idstring

Diperlukan

ID alam semesta.

Request Body

Respons

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

Respons

{}

Universe

Atribut

Universe

Dapatkan Universe

Universe

Perbarui Universi

Universe

Publikasikan Pesan Alam SemestaBeta

Universe

Mulai Ulang Server Univers

Publikasikan Pesan Alam Semesta
Beta