Store di dati standard

*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 i normali store di dati. Per ulteriori informazioni sull'uso dell'API, vedi Handling API Requests for Data Stores e il Guida all'uso .

Datastores

https://apis.roblox.com/datastores

I seguenti endpoint sono disponibili nei percorsi relativi all'URL di base.

Elenca Negozi di Dati

GET /v1/universes/{universeId}/standard-datastores

Restituisce un elenco dei magazzini di dati di un'esperienza.

Parametri

universeId number

L'identificatore dell'esperienza con i dati che vuoi Accesso. Puoi copiare l'ID dell'Universo della tua esperienza sul Creator Dashboard .

Path
Necessario
cursor string

Fornire per richiedere il prossimo set di dati. Vedi Cursori .

limit number

Il numero massimo di oggetti da Riportare. Ogni chiamata legge solo una partizione, quindi può restituire meno del valore specificato quando esaurisce gli obiettivi su una partizione.

prefix string

Fornire per restituire solo i negozi di dati con questo prefisso.

Richiesta

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "prefix=Player" \

-d "limit=5"

Risposta

200 - OK
Ritorna un(a) object
application/json
{

  "datastores": [

    {

      "name": "PlayerInventory",

      "createdTime": "2022-02-18T22:38:59.9244932Z"

    },

    {

      "name": "PlayerExperience",

      "createdTime": "2022-02-18T23:00:10.4773508Z"

    },

    {

      "name": "PlayerWeapons",

      "createdTime": "2022-02-18T23:00:22.3725681Z"

    },

    {

      "name": "PlayerArmor",

      "createdTime": "2022-02-18T22:59:33.8472882Z"

    },

    {

      "name": "PlayerHP",

      "createdTime": "2022-02-18T22:58:47.6904028Z"

    }

  ],

  "nextPageCursor": "..."

}
data array<object>

Un insieme di dati memorizzati nell'esperienza target.

nextPageCursor string

Indica che ci sono più dati disponibili nel Impostaredi risultati richiesto. Vedi Cursori .

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.

  • Elenca i datastore

Entries

https://apis.roblox.com/datastores

I seguenti endpoint sono disponibili nei percorsi relativi all'URL di base.

Elenco delle voci

GET /v1/universes/{universeId}/standard-datastores/datastore/entries

Restituisce un elenco di chiavi di accesso all'interno di un Negoziodi dati.

Parametri

universeId number

L'identificatore dell'esperienza con i dati che vuoi Accesso. Puoi copiare l'ID dell'Universo della tua esperienza sul Creator Dashboard .

Path
Necessario
datastoreName string

Il nome del Negoziodi dati.

scope string

Il valore è global per impostazione predefinita. Vedi Scopi .

allScopes boolean

Imposta su true per restituire le chiavi da tutti gli scopi.

prefix string

Fornisci per restituire solo chiavi con questo prefisso.

cursor string

Fornire per richiedere il prossimo set di dati. Vedi Cursori .

limit number

Il numero massimo di oggetti da Riportare. Ogni chiamata legge solo una partizione, quindi può restituire meno del valore specificato quando esaurisce gli obiettivi su una partizione.

Richiesta

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "prefix=" \

-d "limit=5"

Risposta

200 - OK
Ritorna un(a) object
application/json
{

  "keys": [

    {

      "key": "269323"

    }

  ],

  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"

}
keys array<string>

Un insieme di chiavi di accesso all'Negoziodei dati target.

nextPageCursor string

Indica che ci sono più dati disponibili nel Impostaredi risultati richiesto. Vedi Cursori .

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.

  • Elenco chiavi di accesso

Ottieni l'ingresso

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Restituisce il valore e i metadati associati a un'immagine.

Parametri

universeId number

L'identificatore dell'esperienza con i dati che vuoi Accesso. Puoi copiare l'ID dell'Universo della tua esperienza sul Creator Dashboard .

Path
Necessario
datastoreName string

Il nome del Negoziodi dati.

entryKey string

La chiave che identifica l'elemento.

scope string

Il valore è global per impostazione predefinita. Vedi Scopi .

Richiesta

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323"

Risposta

200 - OK
Restituisce il contenuto utente dell'elemento nel corpo della risposta.
Ritorna un(a) object
application/json
{

  "content-md5": "zuYxEhwuySMvOi8CitXImw==",

  "roblox-entry-version": "08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01",

  "roblox-entry-created-time": "2022-02-02T23:30:06.5388799+00:00",

  "roblox-entry-version-created-time": "2022-02-02T23:30:06.5388799+00:00",

  "roblox-entry-userids": [ 1, 2, 3 ]

}
roblox-entry-created-time string

