地点发布使用指南

地点发布 API 提供了与 在 Studio 中发布到 Roblox 类似的功能，具有额外的权限控制和持续发布工作流中的自动化。您可以使用此 API 将游戏的现有地点更新为新版本，这对于自动化您的发布工作流非常有用。例如，您可以从 GitHub 操作中调用此 API，并在成功的集成测试后自动将二进制地点文件推送到 Roblox。

限制

• 此 API 仅支持 HTTPS 请求。
• 地点发布 API 不会更新某些实例类型。如果您的游戏包含 EditableImage、EditableMesh、PartOperation、SurfaceAppearance 或 BaseWrap 实例，请在修改后从 Studio 发布。

Roblox 上的地点

Roblox 上的游戏可以有多个地点，其中一个 起始地点 是用户进入游戏的入口点，其他地点是可选的，您可以在这些地点之间 传送用户。您可以使用 API 发布游戏的起始地点或其他地点，并进行版本控制。

在您可以更新游戏的现有地点之前，您需要该地点的 地点 ID 和游戏的 宇宙 ID。地点 ID 用于标识地点，宇宙 ID 用于标识游戏。每个 ID 都是唯一的，即使您的游戏只有一个地点。

发布地点

要使用 地点发布 API 发布游戏的现有地点：

1. 在 创作者仪表板 上 创建 API 密钥。确保您执行以下设置：

   1. 将 universe-places 添加到 访问权限。
   2. 将 写入 操作添加到您选择的游戏。

2. 获取您想要发布地点的游戏的 宇宙 ID。

   1. 导航到 创作者仪表板。

   2. 找到您想要更新地点的游戏。

   3. 将鼠标悬停在游戏的缩略图上，点击 ⋯ 按钮，然后选择 复制宇宙 ID。

      

3. 获取您想要更新的地点的 地点 ID。

   1. 在 创作者仪表板 的 创作 页面上，点击目标游戏的缩略图。
   2. 在左侧导航菜单中，点击 地点 选项卡。
   3. 找到您想要更新的地点并点击其缩略图。
   4. 地点 ID 在重定向的 URL 中。例如，在 URL https://create.roblox.com/dashboard/creations/experiences/0000000/places/111111/configure,中，**地点 ID** 是111111`。

4. 在对 API 的 POST 请求的 x-api-key 头中添加 API 密钥。以下两个示例请求引用了 Roblox XML 地点文件（.rbxlx）和二进制地点文件（.rbxl）。

   XML 地点文件请求

   $ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
   --header 'x-api-key: <your-api-key>' \
   --header 'Content-Type: application/xml' \
   --data-binary @/home/placefiles/place1.rbxlx

   二进制地点文件请求

   $ curl --verbose --location POST 'https://apis.roblox.com/universes/v1/{universeId}/places/{placeId}/versions?versionType=Published' \
   --header 'x-api-key: <your-api-key>' \
   --header 'Content-Type: application/octet-stream' \
   --data-binary @/home/placefiles/place1.rbxl

   要运行这些命令，请将 {universeId} 和 {placeId} 替换为您想要发布的游戏和地点的实际 宇宙 ID 和 地点 ID。

5. 如果您正确发送请求，您将收到一个成功的响应主体，其中包含地点版本号，格式如下：

   示例响应主体

   { "versionNumber": 7 }

6. 可选

   在 Studio 或 创作者仪表板 中验证上传。