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

DataStoreEntry

データストアのキー-値エントリ。

リソースパス
/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries

属性

pathstring

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

形式:

universes/{universe_id}/data-stores/{data_store_id}/entries/{data_store_entry_id}
universes/{universe_id}/data-stores/{data_store_id}/scopes/{data_store_scope_id}/entries/{data_store_entry_id}.

createTimestring

出力のみ

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

revisionIdstring

不変

出力のみ

データストアエントリのリビジョンID。

データストアエントリがどのように変更されても、新しいレビジョンがコミットされます。

形式は任意の文字列です。例: "foo".

revisionCreateTimestring

出力のみ

リビジョンが作成された時刻。. この文字列は Timestamp としてフォーマットされています。

stateEnum<string>

出力のみ

データストアエントリの状態。

可能な値:

| 値 | 説明 | | --- | --- | | 状態_未指定 | デフォルトの値。この値は、状態が省略された場合に使用されます。| | アクティブ | 新しく作成されたデータストアエントリのデフォルト状態。| | 削除済み | データストアエントリが削除されたとしてマークされます。将来のある時点で、永久に削除されます。|. 可能な値:

etagstring

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算され、更新と削除リクエスト (および可能には特定のカスタムメソッド) に送信され、クライアントが最新の値を持っていることを確認するために、進行する前に行われます。.

valueJSON value

エントリの値。.

JSON 値は、 null、 boolean、 string、 number、 array、 object にはできません。

idstring

出力のみ

エントリのリソース ID。

これはリソースパスの最後のセグメントと一致し、便宜上提供されるだけです。.

usersarray<string>

エントリに関連するユーザ。.

attributesobject

エントリに関連する任意の属性のセット。.

ベース URL

https://apis.roblox.com

DataStoreEntry リソース

{
  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
  "createTime": "2023-07-05T12:34:56Z",
  "revisionId": "string",
  "revisionCreateTime": "2023-07-05T12:34:56Z",
  "state": "STATE_UNSPECIFIED",
  "etag": "string",
  "value": "JSON value",
  "id": "string",
  "users": [
    "string"
  ],
  "attributes": "object"
}

DataStoreEntry

データストアエントリをリストする
ベータ版

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

データストアからのエントリリストを返します。

のみが path および id フィールドが満たされ、他のフィールドを取得するには GetDataStoreEntry を使用します。

ワイルドカードスコープ ( - ) を指定して、すべてのスコープからのエントリをリストに表示します。

範囲

universe-datastores.objects:list

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

data_store_idstring

必須

データストアID。.

クエリのパラメータ

maxPageSizenumber

返すデータストアエントリの最大数。サービスはこの値より少なく返す可能性があります。指定されない場合、最大 10 個のデータストアエントリが返されます。最大値は 256、それ以上の値は 256 に設定されます。.

pageTokenstring

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

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

filterstring

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

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

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

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

showDeletedboolean

真の場合、保留中の削除にマークされたリソースは結果に含まれます。.

レスポンス

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

dataStoreEntriesarray<DataStoreEntry>

指定されたデータストアまたはデータストアスコープからの DataStoreEntries。.

nextPageTokenstring

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

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

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries?maxPageSize=10&pageToken={string}&filter={string}&showDeleted={boolean}' \
  -H 'x-api-key: {your-api-key}'

レスポンス

{
  "dataStoreEntries": [
    {
      "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
      "createTime": "2023-07-05T12:34:56Z",
      "revisionId": "string",
      "revisionCreateTime": "2023-07-05T12:34:56Z",
      "state": "STATE_UNSPECIFIED",
      "etag": "string",
      "value": "JSON value",
      "id": "string",
      "users": [
        "string"
      ],
      "attributes": "object"
    }
  ],
  "nextPageToken": "string"
}

DataStoreEntry

データストアエントリを作成する
ベータ版

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

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

エントリが存在する場合は、400 悪いリクエストを返します。

範囲

universe-datastores.objects:create

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

data_store_idstring

必須

データストアID。.

クエリのパラメータ

idstring

データストアエントリの最終コンポーネントとなるデータストアエントリの資源パスに使用する ID、これはデータストアエントリの資源パスの最後のコンポーネントになります。

この値は 1-50 文字の文字列であるべきです。小文字の文字、数字、ハイフンのみを使用することを強く推奨します。.

リクエスト本文DataStoreEntry