Il tempo in cui è stata creata la voce.

last-modified string

Il tempo in cui questa particolare versione è stata creata.

roblox-entry-version string

La versione dell'elemento restituito.

roblox-entry-attributes string

Attributi associati alla voce restituita. Obiettivo di mappa JSON oggetto.

roblox-entry-userids array<number>

Lista separata dei ID utente Roblox contrassegnati con l'elemento.

content-md5 string

Il MD5 encodato base-64 del contenuto. Vedi Contenuto-MD5 .

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 elemento

Imposta entrata

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Imposta il valore, i metadati e gli ID utente associati a un'entry.

Parametri

universeId number

L'identificatore dell'esperienza con i dati che vuoi Accesso. Puoi copiare l'ID dell'Universo della tua esperienza sul Creator Dashboard .

Path
Necessario
datastoreName string

Il nome del Negoziodi dati.

entryKey string

La chiave che identifica l'elemento.

matchVersion string

Fornire per aggiornare solo se la versione attuale corrisponde a questo.

exclusiveCreate boolean

Crea l'elemento solo se non esiste.

scope string

Il valore è global per impostazione predefinita. Vedi Scopi .

roblox-entry-attributes string

Attributi associati alla nuova versione dell'elemento. Serializzati dagli oggetti mapa JSON. Se non fornito, gli attributi esistenti vengono cancellati.

Header
roblox-entry-userids string

Lista separata dei ID utente Roblox contrassegnata dall'elemento. Se non fornito, gli ID utente esistenti vengono cancellati.

Header
content-md5 string

Il MD5 encodato base-64 del contenuto. Vedi Contenuto-MD5 .

Header

Richiesta

curl
curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323" \

--header "x-api-key: ${API_KEY}" \

--header "content-md5: IGPBYI1uC6+AJJxC4r5YBA==" \

--header "content-type: application/json" \

--header "roblox-entry-userids: [269323]" \

--header "roblox-entry-attributes: {}" \

--d "value"

Risposta

200 - OK
Ritorna un(a) object
version string

Il nome della versione dell'ingresso di qualificazione.

deleted boolean

Indica se l'elemento è stato eliminato.

contentLength number

La lunghezza del contenuto.

createdTime string

L'ora di creazione della versione nell'ora del formato ISO.

objectCreatedTime string

L'ora di creazione del data store nell'ora del formato ISO.

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.

  • Crea elemento

  • Aggiorna elemento

Elimina elemento

DELETE /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Marca l'elemento come eliminato creando una versione tombstone. Gli elementi vengono permanentemente eliminati dopo 30 giorni.

Parametri

universeId number

L'identificatore dell'esperienza con i dati che vuoi Accesso. Puoi copiare l'ID dell'Universo della tua esperienza sul Creator Dashboard .

Path
Necessario
datastoreName string

Il nome del Negoziodi dati.

entryKey string

La chiave che identifica l'elemento.

scope string

Il valore è global per impostazione predefinita. Vedi Scopi .

Richiesta

curl
curl --include --location --request DELETE "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323"

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.

  • Elimina voce

Incrementa l'ingresso

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment

Aumenta il valore per un'entry by un importo specificato, o crea una nuova entry con quel importo.

Parametri

universeId number

L'identificatore dell'esperienza con i dati che vuoi Accesso. Puoi copiare l'ID dell'Universo della tua esperienza sul Creator Dashboard .

Path
Necessario
datastoreName string

Il nome del Negoziodi dati.

entryKey string

La chiave che identifica l'elemento.

incrementBy number

La quantità per cui l'entry deve essere incrementata, o il valore di partenza se non esiste.

scope string

Il valore è global per impostazione predefinita. Vedi Scopi .

roblox-entry-attributes string

Attributi associati alla nuova versione dell'elemento. Serializzati dagli oggetti mapa JSON. Se non fornito, gli attributi esistenti vengono cancellati.

Header
roblox-entry-userids string

Una lista separata da virgola di ID utente Roblox con cui l'elemento è contrassegnato. Se non viene fornito, gli ID utente esistenti vengono cancellati.

Header

Richiesta

curl
curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/increment" \

--header "x-api-key: ${API_KEY}" \

--header 'content-length: 0' \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "incrementBy=3"

Risposta

