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

DataStoreEntry

Ein Schlüssel-Wert-Eintrag in einem Datenstore.

RESSOURCEN-PFADE
/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

Attribute

pathstring

Der Ressourcenpfad des Datenspeicher-Eintrags.

Formen:

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

Nur Ausgabe

Der Zeitpunkt, an dem der Datenspeicher-Eintrag erstellt wurde. Dieser String ist als Zeitstempel formatiert.

revisionIdstring

Unveränderlich

Nur Ausgabe

Die Revisions-ID des Datenspeicher-Eintrags.

Eine neue Revision wird verwendet, wenn der Datenspeicher-Eintrag in irgendeiner Weise geändert wird.

Das Format ist eine beliebige Zeichenfolge. Beispiel: "foo".

revisionCreateTimestring

Nur Ausgabe

Der Zeitpunkt, an dem die Revision erstellt wurde. Dieser String ist als Zeitstempel formatiert.

stateEnum<string>

Nur Ausgabe

Der Zustand des Datenspeicher-Eintrags.

Mögliche Werte:

| Wert | Beschreibung | | --- | --- | | STATE_UNSPECIFIED | Der Standardwert.Dieser Wert wird verwendet, wenn der Zustand ausgelassen wird.| | AKTIV | Der Standardzustand eines neu erstellten Datenspeicher-Eintrags.| | GELÖSCHT | Der Datenlagereintrag wird als gelöscht markiert. An einem bestimmten Punkt in der Zukunft wird es dauerhaft gelöscht. |. Mögliche Werte:

etagstring

Diese Prüfsumme wird vom Server berechnet, basierend auf dem Wert anderer Felder, und kann auf Updates- und Löschanfragen (und möglicherweise auf bestimmte benutzerdefinierte Methoden) gesendet werden, um sicherzustellen, dass der Client einen aktuellen Wert hat, bevor er fortfährt.

valueJSON value

Der Wert des Eintrags.

Ein JSON-Wert kann null, boolean, string, number, array oder object sein.

idstring

Nur Ausgabe

Die Ressourcen-ID des Eintrags.

Dies entspricht dem letzten Segment des Ressourcenpfads und wird nur aus Gründen der Einfachheit bereitgestellt.

usersarray<string>

Benutzer, die mit dem Eintrag verbunden sind.

attributesobject

Eine willkürliche Reihe von Attributen, die mit dem Eintrag verbunden sind.

Basis-URL

https://apis.roblox.com

Die DataStoreEntry-Ressource

{
  "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

Listen Sie Datenlagerspeicher-Einträge
Beta

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

Gibt eine Liste von Einträgen aus einem Datenspeicher zurück.

Nur die Felder path und id werden ausgefüllt; verwende GetDataStoreEntry, um andere Felder abzurufen.

Geben Sie das Wildcard-Szenario ( - ) an, um Einträge aus allen Bereichen aufzulisten.

Bereiche

universe-datastores.objects:list

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

data_store_idstring

Erforderlich

Die ID des Datenspeichers.

Anfrageparameter

maxPageSizenumber

Die maximale Anzahl von Datenspeicher-Einträgen, die zurückzukehren sind.Der Dienst könnte weniger als diesen Wert zurückgeben.Wenn nicht spezifiziert, werden höchstens 10 Datenspeicher-Einträge zurückgegeben.Der maximale Wert ist 256 und höhere Werte werden auf 256 festgelegt.

pageTokenstring

Ein Seiten-Token, das von einer früheren Anruf erhalten wurde, um eine nachfolgende Seite abzurufen.

Wenn Seiten nummeriert werden, müssen alle anderen Parameter, die der nachfolgenden Anruf bereitgestellt hat, dem Anruf entsprechen, der das Seiten-Token bereitgestellt hat.

filterstring

Dieses Feld kann festgelegt werden, um die zurückgegebenen Ressourcen zu filtern.

Das Feld filter unterstützt einen sehr kleinen Teil von CEL:

Nur das Feld id wird unterstützt.
Nur die startsWith-Funktion ist verfügbar; keine anderen Betreiber oder Builds werden unterstützt.

Beispielfilter: id.startsWith("foo").

showDeletedboolean

Wenn es wahr ist, werden Ressourcen, die für eine anstehende Löschung markiert wurden, in die Ergebnisse einbezogen.

Rückmeldung

Eine Liste von DataStoreEntries in der übergeordneten Sammlung.

dataStoreEntriesarray<DataStoreEntry>

Die DataStoreEntries aus dem angegebenen DataStore oder DataStoreScope.

nextPageTokenstring

Ein Token, das du als pageToken-Parameter senden kannst, um die nächste Seite abzurufen. Wenn dieses Feld ausgelassen wird, gibt es keine nachfolgenden Seiten.

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}'

