標準數據儲存

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

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

Datastores

https://apis.roblox.com/datastores

根據相對基本網址的路徑，可使用下列終點。

列出資料儲存庫

GET /v1/universes/{universeId}/standard-datastores

返回一個體驗的數據儲存列表。

參數

universeId number

您想使用權通行權存取取的資料儲存體經驗的標示符。您可以在創作者面板上複製體驗的宇宙ID。

Path

需要

cursor string

提供要求下一個數據集。見勾選器。

limit number

要傳回的最大項目數量。每次呼叫只讀一個分區，因此在一個分區上的目標用盡時，可以返回少於指定值。

prefix string

提供只返回這個前缀的數據存儲。

請求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "prefix=Player" \
-d "limit=5"

回應

200 - OK

傳回： object

application/json

{
  "datastores": [
    {
      "name": "PlayerInventory",
      "createdTime": "2022-02-18T22:38:59.9244932Z"
    },
    {
      "name": "PlayerExperience",
      "createdTime": "2022-02-18T23:00:10.4773508Z"
    },
    {
      "name": "PlayerWeapons",
      "createdTime": "2022-02-18T23:00:22.3725681Z"
    },
    {
      "name": "PlayerArmor",
      "createdTime": "2022-02-18T22:59:33.8472882Z"
    },
    {
      "name": "PlayerHP",
      "createdTime": "2022-02-18T22:58:47.6904028Z"
    }
  ],
  "nextPageCursor": "..."
}

data array<object>

目標體驗中的數據儲存陣列。

nextPageCursor string

指示請求的結果設定中有更多可用資料。請參閱指標。

需要權限

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

列出資料庫

Entries

https://apis.roblox.com/datastores

根據相對基本網址的路徑，可使用下列終點。

列出入口

GET /v1/universes/{universeId}/standard-datastores/datastore/entries

返回資料商店商家存內的入口鑰匙列表。

參數

universeId number

您想使用權通行權存取取的資料儲存體經驗的標示符。您可以在創作者面板上複製體驗的宇宙ID。

Path

需要

datastoreName string

數據存商店商家的名稱。

scope string

值為預設值 global 。請參閱範圍。

allScopes boolean

設為真值以從所有範圍返回鑰匙。

prefix string

只提供返回這個前缀的鑰匙。

cursor string

提供要求下一個數據集。見勾選器。

limit number

要傳回的最大項目數量。每次呼叫只讀一個分區，因此在一個分區上的目標用盡時，可以返回少於指定值。

請求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "prefix=" \
-d "limit=5"

回應

200 - OK

傳回： object

application/json

{
  "keys": [
    {
      "key": "269323"
    }
  ],
  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"
}

keys array<string>

目標資料商店商家存中的一組入口鑰匙。

nextPageCursor string

指示請求的結果設定中有更多可用資料。請參閱指標。

需要權限

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

列出條目鍵

取得入口

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

返回與入口相關的值和元數據。

元數據可以在回應頭像以追蹤中找到：


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

| 標題 | 說明 | |---|---| | content-md5 | 內容的 base-64 編碼 MD5 檢查總和。請參閱內容-MD5。| | roblox-entry-version | 返回的入口版本。| | roblox-entry-created-time | 入口被創建的時間。| | roblox-entry-version-created-time | 這個特定版本創建的時間。| | roblox-entry-attributes | 標籤與入口標記的特性。序列化 JSON 地圖對物件。| | roblox-entry-userids | 用逗號分開的 Roblox 使用者ID列表，標有入口。|

參數

universeId number

您想使用權通行權存取取的資料儲存體經驗的標示符。您可以在創作者面板上複製體驗的宇宙ID。

Path

需要

datastoreName string

數據存商店商家的名稱。

entryKey string

用於識別入口的鑰匙。

scope string

值為預設值 global 。請參閱範圍。

請求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

回應

200 - OK

成功取回入口。

傳回： object

204 - No Content

需要權限

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

讀取條目

設定入口

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

設置與入口相關的值、元數據和使用者ID。

參數

universeId number

您想使用權通行權存取取的資料儲存體經驗的標示符。您可以在創作者面板上複製體驗的宇宙ID。

Path

需要

datastoreName string

數據存商店商家的名稱。

entryKey string

用於識別入口的鑰匙。

matchVersion string

只提供更新，如果現有版本與此匹配。

exclusiveCreate boolean

僅創建入口，如果它不存在。

scope string

值為預設值 global 。請參閱範圍。

roblox-entry-attributes string

與新版本的入口相關的特性。由 JSON 地圖對象序列化。如果未提供，現有特性將被清除。

Header

roblox-entry-userids string

以逗號分開的列表 Roblox 使用者ID，標有入口。如果未提供，現有使用者ID將被清除。

Header

content-md5 string

內容的 MD5 檢查總和的 base-64 編碼。請參閱內容-MD5。

