排序的資料儲存 ( betBeta 測試 )

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

此頁包含用於處理訂購數據儲存的參考文件。有關使用 API 的更多資訊，請參閱 處理資料儲存的 API 請求 和 使用指南 。

OrderedDataStores

https://apis.roblox.com/ordered-data-stores

列表

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

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

參數

universeId string

您想存取的排序數據儲存體驗的識別符。請參見宇宙ID，在創作者面板上如何複製它。

Path
需要
orderedDataStore string

目標訂購資料商店 商家存的名稱。

Path
需要
scope string

數據儲存範圍的名稱。請參閱範圍。

Path
需要
max_page_size number

要返傳回的最大入口數量。服務可能會返回少於此值。預設值是 10 。最大值是 100 ，任何超過 100 的輸入都被強制轉換為 100 。

page_token string

從以前的 List 呼叫收到的頁面代幣。提供此來恢復下一個頁面。當頁面分頁時，所有其他參數提供給 List 必須與提供頁面代幣的呼叫匹配。

order_by string

枚舉方向。默認排序為上升。輸入 desc 後綴以下降。

filter string

返傳回的輸入資格值範圍。請參閱過濾。

請求

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \

 --header 'x-api-key: <insert-api-key>'

回應

200 - OK
OK
傳回： object
entries array<object>

指定範圍的入口。

nextPageToken string

可以發送為 page_token 來恢復下一頁的代幣。如果此欄位被忽略，就沒有後續頁面。

需要權限

呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。

  • 讀取

創建

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

使用提供的內容值創建新記錄。

參數

universeId string

您想存取的排序數據儲存體驗的識別符。請參見宇宙ID，在創作者面板上如何複製它。

Path
需要
orderedDataStore string

訂購的數據儲存商店 商家名稱。

Path
需要
scope string

數據儲存範圍的名稱。請參閱範圍。

Path
需要
id string

入口的名稱。

需要

請求

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \

--header 'x-api-key: <insert-api-key>' \

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

--data '{ 

    "value": <long> 

}'

回應

200 - OK
OK
傳回： object
id string

入口的名稱

path string

請邀請的資源路徑。

value number

入口的值。

需要權限

呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。

  • 寫入

取得

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

獲取並返回指定的入口。

參數

universeId string

您想存取的排序數據儲存體驗的識別符。請參見宇宙ID，在創作者面板上如何複製它。

Path
需要
orderedDataStore string

訂購的數據儲存商店 商家名稱。

Path
需要
scope string

數據儲存範圍的名稱。請參閱範圍。

Path
需要
entry string

入口ID。

Path
需要

請求

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

回應

200 - OK
OK
傳回： object
id string

入口的名稱

path string

請邀請的資源路徑。

value number

入口的值。

需要權限

呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。

  • 讀取

刪除

DELETE /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

刪除指定的入口。

參數

universeId string

您想存取的排序數據儲存體驗的識別符。請參見宇宙ID，在創作者面板上如何複製它。

Path
需要
orderedDataStore string

訂購的數據儲存商店 商家名稱。

Path
需要
scope string

數據儲存範圍的名稱。請參閱範圍。

Path
需要
entry string

入口ID。

Path
需要

請求

curl
curl --location --request DELETE 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

回應

需要權限

呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。

  • 寫入

更新

PATCH /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

更新一個入口值並返回更新的入口。

參數

universeId string

您想存取的排序數據儲存體驗的識別符。請參見宇宙ID，在創作者面板上如何複製它。

Path
需要
orderedDataStore string

訂購的數據儲存商店 商家名稱。

Path
需要
scope string

數據儲存範圍的名稱。請參閱範圍。

Path
需要
entry string

入口ID。

Path
需要
allow_missing boolean

如果入口沒有存在，允許創建入口的旗幟。請參閱 允許缺少的旗幟。

請求

curl
curl --location --request PATCH 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

--header 'x-api-key: <insert-api-key>' \

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

--data '{ 

    "value": <long> 

}'

回應

200 - OK
OK
傳回： object
id string

入口的名稱

path string

請邀請的資源路徑。

value number

入口的值。

需要權限

呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。

  • 寫入

增量

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment

增加鑰匙的值以提供的數量，並返回更新的入口。

已知問題：輸入值可以超過有效範圍，這可能會在後端持續存在。返回的值將抓住有效範圍。

參數

universeId string

您想存取的排序數據儲存體驗的識別符。請參見宇宙ID，在創作者面板上如何複製它。

Path
需要
orderedDataStore string

訂購的數據儲存商店 商家名稱。

Path
需要
scope string

數據儲存範圍的名稱。請參閱範圍。

Path
需要
entry string

入口ID。

Path
需要

請求

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \

--header 'x-api-key: <insert-api-key>' \

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

--data '{ 

    "amount": <long> 

}'

回應

200 - OK
OK
傳回： object
id string

入口的名稱

path string

請邀請的資源路徑。

value number

入口的值。

需要權限

呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看管理 API 金鑰。

  • 寫入

物件

以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。

CreateEntryRequest

創建一個新的記錄，並使用提供的值。

特性

value number

設置新入口的值。如果輸入值超出 int64 支持的最大值 9,223,372,036,854,775,807，請求將以 400 錯誤發生。

Entry

代表一個入口。

特性

id string

入口的名稱

path string

請邀請的資源路徑。

value number

入口的值。

IncrementEntryRequest

增加入口值。

特性

amount number

由入口值增加的數量。如果輸入值超出 int64 支持的最大值 9,223,372,036,854,775,807，請求將以 400 錯誤發生。

ListEntriesResponse

父收藏合中的入口列表。

特性

entries array<object>

指定範圍的入口。

nextPageToken string

可以發送為 page_token 來恢復下一頁的代幣。如果此欄位被忽略，就沒有後續頁面。

UpdateEntryRequest

以新值更新提供的入口。

特性

value number

用於更新入口的值。如果輸入值超出 int64 支持的最大值 9,223,372,036,854,775,807，請求將以 400 錯誤發生。