Rückmeldung

{
  "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

Erstellen von Datenlagereinträgen
Beta

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

Erstellt einen Eintrag mit der angegebenen ID und dem Wert.

Gibt eine 400-Schlechte-Anfrage zurück, wenn der Eintrag existiert.

Bereiche

universe-datastores.objects:create

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

data_store_idstring

Erforderlich

Die ID des Datenspeichers.

Anfrageparameter

idstring

Die ID, die für den Datenspeicher-Eintrag verwendet wird, der die letzte Komponente des Ressourcenpfads des Datenspeicher-Eintrags wird.

Dieser Wert sollte eine Zeichenfolge von 1 bis 50 sein. Wir empfehlen dringend, nur kleine Buchstaben, numerische Zahlen und Bindestriche zu verwenden.

Text anfordernDataStoreEntry

RückmeldungDataStoreEntry

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"
}'

Rückmeldung

{
  "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

Datenspeicher-Eintrag erhalten
Beta

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

Holen Sie sich den angegebenen Eintrag.

Um den Eintrag bei einer bestimmten Revision zu erhalten, füge @<revisionId> am Ende des Weges hinzu.

Zum Beispiel, um my-entry bei der Revisions-ID 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01 zu erhalten, verwende den Pfad /v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01.

Wenn deine Eintrags-ID ein oder mehrere @ Zeichen enthält und du die neueste Version erhalten möchtest, anstatt eine bestimmte Revision, füge dem Pfad das spezielle Revisions-ID @latest hinzu.Ansonsten wird der Segmentteil der Eintrags-ID nach dem letzten @ als Revisions-ID interpretiert.

Zum Beispiel, um die neueste Revision von my-entry zu erhalten, verwende den Pfad /v2/universes/1234/data-stores/5678/entries/my@entry@latest.

Um den Eintrag zu erhalten, der zu einem bestimmten Zeitpunkt aktuell war, füge @latest:<timestamp> am Ende des Weges hinzu, wo <timestamp> in RFC-3339 formatiert ist.Der angegebene Zeitpunkt muss nach der Unix-Ära (1/1/1970) liegen und nicht mehr als zehn Minuten in der Zukunft sein.

Zum Beispiel, um die Revision von my-entry, die am 12/2/2024 um 06:00 UTC aktuell war, verwende den Weg /v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z.

Bereiche

universe-datastores.objects:read

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

data_store_idstring

Erforderlich

Die ID des Datenspeichers.

entry_idstring

Erforderlich

Die Eintrags-ID.

RückmeldungDataStoreEntry

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}'

Rückmeldung

{
  "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

Datenspeicher-Eintrag löschen
Beta

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

Markiert den angegebenen Eintrag für Löschung.

Einträge werden nicht sofort gelöscht; stattdessen wird das Feld state auf DELETED gesetzt. Eine permanente Löschung erfolgt nach 30 Tagen.

Bei Erfolg gibt es 200 OK zurück. Wenn der Eintrag nicht existiert, gibt es 404 nicht gefunden zurück.

Bereiche

universe-datastores.objects:delete

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

data_store_idstring

Erforderlich

Die ID des Datenspeichers.

entry_idstring

Erforderlich

Die Eintrags-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

Datenspeicher-Eintrag aktualisieren
Beta

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

Aktualisiert den Wert, Attribute und Benutzer eines Eintrags.

Die Aktualisierung bestimmter Änderungen des Eintrags ist nicht unterstützt .Wenn du eine Revisions-ID im Pfad spezifizierst und ist, erstellt die Aktualisierungsanfrage stattdessen einen neuen Eintrag mit dem -Suffix als Teil des Schlüssels.

Teilaktualisierung ist nicht unterstützt .Wenn bei der Aktualisierung des Werts keine Attribute oder Benutzer bereitgestellt werden, werden sie gelöscht.Wert muss immer bereitgestellt werden, wenn ein Eintrag aktualisiert wird.

Bereiche

universe-datastores.objects:update

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

data_store_idstring

Erforderlich

Die ID des Datenspeichers.

entry_idstring

Erforderlich

Die Eintrags-ID.

Anfrageparameter

allowMissingboolean

Wenn auf true gesetzt und der Datenspeicher-Eintrag nicht gefunden wird, wird ein Datenspeicher-Eintrag erstellt.

Text anfordernDataStoreEntry

RückmeldungDataStoreEntry

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"
}'

Rückmeldung

