*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。

OrderedDataStoreEntry

排序數據存儲中的鑰值入口。

特性

pathstring

訂購資料儲存入口的資源路徑。

格式：universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{ordered_data_store_scope_id}/entries/{ordered_data_store_entry_id}.

valuenumber

入口的值。

總是會回合到最接近的整數。.

idstring
僅限輸出

入口的名稱。.

基本網址
https://apis.roblox.com
OrderedDataStoreEntry資源
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

列出排序的資料儲存入口
Beta

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

返回從排序數據儲存中的一個列表入口。

範圍
universe.ordered-data-store.scope.entry:read
請求路徑參數
universe_idstring
需要

宇宙ID。.

ordered_data_store_idstring
需要

訂購的資料儲存ID。.

scope_idstring
需要

範圍 ID。.

查詢參數
maxPageSizenumber

要返回的最大數量已訂購數據儲存入口。服務可能會返回少於此值。如果未指定，最多返回 10 個命名的數據儲存入口。最大值為 100，高於 100 的值設為 100。.

pageTokenstring

從以前的呼叫中收到的頁面代幣，用於取回後續頁面。

當頁面分頁時，所有其他參數提供給後續呼叫的頁面代幣必須與提供頁面代幣的呼叫匹配。.

orderBystring

如果指定，結果依指定的欄位進行排序。

值必須是分開列出的字段列表，並具有可選的每個字段的「 desc」後綴，以排序比值上升而不是下降的值。您可以使用 . 運作符存取子字段。

結果可以依據以下欄位進行排序：值。

範例：「值說明」.

filterstring

此欄位可設為過濾返回的資源。

我們支持這項操作的兩個比較運算符：<= 和 >= 。這些比較運算符作為返回的值的最小值和最大值。如果需要過濾值 minValue 和 maxValue 之間的值，使用者可以使用邏輯運算符 && 。過濾器表達式中的所有代幣必須用單空格分開。

範例過濾器：entry <= 10；entry >= 10 && entry <= 30.

回應

父集合中的一個列表的訂單數據儲存入口點數。

orderedDataStoreEntriesarray<OrderedDataStoreEntry>

指定的訂單資料儲存範圍中的訂單資料儲存入口。.

nextPageTokenstring

您可以將其作為pageToken參數發送到回收下一頁的代幣。如果此欄位被忽略，就沒有後續頁面。.

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries?maxPageSize=10&pageToken={string}&orderBy={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
回應
{

  "orderedDataStoreEntries": [

    {

      "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

      "value": "number",

      "id": "string"

    }

  ],

  "nextPageToken": "string"

}

OrderedDataStoreEntry

創建排序數據儲存入口
Beta

POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

創建具有提供的ID和值的記錄。

如果入口存在，返回 400 個不良請求。

範圍
universe.ordered-data-store.scope.entry:write
請求路徑參數
universe_idstring
需要

宇宙ID。.

ordered_data_store_idstring
需要

訂購的資料儲存ID。.

scope_idstring
需要

範圍 ID。.

查詢參數
idstring

用於訂購的數據儲存入口的ID，將成為訂購的數據儲存入口資源路徑的最後組成部分。

此值應為 1-63 個字元字串。我們強烈建議只使用小寫字母、數字和撇號。.

請求主體OrderedDataStoreEntry
回應OrderedDataStoreEntry
POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries?id=my-entry' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "value": "number"

}'
回應
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

取得訂單資料儲存入口
Beta

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

取得指定的輸入。

範圍
universe.ordered-data-store.scope.entry:read
請求路徑參數
universe_idstring
需要

宇宙ID。.

ordered_data_store_idstring
需要

訂購的資料儲存ID。.

scope_idstring
需要

範圍 ID。.

entry_idstring
需要

入口ID。.

回應OrderedDataStoreEntry
GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}' \

  -H 'x-api-key: {your-api-key}'
回應
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

刪除已排序的資料儲存入口
Beta

DELETE /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

刪除指定的入口。

成功時，返回 200 好。如果入口不存在，返回 404 未找到。

範圍
universe.ordered-data-store.scope.entry:write
請求路徑參數
universe_idstring
需要

宇宙ID。.

ordered_data_store_idstring
需要

訂購的資料儲存ID。.

scope_idstring
需要

範圍 ID。.

entry_idstring
需要

入口ID。.

DELETE /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}' \

  -H 'x-api-key: {your-api-key}'

OrderedDataStoreEntry

更新指定資料儲存入口
Beta

PATCH /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

更新入口值。

範圍
universe.ordered-data-store.scope.entry:write
請求路徑參數
universe_idstring
需要

宇宙ID。.

ordered_data_store_idstring
需要

訂購的資料儲存ID。.

scope_idstring
需要

範圍 ID。.

entry_idstring
需要

入口ID。.

查詢參數
allowMissingboolean

如果設為真實，且找不到指定的數據儲存入口，則會創建一個指定的數據儲存入口。.

請求主體OrderedDataStoreEntry
回應OrderedDataStoreEntry
PATCH /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}?allowMissing={boolean}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "value": "number"

}'
回應
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

增量命令數據儲存入口
Beta

POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment

增加指定入口的值。既有值和增量金額都必須是整數。

如果入口不存在，會創建一個具有指定值的入口。

已知問題：值可能超出有效範圍的值。當發生這種情況時，返回的值將被限制在有效範圍內，但後端可能會保留原始值。這種行為是為了保持與舊版本的相容性，但可能在此 API 的未來版本中發生變更。

範圍
universe.ordered-data-store.scope.entry:write
請求路徑參數
universe_idstring
需要

宇宙ID。.

ordered_data_store_idstring
需要

訂購的資料儲存ID。.

scope_idstring
需要

範圍 ID。.

entry_idstring
需要

入口ID。.

請求主體
amountnumber

增加入口值的數量。既有值和增量數量都必須是整數。.

回應OrderedDataStoreEntry
POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "amount": "number"

}'
回應
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}