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

DataStore

データストアを表現します。

属性

pathstring

データストアのリソースパス。

形式: universes/{universe_id}/data-stores/{data_store_id}.

createTimestring
出力のみ

データストアが作成された時刻。. この文字列は Timestamp としてフォーマットされています。

idstring
出力のみ

データストアの ID。パスの最後のセグメントと一致します。.

ベース URL
https://apis.roblox.com
DataStore リソース
{

  "path": "universes/123/data-stores/some-data-store",

  "createTime": "2023-07-05T12:34:56Z",

  "id": "string"

}

DataStore

データストアのリスト
ベータ版

GET /cloud/v2/universes/{universe_id}/data-stores

データストアのリストを返す

範囲
universe-datastores.control:list
リクエストパスのパラメータ
universe_idstring
必須

ユニバースID。.

クエリのパラメータ
maxPageSizenumber

返すデータストアの最大数。サービスはこの値より少なく返す可能性があります。指定されない場合、最大 10のデータストアが返されます。最大値は 100 で、より高い値は 100 に設定されます。.

pageTokenstring

前の呼び出しから受信したページトークンで、後のページを取得します。

ページをページングするとき、次の呼び出しに提供された他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。.

filterstring

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

filter フィールドは、CEL の非常に小さなサブセットをサポートします：

  • のみ id フィールドがサポートされます。
  • のみ startsWith 機能が利用可能であり、他のオペレーターやビルドインはサポートされていません。

例のフィルタ: id.startsWith("foo").

レスポンス

親コレクションのデータストアのリスト。

dataStoresarray<DataStore>

指定された宇宙からのデータストア。.

nextPageTokenstring

次のページを取得するための pageToken パラメータとして送信できるトークン。このフィールドが省略されると、後続のページはありません。.

GET /cloud/v2/universes/{universe_id}/data-stores
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores?maxPageSize=10&pageToken={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
レスポンス
{

  "dataStores": [

    {

      "path": "universes/123/data-stores/some-data-store",

      "createTime": "2023-07-05T12:34:56Z",

      "id": "string"

    }

  ],

  "nextPageToken": "string"

}

DataStore

スナップショットデータストア
ベータ版

POST /cloud/v2/universes/{universe_id}/data-stores:snapshot

エクスペリエンスのデータストアの新しいスナップショットを取得します。

スナップショットの後、エクスペリエンス内のすべてのキーに次の書き込みが行われると、最後の書き込みの時点に関係なく、以前のデータのバージョン付きバックアップが作成されます。

スナップショット時のすべてのデータは、少なくとも 30 日間バージョン付きバックアップとして利用できることが保証されています。

スナップショットは、UTC 日ごとに 1回、経験ごとに取得できます。最新のスナップショットが同じ UTC 日に取得された場合、この操作はノーオペレーションであり、最新のスナップショットの時間が返されます。

スナップショットの使用に関する詳細は、データストアエンジンガイドを参照してください。

範囲
universe-datastores.control:snapshot
リクエストパスのパラメータ
universe_idstring
必須

ユニバースID。.

リクエスト本文
レスポンス

新しいスナップショットが取得されたかどうか、および操作後の最新スナップショットの時間 (新しいスナップショットが取得されたかどうかに関わらず) を返します。

newSnapshotTakenboolean

この操作によって新しいスナップショットが取得されたかどうか。(UTC 日ごとにエクスペリエンスごとに 1つのスナップショットのみが取得できます).

latestSnapshotTimestring

操作後の最新スナップショットの時間 (新しいスナップショットが作成されたかどうかにかかわらず)。この時間は常に UTC で返されます。. この文字列は Timestamp としてフォーマットされています。

POST /cloud/v2/universes/{universe_id}/data-stores:snapshot
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores:snapshot' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{}'
レスポンス
{

  "newSnapshotTaken": true,

  "latestSnapshotTime": "2023-07-05T12:34:56Z"

}