標準データストア

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

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

Datastores

https://apis.roblox.com/datastores

次のエンドポイントは、ベースのURLに相対するパスで使用できます。

データストアのリスト

GET /v1/universes/{universeId}/standard-datastores

エクスペリエンスのデータストアのリストを返す

パラメータ

universeId number

アクセスしたいデータストアのエクスペリエンスの識別子。エクスペリエンスのユニバースIDをクリエイターダッシュボードにコピーできます。

Path
必須
cursor string

次のデータセットをリクエストするように提供します。カーソル を参照してください。

limit number

返すアイテムの最大数。各呼び出しは、1つのパーティションで目標が尽きたときに返される値より少なくなることがありますが、1つのパーティションで目標が尽きたときには、それぞれのパーティションでの読み取りのみを行います。

prefix string

このプレフィックスを持つデータストアのみを返すように提供します。

リクエスト

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "prefix=Player" \

-d "limit=5"

レスポンス

200 - OK
以下を返す： object
application/json
{

  "datastores": [

    {

      "name": "PlayerInventory",

      "createdTime": "2022-02-18T22:38:59.9244932Z"

    },

    {

      "name": "PlayerExperience",

      "createdTime": "2022-02-18T23:00:10.4773508Z"

    },

    {

      "name": "PlayerWeapons",

      "createdTime": "2022-02-18T23:00:22.3725681Z"

    },

    {

      "name": "PlayerArmor",

      "createdTime": "2022-02-18T22:59:33.8472882Z"

    },

    {

      "name": "PlayerHP",

      "createdTime": "2022-02-18T22:58:47.6904028Z"

    }

  ],

  "nextPageCursor": "..."

}
data array<object>

ターゲットエクスペリエンスのデータストアのアレイ。

nextPageCursor string

リクエストされた結果セットにより多くのデータが利用可能であることを示します。参照してください カーソル。

必要な権限

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

  • データストアをリスト

Entries

https://apis.roblox.com/datastores

次のエンドポイントは、ベースのURLに相対するパスで使用できます。

エントリをリストする

GET /v1/universes/{universeId}/standard-datastores/datastore/entries

データストア内の入力キーのリス保管を返します。

パラメータ

universeId number

アクセスしたいデータストアのエクスペリエンスの識別子。エクスペリエンスのユニバースIDをクリエイターダッシュボードにコピーできます。

Path
必須
datastoreName string

データストアの名前。

scope string

値はデフォルトで global です。詳細は スコープ を参照してください。

allScopes boolean

すべてのスコープからキーを返すには、真に設定します。

prefix string

このプレフィックスを持つキーのみを返すように提供します。

cursor string

次のデータセットをリクエストするように提供します。カーソル を参照してください。

limit number

返すアイテムの最大数。各呼び出しは、1つのパーティションで目標が尽きたときに返される値より少なくなることがありますが、1つのパーティションで目標が尽きたときには、それぞれのパーティションでの読み取りのみを行います。

リクエスト

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "prefix=" \

-d "limit=5"

レスポンス

200 - OK
以下を返す： object
application/json
{

  "keys": [

    {

      "key": "269323"

    }

  ],

  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"

}
keys array<string>

ターゲットデータストア内の入保管キーのアレイ。

nextPageCursor string

リクエストされた結果セットにより多くのデータが利用可能であることを示します。参照してください カーソル。

必要な権限

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

  • エントリーキーの一覧

エントリを取得

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

エントリに関連する値とメタデータを返します。

メタデータは、以フォロー中のような応答ヘッダーで見つけることができます：

content-md5: zuYxEhwuySMv0i8CitXImw==

roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01

roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-attributes: { "myAttribute": "myValue" }

roblox-entry-userids: [1, 2, 3]

| ヘッダー | 説明 | |---|---| | content-md5 | コンテンツの base-64 エンコードされた MD5 チェックサム。見る コンテンツ-MD5。| | roblox-entry-version | 返された入力のバージョン。| | roblox-entry-created-time | エントリが作成された時刻。| | roblox-entry-version-created-time | この特定のバージョンが作成された時刻。| | roblox-entry-attributes | エントリに付与された属性。JSON マップオブジェクトをシリアライズ。| | roblox-entry-userids | コンマ区切りの Roblox ユーザーID タグ付きの入力リスト。 |

パラメータ

universeId number

