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

DataStoreEntry

Un'entrata chiave-valore in un archivio dati.

  • PERCORSI RISORSE
  • /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
  • /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries

Attributi

pathstring

Il percorso delle risorse dell'entrata del data store.

Formati:

  • universes/{universe_id}/data-stores/{data_store_id}/entries/{data_store_entry_id}
  • universes/{universe_id}/data-stores/{data_store_id}/scopes/{data_store_scope_id}/entries/{data_store_entry_id}.
createTimestring
Solo output

L'timestamp quando l'elemento del data store è stato creato. Questa stringa è formattata come Timestamp.

revisionIdstring
Immutabile
Solo output

L'ID della revisione dell'entrata del data store.

Una nuova revisione viene commessa ogni volta che l'ingresso nel deposito di dati viene modificato in qualsiasi modo.

Il formato è una stringa arbitraria. Esempio: "foo".

revisionCreateTimestring
Solo output

L'timestamp quando la revisione è stata creata. Questa stringa è formattata come Timestamp.

stateEnum<string>
Solo output

Lo stato dell'ingresso del data store.

Valori possibili:

| Valore | Descrizione | | --- | --- | | STATO_NON SPECIFICATO | Il valore predefinito.Questo valore viene utilizzato se lo stato viene omesso.| | ATTIVO | Lo stato predefinito di un nuovo elemento di archiviazione dati appena creato.| | ELIMINATO | L'elemento del data store viene contrassegnato come eliminato.A un certo punto nel futuro, verrà eliminato permanentemente. |. Valori possibili:

etagstring

Questa somma di controllo viene calcolata dal server in base al valore di altri campi e può essere inviata su richieste di aggiornamento e cancellazione (e potenzialmente su alcuni metodi personalizzati) per garantire che il client abbia un valore aggiornato prima di procedere.

valueJSON value

Il valore dell'entrata.

Un valore JSON può essere null, boolean, string, number, array, or object.

idstring
Solo output

L'ID risorsa dell'entrata.

Questo corrisponde all'ultimo segmento del percorso risorse e viene fornito solo per comodità.

usersarray<string>

Utenti associati all'entrata.

attributesobject

Un insieme arbitrario di attributi associati all'entrata.

URL di base

https://apis.roblox.com
Risorsa DataStoreEntry

{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}

DataStoreEntry

Elenca gli elementi del deposito dati
Beta

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

Restituisce una lista di elementi da un archivio dati.

Solo i campi path e id sono popolati; usa GetDataStoreEntry per recuperare altri campi.

Specifica la scoperta wildcard ( - ) per elencare le entrate da tutti gli scopi.

Campi
universe-datastores.objects:list
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

data_store_idstring
Necessario

L'ID del deposito dati.

Parametri query
maxPageSizenumber

Il numero massimo di entrate del deposito dati da restituire.Il servizio potrebbe restituire meno di questo valore.Se non specificato, vengono restituiti al massimo 10 elementi di archiviazione dei dati.Il valore massimo è 256 e i valori più alti sono impostati su 256.

pageTokenstring

Un token di pagina, ricevuto da una chiamata precedente, per recuperare una pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti alla chiamata successiva devono corrispondere alla chiamata che ha fornito il token della pagina.

filterstring

Questo campo può essere impostato per filtrare le risorse restituite.

Il campo filter supporta un sottinsieme molto piccolo di CEL:

  • Solo il campo id è supportato.
  • Solo la funzione startsWith è disponibile; non sono supportati altri operatori né costrutti.

Filtro di esempio: id.startsWith("foo").

showDeletedboolean

Se vero, le risorse contrassegnate per la cancellazione in attesa saranno incluse nei risultati.

Risposta

Un elenco di DataStoreEntries nella collezione padre.

dataStoreEntriesarray<DataStoreEntry>

Gli DataStoreEntries dal data store specificato o dal DataStoreScope.

nextPageTokenstring

Un token che puoi inviare come parametro pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non ci sono pagine successive.

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries?maxPageSize=10&pageToken={string}&filter={string}&showDeleted={boolean}' \
-H 'x-api-key: {your-api-key}'
Risposta

