Almacenes de datos ordenados (Beta)

*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 la documentación de referencia para trabajar con almacenes de datos ordenados. Para obtener más información sobre el uso de la API, see Manipulación de solicitudes de API para almacenes de datos y el Guía de uso .

OrderedDataStores

https://apis.roblox.com/ordered-data-stores

Lista

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

Devuelve una lista de entradas de un almacén de datos tienda.

Parámetros

universeId string

El identificador de la experiencia con datos ordenados que quieres acceso. Ver ID del Universo en cómo copiarlo en Pantalla del Creador .

Path
Obligatorio
orderedDataStore string

El nombre del tiendade datos ordenado de destino.

Path
Obligatorio
scope string

El nombre del alcance del almacén de datos. Ver Escalas .

Path
Obligatorio
max_page_size number

El número máximo de entradas para devolver. El servicio puede devolver menos de este valor. El valor predeterminado es 10 . El valor máximo es 100 y cualquier entrada superior a 100 está obligada a 100 .

page_token string

Un token de página recibido de una llamada anterior. Proporcione esto para recuperar la página siguiente. Cuando se paga, todos los demás parámetros proporcionados a List deben coincidir con la llamada que proporciona el token de página.

order_by string

La dirección de la enumeración. La orden por defecto es ascender. Ingrese un desc sufijo para la descendencia.

filter string

El rango de valores de calificación de las entradas para devolver. Véase Filtros .

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
entries array<object>

Las Entradas del alcance especificado.

nextPageToken string

Un token, que se puede enviar como page_token para recuperar la siguiente página. Si se omite este campo, no hay páginas siguientes.

Crear

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

Crea una nueva entrada con el valor de contenido proporcionado.

Parámetros

universeId string

El identificador de la experiencia con datos ordenados que quieres acceso. Ver ID del Universo en cómo copiarlo en Pantalla del Creador .

Path
Obligatorio
orderedDataStore string

El nombre del tiendade datos pedido.

Path
Obligatorio
scope string

El nombre del alcance del almacén de datos. Ver Escalas .

Path
Obligatorio
id string

El nombre de la entrada.

Obligatorio
CreateEntryRequest

Crea una nueva entrada con el valor proporcionado.

Body
Obligatorio

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
id string

El nombre de la entrada

path string

El camino de recursos de la solicitud.

value number

El valor de la entrada.

Obtener

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

Obtiene y devuelve la entrada especificada.

Parámetros

universeId string

El identificador de la experiencia con datos ordenados que quieres acceso. Ver ID del Universo en cómo copiarlo en Pantalla del Creador .

Path
Obligatorio
orderedDataStore string

El nombre del tiendade datos pedido.

Path
Obligatorio
scope string

El nombre del alcance del almacén de datos. Ver Escalas .

Path
Obligatorio
entry string

El ID de la entrada.

Path
Obligatorio

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
id string

El nombre de la entrada

path string

El camino de recursos de la solicitud.

value number

El valor de la entrada.

Eliminar

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

Elimina la entrada especificada.

Parámetros

universeId string

El identificador de la experiencia con datos ordenados que quieres acceso. Ver ID del Universo en cómo copiarlo en Pantalla del Creador .

Path
Obligatorio
orderedDataStore string

El nombre del tiendade datos pedido.

Path
Obligatorio
scope string

El nombre del alcance del almacén de datos. Ver Escalas .

Path
Obligatorio
entry string

El ID de la entrada.

Path
Obligatorio

Solicitud

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

Respuesta

Actualización

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

Actualiza un valor de entrada y devuelve el valor actualizado.

Parámetros

universeIdId string

El identificador de la experiencia con datos ordenados que quieres acceso. Ver ID del Universo en cómo copiarlo en Pantalla del Creador .

Path
Obligatorio
orderedDataStore string

El nombre del tiendade datos pedido.

Path
Obligatorio
scope string

El nombre del alcance del almacén de datos. Ver Escalas .

Path
Obligatorio
entry string

El ID de la entrada.

Path
Obligatorio
UpdateEntryRequest

Actualiza la entrada proporcionada con un nuevo valor.

Body
Obligatorio
allow_missing boolean

La bandera para permitir la creación de una entrada si la entrada no existe. Vea Permitir banderas no existentes .

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
id string

El nombre de la entrada

path string

El camino de recursos de la solicitud.

value number

El valor de la entrada.

Incremento

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

Aumenta el valor de la llave en la cantidad proporcionada y devuelve la entrada actualizada.

Problema conocido: Los valores de entrada pueden incrementar más allá del rango válido y esto puede persistir en el backend. Los valores devueltos se ajustarán al rango válido.

Parámetros

universeId string

El identificador de la experiencia con datos ordenados que quieres acceso. Ver ID del Universo en cómo copiarlo en Pantalla del Creador .

Path
Obligatorio
orderedDataStore string

El nombre del tiendade datos pedido.

Path
Obligatorio
scope string

El nombre del alcance del almacén de datos. Ver Escalas .

Path
Obligatorio
entry string

El ID de la entrada.

Path
Obligatorio
incrementEntryRequest

Aumenta el valor de entrada.

Body
Obligatorio

Solicitud

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

Respuesta

200 - OK
OK
Devuelve un(a) object
id string

El nombre de la entrada

path string

El camino de recursos de la solicitud.

value number

El valor de la entrada.

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.

CreateEntryRequest

Crea una nueva entrada con el valor proporcionado.

Atributos

value number

El valor para establecer la nueva entrada. Si el valor de entrada supera el máximo de valor admitido por int64, que es 9,223,372,036,854,775,807, la solicitud falla con un error de solicitud de 400.

Entry

Representa una entrada.

Atributos

id string

El nombre de la entrada

path string

El camino de recursos de la solicitud.

value number

El valor de la entrada.

IncrementEntryRequest

Aumenta el valor de entrada.

Atributos

amount number

La cantidad a incrementar por el valor de entrada. Si el valor de entrada supera el valor máximo soportado por int64, que es 9,223,372,036,854,775,807, la solicitud falla con un error de solicitud 400.

ListEntriesResponse

Una lista de Entradas en la coleccionespadre.

Atributos

entries array<object>

Las Entradas del alcance especificado.

nextPageToken string

Un token, que se puede enviar como page_token para recuperar la siguiente página. Si se omite este campo, no hay páginas siguientes.

UpdateEntryRequest

Actualiza la entrada proporcionada con un nuevo valor.

Atributos

value number

El valor para actualizar la entrada. Si el valor de entrada supera el máximo de valor admitido por int64, que es 9,223,372,036,854,775,807, la solicitud falla con un error de solicitud de 400.