アクセスしたいデータストアのエクスペリエンスの識別子。エクスペリエンスのユニバースIDをクリエイターダッシュボードにコピーできます。

Path
必須
datastoreName string

データストアの名前。

entryKey string

エントリを識別するキー。

scope string

値はデフォルトで global です。詳細は スコープ を参照してください。

リクエスト

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323"

レスポンス

200 - OK
エントリを成功して取得しました。
以下を返す： object

必要な権限

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

  • エントリを読む

エントリを設定

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

エントリに関連する値、メタデータ、およびユーザーIDを設定します。

パラメータ

universeId number

アクセスしたいデータストアのエクスペリエンスの識別子。エクスペリエンスのユニバースIDをクリエイターダッシュボードにコピーできます。

Path
必須
datastoreName string

データストアの名前。

entryKey string

エントリを識別するキー。

matchVersion string

現在のバージョンがこれに一致する場合にのみ更新を提供します。

exclusiveCreate boolean

存在しない場合にのみエントリを作成します。

scope string

値はデフォルトで global です。詳細は スコープ を参照してください。

roblox-entry-attributes string

エントリの新しいバージョンに関連付けられる属性。JSON マップオブジェクトによって serialize されます。提供されない場合、既存の属性はクリアされます。

Header
roblox-entry-userids string

コンマ区切りのロブロックスユーザーIDのリストが入力と一致した場合。提供されないと、既存のユーザーIDがクリアされます。

Header
content-md5 string

コンテンツのベース-64 符号化された MD5 チェックサム。見る コンテンツ-MD5 。

Header

リクエスト

curl
curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323" \

--header "x-api-key: ${API_KEY}" \

--header "content-md5: IGPBYI1uC6+AJJxC4r5YBA==" \

--header "content-type: application/json" \

--header "roblox-entry-userids: [269323]" \

--header "roblox-entry-attributes: {}" \

--d "value"

レスポンス

200 - OK
以下を返す： object
version string

資格のある入力のバージョン名。

deleted boolean

エントリが削除されたかどうかを示します。

contentLength number

コンテンツの長さ。

createdTime string

バージョンがISO 時刻形式で作成された時刻のタイムスタンプ。

objectCreatedTime string

データストアがISO時間形式で作成された時刻のタイムスタンプ。

必要な権限

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

  • エントリを作成

  • エントリを更新

エントリを削除

DELETE /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

墓石バージョンを作成してエントリを削除すると、エントリは 30 日後に永久に削除されます。

パラメータ

universeId number

アクセスしたいデータストアのエクスペリエンスの識別子。エクスペリエンスのユニバースIDをクリエイターダッシュボードにコピーできます。

Path
必須
datastoreName string

データストアの名前。

entryKey string

エントリを識別するキー。

scope string

値はデフォルトで global です。詳細は スコープ を参照してください。

リクエスト

curl
curl --include --location --request DELETE "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323"

レスポンス

必要な権限

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

  • 入力内容を削除

増分エントリ

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment

入力の値を指定された量で増加するか、その量で新しい入力を作成します。入力とメタデータを返します。

メタデータは、以フォロー中のような応答ヘッダーで見つけることができます：

content-md5: zuYxEhwuySMv0i8CitXImw==

roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01

roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-attributes: { "myAttribute": "myValue" }

roblox-entry-userids: [1, 2, 3]

| ヘッダー | 説明 | |---|---| | content-md5 | コンテンツの base-64 エンコードされた MD5 チェックサム。見る コンテンツ-MD5。| | roblox-entry-version | 返された入力のバージョン。| | roblox-entry-created-time | エントリが作成された時刻。| | roblox-entry-version-created-time | この特定のバージョンが作成された時刻。| | roblox-entry-attributes | エントリに付与された属性。JSON マップオブジェクトをシリアライズ。| | roblox-entry-userids | コンマ区切りの Roblox ユーザーID タグ付きの入力リスト。 |

パラメータ

universeId number

アクセスしたいデータストアのエクスペリエンスの識別子。エクスペリエンスのユニバースIDをクリエイターダッシュボードにコピーできます。

Path
必須
datastoreName string

データストアの名前。

entryKey string

エントリを識別するキー。

incrementBy number

エントリが増加する量、または存在しない場合の開始値。

scope string

値はデフォルトで global です。詳細は スコープ を参照してください。

roblox-entry-attributes string