{
"dataStoreEntries": [
{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}
],
"nextPageToken": "string"
}

DataStoreEntry

Crea l'elemento del Data Store
Beta

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

Crea un'entrata con l'ID e il valore forniti.

Restituisce una richiesta 400 se l'entrata esiste.

Campi
universe-datastores.objects:create
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

data_store_idstring
Necessario

L'ID del deposito dati.

Parametri query
idstring

L'ID da utilizzare per l'ingresso nel data store, che diventerà la componente finale del percorso di risorse dell'ingresso nel data store.

Questo valore dovrebbe essere una stringa di caratteri da 1 a 50. Consigliamo vivamente di utilizzare solo lettere minuscole, numeri e trattini.

Corpo della richiestaDataStoreEntry
POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries?id=my-entry' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"etag": "string",
"value": "JSON value",
"users": [
"string"
],
"attributes": "object"
}'
Risposta

{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}

DataStoreEntry

Ottieni l'ingresso nel Data Store
Beta

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

Ottiene l'entrata specificata.

Per ottenere l'entrata in una revisione specifica, aggiungi @<revisionId> alla fine del percorso.

Ad esempio, per ottenere my-entry alla revisione dell'ID 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01, utilizza il percorso /v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01 .

Se l'ID di ingresso contiene uno o più caratteri @ e vuoi ottenere l'ultima versione piuttosto che in una revisione specifica, aggiungi l'ID della revisione speciale @latest alla fine del percorso.Altrimenti, il segmento dell'ID di ingresso dopo l'ultimo @ sarà interpretato come ID di revisione.

Ad esempio, per ottenere l'ultima revisione di my-entry , utilizza il percorso /v2/universes/1234/data-stores/5678/entries/my@entry@latest .

Per ottenere l'elemento che era attivo in un momento specifico, aggiungi @latest:<timestamp> alla fine del percorso, dove <timestamp> è formattato in RFC-3339.L'timestamp indicato deve essere dopo l'epoca Unix (1/1/1970) e non più di dieci minuti nel futuro.

Ad esempio, per ottenere la revisione di my-entry che era attiva il 12/2/2024 alle 06:00 UTC, usa il percorso /v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z .

Campi
universe-datastores.objects:read
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

data_store_idstring
Necessario

L'ID del deposito dati.

entry_idstring
Necessario

L'ID di ingresso.

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}' \
-H 'x-api-key: {your-api-key}'
Risposta

{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}

DataStoreEntry

Elimina l'elemento del Data Store
Beta

DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

Marca l'elemento specificato per la cancellazione.

Le entrate non vengono eliminate immediatamente; invece, il campo state verrà impostato su DELETED. La cancellazione permanente avviene dopo 30 giorni.

In caso di successo, restituisce 200 OK. Se l'entrata non esiste, restituisce 404 Non trovato.

Campi
universe-datastores.objects:delete
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

data_store_idstring
Necessario

L'ID del deposito dati.

entry_idstring
Necessario

L'ID di ingresso.

DELETE /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}' \
-H 'x-api-key: {your-api-key}'

DataStoreEntry

Aggiorna l'elemento del Data Store
Beta

PATCH /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

Aggiorna il valore, gli attributi e gli utenti di un'entrata.

L'aggiornamento di revisioni specifiche dell'entrata è non supportato .Se specifici un ID di revisione nel percorso e allow_missing è true , la richiesta di aggiornamento creerà invece una nuova voce con il suffisso @<revisionId> come parte della chiave.

L'aggiornamento parziale è non supportato .Se gli attributi o gli utenti non vengono forniti durante l'aggiornamento del valore, verranno cancellati.Il valore deve essere sempre fornito quando si aggiorna un'entrata.

Campi
universe-datastores.objects:update
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

data_store_idstring
Necessario

L'ID del deposito dati.

entry_idstring
Necessario

L'ID di ingresso.

Parametri query
allowMissingboolean

Se impostato su vero e l'elemento del deposito di dati non viene trovato, viene creato un elemento del deposito di dati.