レスポンスDataStoreEntry

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries?id=my-entry' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "etag": "string",
  "value": "JSON value",
  "users": [
    "string"
  ],
  "attributes": "object"
}'

レスポンス

{
  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
  "createTime": "2023-07-05T12:34:56Z",
  "revisionId": "string",
  "revisionCreateTime": "2023-07-05T12:34:56Z",
  "state": "STATE_UNSPECIFIED",
  "etag": "string",
  "value": "JSON value",
  "id": "string",
  "users": [
    "string"
  ],
  "attributes": "object"
}

DataStoreEntry

データストアエントリを取得
ベータ版

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

指定された入力を取得します。

特定のレビューでエントリを取得するには、パスの最後に @<revisionId> を追加します。

たとえば、リビジョン ID my-entry で 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01 を取得するには、パス /v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01 を使用します。

入力 ID に 1つまたは複数の @ 文字が含まれており、特定のバージョンではなく最新バージョンを取得したい場合は、パスの最後に特別なバージョン ID @latest を付け加えます。そうでないと、最後の @ の入力 ID のセグメントは、リビジョン IDとして解釈されます。

たとえば、my-entry の最新バージョンを取得するには、パス /v2/universes/1234/data-stores/5678/entries/my@entry@latest を使用します。

特定の時刻に有効だったエントリを取得するには、@latest:<timestamp> をパスの最後に追加し、<timestamp> が RFC-3339 形式で格納されています。指定されたタイムスタンプは、Unix 時代（1/1/1970）以後であり、10分以内にあってはならない。

たとえば、2024年12月2日 06:00 UTC に現在有効だった my-entry のリビジョンを取得するには、パス /v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z を使用します。

範囲

universe-datastores.objects:read

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

data_store_idstring

必須

データストアID。.

entry_idstring

必須

エントリID。.

レスポンスDataStoreEntry

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}' \
  -H 'x-api-key: {your-api-key}'

レスポンス

{
  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
  "createTime": "2023-07-05T12:34:56Z",
  "revisionId": "string",
  "revisionCreateTime": "2023-07-05T12:34:56Z",
  "state": "STATE_UNSPECIFIED",
  "etag": "string",
  "value": "JSON value",
  "id": "string",
  "users": [
    "string"
  ],
  "attributes": "object"
}

DataStoreEntry

データストアエントリを削除する
ベータ版

DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

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

エントリはすぐに削除されるわけではなく、state フィールドが DELETED に設定されます。永久削除は 30 日後に発生します。

成功すると、200 OK を返します。エントリが存在しない場合は、404 見つかりませんを返します。

範囲

universe-datastores.objects:delete

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

data_store_idstring

必須

データストアID。.

entry_idstring

必須

エントリID。.

DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}' \
  -H 'x-api-key: {your-api-key}'

DataStoreEntry

データストアエントリを更新する
ベータ版

PATCH /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

エントリの値、属性、およびユーザーを更新する。

エントリの特定のレビューを更新することは、サポートされていません。パスにレビジョン ID を指定し、allow_missing が true である場合、アップデートリクエストは、キーの一部として @<revisionId> サフィックスを持つ新しいエントリを作成します。

部分更新はサポートされていません。値を更新するときに属性またはユーザーが提供されない場合、クリアされます。エントリを更新するときは、常に値を提供する必要があります。

範囲

universe-datastores.objects:update

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

data_store_idstring

必須

データストアID。.

entry_idstring

必須

エントリID。.

クエリのパラメータ

allowMissingboolean

真に設定され、データストアエントリが見つからない場合、データストアエントリが作成されます。.

リクエスト本文DataStoreEntry

レスポンスDataStoreEntry

PATCH /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}?allowMissing={boolean}' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "etag": "string",
  "value": "JSON value",
  "users": [
    "string"
  ],
  "attributes": "object"
}'

レスポンス

{
  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
  "createTime": "2023-07-05T12:34:56Z",
  "revisionId": "string",
  "revisionCreateTime": "2023-07-05T12:34:56Z",
  "state": "STATE_UNSPECIFIED",
  "etag": "string",
  "value": "JSON value",
  "id": "string",
  "users": [
    "string"
  ],
  "attributes": "object"
}

DataStoreEntry

データストアのエントリを増加
ベータ版

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment

指定されたエントリの値を増加します。既存の値と増加量の両方が整数である必要があります。

