Magazzini 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 lavorare con store di dati ordinati.Per ulteriori informazioni sull'utilizzo dell'API, vedi Gestisci richieste API per archivi di dati e la 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 voci da un data Negozioordinato.

Parametri

universeId string

L'identificatore dell'esperienza con store di dati ordinati a cui vuoi Accesso.Vedi ID Universo su come copiarlo su Dashboard Creatore.

Path
Necessario
orderedDataStore string

Il nome del data Negozioordinato target.

Path
Necessario
scope string

Il nome dello scope del data store. Vedi Scope.

Path
Necessario
max_page_size number

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

page_token string

Un token di pagina ricevuto da una chiamata precedente List .Fornisci questo per recuperare la pagina successiva.Durante la paginazione, tutti gli altri parametri forniti a List devono corrispondere alla chiamata che fornisce il token della pagina.

order_by string

La direzione di enumerazione. L'ordine predefinito è ascendente. Inserisci un suffisso desc per discesa.

filter string

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

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 dalla scala specificata.

nextPageToken string

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

Permessi Necessari

Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.

  • Leggi

Crea

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

Crea una nuova voce con il valore del contenuto fornito.

Parametri

universeId string

L'identificatore dell'esperienza con store di dati ordinati a cui vuoi Accesso.Vedi ID Universo su come copiarlo su Dashboard Creatore.

Path
Necessario
orderedDataStore string

Il nome del data Negozioordinato.

Path
Necessario
scope string

Il nome dello scope del data store. Vedi Scope.

Path
Necessario
id string

Il nome dell'elemento.

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

path string

Il percorso delle risorse della Richiesta.

value number

Il valore dell'entrata.

Permessi Necessari

Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.

  • Scrivi

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 store di dati ordinati a cui vuoi Accesso.Vedi ID Universo su come copiarlo su Dashboard Creatore.

Path
Necessario
orderedDataStore string

Il nome del data Negozioordinato.

Path
Necessario
scope string

Il nome dello scope del data store. Vedi Scope.

Path
Necessario
entry string

L'ID di ingresso.

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

path string

Il percorso delle risorse della Richiesta.

value number

Il valore dell'entrata.

Permessi Necessari

Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.

  • Leggi

Elimina

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

Elimina l'elemento specificato.

Parametri

universeId string

L'identificatore dell'esperienza con store di dati ordinati a cui vuoi Accesso.Vedi ID Universo su come copiarlo su Dashboard Creatore.

Path
Necessario
orderedDataStore string

Il nome del data Negozioordinato.

Path
Necessario
scope string

Il nome dello scope del data store. Vedi Scope.

Path
Necessario
entry string

L'ID di ingresso.

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

Permessi Necessari

Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.

  • Scrivi

Aggiorna

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

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

Parametri

universeId string

L'identificatore dell'esperienza con store di dati ordinati a cui vuoi Accesso.Vedi ID Universo su come copiarlo su Dashboard Creatore.

Path
Necessario
orderedDataStore string

Il nome del data Negozioordinato.

Path
Necessario
scope string

Il nome dello scope del data store. Vedi Scope.

Path
Necessario
entry string

L'ID di ingresso.

Path
Necessario
allow_missing boolean

La bandiera per consentire la creazione di un'entrata se l'entrata 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'entrata

path string

Il percorso delle risorse della Richiesta.

value number

Il valore dell'entrata.

Permessi Necessari

Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.

  • Scrivi

Incremento

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

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

Problema noto: i valori di ingresso possono incrementare oltre il raggio valido e questo può persistere nel backend. I valori restituiti si agganceranno al raggio valido.

Parametri

universeId string

L'identificatore dell'esperienza con store di dati ordinati a cui vuoi Accesso.Vedi ID Universo su come copiarlo su Dashboard Creatore.

Path
Necessario
orderedDataStore string

Il nome del data Negozioordinato.

Path
Necessario
scope string

Il nome dello scope del data store. Vedi Scope.

Path
Necessario
entry string

L'ID di ingresso.

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

path string

Il percorso delle risorse della Richiesta.

value number

Il valore dell'entrata.

Permessi Necessari

Le seguenti autorizzazioni chiave API sono necessarie per chiamare questo endpoint. Per ulteriori informazioni sulla generazione di chiavi appropriate, vedi Gestisci chiavi API.

  • Scrivi

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 entry.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'entrata

path string

Il percorso delle risorse della Richiesta.

value number

Il valore dell'entrata.

IncrementEntryRequest

Aumenta il valore di ingresso.

Attributi

amount number

L'importo da aumentare con il 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

Un elenco di voci nella Collezionipadre.

Attributi

entries array<object>

Le voci dalla scala specificata.

nextPageToken string

Un token, che può essere inviato come page_token per recuperare la pagina successiva. 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.