Represents a game template in API endpoint responses.

Whether this game template has tutorials.

A model containing information about a group

The Roblox.Platform.Groups.IGroup's name.

A model containing information about a place

A model containing information about a place to be configured

Returns the id of the place's universe, or null - if the place is not part of a universe.

Model for private server details responses from the UniverseSettings controller.

The number of active VIP servers for this universe. A negative value indicates at least this many exist (i.e. -100 means 100+ active private servers).

The number of active VIP server subscriptions. A negative value indicates at least this many exist (i.e. -100 means 100+ active subscriptions).

Whether or not VIP servers are enabled on this universe.

Whether the user can vote on this !:IAsset.

Whether the user has voted on this !:IAsset.

The reason this !:IAsset cannot be voted on.

Whether or not the universe should be enabled for team create

Request model for a TeamCreate membership

A model containing information about a universe permissions

Determines whether or not consumer can cloud the target universe
This is only nullable/optional in the context of https://develop.roblox.com/docs#!/Universes/get_v1_universes_universeId_context_permissions endpoint which is consumed only internally. It should be computed and set for all other usages.

Determines whether or not consumer can manage the target universe

The universe Id these permissions reference

Represents a universe in API endpoint results.

The id of the user or group that created this universe.

The creator type, either "User" or "Group"

Model for UniverseSettings patch requests

Sets the base price of the experience for Fiat purchases.

Determines the change type of the Fiat Product Change request.
Can either Activate the product, Update the price, or Deactivate the product.

Whether game access is limited to friends for user-owned games or group members for group-owned games.

Sets whether access to APIs for mesh and texture is enabled for this universe.

Set is rewarded on-demand ads are allowed for this universe.

List of device types this game can be played on.

 ['Computer' = 1, 'Phone' = 2, 'Tablet' = 3, 'Console' = 4, 'VR' = 5]

Whether custom animations are allowed in the universe.

Which avatar types are allowed in the universe.

What avatar body types are allowed by the universe.

What type of collisions are used by the universe.

What avatar joint positioning type is allowed by the universe.

Whether custom scales allowed in the universe.

Model for UniverseSettings controller responses

If the universe allows the use of private servers.

The current moderation status of the game if it is for sale in fiat. ['Invalid' = 0, 'NotModerated' = 1, 'Pending' = 2, 'Approved' = 3, 'Rejected' = 4]

Game genre. ['All' = 0, 'Tutorial' = 1, 'Scary' = 2, 'TownAndCity' = 3, 'War' = 4, 'Funny' = 5, 'Fantasy' = 6, 'Adventure' = 7, 'SciFi' = 8, 'Pirate' = 9, 'FPS' = 10, 'RPG' = 11, 'Sports' = 12, 'Ninja' = 13, 'WildWest' = 14]

Whether the game is offered for sale in fiat.

Whether access to APIs for mesh and texture is enabled for this universe.

Whether rewarded on-demand ads are allowed for this universe.

Whether studio access to APIs is allowed or not.

The price to purchase a private server in robux.

Whether custom animations are allowed in the universe. ['Standard' = 1, 'PlayerChoice' = 2]

Which avatar types are allowed in the universe. ['MorphToR6' = 1, 'PlayerChoice' = 2, 'MorphToR15' = 3]

What avatar body types are allowed by the universe. ['Standard' = 1, 'PlayerChoice' = 2]

What type of collisions are used by the universe. ['InnerBox' = 1, 'OuterBox' = 2]

What avatar joint positioning is allowed by the universe. ['Standard' = 1, 'ArtistIntent' = 2]

Whether custom scales allowed in the universe. ['NoScales' = 1, 'AllScales' = 2]

Whether or not the universe is enabled for team create

Whether or not comments should be enabled.

Whether or not the plugin allows comments to be posted.

Develop Api v1

The ids of the Roblox.Platform.Assets.IAsset.

assetIds

Gets the voting information of the given assets

Templates subject to change without notice.
Sort order of templates specified by Roblox.

Gets a page of templates that can be used to start off making games.

groupId

isArchived

limit

The paging cursor for the previous or next page.

cursor

sortOrder

Gets a list of universes for the given group.

Currently the only supported functionality for updating the configuration is around Name, and Description.

The place id for the place to be updated.

placeId

configuration

0: Authorization has been denied for this request.

Authenticated user is not authorized to manage this place.
0: Token Validation Failed

Updates the place configuration for the place with the id placeId

1: The universe is invalid.
5: The place is invalid.

2: Not authorized to perform this action.
4: TeamCreate on universe is disabled.

6: Multiple active sessions in a Team Create place.

List of users in the active Team Create session

pluginIds

1: Too many ids.
2: The format of the ids are invalid.

pluginId

The Roblox.Develop.Api.UpdatePluginRequest.

request

5: Description too long.
6: Text moderated.
7: Invalid name.
8: The request body is missing.

0: Token Validation Failed
4: Insufficient permissions.

If a universe can not be found for a given ID (such as -1) it will be skipped.

8: No universe IDs sent to get.
9: Too many universe IDs sent to get, the limit is: 