Corpo della richiestaDataStoreEntry
PATCH /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}?allowMissing={boolean}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"etag": "string",
"value": "JSON value",
"users": [
"string"
],
"attributes": "object"
}'
Risposta

{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}

DataStoreEntry

Incremento dell'archiviazione dati Entry
Beta

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment

Aumenta il valore dell'elemento specificato. Sia il valore esistente che l'importo dell'incremento devono essere interi.

Se l'elemento non esiste, crea un elemento con il valore specificato.

L'incremento delle revisioni specifiche dell'entrata è non supportato .Se specifici un ID di revisione nel percorso, la richiesta di incremento creerà una nuova voce con il suffisso @<revisionId> come parte della chiave.

Problema noto: il valore può essere aumentato oltre il range valido di valori.Quando ciò accade, il valore restituito verrà limitato all'intervallo valido, ma il backend può persistere nel valore originale.Questo comportamento viene mantenuto per motivi di compatibilità retrospettiva, ma potrebbe cambiare in una futura versione di questa API.

Campi
universe-datastores.objects:createuniverse-datastores.objects:update
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

data_store_idstring
Necessario

L'ID del deposito dati.

entry_idstring
Necessario

L'ID di ingresso.

Corpo della richiesta
amountnumber

L'importo con cui aumentare il valore di ingresso. Sia il valore esistente che l'importo di incremento devono essere interi.

usersarray<string>

Utenti associati all'entrata.

Se questo non viene fornito, gli ID utente esistenti vengono cancellati.

attributesobject

Un insieme arbitrario di attributi associati all'entrata.

Se questo non viene fornito, gli attributi esistenti vengono cancellati.

POST /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"amount": "number",
"users": [
"string"
],
"attributes": "object"
}'
Risposta

{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}

DataStoreEntry

Rivisioni dell'archiviazione dei dati della lista
Beta

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions

Elenca le revisioni dell'elemento del data store.

Questo metodo restituisce le entrate del data store parziale.

In particolare, solo i campi path, id, createTime, revisionCreateTime, revisionId, etag e state sono popolati.Sia i campi path e id avranno un suffisso @<version>.

Per ottenere l'intera voce in una revisione, puoi utilizzare il campo fornito path con il metodo GetDataStoreEntry , cioè GET /v1/universes/1234/data-stores/5678/entries/my-entry@<version> .

Campi
universe-datastores.versions:list
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

data_store_idstring
Necessario

L'ID del deposito dati.

entry_idstring
Necessario

L'ID di ingresso.

Parametri query
maxPageSizenumber

Il numero massimo di revisioni da restituire per pagina.

Il servizio potrebbe restituire meno del numero massimo di revisioni.Se non specificato, vengono restituiti al massimo 10 revisioni.Il valore massimo è di 100 valori e i valori più alti sono impostati su 100.

pageTokenstring

Un token di pagina, ricevuto da una chiamata precedente, per recuperare una pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti alla chiamata successiva devono corrispondere alla chiamata che ha fornito il token della pagina.

filterstring

Supporta il seguente sottinsieme di CEL:

  • Sono supportati solo gli operatori &&, <= e >=.
  • Solo il campo revision_create_time è supportato.

Ad esempio:

"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z".

Risposta

Un elenco di revisioni di un'entrata nel data store.

dataStoreEntriesarray<DataStoreEntry>

Le revisioni del data_store_entry.

nextPageTokenstring

Un token che invii come parametro pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non ci sono pagine successive.

GET /cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions?maxPageSize=10&pageToken={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
Risposta

{
"dataStoreEntries": [
{
"path": "universes/123/data-stores/some-data-store/entries/some-data-store-entry",
"createTime": "2023-07-05T12:34:56Z",
"revisionId": "string",
"revisionCreateTime": "2023-07-05T12:34:56Z",
"state": "STATE_UNSPECIFIED",
"etag": "string",
"value": "JSON value",
"id": "string",
"users": [
"string"
],
"attributes": "object"
}
],
"nextPageToken": "string"
}