Header

請求

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323" \
--header "x-api-key: ${API_KEY}" \
--header "content-md5: IGPBYI1uC6+AJJxC4r5YBA==" \
--header "content-type: application/json" \
--header "roblox-entry-userids: [269323]" \
--header "roblox-entry-attributes: {}" \
--d "value"

回應

200 - OK

傳回： object

version string

資格賽入口的版本名稱。

deleted boolean

指示入口是否已刪除。

contentLength number

內容的長度。

createdTime string

版本在ISO時間格式中創建時的時戳。

objectCreatedTime string

資料儲存在ISO時間格式中創建時的時戳。

需要權限

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

建立條目
更新條目

刪除入口

DELETE /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

通過創建墓碑版本來標記入口為刪除。入口會永久刪除後 30 天。

參數

universeId number

您想使用權通行權存取取的資料儲存體經驗的標示符。您可以在創作者面板上複製體驗的宇宙ID。

Path

需要

datastoreName string

數據存商店商家的名稱。

entryKey string

用於識別入口的鑰匙。

scope string

值為預設值 global 。請參閱範圍。

請求

curl

curl --include --location --request DELETE "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

回應

204 - No Content

需要權限

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

刪除條目

增量輸入

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment

增加給定數量的入口值或創建一個新的入口值，使用該數量創建新的入口。返回入口和元數據。

元數據可以在回應頭像以追蹤中找到：


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

參數

universeId number

您想使用權通行權存取取的資料儲存體經驗的標示符。您可以在創作者面板上複製體驗的宇宙ID。

Path

需要

datastoreName string

數據存商店商家的名稱。

entryKey string

用於識別入口的鑰匙。

incrementBy number

入口應增加的數量，或如果沒有的話，起始值。

scope string

值為預設值 global 。請參閱範圍。

roblox-entry-attributes string

與新版本的入口相關的特性。由 JSON 地圖對象序列化。如果未提供，現有特性將被清除。

Header

roblox-entry-userids string

與入口標籤一起標示的 Roblox 使用者 ID 列表，分開用逗號。如果未提供，現有使用者 ID 將被清除。

Header

請求

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/increment" \
--header "x-api-key: ${API_KEY}" \
--header 'content-length: 0' \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "incrementBy=3"

回應

200 - OK

在增量後返回最新版本的入口。

傳回： object

204 - No Content

需要權限

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

建立條目
更新條目

取得入口版本

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version

返回特定版本的入口的值和元數據。

元數據可以在回應頭像以追蹤中找到：


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

參數

universeId number

您想使用權通行權存取取的資料儲存體經驗的標示符。您可以在創作者面板上複製體驗的宇宙ID。

Path

需要

datastoreName string

數據存商店商家的名稱。

entryKey string

用於識別入口的鑰匙。

versionId string

要檢查的版本。

scope string

值為預設值 global 。請參閱範圍。

請求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions/version" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "versionId=08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01"

回應

200 - OK

成功取回入口。

傳回： object

需要權限

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

讀取版本

限制

每個 API 金鑰：每個 IP 位址每 60 秒 5000 個請求

列出入口版本

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions

返回一個入口的版本列表。

參數

universeId number

您想使用權通行權存取取的資料儲存體經驗的標示符。您可以在創作者面板上複製體驗的宇宙ID。

Path

需要

datastoreName string

數據存商店商家的名稱。

entryKey string

用於識別入口的鑰匙。

scope string

值為預設值 global 。請參閱範圍。

cursor string

提供要求下一個數據集 (見勾選器 )。

startTime string

提供不包含比此時間戳更早的版本。

endTime string

提供不包含比此時間戳晚的版本。

sortOrder string

或者 Ascending (先前版本第一) 或 Descending (後來版本第一)。

limit number

要傳回的最大項目數量。每次呼叫只讀一個分區，因此在一個分區上的目標用盡時，可以返回少於指定值。

請求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "limit=5"

回應

200 - OK

傳回： object

version string

資格賽入口的版本名稱。

deleted boolean

指示入口是否已刪除。

contentLength number

內容的長度。

createdTime string

版本在ISO時間格式中創建時的時戳。

objectCreatedTime string

資料儲存在ISO時間格式中創建時的時戳。

其他狀態碼

需要權限

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

列出版本

物件

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

DataStore

資料儲存對象，包括名稱和創建時間。

特性

name string

數據商店商家存的名稱。

createdTime string

資料儲存在ISO時間格式中創建時的時戳。

EntryVersion

由 List Entry Versions 方法返回的入口版本對象。

特性

version string

資格賽入口的版本名稱。

deleted boolean

指示入口是否已刪除。

contentLength number

內容的長度。

createdTime string

版本在ISO時間格式中創建時的時戳。

objectCreatedTime string

資料儲存在ISO時間格式中創建時的時戳。