エントリが存在しない場合、指定された値でエントリを作成します。

エントリの特定のリビジョンを増加することは、サポートされていません。パスにレビジョン ID を指定すると、増分リクエストはキーの一部として @<revisionId> サフィックスを含む新しいエントリを作成します。

既知の問題: 値は有効な値の範囲を超えて増加する可能性があります。これが発生すると、返された値は有効な範囲にクリップされますが、バックエンドは元の値を維持する可能性があります。この動作は、後方互換のために維持されますが、この API の将来のバージョンで変更される可能性があります。

範囲

universe-datastores.objects:createuniverse-datastores.objects:update

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

data_store_idstring

必須

データストアID。.

entry_idstring

必須

エントリID。.

リクエスト本文

amountnumber

エントリ値を増加する量。既存の値と増加量は、整数でなければなりません。.

usersarray<string>

エントリに関連するユーザ。

これが提供されないと、既存のユーザーIDがクリアされます。.

attributesobject

エントリに関連する任意の属性のセット。

これが提供されない場合、既存の属性がクリアされます。.

レスポンスDataStoreEntry

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "amount": "number",
  "users": [
    "string"
  ],
  "attributes": "object"
}'

レスポンス

{
  "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
  "createTime": "2023-07-05T12:34:56Z",
  "revisionId": "string",
  "revisionCreateTime": "2023-07-05T12:34:56Z",
  "state": "STATE_UNSPECIFIED",
  "etag": "string",
  "value": "JSON value",
  "id": "string",
  "users": [
    "string"
  ],
  "attributes": "object"
}

DataStoreEntry

データストアエントリのリビジョンをリストする
ベータ版

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions

データストアエントリのリビジョンをリストする。

このメソッドは、部分データストアエントリを返します。

特に、path , id , createTime , revisionCreateTime , revisionId , etag , そして state フィールドだけが満たされています。両方の path および id フィールドには、@<version> サuffixが付きます。

レビューで全入力を取得するには、path メソッドで提供された GetDataStoreEntry フィールドを使用して、GET /v1/universes/1234/data-stores/5678/entries/my-entry@<version> を使用できます。

範囲

universe-datastores.versions:list

リクエストパスのパラメータ

universe_idstring

必須

ユニバースID。.

data_store_idstring

必須

データストアID。.

entry_idstring

必須

エントリID。.

クエリのパラメータ

maxPageSizenumber

ページごとに戻す最大リビジョン数。

サービスは、最大リビジョン数より少ない数を返す可能性があります。指定されない場合、最大 10 個のリビジョンが返されます。最大値は 100 値で、より高い値は 100 に設定されます。.

pageTokenstring

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

filterstring

CEL の次のサブセットをサポートします：

のみがサポートされています && , <= , そして >= オペレーター。
のみ revision_create_time フィールドがサポートされます。

例えば:

"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z".

レスポンス

データストアエントリのレビューのリスト。

dataStoreEntriesarray<DataStoreEntry>

データ_ストア_エントリの変更。.

nextPageTokenstring

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

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions?maxPageSize=10&pageToken={string}&filter={string}' \
  -H 'x-api-key: {your-api-key}'

レスポンス

{
  "dataStoreEntries": [
    {
      "path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
      "createTime": "2023-07-05T12:34:56Z",
      "revisionId": "string",
      "revisionCreateTime": "2023-07-05T12:34:56Z",
      "state": "STATE_UNSPECIFIED",
      "etag": "string",
      "value": "JSON value",
      "id": "string",
      "users": [
        "string"
      ],
      "attributes": "object"
    }
  ],
  "nextPageToken": "string"
}

DataStoreEntry

属性

DataStoreEntry

データストアエントリをリストするベータ版

DataStoreEntry

データストアエントリを作成するベータ版

DataStoreEntry

データストアエントリを取得ベータ版

DataStoreEntry

データストアエントリを削除するベータ版

DataStoreEntry

データストアエントリを更新するベータ版

DataStoreEntry

データストアのエントリを増加ベータ版

DataStoreEntry

データストアエントリのリビジョンをリストするベータ版

データストアエントリをリストする
ベータ版

データストアエントリを作成する
ベータ版

データストアエントリを取得
ベータ版

データストアエントリを削除する
ベータ版

データストアエントリを更新する
ベータ版

データストアのエントリを増加
ベータ版

データストアエントリのリビジョンをリストする
ベータ版