已命令數據儲存 (Beta)

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

此頁面包含與命令數據存取相關的參考文件。對於使用 API 的更多資訊，請參閱 處理 API 請求 for 數據存取 和 使用手冊。

OrderedDataStores

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

列表

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

返回已命商店 商家的資料存取。

參數

universeId string

您想要存取的體驗具體資料的ID值。請參閱「<a href=\"#宇宙資料清單\">Universe ID</a>」。

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
好的
傳回： object
entries array<object>

指定範圍的輸入。

nextPageToken string

一個代幣，可以發送為 page_token 來取回下一頁。如果此字段被省略，就沒有下一頁。

創建

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

建立一個新的輸入，並提供指定的內容值。

參數

universeId string

您想要存取的體驗具體資料的ID值。請參閱「<a href=\"#宇宙資料清單\">Universe ID</a>」。

Path
需要
orderedDataStore string

命令的資料存取商店 商家的名稱。

Path
需要
scope string

數據存取範圍的名稱。請參閱鏡像。

Path
需要
id string

項目的名稱。

需要
CreateEntryRequest

建立一個新值的輸入。

Body
需要

請求

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
好的
傳回： object
id string

項目的名稱

path string

請邀請的資源路徑。

value number

值入值。

獲取

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

取得並返回指定的項目。

參數

universeId string

您想要存取的體驗具體資料的ID值。請參閱「<a href=\"#宇宙資料清單\">Universe ID</a>」。

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
好的
傳回： object
id string

項目的名稱

path string

請邀請的資源路徑。

value number

值入值。

刪除

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

刪除指定的項目。

參數

universeId string

您想要存取的體驗具體資料的ID值。請參閱「<a href=\"#宇宙資料清單\">Universe ID</a>」。

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>'

回應

更新

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

更新一個值，並且返回更新後的值。

參數

universeIdId string

您想要存取的體驗具體資料的ID值。請參閱「<a href=\"#宇宙資料清單\">Universe ID</a>」。

Path
需要
orderedDataStore string

命令的資料存取商店 商家的名稱。

Path
需要
scope string

數據存取範圍的名稱。請參閱鏡像。

Path
需要
entry string

入口 ID。

Path
需要
UpdateEntryRequest

更新提供的值。

Body
需要
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
好的
傳回： object
id string

項目的名稱

path string

請邀請的資源路徑。

value number

值入值。

增量

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

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

已知的問題：入力值可以超過有效範圍，這可能會在後端持續。 返回的值會壓縮到有效範圍。

參數

universeId string

您想要存取的體驗具體資料的ID值。請參閱「<a href=\"#宇宙資料清單\">Universe ID</a>」。

Path
需要
orderedDataStore string

命令的資料存取商店 商家的名稱。

Path
需要
scope string

數據存取範圍的名稱。請參閱鏡像。

Path
需要
entry string

入口 ID。

Path
需要
incrementEntryRequest

增加入值。

Body
需要

請求

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
好的
傳回： object
id string

項目的名稱

path string

請邀請的資源路徑。

value number

值入值。

物件

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

CreateEntryRequest

建立一個新值的輸入。

特性

value number

設置新項目的值。如果輸入值超過 int64 所支持的最大值，即 9,223,372,036,854,775,807, 請求發生 400 個 Bad Request 錯誤。

Entry

代表一個入口。

特性

id string

項目的名稱

path string

請邀請的資源路徑。

value number

值入值。

IncrementEntryRequest

增加入值。

特性

amount number

輸入值增加值。如果輸入值超過 int64 所支持的最大值，即 9,223,372,036,854,775,807, 請求會發生 400 個 Bad Request 錯誤。

ListEntriesResponse

一個父集中的項目收藏單。

特性

entries array<object>

指定範圍的輸入。

nextPageToken string

一個代幣，可以發送為 page_token 來取回下一頁。如果此字段被省略，就沒有下一頁。

UpdateEntryRequest

更新提供的值。

特性

value number

更新值。如果輸入值超過 int64 最大值，即 9,223,372,036,854,775,807, 請求會發生 400 個 Bad Request 錯誤。