內置 Roblox 的迷你社群，用於通訊、討論和其他用途。

path

取得群組

Group

AcceptGroupJoinRequestRequest

代表與資產相關的行動的配額。

  例如，使用者可能每個月可上傳 100 個音頻文件，已上傳 15 個。在這個例子中：

  *   `quotaType` is `RATE_LIMIT_UPLOAD`
  *   `assetType` is `AUDIO`
  *   `usage` is `15`
  *   `capacity` is `100`
  *   `period` 是 `MONTH``usageResetTime` 指示新期間開始和使用重置到 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

配額的資產類型。

  可能的值：

  | 值 | 說明 | | --- | --- | | 資產類型未指定 | 預設資產類型。 檔案存檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔案檔 |

assetType

usage

capacity

配額的時間期限。

  可能的值：

  | 值 | 說明 | | --- | --- | | 期限\_未指定 | 無效的預設期間。指定另一個值。| | 月 | 月 | | 天 | 天 |

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`必須為空。如果此值為假，產品可能無法由任何用戶獲得。

purchasable

userSeller

groupSeller

創作者商店的產品是一個擁有此資產ID的模型。

modelAssetId

創作者商店的產品是一個具有此資產ID的插件。

  支持的基本價格為美元：$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

創作者商店的產品是具有此資產識別碼的音頻文件。

audioAssetId

創作者商店產品是一個裝有此資產ID的貼花。

decalAssetId

創作者商店的產品是具有此資產識別符號的網格零件。

meshPartAssetId

創作者商店的產品是一個包含此資產ID的視頻。

videoAssetId

創作者商店的產品是具有此資產識別符號的字體家族。

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}`
  *   33.5 百萬===`{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 請求相對應的長時間運行操作的元數據。

  這是回應於 `GetOperation` 操作的 `Operation.metadata` 類型。

FlushMemoryStoreMetadata

FlushMemoryStoreRequest

返回一個 FlushMemoryStoreResponse 對象。

FlushMemoryStoreResponse

代表與生成使用者拇指圖像請求相對應的長時間運行操作的元數據。

  這是回應到 `GetOperation` 生成使用者縮略圖操作的 `Operation.metadata` 字段類型。

GenerateUserThumbnailMetadata

返回使用者的頭像縮略圖的 URL。

GenerateUserThumbnailResponse

imageUri

代表與獲取Instance請求相對應的長時間運行操作的元數據。

  這是回應於 `GetOperation` 要求的 GetInstance 操作的 `Operation.metadata` 字段類型。

GetInstanceMetadata

包含一個隨機serialize的訊息，以及@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\_ACCESSORY | 庫存物品 | | AUDIO | 音訊 | | HAIR\_ACCESSORY | 頭髮類 | | --- | 說明 | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |

inventoryItemAssetType

一個獨特的ID，用於識別擁有用戶的資產的實例或「副本」。

instanceId

如果此資產是一件收藏品，額外細節將被忽略。否則，此特性將被省略。

collectibleDetails

InventoryItem_BadgeDetails

badgeId

InventoryItem_CollectibleDetails

一個獨特的 Roblox 項目 ID，該項目是一件收藏品。

itemId

與群組或使用者相關的收藏品複製的獨特ID。

此特定收藏品項目實例的狀態，會影響它是否可以出售或交易。

  可能的值：

  | 值 | 說明 | | --- | --- | | COLLECTIBLE\_ITEM\_INSTANCE\_STATE\_UNSPECIFIED | 預設收藏品項目狀態 | | AVAILABLE | 收藏品項目可用於所有行動 | | HOLD | 收藏品項目已暫停（無法出售或交易） |

instanceState

如果資產是有限的，顯示此項目的用戶可見數字是資產的第 n 個複製。否則，此特性將被忽略。

Group

特性

Group

取得群組Beta

取得群組
Beta