順序付けられたデータストア (ベータ)

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

このページには、注文されたデータストアでの作業に関する参照文書が含まれています。API の使用に関する詳細は、データストアの API リクエストを処理する使用ガイド を参照してください。

OrderedDataStores

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

リスト

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

注文されたデータストアからのエントリのリストを返します。

パラメータ

universeId string

アクセスしたいオーダー済みデータストアのエクスペリエンスの識別子。見る ユニバースID クリエイターダッシュボード上でのコピー方法については、Creator Dashboard

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
OK
以下を返す: object
entries array<object>

指定されたスコープからのエントリ。

nextPageToken string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはありません。

必要な権限

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 読み取り

作成

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

提供されたコンテンツ値で新しいエントリを作成します。

パラメータ

universeId string

アクセスしたいオーダー済みデータストアのエクスペリエンスの識別子。見る ユニバースID クリエイターダッシュボード上でのコピー方法については、Creator Dashboard

Path
必須
orderedDataStore string

注文されたデータストアの名前。

Path
必須
scope string

データストアスコープの名前。見る スコープ

Path
必須
id string

エントリの名前。

必須

リクエスト

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
OK
以下を返す: object
id string

エントリの名前

path string

リクエストのリソースパス。

value number

エントリの値。

必要な権限

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 書き込み

取得する

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

指定されたエントリを取得して返す。

パラメータ

universeId string

アクセスしたいオーダー済みデータストアのエクスペリエンスの識別子。見る ユニバースID クリエイターダッシュボード上でのコピー方法については、Creator Dashboard

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
OK
以下を返す: object
id string

エントリの名前

path string

リクエストのリソースパス。

value number

エントリの値。

必要な権限

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 読み取り

削除

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

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

パラメータ

universeId string

アクセスしたいオーダー済みデータストアのエクスペリエンスの識別子。見る ユニバースID クリエイターダッシュボード上でのコピー方法については、Creator Dashboard

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

レスポンス

必要な権限

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 書き込み

更新

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

エントリ値を更新し、更新されたエントリを返します。

パラメータ

universeId string

アクセスしたいオーダー済みデータストアのエクスペリエンスの識別子。見る ユニバースID クリエイターダッシュボード上でのコピー方法については、Creator Dashboard

Path
必須
orderedDataStore string

注文されたデータストアの名前。

Path
必須
scope string

データストアスコープの名前。見る スコープ

Path
必須
entry string

エントリID。

Path
必須
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
OK
以下を返す: object
id string

エントリの名前

path string

リクエストのリソースパス。

value number

エントリの値。

必要な権限

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 書き込み

増加

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

提供された量でキーの値を増加し、更新されたエントリを返します。

既知の問題: エントリ値は有効な範囲を超えて増加でき、バックエンドに残る可能性があります。返された値は、有効な範囲に収まります。

パラメータ

universeId string

アクセスしたいオーダー済みデータストアのエクスペリエンスの識別子。見る ユニバースID クリエイターダッシュボード上でのコピー方法については、Creator Dashboard

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>:increment' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": <long>
}'

レスポンス

200 - OK
OK
以下を返す: object
id string

エントリの名前

path string

リクエストのリソースパス。

value number

エントリの値。

必要な権限

このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。

  • 書き込み

オブジェクト

以下のオブジェクトは、受け入れられたか返されたペイロードの説明です。これらのオブジェクトがいつ使用されるかについて詳しくは、各エンドポイントを参照してください。

CreateEntryRequest

提供された値で新規エントリを作成します。

属性

value number

新しいエントリを設定する値。入力値が int64 でサポートされる最大値 9,223,372,036,854,775,807 を超える場合、400 悪いリクエストエラーでリクエストが失敗します。

Entry

エントリを表します。

属性

id string

エントリの名前

path string

リクエストのリソースパス。

value number

エントリの値。

IncrementEntryRequest

入力値を増加させます。

属性

amount number

エントリ値で増加する量。入力値が int64 でサポートされる最大値 9,223,372,036,854,775,807 を超える場合、400 悪いリクエストエラーでリクエストが失敗します。

ListEntriesResponse

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

属性

entries array<object>

指定されたスコープからのエントリ。

nextPageToken string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはありません。

UpdateEntryRequest

新しい値で提供されたエントリを更新します。

属性

value number

エントリを更新する値。入力値が int64 でサポートされる最大値 9,223,372,036,854,775,807 を超える場合、400 悪いリクエストエラーでリクエストが失敗します。