*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

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
出力のみ

エントリの名前。.

ベース URL
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

列順序のデータストアエントリをリストする
ベータ版

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」付きのオプションのフィールドごとの「 desc」サフィックスで、上から下に並べ替えるのではなく、下から上に並べ替えるためのフィールドのリストでなければなりません。Values must be a comma-separated list of fields, with an optional, per-field "desc" suffix to sort by descending rather than ascending values.. オペレータでサブフィールドにアクセスできます。

結果は次のフィールドで並べ替えることができます：値。

例: "値の説明".

filterstring

このフィールドは、返された資源をフィルタするために設定できます。

この操作のための 2つの比較演算子をサポートしています: <= および >= 。これらの比較演算子は、返された値の最小値と最大値として機能します。値が minValue と maxValue の間にある場合、ユーザーは論理演算子 && を使用できます。フィルター式のすべてのトークンは、1つのスペースで分離されなければなりません。

例のフィルター: entry <= 10 ; entry >= 10 && entry <= 30.

レスポンス

親コレクションの OrderedDataStoreEntries のリスト。

orderedDataStoreEntriesarray<OrderedDataStoreEntry>

指定された OrderedDataStoreScope からの OrderedDataStoreEntries。.

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

順序付けられたデータストアエントリを作成する
ベータ版

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、これは注文されたデータストアエントリの資源パスの最終コンポーネントになります。

この値は A 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

注文されたデータストアエントリを取得
ベータ版

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

順序付けられたデータストアエントリを削除
ベータ版

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

指定したエントリを削除します。

成功すると、200 OK を返します。エントリが存在しない場合は、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

注文されたデータストアエントリを更新
ベータ版

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

増分順番付けデータストアエントリ
ベータ版

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"

}