Magazzini 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 lavorare con i depositi di dati standard.Per ulteriori informazioni sull'utilizzo dell'API, vedi Gestisci richieste API per archivi di dati e la guida all'uso.

Datastores

https://apis.roblox.com/datastores

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

Lista negozi di dati

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

Restituisce un elenco di depositi di dati di un'esperienza.

Parametri

universeId number

L'identificatore dell'esperienza con i depositi di dati a cui vuoi Accesso.Puoi copiare l'ID dell'universo della tua esperienza sulla Dashboard del creatore .

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

Fornisci il ritorno solo di archivi 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'array di archivi di dati 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.

Lista voci

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

Restituisce un elenco di chiavi di ingresso all'interno di un Negoziodati.

Parametri

universeId number

L'identificatore dell'esperienza con i depositi di dati a cui vuoi Accesso.Puoi copiare l'ID dell'universo della tua esperienza sulla Dashboard del creatore .

Path
Necessario
datastoreName string

Il nome del data Negozio.

scope string

Il valore è global di default. Vedi Ambiti.

allScopes boolean

Imposta su vero per restituire le chiavi da tutti gli ambiti.

prefix string

Fornisci il ritorno solo di 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 array di chiavi di ingresso all'interno del data Negoziotarget.

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

I metadati possono essere trovati negli header di risposta come il Seguendo:

content-md5: zuYxEhwuySMv0i8CitXImw==

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-attributes: { "myAttribute": "myValue" }

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

| Intestazione | Descrizione | |---|---| | content-md5 | La somma di controllo MD5 base-64 del contenuto.Vedi Contenuto-MD5 .| | roblox-entry-version | La versione dell'elemento restituito.| | roblox-entry-created-time | L'ora in cui è stata creata l'entrata.| | roblox-entry-version-created-time | L'ora in cui è stata creata questa particolare versione.| | roblox-entry-attributes | Attributi contrassegnati con l'entrata.Oggetto oggettoJSON serializzato.| | roblox-entry-userids | Lista separata per commi degli ID utente Roblox contrassegnati con l'entrata. |

Parametri

universeId number

L'identificatore dell'esperienza con i depositi di dati a cui vuoi Accesso.Puoi copiare l'ID dell'universo della tua esperienza sulla Dashboard del creatore .

Path
Necessario
datastoreName string

Il nome del data Negozio.

entryKey string

La chiave che identifica l'entrata.

scope string

Il valore è global di default. Vedi Ambiti.

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
R recuperato con successo l'elemento.
Ritorna un(a) object

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

Parametri

universeId number

L'identificatore dell'esperienza con i depositi di dati a cui vuoi Accesso.Puoi copiare l'ID dell'universo della tua esperienza sulla Dashboard del creatore .

Path
Necessario
datastoreName string

Il nome del data Negozio.

entryKey string

La chiave che identifica l'entrata.

matchVersion string

Fornire l'aggiornamento solo se la versione attuale corrisponde a questo.

exclusiveCreate boolean

Crea l'entrata solo se non esiste.

scope string

Il valore è global di default. Vedi Ambiti.

roblox-entry-attributes string

Attributi da associare alla nuova versione dell'elemento. Serializzati da oggetti mappe JSON. Se non forniti, gli attributi esistenti vengono cancellati.

Header
roblox-entry-userids string

Lista separata con gli ID utente di Roblox contrassegnati con l'elemento. Se non fornito, gli ID utente esistenti vengono cancellati.

Header
content-md5 string

Il checksum MD5 codificato in 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'entrata qualificante.

deleted boolean

Indica se l'elemento è stato eliminato.

contentLength number

La lunghezza del contenuto.

createdTime string

L'timestamp di quando la versione è stata creata nel formato temporale ISO.

objectCreatedTime string

L'timestamp di quando il data store è stato creato nel formato temporale 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 entrata

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

Marca l'ingresso come eliminato creando una versione tombstone. Gli ingressi vengono eliminati definitivamente dopo 30 giorni.

Parametri

universeId number

L'identificatore dell'esperienza con i depositi di dati a cui vuoi Accesso.Puoi copiare l'ID dell'universo della tua esperienza sulla Dashboard del creatore .

Path
Necessario
datastoreName string

Il nome del data Negozio.

entryKey string

La chiave che identifica l'entrata.

scope string

Il valore è global di default. Vedi Ambiti.

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

Incremento Entrata

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

Aumenta il valore per un'entrata di un importo dato o crea una nuova entrata con quell'importo. Restituisce l'entrata e i metadati.

