Almacenes de datos estándar

*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

Esta página incluye documentación de referencia para trabajar con almacenes de datos estándar.Para obtener más información sobre el uso de la API, consulte manejar solicitudes de API para almacenamientos de datos y la guía de uso.

Datastores

https://apis.roblox.com/datastores

Los siguientes extremos están disponibles en rutas relativas a la URL base.

Almacenes de datos de lista

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

Devuelve una lista de almacenes de datos de una experiencia.

Parámetros

universeId number

El identificador de la experiencia con almacenes de datos a los que desea acceso.Puedes copiar la ID del universo de tu experiencia en el tablero de creación .

Path
Obligatorio
cursor string

Proporcione para solicitar el próximo conjunto de datos. Vea Cursores.

limit number

El número máximo de artículos para devolver.Cada llamada solo lee una partición, por lo que puede devolver menos que el valor dado cuando se agoten los objetivos en una partición.

prefix string

Proporcionar para devolver solo almacenes de datos con este prefijo.

Solicitud

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"

Respuesta

200 - OK
Devuelve 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 conjunto de almacenes de datos en la experiencia objetivo.

nextPageCursor string

Indica que hay más datos disponibles en el establecerde resultados solicitado. Ver cursor.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Enumerar almacenes de datos

Entries

https://apis.roblox.com/datastores

Los siguientes extremos están disponibles en rutas relativas a la URL base.

Listar entradas

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

Devuelve una lista de claves de entrada dentro de un tiendade datos.

Parámetros

universeId number

El identificador de la experiencia con almacenes de datos a los que desea acceso.Puedes copiar la ID del universo de tu experiencia en el tablero de creación .

Path
Obligatorio
datastoreName string

El nombre del tiendade datos.

scope string

El valor es global por defecto. Vea Ámbitos .

allScopes boolean

Establezca en verdadero para devolver las claves de todos los alcances.

prefix string

Proporcionar para devolver solo claves con este prefijo.

cursor string

Proporcione para solicitar el próximo conjunto de datos. Vea Cursores.

limit number

El número máximo de artículos para devolver.Cada llamada solo lee una partición, por lo que puede devolver menos que el valor dado cuando se agoten los objetivos en una partición.

Solicitud

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"

Respuesta

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

  "keys": [

    {

      "key": "269323"

    }

  ],

  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"

}
keys array<string>

Un conjunto de claves de entrada dentro del tiendade datos objetivo.

nextPageCursor string

Indica que hay más datos disponibles en el establecerde resultados solicitado. Ver cursor.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Lista de claves de entrada

Obtener entrada

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

Devuelve el valor y el metadato asociado a una entrada.

Los metadatos se pueden encontrar en los encabezados de respuesta como lo siguiendo:

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]

| Encabezado | Descripción | |---|---| | content-md5 | La suma de control MD5 codificada en base-64 del contenido.Vea Contenido-MD5.| | roblox-entry-version | La versión de la entrada devuelta.| | roblox-entry-created-time | El tiempo en el que se creó la entrada.| | roblox-entry-version-created-time | El tiempo en el que se creó esta versión en particular.| | roblox-entry-attributes | Atributos etiquetados con la entrada.objetode mapa JSON serializado.| | roblox-entry-userids | Lista separada por comas de ID de usuario de Roblox etiquetados con la entrada. |

Parámetros

universeId number

El identificador de la experiencia con almacenes de datos a los que desea acceso.Puedes copiar la ID del universo de tu experiencia en el tablero de creación .

Path
Obligatorio
datastoreName string

El nombre del tiendade datos.

entryKey string

La clave que identifica la entrada.

scope string

El valor es global por defecto. Vea Ámbitos .

Solicitud

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"

Respuesta

200 - OK
Recuperado con éxito la entrada.
Devuelve un(a) object

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer entrada

Establecer entrada

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

Establece el valor, los metadatos y las ID de usuario asociados con una entrada.

