Bestellte Datenspeicher (Beta)

*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 bestellten Datenlagern.Für weitere Informationen zur Verwendung der API siehe API-Anfragen für Datenbanken bearbeiten und den Nutzungsleitfaden.

OrderedDataStores

https://apis.roblox.com/ordered-data-stores

Zur Liste

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Gibt eine Liste von Einträgen aus einem bestellten Storezurück.

Parameter

universeId string

Die Identifikator des Erlebnisses mit bestellten Datenlagern, auf die Sie Zugriffmöchten.Siehe Universitäts-ID auf, wie sie auf Creator-Dashboard kopiert werden kann.

Path
Erforderlich
orderedDataStore string

Der Name des angeforderten Store.

Path
Erforderlich
scope string

Der Name des Datenspeicherbereichs. Siehe Bereiche.

Path
Erforderlich
max_page_size number

Die maximale Anzahl von Einträgen, die zurückzukehren sind.Der Dienst kann weniger als diesen Wert zurückgeben.Der Standardwert ist 10.Der maximale Wert ist 100 , und jede Eingabe über 100 wird gezwungen zu 100 .

page_token string

Ein Seiten-Token, das von einem früheren List Anruf empfangen wurde.Geben Sie dies an, um die nachfolgende Seite abzurufen.Wenn Seiten nummeriert werden, müssen alle anderen Parameter, die an List bereitgestellt wurden, mit dem Anruf übereinstimmen, der die Seiten-Token bereitstellt.

order_by string

Die Enumerationsrichtung. Die Sortierung erfolgt standardmäßig aufsteigend. Geben Sie einen desc -Suffix für die Absteigerung ein.

filter string

Die Reihe von qualifizierenden Werten von Einträgen, die zurückgebensind. Siehe Filter.

Anfrage

curl

curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \
--header 'x-api-key: <insert-api-key>'

Rückmeldung

200 - OK
OK
Gibt zurück ein(e) object
entries array<object>

Die Einträge aus dem angegebenen Bereich.

nextPageToken string

Ein Token, das als page_token an einen Server gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld ausgelassen wird, gibt es keine nachfolgenden Seiten.

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.

  • Lesen

Erstellen

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Erstellt einen neuen Eintrag mit dem angegebenen Inhaltswert.

Parameter

universeId string

Die Identifikator des Erlebnisses mit bestellten Datenlagern, auf die Sie Zugriffmöchten.Siehe Universitäts-ID auf, wie sie auf Creator-Dashboard kopiert werden kann.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Datenspeicherbereichs. Siehe Bereiche.

Path
Erforderlich
id string

Der Name des Eintrags.

Erforderlich

Anfrage

curl

curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": <long>
}'

Rückmeldung

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

Der Name des Eintrags

path string

Der Ressourcenpfad der Anfrage.

value number

Der Wert des Eintrags.

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.

  • Schreiben

Abrufen

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Holt und gibt den angegebenen Eintrag zurück.

Parameter

universeId string

Die Identifikator des Erlebnisses mit bestellten Datenlagern, auf die Sie Zugriffmöchten.Siehe Universitäts-ID auf, wie sie auf Creator-Dashboard kopiert werden kann.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Datenspeicherbereichs. Siehe Bereiche.

Path
Erforderlich
entry string

Die Eintrags-ID.

Path
Erforderlich

Anfrage

curl

curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>'

Rückmeldung

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

Der Name des Eintrags

path string

Der Ressourcenpfad der Anfrage.

value number

Der Wert des Eintrags.

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.

  • Lesen

Löschen

DELETE /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Löscht den angegebenen Eintrag.

Parameter

universeId string

Die Identifikator des Erlebnisses mit bestellten Datenlagern, auf die Sie Zugriffmöchten.Siehe Universitäts-ID auf, wie sie auf Creator-Dashboard kopiert werden kann.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Datenspeicherbereichs. Siehe Bereiche.

Path
Erforderlich
entry string

Die Eintrags-ID.

Path
Erforderlich

Anfrage

curl

curl --location --request DELETE 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>'

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.

  • Schreiben

Update

PATCH /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Aktualisiert einen Eintragswert und gibt den aktualisierten Eintrag zurück.

Parameter

universeId string

Die Identifikator des Erlebnisses mit bestellten Datenlagern, auf die Sie Zugriffmöchten.Siehe Universitäts-ID auf, wie sie auf Creator-Dashboard kopiert werden kann.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Datenspeicherbereichs. Siehe Bereiche.

Path
Erforderlich
entry string

Die Eintrags-ID.

Path
Erforderlich
allow_missing boolean

Die Flagge, um die Erstellung eines Eintrags zu ermöglichen, wenn der Eintrag nicht existiert. Siehe Fehlende Flags zulassen.

Anfrage

curl

curl --location --request PATCH 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": <long>
}'

Rückmeldung

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

Der Name des Eintrags

path string

Der Ressourcenpfad der Anfrage.

value number

Der Wert des Eintrags.

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.

  • Schreiben

Zunahme

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment

Erhöht den Wert des Schlüssels um den angegebenen Betrag und gibt den aktualisierten Eintrag zurück.

Bekanntes Problem: Eintrittswerte können über die gültige Reichweite hinaus zunehmen, und dies kann im Backend bestehen bleiben. Zurückgegebene Werte werden sich an die gültige Reichweite halten.

Parameter

universeId string

Die Identifikator des Erlebnisses mit bestellten Datenlagern, auf die Sie Zugriffmöchten.Siehe Universitäts-ID auf, wie sie auf Creator-Dashboard kopiert werden kann.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Datenspeicherbereichs. Siehe Bereiche.

Path
Erforderlich
entry string

Die Eintrags-ID.

Path
Erforderlich

Anfrage

curl

curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": <long>
}'

Rückmeldung

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

Der Name des Eintrags

path string

Der Ressourcenpfad der Anfrage.

value number

Der Wert des Eintrags.

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.

  • Schreiben

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.

CreateEntryRequest

Erstellt einen neuen Eintrag mit dem angegebenen Wert.

Attribute

value number

Der Wert, um den neuen Eintrag zu setzen.Wenn der Eingabewert den maximalen Wert von int64 überschreitet, der 9,223,372,036,854,775,807 beträgt, scheitert die Anfrage mit einem 400-Fehler "Bad Request".

Entry

Repräsentiert einen Eintrag.

Attribute

id string

Der Name des Eintrags

path string

Der Ressourcenpfad der Anfrage.

value number

Der Wert des Eintrags.

IncrementEntryRequest

Erhöht den Eingabewert.

Attribute

amount number

Die Menge, die um den Eintragswert zu erhöhen.Wenn der Eingabewert den maximalen Wert von int64 überschreitet, der 9,223,372,036,854,775,807 beträgt, scheitert die Anfrage mit einem 400-Fehler "Bad Request".

ListEntriesResponse

Eine Liste von Einträgen in der übergeordneten Sammlungen.

Attribute

entries array<object>

Die Einträge aus dem angegebenen Bereich.

nextPageToken string

Ein Token, das als page_token an einen Server gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld ausgelassen wird, gibt es keine nachfolgenden Seiten.

UpdateEntryRequest

Aktualisiert den Eintrag mit einem neuen Wert.

Attribute

value number

Der Wert, um den Eintrag zu aktualisieren.Wenn der Eingabewert den maximalen Wert von int64 überschreitet, der 9,223,372,036,854,775,807 beträgt, scheitert die Anfrage mit einem 400-Fehler "Bad Request".