{
  "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

Zunahme Datenlagerspeicher-Eintrag
Beta

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

Erhöht den Wert des angegebenen Eintrags. Sowohl der vorhandene Wert als auch die Erhöhungsmenge müssen Zahlen sein.

Wenn der Eintrag nicht existiert, erstellt er einen Eintrag mit dem angegebenen Wert.

Die Erhöhung bestimmter Änderungen des Eintrags ist nicht unterstützt .Wenn du eine Revisions-ID im Pfad spezifizierst, erstellt die Inkrementanforderung einen neuen Eintrag mit dem Präfix @<revisionId> als Teil des Schlüssels.

Bekanntes Problem: Der Wert kann über die gültige Range von Werten hinaus erhöht werden.Wenn dies passiert, wird der zurückgegebene Wert an die gültige Reichweite angepasst, aber der Backend kann den ursprünglichen Wert beibehalten.Dieses Verhalten wird aus Gründen der Rückwärtskompatibilität aufrechterhalten, kann sich aber in einer zukünftigen Version dieser API ändern.

Bereiche

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

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

data_store_idstring

Erforderlich

Die ID des Datenspeichers.

entry_idstring

Erforderlich

Die Eintrags-ID.

Text anfordern

amountnumber

Die Menge, mit der der Eintragswert erhöht wird. Sowohl der vorhandene Wert als auch die Erhöhungsmenge müssen Zahlen sein.

usersarray<string>

Benutzer, die mit dem Eintrag verbunden sind.

Wenn dies nicht bereitgestellt wird, werden vorhandene Benutzer-IDs gelöscht.

attributesobject

Eine willkürliche Reihe von Attributen, die mit dem Eintrag verbunden sind.

Wenn dies nicht bereitgestellt wird, werden vorhandene Attribute zurückgesetzt.

RückmeldungDataStoreEntry

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"
}'

Rückmeldung

{
  "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

Liste der Datenlagereingabe-Änderungen
Beta

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

Liste der Überarbeitungen des Datenspeicher-Eintrags.

Diese Methode gibt teilweise Datenbank-Einträge zurück.

Insbesondere werden nur die Felder , , , , und ausgefüllt.Beide Felder path und id werden einen @<version> Suffix haben.

Um den vollständigen Eintrag bei einer Revision zu erhalten, kannst du das bereitgestellte Feld path mit der Methode GetDataStoreEntry verwenden, d. h. GET /v1/universes/1234/data-stores/5678/entries/my-entry@<version>.

Bereiche

universe-datastores.versions:list

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

data_store_idstring

Erforderlich

Die ID des Datenspeichers.

entry_idstring

Erforderlich

Die Eintrags-ID.

Anfrageparameter

maxPageSizenumber

Die maximale Anzahl der Änderungen, die pro Seite zurückgegeben werden.

Der Dienst könnte weniger als die maximale Anzahl von Änderungen zurückgeben.Wenn nicht spezifiziert, werden höchstens 10 Änderungen zurückgegeben.Der maximale Wert beträgt 100 Werte und höhere Werte werden auf 100 festgelegt.

pageTokenstring

Ein Seiten-Token, das von einer früheren Anruf erhalten wurde, um eine nachfolgende Seite abzurufen.

Wenn Seiten nummeriert werden, müssen alle anderen Parameter, die der nachfolgenden Anruf bereitgestellt hat, dem Anruf entsprechen, der das Seiten-Token bereitgestellt hat.

filterstring

Unterstützt den folgenden Unterbereich von CEL:

Nur die &&, <= und >= Betreiber werden unterstützt.
Nur das Feld revision_create_time wird unterstützt.

Zum Beispiel:

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

Rückmeldung

Eine Liste der Änderungen eines Datenspeicher-Eintrags.

dataStoreEntriesarray<DataStoreEntry>

Die Änderungen des data_store_entry.

nextPageTokenstring

Ein Token, das du als pageToken-Parameter sendest, um die nächste Seite abzurufen. Wenn dieses Feld ausgelassen wird, gibt es keine nachfolgenden Seiten.

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}'

Rückmeldung

{
  "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

Attribute

DataStoreEntry

Listen Sie Datenlagerspeicher-EinträgeBeta

DataStoreEntry

Erstellen von DatenlagereinträgenBeta

DataStoreEntry

Datenspeicher-Eintrag erhaltenBeta

DataStoreEntry

Datenspeicher-Eintrag löschenBeta

DataStoreEntry

Datenspeicher-Eintrag aktualisierenBeta

DataStoreEntry

Zunahme Datenlagerspeicher-EintragBeta

DataStoreEntry

Liste der Datenlagereingabe-ÄnderungenBeta

Listen Sie Datenlagerspeicher-Einträge
Beta

Erstellen von Datenlagereinträgen
Beta

Datenspeicher-Eintrag erhalten
Beta

Datenspeicher-Eintrag löschen
Beta

Datenspeicher-Eintrag aktualisieren
Beta

Zunahme Datenlagerspeicher-Eintrag
Beta

Liste der Datenlagereingabe-Änderungen
Beta