Bestellte Daten-Stores (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 Referenzdokumente für das Arbeiten mit bestellten Daten-Stores. Weitere Informationen zum Verwenden der API finden Sie unter Verarbeiten von API-Anfragen für Daten-Stores und dem Leitfaden für die Verwendung.

OrderedDataStores

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

Liste

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

Gibt eine Liste von Einreichungen aus einem bestellten Daten-Store zurück.

Parameter

universeId string

Die Identifikator der Erfahrung mit bestellten Daten, die Sie Zugriffmöchten. Siehe Universum-ID auf, wie Sie es auf Creator-Dashboard kopieren.

Path
Erforderlich
orderedDataStore string

Der Name des Ziels, das die bestellte Storespeichert.

Path
Erforderlich
scope string

Der Name des Daten-Store-Ziels. Siehe Szenen.

Path
Erforderlich
max_page_size number

Die maximale Anzahl von Einreichungen, die zurückgegeben werden. Der Dienst kann weniger als diesen Wert zurückgeben. Der Standardwert ist 10 . Der maximale Wert ist 100 , und jede Eingabe über 100 ist auf 100 gezwungen.

page_token string

Ein Seiten-Token, der von einer früheren List-Anrufe erhalten. Stellen Sie dies bereit, um die nächste Seite abzurufen. Wenn Sie pagieren, müssen alle anderen von der Anrufe bereitgestellten Werte mit der Anrufe, die die Seiten-Token bereitstellen, übereinstimmen.

order_by string

Die Reihenfolge der Liste. Die Standardreihenfolge ist aufsteigend. Gib eine desc Präfix für eine absteigende Reihenfolge ein.

filter string

Die Reihe der qualifizierenden Werte, 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 Einreichungen aus dem angegebenen Scope.

nextPageToken string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite zu erhalten. Wenn dieses Feld auslassen wird, gibt es keine nächsten Seiten.

Erstellen

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

Erstellt einen neuen Eintrag mit dem bereitgestellten Inhalt.

Parameter

universeId string

Die Identifikator der Erfahrung mit bestellten Daten, die Sie Zugriffmöchten. Siehe Universum-ID auf, wie Sie es auf Creator-Dashboard kopieren.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Daten-Store-Ziels. Siehe Szenen.

Path
Erforderlich
id string

Der Name des Einreichs.

Erforderlich
CreateEntryRequest

Erstellt einen neuen Eintrag mit dem bereitgestellten Wert.

Body
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 Ressourcen-Weg der Anfrage.

value number

Der Wert des Eintrags.

Erhalten

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

Bietet und gibt die angegebene Einheit zurück.

Parameter

universeId string

Die Identifikator der Erfahrung mit bestellten Daten, die Sie Zugriffmöchten. Siehe Universum-ID auf, wie Sie es auf Creator-Dashboard kopieren.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Daten-Store-Ziels. Siehe Szenen.

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 Ressourcen-Weg der Anfrage.

value number

Der Wert des Eintrags.

Löschen

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

Löscht den angegebenen Eintrag.

Parameter

universeId string

Die Identifikator der Erfahrung mit bestellten Daten, die Sie Zugriffmöchten. Siehe Universum-ID auf, wie Sie es auf Creator-Dashboard kopieren.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Daten-Store-Ziels. Siehe Szenen.

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

Aktualisieren

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

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

Parameter

universeIdId string

Die Identifikator der Erfahrung mit bestellten Daten, die Sie Zugriffmöchten. Siehe Universum-ID auf, wie Sie es auf Creator-Dashboard kopieren.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Daten-Store-Ziels. Siehe Szenen.

Path
Erforderlich
entry string

Die Eintrags-ID.

Path
Erforderlich
UpdateEntryRequest

Aktualisiert den Eintrag mit einem neuen Wert.

Body
Erforderlich
allow_missing boolean

Die Flagge, die erlaubt, eine Eintrag zu erstellen, wenn der Eintrag nicht existiert. Siehe Erlaube verbleibende Flaggen.

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 Ressourcen-Weg der Anfrage.

value number

Der Wert des Eintrags.

Erhöhung

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

Erhöht den Wert des Schlüssels um die angegebene Menge und gibt die aktualisierte Eintrag zurück.

Bekanntes Problem: Eintrittswerte können die gültige Reichweite überschreiten und dies kann im Backend bestehen. Rückgabewerte werden auf die gültige Reichweite geklampft.

Parameter

universeId string

Die Identifikator der Erfahrung mit bestellten Daten, die Sie Zugriffmöchten. Siehe Universum-ID auf, wie Sie es auf Creator-Dashboard kopieren.

Path
Erforderlich
orderedDataStore string

Der Name des bestellten Store.

Path
Erforderlich
scope string

Der Name des Daten-Store-Ziels. Siehe Szenen.

Path
Erforderlich
entry string

Die Eintrags-ID.

Path
Erforderlich
incrementEntryRequest

Erhöht den Eintragswert.

Body
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 Ressourcen-Weg der Anfrage.

value number

Der Wert des Eintrags.

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 bereitgestellten Wert.

Attribute

value number

Der Wert, der den neuen Eintrag festgelegt. Wenn der Eingabewert den maximalen Wert von int64 überschreitet, der 9,223,372,036,854,775,807, der Anfrage mit einem 400 Bad Request-Fehler fehlschlägt.

Entry

Repräsentiert eine Einheit.

Attribute

id string

Der Name des Eintrags

path string

Der Ressourcen-Weg der Anfrage.

value number

Der Wert des Eintrags.

IncrementEntryRequest

Erhöht den Eintragswert.

Attribute

amount number

Die Menge, die durch den Eintragswert erhöht wird. Wenn der Eingabewert den maximalen Wert von int64, der 9.223.372,036,854,775,807,854 überschreitet, ist die Anfrage mit einem 400-Bad Request-Fehler fehlgeschlagen.

ListEntriesResponse

Eine Liste der Einreichungen in der übergeordneten Sammlungen.

Attribute

entries array<object>

Die Einreichungen aus dem angegebenen Scope.

nextPageToken string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite zu erhalten. Wenn dieses Feld auslassen wird, gibt es keine nächsten Seiten.

UpdateEntryRequest

Aktualisiert den Eintrag mit einem neuen Wert.

Attribute

value number

Der Wert, der den Eintrag aktualisiert. Wenn der Eingabe-Wert den maximalen Wert von int64 überschreitet, der 9.223.372,036,854,775,807, die Anfrage mit einem 400-Bad Request-Fehler fehlschlägt.