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 Referenzdokumentation für die Arbeit mit Standard-Datenspeichern.Für weitere Informationen zur Verwendung der API siehe API-Anfragen für Datenbanken bearbeiten und den Nutzungsleitfaden.

Datastores

https://apis.roblox.com/datastores

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

Listen von Datenlagern

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

Gibt eine Liste der Datenlagern eines Erlebnisses zurück.

Parameter

universeId number

Die Identifikator des Erlebnisses mit Datenlagern, auf die Sie zugreifen möchten.Du kannst die Universitäts-ID deiner Erfahrung auf dem Creator-Dashboard Zugriff.

Path
Erforderlich
cursor string

Stellen Sie die nächste Reihe von Daten an. Siehe Kursoren.

limit number

Die maximale Anzahl der zu zurücksendenden Artikel.Jeder Anruf liest nur eine Partition, so dass er weniger als den angegebenen Wert zurückgeben kann, wenn auf einer Partition keine Ziele mehr verfügbar sind.

prefix string

Stellen Sie nur Datenstores 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 Datenlagern in der Erlebnis.

nextPageCursor string

Weist darauf hin, dass es mehr Daten im angeforderten festlegengibt. Siehe Kursoren.

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

Gibt eine Liste der Eingabetasten innerhalb eines Storezurück.

Parameter

universeId number

Die Identifikator des Erlebnisses mit Datenlagern, auf die Sie zugreifen möchten.Du kannst die Universitäts-ID deiner Erfahrung auf dem Creator-Dashboard Zugriff.

Path
Erforderlich
datastoreName string

Der Name des Store.

scope string

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

allScopes boolean

Setze es auf wahr, um Schlüssel aus allen Bereichen zurückzugeben.

prefix string

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

cursor string

Stellen Sie die nächste Reihe von Daten an. Siehe Kursoren.

limit number

Die maximale Anzahl der zu zurücksendenden Artikel.Jeder Anruf liest nur eine Partition, so dass er weniger als den angegebenen Wert zurückgeben kann, wenn auf einer Partition keine Ziele mehr verfügbar sind.

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 Eingabetasten innerhalb des Store.

nextPageCursor string

Weist darauf hin, dass es mehr Daten im angeforderten festlegengibt. Siehe Kursoren.

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 erhalten

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

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

Metadaten können in den Antwort-Headern wie gefolgte Profilegefunden werden:

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]

| Kopfzeile | Beschreibung | |---|---| | content-md5 | Die MD5-Prüfsumme der Inhalte, die in Base-64 codiert ist.Siehe Inhalt-MD5.| | roblox-entry-version | Die Version des zurückgegebenen Eintrags.| | roblox-entry-created-time | Die Zeit, in der der Eintrag erstellt wurde.| | roblox-entry-version-created-time | Die Zeit, in der diese spezielle Version erstellt wurde.| | roblox-entry-attributes | Attribute, die mit dem Eintrag versehen wurden.Serialisiertes Objekt.| | roblox-entry-userids | Kommaseparierte Liste der Roblox-Benutzer-IDs, die mit dem Eintrag versehen sind. |

Parameter

universeId number

Die Identifikator des Erlebnisses mit Datenlagern, auf die Sie zugreifen möchten.Du kannst die Universitäts-ID deiner Erfahrung auf dem Creator-Dashboard Zugriff.

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

scope string

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

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
Eintrag erfolgreich abgerufen.
Gibt zurück ein(e) object

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 festlegen

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

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

Parameter

universeId number

Die Identifikator des Erlebnisses mit Datenlagern, auf die Sie zugreifen möchten.Du kannst die Universitäts-ID deiner Erfahrung auf dem Creator-Dashboard Zugriff.

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

matchVersion string

Bieten Sie zum Aktualisieren nur an, wenn die aktuelle Version diesem entspricht.

exclusiveCreate boolean

Erstelle den Eintrag nur, wenn er nicht existiert.

scope string

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

roblox-entry-attributes string

Attribute, die mit der neuen Version des Eintrags verbunden werden sollen. Serialisiert durch JSON-Kartenobjekte. Wenn sie nicht bereitgestellt werden, werden vorhandene Attribute zurückgesetzt.

Header
roblox-entry-userids string

Kommasgetrennte Liste der Roblox-Benutzer-IDs, die mit dem Eintrag versehen sind. Wenn nicht bereitgestellt, werden vorhandene Benutzer-IDs gelöscht.

Header
content-md5 string

Die MD5-Prüfsumme der Inhalte, die in Base-64 kodiert ist. Siehe Inhalts-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 Versionsname des qualifizierenden Eintrags.

deleted boolean

Weist darauf hin, ob der Eintrag gelöscht wurde.

contentLength number

Die Länge des Inhalts.

createdTime string

Der Zeitstempel, in dem die Version im ISO-Zeitformat erstellt wurde.

objectCreatedTime string

Der Zeitstempel, in dem der Datenspeicher im ISO-Zeitformat erstellt 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 Grabsteinversion erstellt wird. Einträge werden nach 30 Tagen dauerhaft gelöscht.

Parameter

universeId number

Die Identifikator des Erlebnisses mit Datenlagern, auf die Sie zugreifen möchten.Du kannst die Universitäts-ID deiner Erfahrung auf dem Creator-Dashboard Zugriff.

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

