以實時方式管理您在經歷中的配置值，而無需重啟伺服器。請參見[配置指南](https://create.roblox.com/docs/cloud/guides/configs)以獲取Open Cloud的設置和使用。

公共 API 請求中 RPN 條件規則的 JSON 形狀，與 `roblox.creatorexperienceconfig.conditionrules.v1.RpnRule` 對齊。

修訂的條件規則的最小增量（可選擴展列表修訂）。

條件規則的公共 JSON 結構（`rules` + `rulesOrder`），與 CMS 的 `ConditionalRules` 對齊。

以條件 ID 為鍵的 RPN 規則。在 `draft:overwrite` 中，省略已發佈的規則 ID 將移除該規則；JSON `null` 孤島；
`{ "tokens": [] }` 是一條明確的空規則。

包含一個值和可選描述的草稿項目。

A description of the configuration entry.

草稿中分階段的條件規則，如果存在的話。

草稿中的配置項目（鍵對值及可選描述）。

配置庫的完整表示，包括所有項目及其元數據。

條件 RPN 規則和評估順序，如果存在的話。

配置項目（鍵值對和元數據，例如描述、最後修改/訪問時間）。

僅包含值的配置庫表示（無元數據或裝飾）。
此響應可用於直接複製和粘貼到草稿更新端點。

配置值的完整表示，包括其元數據。

非預設分支（例如條件），如有時存在。

配置項目的非預設分支（公共 API 區分變體）。

變體鑑別符（例如條件分支）。

條件

此變體在 CreatorConfigsPublicApi.Models.ConfigVariantDto.Type 中的識別符（例如，CreatorConfigsPublicApi.Models.ConfigVariantType.Conditional 的條件規則 ID）。

區分 CreatorConfigsPublicApi.Models.ConfigVariantDto 變體列表中條目的鑑別符（完整配置及修訂快照）。

條件

進行並發控制的先前草稿哈希。如果提供，則刪除將在不匹配時失敗。

發布配置的部署策略。

無效

漸進式推出

立即

RPN運算元的字面常量（proto `LiteralValue` oneof作為獨立字段的JSON）。

發佈時要使用的部署策略。

無效

漸進式滾動

立即

用於並發控制的草稿哈希。如果提供，則如果無法匹配，發佈將失敗。

公共 API 存储库标识符。仅包含公共 API 暴露的值；
内部存储库类型不会暴露，以便在启用之前进行开发和测试。

体验配置

推荐服务配置

数据存储配置

扩展服务配置

排行榜配置

体验用户配置

旅程配置

表示修訂的變更，顯示之前和之後的值。

變更之後的值。如果鍵被刪除，則為空。

變更之前的值。如果鍵被添加，則為空。

要自動恢復到的版本，或 -1 如果不適用。

此修訂中的變更，按條目鍵入。

當此修訂涉及規則或評估順序時，條件規則的可選增量。

RPN 操作數：屬性引用或字面值（與 proto `RpnOperand` oneof 相同概念）。

RPN 操作數的字面常數（proto `LiteralValue` oneof 作为獨立字段的 JSON）。

一個 RPN 令牌：邏輯/比較的 CreatorConfigsPublicApi.Models.ConditionalRuleOperator（proto JSON `OPERATOR_*`）或一個操作數對象。

草擬更新的請求模型：PATCH 使用部分合併；PUT `draft:overwrite` 將主體視為發佈後的完整預期配置。

可選的條件規則。在 PATCH 時，當此有效載荷非空時，與當前草案規則合併（任何規則 ID 或 `rulesOrder` 條目）。
省略該屬性或發送空對象 `{}` 以保持規則不變（草案規則，或如果草案尚無最新發佈規則）。
在 PUT `draft:overwrite` 中，當此屬性存在時，
CreatorConfigsPublicApi.Models.ConditionalRulesPayload.Rules 是發佈後完整的預期規則集：在最新發佈配置中存在但省略的規則將被刪除。
在覆寫時省略，將清除所有已發佈的條件規則（條目不得引用條件，除非您提供此對象）。

前一草案哈希值，用於並發控制。如果提供，則如果不匹配則更新將失敗。

在 PATCH，未包含的鍵保持不變；將鍵設置為 null 以根據合併規則刪除分支或條目。
在 PUT `draft:overwrite` 中，該映射是最終的授權條目集：最新發佈配置中存在的任何鍵但此處省略的將被刪除，而對於保留的鍵省略的任何條件分支將被刪除。

可配置的密鑰，允許對 Roblox 資源進行細粒度訪問。詳細信息請參見 https://create.roblox.com/docs/cloud/auth/api-keys。

x-api-key

表示 Roblox 用戶身份的瀏覽器 Cookie。請勿分享此物。分享此物會允許他人以您的身份登錄，並竊取您的 Robux 和物品。我們不建議使用 Cookie 來調用端點。在可能的情況下，請改用帶有 x-api-key 標頭的 API 密鑰或 OAuth 2.0 進行身份驗證。

.ROBLOSECURITY

構建或授權應用程序以訪問 Roblox 資源。詳細信息請參見 https://create.roblox.com/docs/cloud/auth/oauth2-overview。

Roblox API。詳情請參見 https://create.roblox.com/docs/cloud/open-cloud。

Roblox API

返回最新的已發布配置值，不帶元數據和修飾符。
此響應可以作為直接的複製粘貼到草案更新端點。

universeId



体验配置

推荐服务配置

数据存储配置

扩展服务配置

排行榜配置

体验用户配置

旅程配置

repository

獲取不帶元數據的已發布配置值。

universe:read

重置當前草稿區域。如果提供了 draftHash，則如果哈希不匹配，該調用將失敗。

universe:write

返回配置存儲庫的當前草稿變更。

按部分變更集更新草稿。
如果提供了 draftHash，則此調用將在哈希不匹配時失敗。
不包括的鍵將不會發生變更。要指示刪除，將鍵設置為 null。
要放棄變更，將鍵設置為當前發布的值。
當 `conditionalRules` 被遺漏或為空（`{}`）時，CMS 更新將省略條件規則欄位，因此在發布時現有的發布規則保持不變；
傳送非空的 `conditionalRules` 對象以合併規則變更。
這裡強制執行條目數量和每個值的大小限制，通過 CreatorConfigsPublicApi.Utils.DraftValidationHelper 實現；進一步的架構驗證由配置管理執行。

完全覆蓋當前草稿。負載是發布後預期的最終狀態（並非與草稿或已發布配置的合併）。
該服務通過對已發布鍵進行明確刪除並省略主體中的條件分支，來使CMS驗證與該意圖對齊。
如果某個鍵未包含，則被解釋為已刪除。
當`conditionalRules`包含時，`conditionalRules.rules`對於規則定義具有權威性：
任何存在於最新已發布配置上的條件規則，但在`rules`中被省略的將被刪除（與發送空RPN規則相同）。
當`conditionalRules`被省略時，所有已發布的條件規則將被刪除；條目不得使用條件分支或`.RBX.conditional.*`鍵，除非您發送`conditionalRules`。
如果提供了draftHash，則如果哈希不匹配則此調用將失敗。
條目計數和每值大小限制在這裡是由CreatorConfigsPublicApi.Utils.DraftValidationHelper強制執行的；進一步的架構驗證由配置管理執行。

返回完整配置，包括元數據（版本、描述、最後修改/訪問時間）。

將當前草稿應用到已發布配置。需要草稿哈希和可選的消息及部署策略。

返回存儲庫的之前修訂列表。支持可選的開始/結束時間和分頁。

startTime

endTime

MaxPageSize

Skip

SearchKey

排序順序（例如，"SORT_ORDER_DESCENDING"，"SORT_ORDER_ASCENDING"）。

SortOrder

排序鍵（例如，"SORT_KEY_LAST_MODIFIED_TIME"）。

SortKey

嘗試將配置恢復到提供的修訂。這將清除階段並階段反轉提交。
您必須調用發布才能使反轉生效。

revisionId

Configs

体验

虚拟形象

素材

范例和项目

引擎 API

Open Cloud API

Studio

分析

平台

教程

创作者计划

教育

课程

学习

此方法是异步的，会返回一个`Operation`对象，该对象表示操作的当前状态。它包含一个端点路径，您可以轮询该路径以获取实际响应和相关的元数据。有关长时间运行操作的更多信息，请参阅[文档]({longRunningOperationsLink})。

以下部分描述了操作完成时提供的响应和元数据对象。

Beta 测试终点已准备好公开使用。可能出现导致功能无法正常运作的更改，但几率极低。

这些 Open Cloud 文档页面将于 2026 年 3 月 31 日移除。届时你将被自动重定向到新的 Open Cloud 文档。{linkStart}了解更多{linkEnd}

这些旧 Open Cloud 页面将于 2026 年 3 月 31 日移除并重定向。{linkStart}了解更多{linkEnd}

实验性终端节点已准备好供公众使用，但随着 API 协定的最终确定，可能偶尔会出现重大变更。

此终端节点可通过使用 API 密钥的 {httpServiceLinkStart}HttpService{httpServiceLinkEnd} 在体验中调用。

此字段可能在创建资源时被设置，但可能无法在后续请求中修改。

这些字段可能在创建资源时被设置，但可能无法在后续请求中修改。

此字段可以在请求中提供，但永远不会包括在答复中。

旧版验证方法。始终首选使用 API 密钥或 OAuth 2.0（如有）。

每个 API 密钥：每个 IP 地址每 {periodInSeconds} 秒有 {maxInPeriod} 次请求

无需身份验证即可调用。通常会显著降低速率限制。始终首选使用 API 密钥或 OAuth 2.0（如有）。

对于每个分组，只需提供架构中的以下字段之一，其余字段可以排除。

你可以随时重新选择加入。{linkStart}提供反馈。{linkEnd}

你正在查看旧版文档。{linkStart}提供反馈。{linkEnd}

你可以随时退出，并重定向回旧的引用页面。{linkStart}在这里提供反馈。{linkEnd}

你正在查看全新改版的文档。{linkStart}提供反馈。{linkEnd}

此字段可能被设置为响应，但在请求中将被忽略。

注意：在高流量期间，速率限制可能会更低。某些终端节点有额外的速率限制。[进一步了解速率限制]({link})。

用户或群组所有 API 密钥每天 {limit} 个请求

用户或群组所有 API 密钥每小时 {limit} 个请求

用户或群组所有 API 密钥每分钟 {limit} 个请求

用户或群组所有 API 密钥每秒 {limit} 个请求

每个 API 密钥所有者每分钟 {limit} 个请求

每个 App 用户每天 {limit} 个请求

每个 App 用户每小时 {limit} 个请求

每个 App 用户每分钟 {limit} 个请求

每个 App 用户每秒 {limit} 个请求

每个 API 密钥所有者每秒 {limit} 个请求

范围可以控制你的凭据拥有哪些权限。你的凭据只能访问你所选范围支持的终端节点。

稳定终端节点已准备好投入生产使用，在其生命周期内几乎不会发生重大变更。

此目标允许你将密钥的访问权限限制为选定的{requiredParts}

此目标允许你将密钥的访问权限限制为选定的{requiredParts}和{optionalParts}

目标类型用于限制你的凭据可操作的资源。即使你的帐户拥有其他资源的权限，也只能处理选定的资源。某些范围没有目标部件，在这种情况下，你的所有相关资源都可进行操作。

对于用户拥有的 API 密钥，无需选择宇宙顶级部件。在这种情况下，你的 API 密钥可以访问你拥有的所有个人体验，以及你在群组中拥有相应权限的群组体验。

尚不支持试用需要 API 密钥或 OAuth 2.0 验证的终端节点

为了安全起见，已停用高风险操作的 Cookie 验证。

关键风险终端节点非常敏感，为了安全起见，已停用“试用”

注意：此代码示例中不包含验证标头。你可能需要添加验证标头，以便此命令能够正常运作。

这是会修改或删除关键数据的高风险终端节点。测试时要格外小心。

此 API 终端节点已被归类为高风险，可能会影响实时数据或用户帐户。

对高风险 API 的已验证请求可能会进行无法撤销的更改。请在继续之前仔细查看你的请求参数。

这是会取回数据的低风险终端节点。通常可以安全测试。

这是会修改数据的中风险终端节点。请使用非关键帐户仔细测试，因为更改可能是永久性的。

为了确保你帐户的安全，请不要在此处粘贴来自其他来源的文本，或将此页面的信息发送给其他人。

你即将使用实际帐户凭据测试实时 API 终端节点。

只有在你了解即将进行的 API 调用的影响后才能继续。在测试之前，请仔细查看 API 文档。

将使用已验证的会话进行 API 调用

这些是可能影响你帐户或数据的真实 API 调用

某些操作可能会修改或删除数据

此终端节点已被以下推荐的替代终端节点取代：

调用此终端节点需要以下范围。如需
有关生成正确密钥的更多信息，请参阅 [管理 API 密钥]({apiKeyReferenceDocLink})。

如需有关生成密钥的更多信息，请参阅 [管理 API 密钥]({apiKeyReferenceDocLink})。

相对于基础 URL 的路径，下列端点是可用的。

此字符串格式为 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可以是 “null”、“boolean”、“string”、“number”、“array” 或 “object”。

你的 OAuth 2.0 应用程序需要以下范围才能使用此终端节点。如需进一步了解如何注册 OAuth 2.0 应用程序，请参阅 [App 注册和审核]({oauth2ReferenceDocLink})。

如需进一步了解如何注册 OAuth 2.0 应用程序，请参阅 [App 注册和审核]({oauth2ReferenceDocLink})。

下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点，以了解更多关于这些对象用途的信息。

调用此终端节点需要以下范围。

资源路径

若要使用此端点，你的 OAuth 2.0 应用程序需要以下范围。关于如何注册 OAuth 2.0 应用程序的更多信息，请查看【应用程序注册及评价】({oauth2ReferenceDocLink})。

不推荐

你正在查看更新后的 Open Cloud 引用。

你已退出新的 Open Cloud 引用。

创建、更新和管理你的广告活动。

这将允许查看关于你素材的信息。

这将允许在 Roblox 上传或更新素材。

允许查看你的帐户有权访问的主体（包括群组和体验）和素材。

这将允许向你帐户有权访问的任何主体（包括群组和体验）和素材授予素材权限。

允许代表你查看虚拟形象自动设置任务的状态和结果。

允许代表你创建和管理虚拟形象自动设置任务。

授予更新用户拥有的徽章的能力。

这将允许查看有关你商业项目的信息。

这将允许更改你的同步商业项目。

这将允许查看有关你商户联结平台的信息。

这将允许编辑你的商户联结平台。

这将允许你查看关于你创作者商店产品的信息。

这将允许你修改关于你创作者商店产品的信息。

这将允许你查看关于你创作者商店保存的信息。

这将允许你修改关于你创作者商店保存的信息。

授予代表你创建数据存储的权限。

授予代表你删除数据存储的权限。

授予读取数据存储列表的权限。

授予拍摄数据存储快照的权限。

授予在数据存储中创建条目的权限。

授予标记要删除的指定条目的权限。

授予列出数据存储条目的权限。

授予读取数据存储中指定条目的权限。

授予更新条目的值、属性和用户的权限。

授予删除数据存储条目修订的权限。

授予列出数据存储条目修订的权限。

授予读取数据存储条目修订的权限。

授予查看授权用户的开发者产品配置详细信息的权限。

授予编辑授权用户的开发者产品的权限。

这将允许查看有关你宇宙环境的信息。

授予查看授权用户的游戏通行证配置详细信息的权限。

授予编辑授权用户的游戏通行证的权限。

授予查看你的帐户社区论坛信息的权限。

授予访问权限，允许管理你的帐户对应的社区论坛信息。

这将允许查看有关你社区的信息。

这将允许你管理社区加入请求，并处理你帐户中低级别社区成员的角色更新。

允许你修改实例的属性数据（目前仅支持脚本）。

这将允许查看你的道具栏信息。

授予权限，以管理你的徽章并使用 Robux。

授予更新授权用户徽章的权限。

授予读取你已开启通知的体验信息的权限。

授予代表你开启或关闭体验通知的权限。

授予读取和写入本地化表格的权限

授予为你拥有的所有体验管理团队协作的权限。

授予管理体验和与体验相关的某些信息（例如本地化信息）的权限。

授予读取体验本地化信息的权限。

授予修改体验本地化偏好设置的权限。

授予修改用户本地化偏好设置的权限。

允许你查看关联场景的 Luau 执行任务的状态、日志和结果。

允许你为关联场景创建新的 Luau 执行任务。

授予异步清空宇宙中所有数据结构的权限。

授予从队列前端丢弃已读项目的权限。

授予读取队列前端项目的权限。

授予读取记忆存储项目的权限。

授予创建、更新和删除地图项目的权限。

授予代替用户发布信息的权力。

这将允许从你的体验向用户发送通知。

（已弃用）授予读取有序数据存储中条目列表的权限。

（已弃用）授予在有序数据存储中创建新条目的权限。

授予从有序数据存储中列出条目的权限。

授予在有序数据存储中创建条目的权限。

这将允许列出与你的作品相关联的密钥。

这将允许创作和更新与你的作品相关联的密钥。

此权限允许你提交评估工作并查看工作结果。

授予读取订阅产品信息的权限。

授予在 Roblox 上发布新版本体验的权限。

授予编辑授权用户体验的权限。

允许你查看体验中的用户限制。

允许你编辑体验中的用户限制。

允许查看发送至你帐户的通知。

授予读取用户 Premium 和验证状态的能力。

这将允许你查看授权用户的社交帐户。

这将授予读取你的个人资料信息的权限。