Standard-Datenspeicher

*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Diese Seite enthält Referenzdokumente für das Arbeiten mit Standard-Datenspeichern. Weitere Informationen zum Verwenden der API finden Sie unter Verarbeiten von API-Anfragen für Datenspeicher und dem Leitfaden für die Verwendung.

Datastores

https://apis.roblox.com/datastores

Die folgenden Endpunkte sind bei Pfaden relativ zur Basis-URL verfügbar.

Listen-Datenspeicher

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

Gibt eine Liste der Datenstores einer Erlebniszurück.

Parameter

universeId number

Die Identifikator der Erfahrung mit Daten-Stores, die Sie Zugriffmöchten. Sie können kopieren Sie die Universe-ID Ihrer Erlebnisauf dem Creator-Dashboard .

Path
Erforderlich
cursor string

Geben Sie eine Anfrage auf das nächste Set von Daten. Siehe Cursors.

limit number

Die maximale Anzahl von zurückzukerenden Elementen. Jeder Aufruf liest nur einePartition, so dass er weniger als der angegebene Wert zurückgeben kann, wenn die Ziele auf einerPartition ausgeführt werden.

prefix string

Geben Sie nur Daten-Stores mit diesem Präfix zurück.

Anfrage

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"

Rückmeldung

200 - OK
Gibt zurück ein(e) 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>

Ein Array von Daten-Stores in der Ziel-Erlebnissen.

nextPageCursor string

Zeigt an, dass mehr Daten in der angefordertenen festlegenverfügbar sind. Siehe Cursors.

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Datenspeicher auflisten

Entries

https://apis.roblox.com/datastores

Die folgenden Endpunkte sind bei Pfaden relativ zur Basis-URL verfügbar.

Listen-Einträge

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

Kehre eine Liste von Eintrittstasten in einem Daten-Store zurück.

Parameter

universeId number

Die Identifikator der Erfahrung mit Daten-Stores, die Sie Zugriffmöchten. Sie können kopieren Sie die Universe-ID Ihrer Erlebnisauf dem Creator-Dashboard .

Path
Erforderlich
datastoreName string

Der Name des Store.

scope string

Der Wert ist global standardmäßig. Siehe Skalierungen .

allScopes boolean

Setzen Sie auf "Ja", um Schlüssel aus allen Skalen zurückzugeben.

prefix string

Geben Sie nur Schlüssel mit diesem Präfix zurück.

cursor string

Geben Sie eine Anfrage auf das nächste Set von Daten. Siehe Cursors.

limit number

Die maximale Anzahl von zurückzukerenden Elementen. Jeder Aufruf liest nur einePartition, so dass er weniger als der angegebene Wert zurückgeben kann, wenn die Ziele auf einerPartition ausgeführt werden.

Anfrage

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"

Rückmeldung

200 - OK
Gibt zurück ein(e) object
application/json
{

  "keys": [

    {

      "key": "269323"

    }

  ],

  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"

}
keys array<string>

Ein Array von Schlüsselzeichen innerhalb der Store.

nextPageCursor string

Zeigt an, dass mehr Daten in der angefordertenen festlegenverfügbar sind. Siehe Cursors.

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Listeneintragschlüssel

Eintrag holen

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

Gibt den Wert und die Metadaten, die mit einem Eintrag verbunden sind, zurück.

Parameter

universeId number

Die Identifikator der Erfahrung mit Daten-Stores, die Sie Zugriffmöchten. Sie können kopieren Sie die Universe-ID Ihrer Erlebnisauf dem Creator-Dashboard .

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

scope string

Der Wert ist global standardmäßig. Siehe Skalierungen .

Anfrage

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"

Rückmeldung

200 - OK
Kehrt den Inhalt des Benutzers der Einreichung in den Körper der Antwort zurück.
Gibt zurück ein(e) object
application/json
{

  "content-md5": "zuYxEhwuySMvOi8CitXImw==",

  "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-userids": [ 1, 2, 3 ]

}
roblox-entry-created-time string

Die Zeit, zu der der Eintrag erstellt wurde.

last-modified string

Die Zeit, zu der diese besondere Version erstellt wurde.

roblox-entry-version string

Die Version der zurückgegebenen Einreichung.

roblox-entry-attributes string

Attribute, die mit der zurückgegebenen Einheit verbunden sind. Serialisiertes Objekt.

roblox-entry-userids array<number>

Komma getrennte Liste von Roblox-Benutzer-IDs, die mit dem Eintrag versehen ist.

content-md5 string