scope string

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

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

Zunahme-Eintrag

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 diesem Betrag. Gibt den Eintrag und die Metadaten zurück.

Metadaten können in den Antwort-Headern wie gefolgte Profilegefunden werden:

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]

| Kopfzeile | Beschreibung | |---|---| | content-md5 | Die MD5-Prüfsumme der Inhalte, die in Base-64 codiert ist.Siehe Inhalt-MD5.| | roblox-entry-version | Die Version des zurückgegebenen Eintrags.| | roblox-entry-created-time | Die Zeit, in der der Eintrag erstellt wurde.| | roblox-entry-version-created-time | Die Zeit, in der diese spezielle Version erstellt wurde.| | roblox-entry-attributes | Attribute, die mit dem Eintrag versehen wurden.Serialisiertes Objekt.| | roblox-entry-userids | Kommaseparierte Liste der Roblox-Benutzer-IDs, die mit dem Eintrag versehen sind. |

Parameter

universeId number

Die Identifikator des Erlebnisses mit Datenlagern, auf die Sie zugreifen möchten.Du kannst die Universitäts-ID deiner Erfahrung auf dem Creator-Dashboard Zugriff.

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 standardmäßig global . Siehe Bereiche .

roblox-entry-attributes string

Attribute, die mit der neuen Version des Eintrags verbunden werden sollen. Serialisiert durch JSON-Kartenobjekte. Wenn sie nicht bereitgestellt werden, werden vorhandene Attribute zurückgesetzt.

Header
roblox-entry-userids string

Eine mit Kommata getrennte Liste von Roblox-Benutzer-IDs, mit denen der Eintrag gekennzeichnet ist. Wenn nicht bereitgestellt, 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
Gibt die neueste Version des Eintrags zurück, nachdem er erhöht wurde.
Gibt zurück ein(e) object

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

Erhalte die Eintrittsversion

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

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

Metadaten können in den Antwort-Headern wie gefolgte Profilegefunden werden:

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]

| Kopfzeile | Beschreibung | |---|---| | content-md5 | Die MD5-Prüfsumme der Inhalte, die in Base-64 codiert ist.Siehe Inhalt-MD5.| | roblox-entry-version | Die Version des zurückgegebenen Eintrags.| | roblox-entry-created-time | Die Zeit, in der der Eintrag erstellt wurde.| | roblox-entry-version-created-time | Die Zeit, in der diese spezielle Version erstellt wurde.| | roblox-entry-attributes | Attribute, die mit dem Eintrag versehen wurden.Serialisiertes Objekt.| | roblox-entry-userids | Kommaseparierte Liste der Roblox-Benutzer-IDs, die mit dem Eintrag versehen sind. |

Parameter

universeId number

Die Identifikator des Erlebnisses mit Datenlagern, auf die Sie zugreifen möchten.Du kannst die Universitäts-ID deiner Erfahrung auf dem Creator-Dashboard Zugriff.

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

versionId string

Die Version zum Überprüfen.

scope string

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

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
Eintrag erfolgreich abgerufen.
Gibt zurück ein(e) object

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: 5000 Anfoderungen pro 60 Sekunden pro IP-Adresse

Listen-Eintrag-Versionen

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

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

Parameter

universeId number

Die Identifikator des Erlebnisses mit Datenlagern, auf die Sie zugreifen möchten.Du kannst die Universitäts-ID deiner Erfahrung auf dem Creator-Dashboard Zugriff.

Path
Erforderlich
datastoreName string

Der Name des Store.

entryKey string

Der Schlüssel, der die Einheit identifiziert.

scope string

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

cursor string

Stellen Sie die nächste Reihe von Daten an (siehe Kursoren).

startTime string

Stellen Sie sicher, dass keine Versionen früher als dieser Zeitpunkt enthalten sind.

endTime string

Stellen Sie sicher, dass keine Versionen später als dieser Zeitpunkt enthalten sind.

sortOrder string

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

limit number

Die maximale Anzahl der zu zurücksendenden Artikel.Jeder Anruf liest nur eine Partition, so dass er weniger als den angegebenen Wert zurückgeben kann, wenn auf einer Partition keine Ziele mehr verfügbar sind.

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 Versionsname des qualifizierenden Eintrags.

deleted boolean

Weist darauf hin, ob der Eintrag gelöscht wurde.

contentLength number

Die Länge des Inhalts.

createdTime string

Der Zeitstempel, in dem die Version im ISO-Zeitformat erstellt wurde.

objectCreatedTime string

Der Zeitstempel, in dem der Datenspeicher im ISO-Zeitformat erstellt 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 Datenlagerspeicherobjekt mit seinem Namen und der erstellten Zeit.

Attribute

name string

Der Name deines Store.

createdTime string

Der Zeitstempel, in dem der Datenspeicher im ISO-Zeitformat erstellt wurde.

EntryVersion

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

Attribute

version string

Der Versionsname des qualifizierenden Eintrags.

deleted boolean

Weist darauf hin, ob der Eintrag gelöscht wurde.

contentLength number

Die Länge des Inhalts.

createdTime string

Der Zeitstempel, in dem die Version im ISO-Zeitformat erstellt wurde.

objectCreatedTime string

Der Zeitstempel, in dem der Datenspeicher im ISO-Zeitformat erstellt wurde.