Gets a System.Collections.Generic.List`1.

Returns an array of granted and declined permissions related to the universes with the ids in ids for the authenticated user.

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.TooManyUniverseIdsSent

Gets TeamCreate settings for multiple universes specified by Ids

universeId

Gets a Roblox.Api.Develop.Models.UniverseModel.

1: The universe does not exist.
2: This universe does not have a root place.

0: Token Validation Failed
3: You are not authorized to configure this universe.
6: The root place for this universe is under review and can not be activated.
7: Creator already has the maximum number of places active.

2: You are not authorized to configure this universe.

The Roblox.Api.Develop.Models.UniverseSettingsRequest model.

model

1: The universe does not exist.
3: Invalid UniverseAvatarType.
4: Invalid UniverseScaleType.
5: Invalid UniverseAnimationType.
6: Invalid UniverseCollisionType.
7: New universe name or description has been rejected.
8: New universe name is too long.
10: Invalid UniverseBodyType.
11: Invalid UniverseJointPositioningType.
12: The universe has no root place.
15: Price is required when isForSale is true.
16: This game cannot be offered for sale because it is not public.
17: This game cannot be offered for sale because it has private servers enabled.
18: The game price is outside of the allowed range.
19: Invalid genre.
20: The request body is missing.
21: Invalid device type.
22: Invalid asset type.
23: Invalid value, the min must be less than or equal to the max
24: Invalid scale value

0: Token Validation Failed
2: You are not authorized to configure this universe.
14: You are not authorized to sell games.

9: Failed to shutdown all intances of game after changing AvatarType. The change has been reverted.

Update universe settings for an owned universe.

Get settings for an owned universe's VIP servers.

0: Token Validation Failed
3: You are not authorized to configure this universe.

Returns list of granted and declined permissions related to the universe with the id universeId for authenticated user

isUniverseCreation

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.InvalidUniverse

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.Unauthorized

Gets TeamCreate settings for an Roblox.Platform.Universes.IUniverse.

Enables, or disables team create for a universe.

The request body containing the team create settings.

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.Unauthorized
0: Token Validation Failed

Edit team create settings for a universe.

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.InvalidUniverse OR Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.InvalidUser

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.TeamCreateDisabled
0: Token Validation Failed

Removes a user from a TeamCreate permissions list.

Gets a list of Groups that a user can manage.

Gets a list of groups a user can manage games or items for.

Gets a list of universes for the authenticated user.

ภาพรวม

คำแนะนำ

คู่มือการใช้งาน

การอ้างอิง

แหล่งข้อมูล

งานศิลป์

การออกแบบ

Engine

อวาตาร์

คลาวด์

วิธีนี้ไม่ได้ทำพร้อมกันและส่งคืน `Operation` ซึ่งแสดงสถานะปัจจุบันของการดำเนินการและมีเส้นทาง Endpoint ที่คุณใช้สำรวจความคิดเห็นได้ เพื่อเช็คการตอบสนองจริงและข้อมูลเมตาที่เกี่ยวข้อง หากต้องการข้อมูลเพิ่มเติม โปรดดู[เอกสาร]({longRunningOperationsLink})เกี่ยวกับการดำเนินการที่ใช้เวลานาน
            
ส่วนต่อไปนี้จะอธิบายการตอบสนองและวัตถุข้อมูลเมตาที่จะได้รับเมื่อดำเนินการเสร็จสิ้น

Endpoint เวอร์ชัน Beta พร้อมสำหรับการใช้งานทั่วไปแล้ว อาจมีการเปลี่ยนแปลงที่ทำให้ใช้งานไม่ได้ แต่ก็เป็นไปได้ยาก

สามารถตั้งค่าฟิลด์นี้ได้เมื่อสร้างทรัพยากร แต่ไม่สามารถแก้ไขได้ด้วยคำขอภายหลัง

อาจมีช่องข้อมูลนี้ในคำขอ แต่จะไม่รวมอยู่ในการตอบกลับโดยเด็ดขาด

ต่อคีย์ API: {maxInPeriod} คำขอทุกๆ {periodInSeconds} วินาทีต่อที่อยู่ IP

อาจใช้ช่องข้อมูลนี้การตอบกลับ แต่จะเว้นไว้ในคำขอ

ต้องมีสิทธิ์เข้าถึงคีย์ API ต่อไปนี้เพื่อเรียกใช้ Endpoint นี้ ดูข้อมูล
เพิ่มเติมเกี่ยวกับการสร้างคีย์ที่เหมาะสมได้ที่[จัดการคีย์ API]({apiKeyReferenceDocLink})

Endpoints ต่อไปนี้พร้อมใช้งานที่เส้นทางที่สัมพันธ์กับ URL หลัก

สตริงนี้มีรูปแบบ [FieldMask](/cloud/reference/types#fieldmask)

ค่า JSON จะเป็น `null`, `boolean`, `string`, `number`, `array` หรือ `object` ก็ได้

แอปพลิเคชัน OAuth 2.0 ของคุณต้องมีขอบเขตต่อไปนี้เพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่[การลงทะเบียนและการตรวจสอบแอป]({oauth2ReferenceDocLink})

วัตถุต่อไปนี้ใช้บรรยายเพย์โหลดที่ยอมรับหรือส่งคืน ดูข้อมูลเพิ่มเติมว่าจะใช้วัตถุเหล่านี้ตอนไหนที่ Endpoint แต่ละจุด

เนื้อหาคำขอเป็น

สตริงนี้มีรูปแบบ[ประทับเวลา](/cloud/reference/types#timestamp)

ต้องมีขอบเขตต่อไปนี้สำหรับแอปพลิเคชัน OAuth 2.0 ของคุณเพื่อใช้ Endpoint นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีลงทะเบียนแอปพลิเคชัน OAuth 2.0 ได้ที่[การลงทะเบียนและการตรวจสอบแอป]({oauth2ReferenceDocLink})

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

This allows viewing information about your inventory.

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you follow.

Grants access to follow and unfollow experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.

ค่าเริ่มต้น: {defaultValueStart}{defaultValueEnd}

อาร์เรย์คือรายการค่าที่เรียงตามลำดับ โดยมีไว้จัดเก็บคอลเล็กชันข้อมูล

ชุดคู่คีย์-ค่า โดยคีย์อาจเป็นตัวเลข สตริง หรืออ็อบเจกต์ใดก็ได้

เช่น {tuples} ซึ่งเป็นรายการค่า

คืนค่าเป็นศูนย์

ฟังก์ชันนี้จะส่งคืนค่าทันทีหากเป็นไปได้ แต่อาจหยุดการทำงานของเธรดที่เรียกใช้จนกว่าจะส่งคืนค่าได้

Roblox ไม่รองรับหรือดูแลรักษา{nameStart}ชื่อ{nameEnd}อีกต่อไป

Roblox ไม่รองรับหรือปรับปรุงการคำนวณนี้อีกต่อไป

สมาชิกรายการนี้ไม่ปรากฏในเบราว์เซอร์วัตถุและไม่ได้มีไว้สำหรับการใช้งานอย่างแพร่หลาย

สามารถเข้าถึงสมาชิกรายการนี้ได้ทางแถบคำสั่งเท่านั้น หากพยายามเข้าถึงจากสคริปต์ จะเกิดข้อผิดพลาด

ฟังก์ชันนี้ไม่สามารถหยุดเธรดภาษา Lua ที่เรียกใช้ไว้ชั่วคราว

หากพยายามเข้าถึงสมาชิกรายการนี้ในสคริปต์ จะเกิดข้อผิดพลาด คุณอาจเข้าถึงสมาชิกรายการนี้ได้จากหน้าต่างคุณสมบัติของ Roblox Studio

สมาชิกรายการนี้ไม่ปรากฏในเบราว์เซอร์วัตถุของ Roblox Studio

คุณไม่สามารถสร้างอินสแตนซ์ของ Class นี้ด้วยคอนสตรัคเตอร์ Instance.new

Roblox ไม่ได้จำลองสมาชิกรายการนี้ข้ามระหว่างเซิร์ฟเวอร์กับไคลเอนต์

โค้ดภาษา Lua เข้าถึงสมาชิกรายการนี้ไม่ได้ คุณอาจเปลี่ยนค่าได้จากหน้าต่างคุณสมบัติใน Roblox Studio

เข้าถึงสมาชิกรายการนี้ได้จากการดำเนินการของ Luau ใน OpenCloud

พฤติกรรมการจำลองวัตถุนี้ขึ้นอยู่กับผู้เล่นที่เป็นเจ้าของ

สามารถเข้าถึงสมาชิกรายการนี้ได้ทางแถบคำสั่งและปลั๊กอิน หากพยายามเข้าถึงจากสคริปต์ จะเกิดข้อผิดพลาด

สมาชิกรายการนี้เป็นแบบอ่านอย่างเดียว หากพยายามเขียน จะเกิดข้อผิดพลาด

คุณสมบัตินี้อ่านได้อย่างเดียวและอ่านได้อย่างปลอดภัยในเธรดที่ไม่ซิงค์ การพยายามเขียนคุณสมบัตินี้อาจทำให้เกิดข้อผิดพลาด

สามารถเข้าถึงสมาชิกรายการนี้ได้ใน CoreScripts เท่านั้น

มีเพียง Roblox CoreScripts เท่านั้นที่สามารถเข้าถึงสมาชิกรายการนี้ได้ ซึ่ง Player จะไม่สามารถใช้ได้

อ่านและเขียนคุณสมบัตินี้ได้อย่างปลอดภัยจากหลายเธรด

Class นี้เป็นซิงเกิลตันระดับบนสุด ดึงอินสแตนซ์ Class นี้ด้วยฟังก์ชัน GetService

อาจมีหลายเธรดที่เขียนไปยังคุณสมบัตินี้ได้ จึงไม่ปลอดภัยที่จะอ่านจากเธรดที่ไม่ได้ซิงค์

ฟังก์ชันนี้จะหยุดเธรดภาษา Lua ที่เรียกใช้ชั่วคราวจนกว่าจะได้ผลลัพธ์ โดยการดำเนินการนี้จะไม่ขัดจังหวะสคริปต์อื่น

Develop v1