Parámetros

universeId number

El identificador de la experiencia con almacenes de datos a los que desea acceso.Puedes copiar la ID del universo de tu experiencia en el tablero de creación .

Path
Obligatorio
datastoreName string

El nombre del tiendade datos.

entryKey string

La clave que identifica la entrada.

matchVersion string

Proporcione actualizar solo si la versión actual coincide con esto.

exclusiveCreate boolean

Crea la entrada solo si no existe.

scope string

El valor es global por defecto. Vea Ámbitos .

roblox-entry-attributes string

Atributos que deben asociarse con la nueva versión de la entrada. Serializado por objetos de mapa JSON. Si no se proporciona, se eliminan los atributos existentes.

Header
roblox-entry-userids string

Lista separada por comas de ID de usuario de Roblox etiquetados con la entrada. Si no se proporciona, se eliminan los ID de usuario existentes.

Header
content-md5 string

El resumen de MD5 codificado en base-64 del contenido. Vea Contenido-MD5.

Header

Solicitud

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"

Respuesta

200 - OK
Devuelve un(a) object
version string

El nombre de la versión de la entrada calificada.

deleted boolean

Indica si la entrada ha sido eliminada.

contentLength number

La longitud del contenido.

createdTime string

La fecha y hora de creación de la versión en el formato de tiempo ISO.

objectCreatedTime string

La marca de tiempo de cuando se creó el almacén de datos en el formato de tiempo ISO.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Crear entrada

  • Actualizar entrada

Eliminar entrada

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

Marca la entrada como eliminada al crear una versión de lápida. Las entradas se eliminan permanentemente después de 30 días.

Parámetros

universeId number

El identificador de la experiencia con almacenes de datos a los que desea acceso.Puedes copiar la ID del universo de tu experiencia en el tablero de creación .

Path
Obligatorio
datastoreName string

El nombre del tiendade datos.

entryKey string

La clave que identifica la entrada.

scope string

El valor es global por defecto. Vea Ámbitos .

Solicitud

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"

Respuesta

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Eliminar entrada

Entrada de incremento

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

Incrementa el valor de una entrada en una cantidad determinada o crea una nueva entrada con esa cantidad. Devuelve la entrada y el metadato.

Los metadatos se pueden encontrar en los encabezados de respuesta como lo siguiendo:

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]

| Encabezado | Descripción | |---|---| | content-md5 | La suma de control MD5 codificada en base-64 del contenido.Vea Contenido-MD5.| | roblox-entry-version | La versión de la entrada devuelta.| | roblox-entry-created-time | El tiempo en el que se creó la entrada.| | roblox-entry-version-created-time | El tiempo en el que se creó esta versión en particular.| | roblox-entry-attributes | Atributos etiquetados con la entrada.objetode mapa JSON serializado.| | roblox-entry-userids | Lista separada por comas de ID de usuario de Roblox etiquetados con la entrada. |

Parámetros

universeId number

El identificador de la experiencia con almacenes de datos a los que desea acceso.Puedes copiar la ID del universo de tu experiencia en el tablero de creación .

Path
Obligatorio
datastoreName string

El nombre del tiendade datos.

entryKey string

La clave que identifica la entrada.

incrementBy number

La cantidad por la cual debe incrementarse la entrada o el valor inicial si no existe.

scope string

El valor es global por defecto. Vea Ámbitos .

roblox-entry-attributes string

Atributos que deben asociarse con la nueva versión de la entrada. Serializado por objetos de mapa JSON. Si no se proporciona, se eliminan los atributos existentes.

Header
roblox-entry-userids string

Una lista separada por comas de ID de usuario de Roblox con los que la entrada está etiquetada. Si no se proporciona, se eliminan los ID de usuario existentes.

Header

Solicitud

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"

Respuesta

200 - OK
Devuelve la última versión de la entrada después de que se haya incrementado.
Devuelve un(a) object

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Crear entrada

  • Actualizar entrada

