Roblox 内的迷你社区，用于交流、讨论等。

path

获取组

Group

AcceptGroupJoinRequestRequest

代表资产相关操作的配额。

  例如，用户可能每月能上传 100 个音频文件，已上传 15 个。在这个例子中：

  *   `quotaType` is `RATE_LIMIT_UPLOAD`
  *   `assetType` is `AUDIO`
  *   `usage` is `15`
  *   `capacity` is `100`
  *   表示新时段开始时间和使用重置为 0。这个值 **不一定** 与日历月的第一天或特定日期的午夜相关。了解上传过程的更多信息，请参阅[使用指南](https://create.roblox.com/docs/en-us/cloud/open-cloud/usage-assets)。

AssetQuota

资产配额的资源路径。

  格式：`users/{user_id}/asset-quotas/{asset_quota_id}`

配额类型。

  可能的值：

  | 值 | 描述 | | --- | --- | | QUOTA\_TYPE\_UNSPECIFIED | 默认的配额类型。| | RATE\_LIMIT\_UPLOAD | 上传资产的频率限制。| | RATE\_LIMIT\_CREATOR\_STORE\_DISTRIBUTE | 创建者商店上分发资产的频率限制。 |

quotaType

属于配额的资产类型。

  可能的值：

  | 值 | 描述 | | --- | --- | | ASSET\_TYPE\_UNSPECIFIED | 默认资产类型。 图像处理 |
  Chinese: 图像处理 |
  English: 文本地图 |
  Python: 文本地图 |

assetType

usage

capacity

配额的有效期。

  可能的值：

  | 值 | 描述 | | --- | --- | | PERIOD\_UNSPECIFIED | 无效的默认期间。指定另一个值。| | 月 | 月 | | 天 | 天 |

period

usageResetTime

在创作者商店中代表一个产品。该资源用于管理创作者商店的资产分发和价格。

CreatorStoreProduct

创建者商店产品的资源路径。

  格式：`creator-store-products/{creator_store_product_id}`

产品的基础价格。了解更多信息，请参阅[金钱](/cloud/reference/types#money)。每种产品类型（例如 `pluginAssetId`）支持一组特定价格。目前只支持设置基价在美元。

  根据类型，每个创作者商店产品都有一个固定的支持价格集；查看 `productType` 属性获取完整列表。例如，要将插件价格设置为 $4.99，使用以下基础价格：

  ```
  "basePrice": {
    "currencyCode": "USD",
    "quantity": {
      "significand": 4990000000,
      "exponent": -9
    }
  }
  ```

  注意：指数 **必须** 为 -9，和值必须采用此格式。对应的 [十进制](/cloud/reference/types#decimal) 格式是 `significand * 10^exponent` 。

  如果你想将插件价格设置为 $0 (即免费)，使用以下 `base_price`

  ```
  "basePrice": {
    "currencyCode": "USD",
    "quantity": {
      "significand": 0,
      "exponent": 0
    }
  }
  ```

  注意：您仍然必须将 `currencyCode` 设置为美元，即使是免费产品。

  实际购买价格基于此基价，但由于地区特定考虑，经常略有不同。

  将此设置为零以使产品免费。

basePrice

用户的有效购买价格，在考虑到本地因素后。

purchasePrice

卖家是否打算在创作者商店分发创作者商店产品。卖家可能打算分发产品，但由于卖家或基础创作者商店产品的某些限制，产品可能无法购买。见 `restrictions` 和 `purchasable` 获取更多细节。

published

对产品的限制。产品可以在一次启用多个限制。

  可能的值：

  | 值 | 描述 | | --- | --- | | RESTRICTION\_UNSPECIFIED | 未指定限制。| | SOLD\_ITEM\_RESTRICTED | 正在出售的物品已被 Roblox 限制详情可以通过直接查找那个物品来获得。| | SELLER\_TEMPORARILY\_RESTRICTED | 产品受限，因为卖家的帐户暂时被 Roblox 限制。| | SELLER\_PERMANENTLY\_RESTRICTED | 产品受限，因为卖家的帐户永久被 Roblox 限制。| | SELLER\_NO\_LONGER\_ACTIVE | 产品受限，因为卖家的帐户已被删除或其他原因不再活跃。 |

restrictions

产品是否可购买。

  为了使这个值为真，`published`必须为真，而`restrictions`必须为空。如果此值为 false，产品可能无法由任何用户获取。

purchasable

userSeller

groupSeller

创作者商店产品是一个拥有此资产ID的模型。

modelAssetId

创作者商店产品是一个具有此资产 ID 的插件。

  支持的基础价格为 USD：$0、$4.99、$5.99、$6.99、$7.99、$8.99、$9.99、$10.99、$11.99、$12.99、$13.99、$14.99、$15.99、$16.99、$17.99、$18.99、$19.99、$24.99、$29.99、$34.99、$39.99、$44.99、$49.99、$59.99、$69.99、$79.99、$89.99、$99.99、$149.99、$199.99、$249.99

pluginAssetId

创作者商店产品是具有此资产 ID 的音频文件。

audioAssetId

创作者商店产品是带有此资产ID的贴花。

decalAssetId

创作者商店产品是一个拥有此资产ID的网格部分。

meshPartAssetId

创作者商店产品是带有此资产ID的视频。

videoAssetId

创作者商店产品是具有此资产 ID 的字体家族。

fontFamilyAssetId

DataStore

数据存储的资源路径。

  格式：`universes/{universe_id}/data-stores/{data_store_id}`

createTime

数据存储的ID。与路径的最后一部分匹配。

DataStoreEntry

数据存储入口的资源路径。

  格式：

  *   `universes/{universe_id}/data-stores/{data_store_id}/entries/{data_store_entry_id}`
  *   `universes/{universe_id}/data-stores/{data_store_id}/scopes/{data_store_scope_id}/entries/{data_store_entry_id}`

数据存储入口的版本 ID。

  每当数据存储入口以任何方式更改时，都会提交新的修订。

  格式是任意字符串。例如：“foo”

revisionId

revisionCreateTime

数据存储入口的状态。

  可能的值：

  | 值 | 描述 | | --- | --- | | STATE\_UNSPECIFIED | 默认值。如果状态被忽略，将使用此值。| | 激活 | 新创建的数据存储入口的默认状态。| | 删除 | 数据存储入口被标记为已删除。在未来的某个时刻，它将永久删除。|

state

此校验由服务器根据其他字段的值计算，可以在更新和删除请求（可能还会在某些自定义方法上）上发送，以确保客户端在继续前拥有最新的值。

etag

value

入口的资源 ID。

  这与资源路径的最后一部分匹配，仅供便利。

users

attributes

以类似科学记号的形式表示十进制数字。

  例子：

  *   17 === `{significand: 17   exponent: 0} (or just {significand:
      17})`
  *   \-0.005 === `{significand: -5   exponent: -3}`
  *   3350万===`{significand: 335  exponent: 5}`
  *   11/8 (1.375) === `{significand: 1375 exponent: -3}`

  请注意，十进制的范围超过 JSON `number` (双倍) 以及 `decimal64` 的范围。

Decimal

significand

代表小数点在意义上的位置。

  当指数为 0 时，十进制的值简单地是 `significand` 的值。

  当指数大于 0 时，表示重要数字后的零数量。

  当指数小于 0 时，表示多少重要数字 (和隐含的零位，如果需要) 在十进制点之后出现。

exponent

DeclineGroupJoinRequestRequest

DiscardMemoryStoreQueueItemsRequest

以前阅读操作的 `readId` 用于丢弃阅读项目。

readId

代表与 FlushMemoryStore 请求相应的长时间运行操作的元数据。

  这是响应于 操作 FlushMemoryStore 请求的字段类型。

FlushMemoryStoreMetadata

FlushMemoryStoreRequest

返回一个 FlushMemoryStoreResponse 对象。

FlushMemoryStoreResponse

代表与生成用户图像请求相对应的长时运行操作的元数据。

  这是响应于 `Operation.metadata` 生成用户缩略图操作的请求的 `GetOperation` 字段类型。

GenerateUserThumbnailMetadata

返回用户的虚拟形象缩略图的 URL。

GenerateUserThumbnailResponse

imageUri

代表与获取实例请求相应的长时运行操作的元数据。

  这是响应于 `Operation.metadata` 获取实例操作的请求的 `GetOperation` 字段类型。

GetInstanceMetadata

包含一个随机序列化消息以及 @type 描述序列化消息类型的字符串。

GoogleProtobufAny

@type

群组的资源路径。

  格式：`groups/{group_id}`

updateTime

群组的名称。

  必须不为空。最多有 50 个字符的限制。

displayName

群组的描述。

  最大限制为 1000 个字符。

description

所有者的资源路径。

  如果群组被放弃且没有所有者，该字段不会返回。

owner

memberCount

publicEntryAllowed

群组是否被锁定。

  被锁定的群组是被 Roblox 审核/禁止的群组。

locked

verified

加入群组的请求。

  需要`acceptRequests`权限。

GroupJoinRequest

群组加入请求的资源路径。

  格式：`groups/{group_id}/join-requests/{group_join_request_id}`

user

对群组的会员资格。用户ID可以用作会员ID的替代。

GroupMembership

群组成员的资源路径。

  格式：`groups/{group_id}/memberships/{group_membership_id}`

role

可配置的属性，可为群组内的成员授予特定权限。

GroupRole

群组角色的资源路径。

  格式：`groups/{group_id}/roles/{group_role_id}`

群组角色最后更新时的时戳。

  仅对群组的所有者可见。

群组角色最后更新时间戳。

  仅对群组的所有者可见。

一个唯一的ID，用于识别角色。

  与角色的等级不同，仅在群组中独一无二。

角色的名称。

  最多限制为 100 个字符。超过限制的名称被拒绝。

角色的描述。

  最多限制为 1000 个字符。超过限制的字符串被拒绝。仅对群组的所有者可见。

角色的等级。

  最小值为 0。最大值为 255。

rank

角色内的成员总数。

  该字段不返回给访客角色。

为该角色授予的权限。

  这个值由授权用户或 API 钥匙创建者的阅读范围和角色决定填充。如果用户或创建者是父组的所有者，他们可以查看组中的所有角色权限。如果用户或创建者是父组成员，他们可以在群组中查看其角色的权限。任何人都可以查看访客权限。如果有人无法查看权限，此字段不会返回。

permissions

GroupRole_RolePermissions

viewWallPosts

createWallPosts

deleteWallPosts

viewGroupShout

createGroupShout

changeRank

acceptRequests

exileMembers

manageRelationships

viewAuditLog

spendGroupFunds

advertiseGroup

createAvatarItems

manageAvatarItems

manageGroupUniverses

viewUniverseAnalytics

createApiKeys

manageApiKeys

banMembers

viewForums

manageCategories

createPosts

lockPosts

pinPosts

removePosts

createComments

removeComments

一个可以容纳重要群组更新或其他信息的群组上的单个状态帖子。

GroupShout

群组喊话的资源路径。

  格式：`groups/{group_id}/shout`

群组大声喊的最后更新时间戳。

喊话内容。

  最多有 255 个字符的限制。

content

群组喊话的资源路径。

  如果群组被放弃、没有所有者，且从未发出过喊声，该字段不会返回。

poster

增加输入值。

  如果值不是数字，该请求将失败。

IncrementDataStoreEntryRequest

增加入口值的数量。既有值和增量值都必须是整数。

amount

与入口相关的用户。

  如果未提供，现有用户 ID 将被清除。

与入口相关的任意一组属性。

  如果未提供，现有属性将被清除。

IncrementOrderedDataStoreEntryRequest

Instance

实例的资源路径。

  格式：`universes/{universe_id}/places/{place_id}/instances/{instance_id}`

hasChildren

engineInstance

InventoryItem

库存项目的资源路径。

  格式：`users/{user_id}/inventory-items/{inventory_item_id}`

assetDetails

badgeDetails

如果该项目是游戏通行证，则已填充。

gamePassDetails

如果该项目是私有服务器，则会被填充。

privateServerDetails

物品被添加到用户的库存时间。例如，用户购买了私人服务器或获得了徽章的时间。

  该字段目前对通行证尚未填充。

addTime

InventoryItem_AssetDetails

一个唯一的ID，用于识别资产。

assetId

该物品的特定资产类型。

  可能的值：

  中文:
  | 值 | 描述 | | --- | --- | INVENTORY\_ITEM\_ASSET\_UNSPECIFIED | 物品目录 | | HAIR\_ACCESSORY | 头发饰品目录 | | EYELASH\_ACCESSORY | 头发饰品目录 | | EYELASH\_ACCESSORY | 眼镜配件目录 | | EYELASH\_ACCESSORY | 眼镜配件目录 | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |

inventoryItemAssetType

一个唯一的ID，用于识别由用户拥有的资产的实例或“副本”。

instanceId

如果这个资产是一件收藏品，还需要提供额外细节。否则，此属性将被忽略。

collectibleDetails

InventoryItem_BadgeDetails

一个唯一的ID，用于识别徽章。

badgeId

InventoryItem_CollectibleDetails

一个独特的 Roblox 物品的 ID，该物品是一件收藏品。

itemId

一个具有与群组或用户相关的所有权的收藏品的独特ID的副本。

影响是否可以出售或交易的特定收藏品物品实例的状态。

  可能的值：

  | 值 | 描述 | | --- | --- | | COLLECTIBLE\_ITEM\_INSTANCE\_STATE\_UNSPECIFIED | 默认收藏品项实例状态 | | AVAILABLE | 收藏品项可用于所有操作 | | HOLD | 收藏品项处于保留状态（不能出售或交易） |

instanceState

如果资产是有限的，显示该项目的用户可见数量是资产的第 n 个复制品。否则，此属性将被忽略。

Group

属性

Group

获取组Beta

获取组
Beta