200 - OK
Restituisce la versione più recente dell'elemento dopo che è stata incrementata.
Ritorna un(a) object
application/json
{

  "content-md5": "K4phWUsfTE2wkCqKOVztkw==",

  "roblox-entry-version": "08D9E6A3F2188CFF.0000000009.08D9E6DF74AC5F42.01",

  "roblox-entry-created-time": "2022-02-02T23:30:06.5388799+00:00",

  "roblox-entry-version-created-time": "2022-02-03T06:36:05.9184962+00:00",

  "roblox-entry-userids": []

}
roblox-entry-created-time string

Il tempo in cui è stata creata la voce.

last-modified string

Il tempo in cui questa particolare versione è stata creata.

roblox-entry-version string

La versione dell'elemento restituito.

roblox-entry-attributes string

Attributi associati alla voce restituita. Obiettivo di mappa JSON oggetto.

roblox-entry-userids array<number>

Lista separata dei ID utente Roblox contrassegnati con l'elemento.

content-md5 string

Il MD5 encodato base-64 del contenuto. Vedi Contenuto-MD5 .

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.

  • Crea elemento

  • Aggiorna elemento

Ottieni la versione di ingresso

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version

Restituisce il valore e i metadati di una versione specifica di un'entry.

Parametri

universeId number

L'identificatore dell'esperienza con i dati che vuoi Accesso. Puoi copiare l'ID dell'Universo della tua esperienza sul Creator Dashboard .

Path
Necessario
datastoreName string

Il nome del Negoziodi dati.

entryKey string

La chiave che identifica l'elemento.

versionId string

La versione da cui ispezionare.

scope string

Il valore è global per impostazione predefinita. Vedi Scopi .

Richiesta

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions/version" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "versionId=08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01"

Risposta

200 - OK
Ritorna un(a) object
application/json
{

  "content-md5": "sTf90fedVsft8zZf6nUg8g==",

  "roblox-entry-version": "08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01",

  "roblox-entry-created-time": "2022-02-02T23:30:06.5388799+00:00",

  "roblox-entry-version-created-time": "2022-02-03T06:27:42.0652160+00:00",

  "roblox-entry-attributes": {},

  "roblox-entry-userids": [ 269323 ]

}
roblox-entry-created-time string

Il tempo in cui è stata creata la voce.

last-modified string

Il tempo in cui questa particolare versione è stata creata.

roblox-entry-version string

La versione dell'elemento restituito.

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 versione

Limiti

Per chiave API: 100 richieste ogni 60 secondi per indirizzo IP

Versioni dell'elemento di lista

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions

Restituisce una lista di versioni per un'entry.

Parametri

universeId number

L'identificatore dell'esperienza con i dati che vuoi Accesso. Puoi copiare l'ID dell'Universo della tua esperienza sul Creator Dashboard .

Path
Necessario
datastoreName string

Il nome del Negoziodi dati.

entryKey string

La chiave che identifica l'elemento.

scope string

Il valore è global per impostazione predefinita. Vedi Scopi .

cursor string

Fornire per richiedere il prossimo set di dati (vedi Cursori ).

startTime string

Fornire di non includere versioni precedenti a questo timestamp.

endTime string

Fornire di non includere versioni successive a questo timestamp.

sortOrder string

O Ascending (versioni precedenti) o Descending (versioni successive).

limit number

Il numero massimo di oggetti da Riportare. Ogni chiamata legge solo una partizione, quindi può restituire meno del valore specificato quando esaurisce gli obiettivi su una partizione.

Richiesta

curl
curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions" \

--header "x-api-key: ${API_KEY}" \

--get \

-d "datastoreName=Coins" \

-d "entryKey=269323" \

-d "limit=5"

Risposta

200 - OK
Ritorna un(a) object
version string

Il nome della versione dell'ingresso di qualificazione.

deleted boolean

Indica se l'elemento è stato eliminato.

contentLength number

La lunghezza del contenuto.

createdTime string

L'ora di creazione della versione nell'ora del formato ISO.

objectCreatedTime string

L'ora di creazione del data store nell'ora del formato ISO.

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.

  • Elenca versioni

Oggetti

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

DataStore

L'oggetto di memorizzazione dei dati con il suo nome e il suo tempo di creazione.

Attributi

name string

Il nome del tuo data Negozio.

createdTime string

L'ora di creazione del data store nell'ora del formato ISO.

EntryVersion

L'oggetto versione dell'ingresso restituito dal metodo List Entry Versions.

Attributi

version string

Il nome della versione dell'ingresso di qualificazione.

deleted boolean

Indica se l'elemento è stato eliminato.

contentLength number

La lunghezza del contenuto.

createdTime string

L'ora di creazione della versione nell'ora del formato ISO.

objectCreatedTime string

L'ora di creazione del data store nell'ora del formato ISO.