Negozi di dati ordinati (Beta)

*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.

Questa pagina include la documentazione di riferimento per il lavoro con archivi dati ordinati. Per ulteriori informazioni sull'uso dell'API, vedi Handling API Requests for Data Stores e il Guida all'uso .

OrderedDataStores

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

Lista

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

Restituisce un elenco di entrate da un Negoziodi dati ordinato.

Parametri

universeId string

L'identificatore dell'esperienza con i dati ordinati che vuoi Accesso. Vedi ID dell'universo su come copiarlo su Dashboard del creatore .

Path
Necessario
orderedDataStore string

Il nome del Negoziodi dati target ordinato.

Path
Necessario
scope string

Il nome dello storage di dati. Vedi Scorpia .

Path
Necessario
max_page_size number

Il numero massimo di entrate da Riportare. Il servizio può restituire meno di questo valore. Il valore predefinito è 10 . Il valore massimo è 100 , e qualsiasi input oltre 100 è costretto a 100 .

page_token string

Un token di pagina ricevuto da un precedente List chiamata. Fornire questo per recuperare la pagina successiva. Quando pagare, tutti gli altri parametri forniti a List devono corrispondere alla chiamata che fornisce il token di pagina.

order_by string

La direzione di enumerazione. L'ordine predefinito è ascendente. Inserisci un suffice desc per scendere.

filter string

La gamma di valori di qualificazione delle entrate da Riportare. Vedi Filters .

Richiesta

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

Risposta

200 - OK
Ok
Ritorna un(a) object
entries array<object>

Le voci dallo specifico campo di visione.

nextPageToken string

Un token, che può essere inviato come page_token per recuperare la prossima pagina. Se questo campo viene omesso, non ci sono pagine successive.

Crea

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

Crea una nuova entry con il valore contenuto fornito.

Parametri

universeId string

L'identificatore dell'esperienza con i dati ordinati che vuoi Accesso. Vedi ID dell'universo su come copiarlo su Dashboard del creatore .

Path
Necessario
orderedDataStore string

Il nome del Negoziodi dati ordinato.

Path
Necessario
scope string

Il nome dello storage di dati. Vedi Scorpia .

Path
Necessario
id string

Il nome dell'elemento.

Necessario
CreateEntryRequest

Crea una nuova entry con il valore fornito.

Body
Necessario

Richiesta

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

Risposta

200 - OK
Ok
Ritorna un(a) object
id string

Il nome dell'elemento

path string

Il percorso risorsa della Richiesta.

value number

Il valore dell'elemento.

Ottieni

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

Ottiene e restituisce l'elemento specificato.

Parametri

universeId string

L'identificatore dell'esperienza con i dati ordinati che vuoi Accesso. Vedi ID dell'universo su come copiarlo su Dashboard del creatore .

Path
Necessario
orderedDataStore string

Il nome del Negoziodi dati ordinato.

Path
Necessario
scope string

Il nome dello storage di dati. Vedi Scorpia .

Path
Necessario
entry string

L'ID dell'elemento.

Path
Necessario

Richiesta

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

Risposta

200 - OK
Ok
Ritorna un(a) object
id string

Il nome dell'elemento

path string

Il percorso risorsa della Richiesta.

value number

Il valore dell'elemento.

Elimina

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

Elimina l'elemento specificato.

Parametri

universeId string

L'identificatore dell'esperienza con i dati ordinati che vuoi Accesso. Vedi ID dell'universo su come copiarlo su Dashboard del creatore .

Path
Necessario
orderedDataStore string

Il nome del Negoziodi dati ordinato.

Path
Necessario
scope string

Il nome dello storage di dati. Vedi Scorpia .

Path
Necessario
entry string

L'ID dell'elemento.

Path
Necessario

Richiesta

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

Risposta

Aggiornamento

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

Aggiorna un valore di ingresso e restituisce l'ingresso aggiornato.

Parametri

universeIdId string

L'identificatore dell'esperienza con i dati ordinati che vuoi Accesso. Vedi ID dell'universo su come copiarlo su Dashboard del creatore .

Path
Necessario
orderedDataStore string

Il nome del Negoziodi dati ordinato.

Path
Necessario
scope string

Il nome dello storage di dati. Vedi Scorpia .

Path
Necessario
entry string

L'ID dell'elemento.

Path
Necessario
UpdateEntryRequest

Aggiorna l'elemento fornito con un nuovo valore.

Body
Necessario
allow_missing boolean

La bandiera per consentire la creazione di un'entry se l'entry non esiste. Vedi Consenti bandiere mancanti .

Richiesta

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

Risposta

200 - OK
Ok
Ritorna un(a) object
id string

Il nome dell'elemento

path string

Il percorso risorsa della Richiesta.

value number

Il valore dell'elemento.

Incremento

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

Aumenta il valore della chiave di importo fornito e restituisce l'elemento aggiornato.

Problema conosciuto: I valori di ingresso possono incrementare oltre la gamma valida e questo può persistere nel backend. I valori restituiti si agganceranno alla gamma valida.

Parametri

universeId string

L'identificatore dell'esperienza con i dati ordinati che vuoi Accesso. Vedi ID dell'universo su come copiarlo su Dashboard del creatore .

Path
Necessario
orderedDataStore string

Il nome del Negoziodi dati ordinato.

Path
Necessario
scope string

Il nome dello storage di dati. Vedi Scorpia .

Path
Necessario
entry string

L'ID dell'elemento.

Path
Necessario
incrementEntryRequest

Aumenta il valore dell'elemento.

Body
Necessario

Richiesta

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

Risposta

200 - OK
Ok
Ritorna un(a) object
id string

Il nome dell'elemento

path string

Il percorso risorsa della Richiesta.

value number

Il valore dell'elemento.

Oggetti

Gli oggetti seguenti descrivono i payloads accettati o restituiti. Per maggiori informazioni su quando vengono utilizzati questi oggetti, consultare ogni singolo endpoint.

CreateEntryRequest

Crea una nuova entry con il valore fornito.

Attributi

value number

Il valore per impostare la nuova voce. Se il valore di input supera il valore massimo supportato da int64, che è 9.223.372,036,854,775,807, la richiesta fallisce con un errore 400 Bad Request.

Entry

Rappresenta un'entrata.

Attributi

id string

Il nome dell'elemento

path string

Il percorso risorsa della Richiesta.

value number

Il valore dell'elemento.

IncrementEntryRequest

Aumenta il valore dell'elemento.

Attributi

amount number

La quantità da incrementare valore di ingresso. Se il valore di input supera il valore massimo supportato da int64, che è 9,223,372,036,854,775,807, la richiesta fallisce con un errore 400 Bad Request.

ListEntriesResponse

Una lista di Entries nella Collezionipadre.

Attributi

entries array<object>

Le voci dallo specifico campo di visione.

nextPageToken string

Un token, che può essere inviato come page_token per recuperare la prossima pagina. Se questo campo viene omesso, non ci sono pagine successive.

UpdateEntryRequest

Aggiorna l'elemento fornito con un nuovo valore.

Attributi

value number

Il valore per aggiornare l'elemento. Se il valore di input supera il valore massimo supportato da int64, che è 9,223,372,036,854,775,807, la richiesta fallisce con un errore 400 Bad Request.