*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

Universe

Biểu hiện một trải nghiệm Roblox.

Thuộc Tính

pathstring

Con đường tài nguyên của vũ trụ.

Định dạng: universes/{universe_id}.

createTimestring
Chỉ Xuất

Thời gian chạy khi vũ trụ được tạo ra. Chuỗi này được định dạng là Dấu thời gian.

updateTimestring
Chỉ Xuất

Thời gian chính xác khi vũ trụ được cập nhật lần cuối. Chuỗi này được định dạng là Dấu thời gian.

displayNamestring
Chỉ Xuất

Tên của vũ trụ.

Trường này có thể được cập nhật bằng cách cập nhật tên của nơi gốc.

descriptionstring
Chỉ Xuất

Sự mô tả của vũ trụ.

Trường này có thể được cập nhật bằng cách cập nhật mô tả nơi gốc.

Một trong những thông tin sau đây cho owner:

userstring
Chỉ Xuất

Vũ trụ là của người dùng.

groupstring
Chỉ Xuất

Vũ trụ là sở hữu nhóm.

visibilityEnum<string>
Chỉ Xuất

Liệu vũ trụ có dễ tiếp cận công khai hay không.

Các giá trị có thể:

| Giá trị | Mô tả | | --- | --- | | VISIBILITY_UNSPECIFIED | Các bản cập nhật sử dụng giá trị này sẽ gây ra lỗi trên máy chủ.| | CÔNG CỘNG | Vũ trụ là công cộng.| | RIÊNG TƯ | Vũ trụ là riêng tư.Nếu tầm nhìn của vũ trụ được đặt thành PRIVATE, tất cả các người chơi hoạt động sẽ ngay lập tức bị xóa khỏi tất cả các máy chủ chạy. |. Giá trị có thể:

facebookSocialLinkobject

Liên kết xã hội Facebook.

twitterSocialLinkobject

Liên kết xã hội Twitter.

youtubeSocialLinkobject

Liên kết xã hội Youtube.

twitchSocialLinkobject

Liên kết xã hội Twitch.

discordSocialLinkobject

Liên kết xã hội Discord.

robloxGroupSocialLinkobject

Liên kết xã hội nhóm Roblox.

guildedSocialLinkobject

Liên kết xã hội Guilded.

voiceChatEnabledboolean

Liệu có nói chuyện giọng nói được bật cho người dùng trong Trải nghiệm hay không.

Cập nhật giá trị này sẽ không ảnh hưởng đến các máy chủ hoạt động.

ageRatingEnum<string>
Chỉ Xuất

Xếp hạng tuổi của vũ trụ này.

Các giá trị có thể:

| Giá trị | Mô tả | | --- | --- | | AGE_RATING_UNSPECIFIED | Xếp hạng tuổi không được đặt.| | AGE_RATING_ALL | Hỗ trợ cho tất cả người dùng.| | AGE_RATING_9_PLUS | Hỗ trợ cho người dùng ở độ tuổi 9 và trên.| | AGE_RATING_13_PLUS | Hỗ trợ cho người dùng ở độ tuổi 13 và trên.| | AGE_RATING_17_PLUS | Hỗ trợ cho người dùng ở độ tuổi 17 và trên. |. Giá trị có thể:

privateServerPriceRobuxnumber

Biểu diễn giá trong Robux của các máy chủ riêng.

Nếu chưa được bật, các máy chủ riêng không được hỗ trợ cho vũ trụ này.

Chỉ có thể vô hiệu hóa khi sử dụng mặt nạ trường.

Cài đặt thành null sẽ vô hiệu hóa tất cả các máy chủ riêng chủ động.

Thay đổi giá sẽ hủy tất cả các đăng ký máy chủ riêng.

desktopEnabledboolean

Liệu người chơi có thể tham gia Trải nghiệm qua Màn hình máy tính hay không.

mobileEnabledboolean

Liệu người chơi có thể tham gia Trải nghiệm qua Điện thoại hay không.

tabletEnabledboolean

Liệu người chơi có thể tham gia Trải nghiệm qua Máy tính bảng hay không.

consoleEnabledboolean

Liệu người chơi có thể tham gia Trải nghiệm qua Bảng điều khiển hay không.

vrEnabledboolean

Liệu người chơi có thể tham gia Trải nghiệm qua VR hay không.

URL Cơ Sở

https://apis.roblox.com
Tài nguyên 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

Nhận vũ trụ

GET /cloud/v2/universes/{universe_id}

Nhận được vũ trụ được chỉ định.

Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

Phản HồiUniverse
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}'
Phản Hồi

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

Cập nhật vũ trụ

PATCH /cloud/v2/universes/{universe_id}

Cập nhật vũ trụ được chỉ định.

Phương pháp này được đảm bảo trả lại tất cả các trường được cập nhật. Phương pháp này cũng có thể trả lại toàn bộ tài nguyên.

Phạm Vi
universe:write
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

Tham Số Truy Vấn
updateMaskstring

Danh sách các trường để cập nhật. Chuỗi này được định dạng là Mặt nạ trường.

Yêu Cầu Cơ ThểUniverse
Phản HồiUniverse
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
}'
Phản Hồi

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

Xuất bản Tin nhắn Thiên hà
Bản Beta

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

Xuất một tin nhắn lên các máy chủ trực tiếp của vũ trụ.

Các máy chủ có thể tiêu thụ tin nhắn thông qua Dịch vụ gửi tin nhắn.

Phạm Vi
universe-messaging-service:publish
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

Yêu Cầu Cơ Thể
topicstring

Chủ đề mà để xuất bản tin nhắn.

messagestring

Tin nhắn để xuất bản.

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

Khởi động lại máy chủ vũ trụ

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

Khởi động lại tất cả các máy chủ hoạt động cho một vũ trụ cụ thể nếu và chỉ nếu một phiên bản mới của trải nghiệm đã được xuất bản.Sử dụng để phát hành cập nhật trải nghiệm.

Phạm Vi
universe:write
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

Yêu Cầu Cơ Thể
Phản Hồi
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 '{}'
Phản Hồi

{}