オーダードデータストア (ベータ)
*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。
このページには、オーダーされたデータストアとの作業に関する参照ドキュメントが含まれています。API の使用に関する詳細は、データストアのハンドリング API リクエスト と使用ガイド を参照してください。
OrderedDataStores
リスト
注文されたデータストアからのエントリのリストを返します。
パラメータ
アクセスしたいオーダーされたデータストアのエクスペリエンスの識別子。クリエイターダッシュボード で宇宙IDをコピーする方法については、「コピー」を参照してください。
ターゲットの指定したデータストアの名前。
データストアのスコープの名前。 Scopes を参照してください。
返す必要のあるエントリの最大数。サービスはこの値よりも少なく返すかもしれません。デフォルト値は 10 です。最大値は 100 です。100 以上の入力は 100 に強制されます。
以前の List 呼び出しから受信されたページトークン。これを提供すると、次のページを取得できます。当該ページトークンを提供すると、List 以外のすべてのパラメーターが List を提供する必要があります。
列挙方向。デフォルトでは、アルファベット順に昇ります。desc の付属名を入力して、下降するようにします。
戻るエントリの予選値の範囲。フィルタ を参照してください。
リクエスト
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \
--header 'x-api-key: <insert-api-key>'レスポンス
作成
入力したコンテンツの新しいエントリを作成します。
パラメータ
アクセスしたいオーダーされたデータストアのエクスペリエンスの識別子。クリエイターダッシュボード で宇宙IDをコピーする方法については、「コピー」を参照してください。
注文されたデータストアの名前。
データストアのスコープの名前。 Scopes を参照してください。
エントリの名前。
入力した値で新しいエントリを作成します。
リクエスト
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>
}'レスポンス
取得する
指定された入力を取得し、返します。
パラメータ
アクセスしたいオーダーされたデータストアのエクスペリエンスの識別子。クリエイターダッシュボード で宇宙IDをコピーする方法については、「コピー」を参照してください。
注文されたデータストアの名前。
データストアのスコープの名前。 Scopes を参照してください。
エントリID。
リクエスト
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>'レスポンス
削除
指定したエントリを削除します。
パラメータ
アクセスしたいオーダーされたデータストアのエクスペリエンスの識別子。クリエイターダッシュボード で宇宙IDをコピーする方法については、「コピー」を参照してください。
注文されたデータストアの名前。
データストアのスコープの名前。 Scopes を参照してください。
エントリID。
リクエスト
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>'レスポンス
アップデート
入力値を更新し、更新された入力を返します。
パラメータ
アクセスしたいオーダーされたデータストアのエクスペリエンスの識別子。クリエイターダッシュボード で宇宙IDをコピーする方法については、「コピー」を参照してください。
注文されたデータストアの名前。
データストアのスコープの名前。 Scopes を参照してください。
エントリID。
新しい値で提供されたエントリを更新します。
エントリが存在しない場合のエントリの作成を許可するフラグ。入力のフラグを許可する を参照してください。
リクエスト
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>
}'レスポンス
インクリメント
入力した値を基準にキーの値を増加させ、更新されたエントリを返します。
既知の問題: 入力値は有効な範囲を超えて増加する可能性があり、これはバックエンドで持続する可能性があります。返された値は、有効な範囲に減少することがあります。
パラメータ
アクセスしたいオーダーされたデータストアのエクスペリエンスの識別子。クリエイターダッシュボード で宇宙IDをコピーする方法については、「コピー」を参照してください。
注文されたデータストアの名前。
データストアのスコープの名前。 Scopes を参照してください。
エントリID。
入力値を増加させます。
リクエスト
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>
}'レスポンス
オブジェクト
以下のオブジェクトは、受け入れられたか返されたペイロードの説明です。これらのオブジェクトがいつ使用されるかについて詳しくは、各エンドポイントを参照してください。
CreateEntryRequest
入力した値で新しいエントリを作成します。
属性
新しいエントリを設定する値。入力値が int64 によってサポートされている最大値を超えると、リクエストは 400 Bad Request エラーで失敗します。
Entry
エントリを表示します。
属性
エントリの名前
リクエストのリソースパス。
エントリの値。
IncrementEntryRequest
入力値を増加させます。
属性
入力値に対応する数値の増加量。入力値が int64 によってサポートされている最大値を超えると、リクエストが 400 Bad Request エラーで失敗します。
ListEntriesResponse
親コレクションにあるエントリのリスト。
属性
指定されたスコープからのエントリ。
次のページを取得するために page_token として送信できるトークン。このフィールドがオミットされている場合、次のページはありません。
UpdateEntryRequest
新しい値で提供されたエントリを更新します。
属性
入力値がサポートされている最大値を超えると、int64 の 9,223,372,036,854,775,807,リクエストは 400 Bad Request エラーで失敗します。