Die base-64-codierte MD5-Checksum des Inhalts. Siehe Inhalt-MD5 .

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Eintrag lesen

Eintrag einrichten

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

Setzt den Wert, die Metadaten und die Benutzer-IDs, die mit einem Eintrag verbunden sind.

Parameter

universeId number

Die Identifikator der Erfahrung mit Daten-Stores, die Sie Zugriffmöchten. Sie können kopieren Sie die Universe-ID Ihrer Erlebnisauf dem Creator-Dashboard .

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

matchVersion string

Geben Sie nur ein Update bereit, wenn die aktuelle Version dies entspricht.

exclusiveCreate boolean

Erstellen Sie den Eintrag nur, wenn er nicht existiert.

scope string

Der Wert ist global standardmäßig. Siehe Skalierungen .

roblox-entry-attributes string

Attribute, mit denen neue Versionen des Einreichs verbunden werden sollen. Serialisiert durch JSON-Kartenobjekte. Wenn nicht angegeben, werden vorhandene Attribute zurückgesetzt.

Header
roblox-entry-userids string

Komma getrennte Liste von Roblox-Benutzer-IDs, die mit dem Eintrag versehen sind. Wenn nicht angegeben, werden vorhandene Benutzer-IDs gelöscht.

Header
content-md5 string

Die base-64-codierte MD5-Checksum des Inhalts. Siehe Inhalt-MD5 .

Header

Anfrage

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"

Rückmeldung

200 - OK
Gibt zurück ein(e) object
version string

Der Name der qualifizierenden Einreichung.

deleted boolean

Zeigt an, ob der Eintrag gelöscht wurde.

contentLength number

Die Länge des Inhalts.

createdTime string

Der Zeitpunkt, in dem die Version in der ISO-Zeit formatiert wurde.

objectCreatedTime string

Der Zeitpunkt, in dem der Datenstores in der ISO-Zeit formatiert wurde.

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Eintrag erstellen

  • Eintrag aktualisieren

Eintrag löschen

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

Markiert den Eintrag als gelöscht, indem eine Grabstein-Version erstellt wird. Einreichungen werden nach 30 Tagen permanent gelöscht.

Parameter

universeId number

Die Identifikator der Erfahrung mit Daten-Stores, die Sie Zugriffmöchten. Sie können kopieren Sie die Universe-ID Ihrer Erlebnisauf dem Creator-Dashboard .

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

scope string

Der Wert ist global standardmäßig. Siehe Skalierungen .

Anfrage

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"

Rückmeldung

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Eintrag löschen

Einkommens-Erhöhung

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

Erhöht den Wert für einen Eintrag um einen bestimmten Betrag oder erstellt einen neuen Eintrag mit dieser Menge.

Parameter

universeId number

Die Identifikator der Erfahrung mit Daten-Stores, die Sie Zugriffmöchten. Sie können kopieren Sie die Universe-ID Ihrer Erlebnisauf dem Creator-Dashboard .

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

incrementBy number

Die Menge, mit der der Eintrag erhöht werden soll, oder der Startwert, wenn er nicht existiert.

scope string

Der Wert ist global standardmäßig. Siehe Skalierungen .

roblox-entry-attributes string

Attribute, mit denen neue Versionen des Einreichs verbunden werden sollen. Serialisiert durch JSON-Kartenobjekte. Wenn nicht angegeben, werden vorhandene Attribute zurückgesetzt.

Header
roblox-entry-userids string

Eine komma getrennte Liste von Roblox-Benutzer-IDs, mit denen der Eintrag versehen ist. Wenn nicht angegeben, werden vorhandene Benutzer-IDs gelöscht.

Header

Anfrage

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"

Rückmeldung

200 - OK
Kehrt die neueste Version des Eintrags zurück, nachdem er incrementiert wurde.
Gibt zurück ein(e) object
application/json
{

  "content-md5": "K4phWUsfTE2wkCqKOVztkw==",

  "roblox-entry-version": "08D9E6A3F2188CFF.0000000009.08D9E6DF74AC5F42.01",

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

  "roblox-entry-version-created-time": "2022-02-03T06:36:05.9184962+00:00",

  "roblox-entry-userids": []

}
roblox-entry-created-time string

Die Zeit, zu der der Eintrag erstellt wurde.

last-modified string

Die Zeit, zu der diese besondere Version erstellt wurde.

roblox-entry-version string

Die Version der zurückgegebenen Einreichung.

roblox-entry-attributes string

Attribute, die mit der zurückgegebenen Einheit verbunden sind. Serialisiertes Objekt.

roblox-entry-userids array<number>