Obtener la versión de entrada

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

Devuelve el valor y el metadato de una versión específica de una entrada.

Los metadatos se pueden encontrar en los encabezados de respuesta como lo siguiendo:

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]

| Encabezado | Descripción | |---|---| | content-md5 | La suma de control MD5 codificada en base-64 del contenido.Vea Contenido-MD5.| | roblox-entry-version | La versión de la entrada devuelta.| | roblox-entry-created-time | El tiempo en el que se creó la entrada.| | roblox-entry-version-created-time | El tiempo en el que se creó esta versión en particular.| | roblox-entry-attributes | Atributos etiquetados con la entrada.objetode mapa JSON serializado.| | roblox-entry-userids | Lista separada por comas de ID de usuario de Roblox etiquetados con la entrada. |

Parámetros

universeId number

El identificador de la experiencia con almacenes de datos a los que desea acceso.Puedes copiar la ID del universo de tu experiencia en el tablero de creación .

Path
Obligatorio
datastoreName string

El nombre del tiendade datos.

entryKey string

La clave que identifica la entrada.

versionId string

La versión para inspeccionar.

scope string

El valor es global por defecto. Vea Ámbitos .

Solicitud

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"

Respuesta

200 - OK
Recuperado con éxito la entrada.
Devuelve un(a) object

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Leer versión

Límites

Por clave API: 5000 solicitudes cada 60 segundos por dirección IP

Versiones de entrada de lista

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

Devuelve una lista de versiones para una entrada.

Parámetros

universeId number

El identificador de la experiencia con almacenes de datos a los que desea acceso.Puedes copiar la ID del universo de tu experiencia en el tablero de creación .

Path
Obligatorio
datastoreName string

El nombre del tiendade datos.

entryKey string

La clave que identifica la entrada.

scope string

El valor es global por defecto. Vea Ámbitos .

cursor string

Proporcionar para solicitar el siguiente conjunto de datos (ver cursor ).

startTime string

Proporcione para que no se incluyan versiones anteriores a esta fecha y hora.

endTime string

Proporcione para que no se incluyan versiones posteriores a esta fecha y hora.

sortOrder string

O bien Ascending (versiones anteriores primero) o Descending (versiones posteriores primero).

limit number

El número máximo de artículos para devolver.Cada llamada solo lee una partición, por lo que puede devolver menos que el valor dado cuando se agoten los objetivos en una partición.

Solicitud

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"

Respuesta

200 - OK
Devuelve un(a) object
version string

El nombre de la versión de la entrada calificada.

deleted boolean

Indica si la entrada ha sido eliminada.

contentLength number

La longitud del contenido.

createdTime string

La fecha y hora de creación de la versión en el formato de tiempo ISO.

objectCreatedTime string

La marca de tiempo de cuando se creó el almacén de datos en el formato de tiempo ISO.

Permisos obligatorios

Se requieren los siguientes permisos de clave API para llamar a este extremo. Para obtener más información sobre cómo generar claves adecuadas, consulta Gestionar claves API.

  • Enumerar versiones

Objetos

Los siguientes objetos describen cargas que son aceptadas o devueltas. Ve cada extremo para más información sobre cuándo se utilizan estos objetos.

DataStore

El objeto almacén de datos con su nombre y tiempo de creación.

Atributos

name string

El nombre de tu tiendade datos.

createdTime string

La marca de tiempo de cuando se creó el almacén de datos en el formato de tiempo ISO.

EntryVersion

El objeto de versión de entrada devuelto por el método List Entry Versions.

Atributos

version string

El nombre de la versión de la entrada calificada.

deleted boolean

Indica si la entrada ha sido eliminada.

contentLength number

La longitud del contenido.

createdTime string

La fecha y hora de creación de la versión en el formato de tiempo ISO.

objectCreatedTime string

La marca de tiempo de cuando se creó el almacén de datos en el formato de tiempo ISO.