I metadati possono essere trovati negli header di risposta come il Seguendo:

content-md5: zuYxEhwuySMv0i8CitXImw==

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-attributes: { "myAttribute": "myValue" }

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

| Intestazione | Descrizione | |---|---| | content-md5 | La somma di controllo MD5 base-64 del contenuto.Vedi Contenuto-MD5 .| | roblox-entry-version | La versione dell'elemento restituito.| | roblox-entry-created-time | L'ora in cui è stata creata l'entrata.| | roblox-entry-version-created-time | L'ora in cui è stata creata questa particolare versione.| | roblox-entry-attributes | Attributi contrassegnati con l'entrata.Oggetto oggettoJSON serializzato.| | roblox-entry-userids | Lista separata per commi degli ID utente Roblox contrassegnati con l'entrata. |

Parametri

universeId number

L'identificatore dell'esperienza con i depositi di dati a cui vuoi Accesso.Puoi copiare l'ID dell'universo della tua esperienza sulla Dashboard del creatore .

Path
Necessario
datastoreName string

Il nome del data Negozio.

entryKey string

La chiave che identifica l'entrata.

incrementBy number

L'importo con cui l'elemento deve essere aumentato, o il valore iniziale se non esiste.

scope string

Il valore è global di default. Vedi Ambiti.

roblox-entry-attributes string

Attributi da associare alla nuova versione dell'elemento. Serializzati da oggetti mappe JSON. Se non forniti, gli attributi esistenti vengono cancellati.

Header
roblox-entry-userids string

Un elenco separato da virgoletta degli ID utente di Roblox con cui l'elemento è contrassegnato. Se non 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 l'ultima versione dell'elemento dopo che è stata incrementata.
Ritorna un(a) object

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

I metadati possono essere trovati negli header di risposta come il Seguendo:

content-md5: zuYxEhwuySMv0i8CitXImw==

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-attributes: { "myAttribute": "myValue" }

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

| Intestazione | Descrizione | |---|---| | content-md5 | La somma di controllo MD5 base-64 del contenuto.Vedi Contenuto-MD5 .| | roblox-entry-version | La versione dell'elemento restituito.| | roblox-entry-created-time | L'ora in cui è stata creata l'entrata.| | roblox-entry-version-created-time | L'ora in cui è stata creata questa particolare versione.| | roblox-entry-attributes | Attributi contrassegnati con l'entrata.Oggetto oggettoJSON serializzato.| | roblox-entry-userids | Lista separata per commi degli ID utente Roblox contrassegnati con l'entrata. |

Parametri

universeId number

L'identificatore dell'esperienza con i depositi di dati a cui vuoi Accesso.Puoi copiare l'ID dell'universo della tua esperienza sulla Dashboard del creatore .

Path
Necessario
datastoreName string

Il nome del data Negozio.

entryKey string

La chiave che identifica l'entrata.

versionId string

La versione da ispezionare.

scope string

Il valore è global di default. Vedi Ambiti.

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
R recuperato con successo l'elemento.
Ritorna un(a) object

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: 5000 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'entrata.

Parametri

universeId number

L'identificatore dell'esperienza con i depositi di dati a cui vuoi Accesso.Puoi copiare l'ID dell'universo della tua esperienza sulla Dashboard del creatore .

Path
Necessario
datastoreName string

Il nome del data Negozio.

entryKey string

La chiave che identifica l'entrata.

scope string

Il valore è global di default. Vedi Ambiti.

cursor string

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

startTime string

Fornire per non includere versioni precedenti a questo timestamp.

endTime string

Fornire per non includere versioni successive a questo timestamp.

sortOrder string

Oppure Ascending (versioni precedenti prima) o Descending (versioni successive prima).

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

deleted boolean

Indica se l'elemento è stato eliminato.

contentLength number

La lunghezza del contenuto.

createdTime string

L'timestamp di quando la versione è stata creata nel formato temporale ISO.

objectCreatedTime string

L'timestamp di quando il data store è stato creato nel formato temporale 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 archiviazione dati con il suo nome e il tempo di creazione.

Attributi

name string

Il nome del tuo Negoziodati.

createdTime string

L'timestamp di quando il data store è stato creato nel formato temporale ISO.

EntryVersion

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

Attributi

version string

Il nome della versione dell'entrata qualificante.

deleted boolean

Indica se l'elemento è stato eliminato.

contentLength number

La lunghezza del contenuto.

createdTime string

L'timestamp di quando la versione è stata creata nel formato temporale ISO.

objectCreatedTime string

L'timestamp di quando il data store è stato creato nel formato temporale ISO.