Komma getrennte Liste von Roblox-Benutzer-IDs, die mit dem Eintrag versehen ist.

content-md5 string

Die base-64-codierte MD5-Checksum des Inhalts. Siehe Inhalt-MD5 .

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Eintrag erstellen

  • Eintrag aktualisieren

Eintrag-Version abrufen

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

Gibt die Werte und Metadaten einer bestimmten Version eines Eintrags zurück.

Parameter

universeId number

Die Identifikator der Erfahrung mit Daten-Stores, die Sie Zugriffmöchten. Sie können kopieren Sie die Universe-ID Ihrer Erlebnisauf dem Creator-Dashboard .

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

versionId string

Die Version zum Inspektieren.

scope string

Der Wert ist global standardmäßig. Siehe Skalierungen .

Anfrage

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"

Rückmeldung

200 - OK
Gibt zurück ein(e) object
application/json
{

  "content-md5": "sTf90fedVsft8zZf6nUg8g==",

  "roblox-entry-version": "08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01",

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

  "roblox-entry-version-created-time": "2022-02-03T06:27:42.0652160+00:00",

  "roblox-entry-attributes": {},

  "roblox-entry-userids": [ 269323 ]

}
roblox-entry-created-time string

Die Zeit, zu der der Eintrag erstellt wurde.

last-modified string

Die Zeit, zu der diese besondere Version erstellt wurde.

roblox-entry-version string

Die Version der zurückgegebenen Einreichung.

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Version lesen

Limits

Pro API-Schlüssel: 100 Anfoderungen pro 60 Sekunden pro IP-Adresse

Listen-Eintrag-Versionen

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

Gibt eine Liste der Versionen für einen Eintrag zurück.

Parameter

universeId number

Die Identifikator der Erfahrung mit Daten-Stores, die Sie Zugriffmöchten. Sie können kopieren Sie die Universe-ID Ihrer Erlebnisauf dem Creator-Dashboard .

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

scope string

Der Wert ist global standardmäßig. Siehe Skalierungen .

cursor string

Geben Sie eine Anfrage auf das nächste Set von Daten (siehe Cursors ).

startTime string

Stellen Sie sicher, dass Sie keine Versionen vor diesem Zeitpunkt enthalten.

endTime string

Stellen Sie sicher, dass Sie keine Versionen enthalten, die nach diesem Zeitpunkt liegen.

sortOrder string

Entweder Ascending (frühere Versionen zuerst) oder Descending ( spätere Versionen zuerst).

limit number

Die maximale Anzahl von zurückzukerenden Elementen. Jeder Aufruf liest nur einePartition, so dass er weniger als der angegebene Wert zurückgeben kann, wenn die Ziele auf einerPartition ausgeführt werden.

Anfrage

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"

Rückmeldung

200 - OK
Gibt zurück ein(e) object
version string

Der Name der qualifizierenden Einreichung.

deleted boolean

Zeigt an, ob der Eintrag gelöscht wurde.

contentLength number

Die Länge des Inhalts.

createdTime string

Der Zeitpunkt, in dem die Version in der ISO-Zeit formatiert wurde.

objectCreatedTime string

Der Zeitpunkt, in dem der Datenstores in der ISO-Zeit formatiert wurde.

Erforderliche Berechtigungen

Die folgenden API-Schlüssel-Berechtigungen werden benötigt, um diesen Endpunkt aufzurufen. Für weitere Informationen zur Erzeugung korrekter Schlüssel siehe API-Schlüssel verwalten.

  • Versionen auflisten

Objekte

Die folgenden Objekte beschreiben Nutzlasten, die akzeptiert oder zurückgegeben werden. Die einzelnen Endpunkte zeigen weitere Informationen darüber an, wann diese Objekte verwendet werden.

DataStore

Das Daten-Store-Objekt mit seinem Namen und der erstellten Zeit.

Attribute

name string

Der Name deines Daten-Stores.

createdTime string

Der Zeitpunkt, in dem der Datenstores in der ISO-Zeit formatiert wurde.

EntryVersion

Das Eintrittsversion-Objekt, das von der Methode List Entry Versions zurückgegeben wird.

Attribute

version string

Der Name der qualifizierenden Einreichung.

deleted boolean

Zeigt an, ob der Eintrag gelöscht wurde.

contentLength number

Die Länge des Inhalts.

createdTime string

Der Zeitpunkt, in dem die Version in der ISO-Zeit formatiert wurde.

objectCreatedTime string

Der Zeitpunkt, in dem der Datenstores in der ISO-Zeit formatiert wurde.