*此内容使用人工智能（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。.

pageTokenstring

从前一次调用收到的页面代币，用于检索后续页面。

当页面分页时，所有其他参数提供给后续调用的必须与提供页面代币的调用匹配。.

orderBystring

如果指定，结果按指定的字段进行排序。

值必须是分开列出的字段列表，带有可选的每个字段“ desc”后缀，以排序从下向上而不是从上向下的值。您可以使用 . 运营符访问子领域。

结果可以按以下字段进行排序：值。

例子：“值描述”.

filterstring

该字段可以设置以便筛选返回的资源。

我们支持这个操作的两个比较运营商: <= 和 >= .这些比较运营商为返回的值起作为最小值和最大值。如果需要对值进行筛选，从最小值到最大值之间，用户可以使用逻辑运算符 &&。过滤器表达式中的所有代币必须用单个空格分开。

例如过滤器： 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"

}