エントリの新しいバージョンに関連付けられる属性。JSON マップオブジェクトによって serialize されます。提供されない場合、既存の属性はクリアされます。

Header
roblox-entry-userids string

入力がタグ付けされた Roblox ユーザー ID のコンマ区切りリスト。提供されないと、既存のユーザー ID がクリアされます。

Header

リクエスト

curl
curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/increment" \

--header "x-api-key: ${API_KEY}" \

--header 'content-length: 0' \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "incrementBy=3"

レスポンス

200 - OK
増分後のエントリの最新バージョンを返します。
以下を返す： object

必要な権限

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

  • エントリを作成

  • エントリを更新

エントリバージョンを取得

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version

エントリの特定のバージョンの値とメタデータを返します。

メタデータは、以フォロー中のような応答ヘッダーで見つけることができます：

content-md5: zuYxEhwuySMv0i8CitXImw==

roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01

roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00

roblox-entry-attributes: { "myAttribute": "myValue" }

roblox-entry-userids: [1, 2, 3]

| ヘッダー | 説明 | |---|---| | content-md5 | コンテンツの base-64 エンコードされた MD5 チェックサム。見る コンテンツ-MD5。| | roblox-entry-version | 返された入力のバージョン。| | roblox-entry-created-time | エントリが作成された時刻。| | roblox-entry-version-created-time | この特定のバージョンが作成された時刻。| | roblox-entry-attributes | エントリに付与された属性。JSON マップオブジェクトをシリアライズ。| | roblox-entry-userids | コンマ区切りの Roblox ユーザーID タグ付きの入力リスト。 |

パラメータ

universeId number

アクセスしたいデータストアのエクスペリエンスの識別子。エクスペリエンスのユニバースIDをクリエイターダッシュボードにコピーできます。

Path
必須
datastoreName string

データストアの名前。

entryKey string

エントリを識別するキー。

versionId string

調査するバージョン。

scope string

値はデフォルトで global です。詳細は スコープ を参照してください。

リクエスト

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions/version" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "versionId=08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01"

レスポンス

200 - OK
エントリを成功して取得しました。
以下を返す： object

必要な権限

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

  • 読み取りバージョン

限度

各APIキー：各IPアドレスにつき 5000 回のリクエストが 60 秒ごとに送信されます

リストエントリバージョン

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions

入力のバージョンリストを返します。

パラメータ

universeId number

アクセスしたいデータストアのエクスペリエンスの識別子。エクスペリエンスのユニバースIDをクリエイターダッシュボードにコピーできます。

Path
必須
datastoreName string

データストアの名前。

entryKey string

エントリを識別するキー。

scope string

値はデフォルトで global です。詳細は スコープ を参照してください。

cursor string

次のデータセットをリクエストするように提供します (カーソル を参照)。

startTime string

このタイムスタンプより前のバージョンを含めないように提供します。

endTime string

このタイムスタンプ以降のバージョンを含めないように提供します。

sortOrder string

Either Ascending (以前のバージョンが最初) または Descending (後のバージョンが最初).

limit number

返すアイテムの最大数。各呼び出しは、1つのパーティションで目標が尽きたときに返される値より少なくなることがありますが、1つのパーティションで目標が尽きたときには、それぞれのパーティションでの読み取りのみを行います。

リクエスト

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "limit=5"

レスポンス

200 - OK
以下を返す： object
version string

資格のある入力のバージョン名。

deleted boolean

エントリが削除されたかどうかを示します。

contentLength number

コンテンツの長さ。

createdTime string

バージョンがISO 時刻形式で作成された時刻のタイムスタンプ。

objectCreatedTime string

データストアがISO時間形式で作成された時刻のタイムスタンプ。

必要な権限

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

  • バージョン一覧

オブジェクト

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

DataStore

名前と作成時間を持つデータストアオブジェクト。

属性

name string

データストアの名保管。

createdTime string

データストアがISO時間形式で作成された時刻のタイムスタンプ。

EntryVersion

List Entry Versions メソッドによって返された入力バージョンオブジェクト。

属性

version string

資格のある入力のバージョン名。

deleted boolean

エントリが削除されたかどうかを示します。

contentLength number

コンテンツの長さ。

createdTime string

バージョンがISO 時刻形式で作成された時刻のタイムスタンプ。

objectCreatedTime string

データストアがISO時間形式で作成された時刻のタイムスタンプ。