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, consulte manejar solicitudes de API para almacenamientos de datos y la guía de uso.
OrderedDataStores
Lista
Devuelve una lista de entradas de un almacén de datos tienda.
Parámetros
El identificador de la experiencia con almacenes de datos ordenados a los que desea acceso.Vea ID del universo en cómo copiarlo en Panel del creador.
El nombre del tiendade datos solicitado objetivo.
El nombre del alcance del almacén de datos. Vea Alcances.
El número máximo de entradas para devolver.El servicio puede devolver menos que este valor.El valor predeterminado es 10 .El valor máximo es 100 , y cualquier entrada por encima de 100 se ve obligada a 100 .
Una ficha de página recibida de una llamada anterior List.Proporcione esto para recuperar la página siguiente.Al paginar, todos los demás parámetros proporcionados a List deben coincidir con la llamada que proporciona la ficha de página.
La dirección de enumeración. La orden predeterminada es ascendente. Ingrese un sufijo desc para descender.
El rango de valores calificados de entradas para devolver. Vea Filtros .
Solicitud
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
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
Crea una nueva entrada con el valor de contenido proporcionado.
Parámetros
El identificador de la experiencia con almacenes de datos ordenados a los que desea acceso.Vea ID del universo en cómo copiarlo en Panel del creador.
El nombre del tiendade datos solicitado.
El nombre del alcance del almacén de datos. Vea Alcances.
El nombre de la entrada.
Solicitud
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
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.
Obtener
Obtiene y devuelve la entrada especificada.
Parámetros
El identificador de la experiencia con almacenes de datos ordenados a los que desea acceso.Vea ID del universo en cómo copiarlo en Panel del creador.
El nombre del tiendade datos solicitado.
El nombre del alcance del almacén de datos. Vea Alcances.
El ID de entrada.
Solicitud
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
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.
Borrar
Elimina la entrada especificada.
Parámetros
El identificador de la experiencia con almacenes de datos ordenados a los que desea acceso.Vea ID del universo en cómo copiarlo en Panel del creador.
El nombre del tiendade datos solicitado.
El nombre del alcance del almacén de datos. Vea Alcances.
El ID de entrada.
Solicitud
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
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.
Actualizar
Actualiza un valor de entrada y devuelve la entrada actualizada.
Parámetros
El identificador de la experiencia con almacenes de datos ordenados a los que desea acceso.Vea ID del universo en cómo copiarlo en Panel del creador.
El nombre del tiendade datos solicitado.
El nombre del alcance del almacén de datos. Vea Alcances.
El ID de entrada.
La bandera para permitir la creación de una entrada si la entrada no existe. Vea Permitir banderas perdidas.
Solicitud
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
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.
Incremento
Incrementa el valor de la clave por la cantidad proporcionada y devuelve la entrada actualizada.
Problema conocido: los valores de entrada pueden incrementarse 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
El identificador de la experiencia con almacenes de datos ordenados a los que desea acceso.Vea ID del universo en cómo copiarlo en Panel del creador.
El nombre del tiendade datos solicitado.
El nombre del alcance del almacén de datos. Vea Alcances.
El ID de entrada.
Solicitud
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
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.
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
El valor para establecer la nueva entrada.Si el valor de entrada supera el valor máximo admitido por int64, que es 9,223,372,036,854,775,807, la solicitud falla con un error de error 400 Bad Request.
Entry
Representa una entrada.
Atributos
El nombre de la entrada
El camino de recursos de la solicitud.
El valor de la entrada.
IncrementEntryRequest
Aumenta el valor de entrada de incrementos.
Atributos
La cantidad para incrementar por el valor de entrada.Si el valor de entrada supera el valor máximo admitido por int64, que es 9,223,372,036,854,775,807, la solicitud falla con un error de error 400 Bad Request.
ListEntriesResponse
Una lista de entradas en la coleccionespadre.
Atributos
Las entradas del alcance especificado.
Una token, que se puede enviar como page_token para recuperar la siguiente página. Si este campo se omite, no hay páginas posteriores.
UpdateEntryRequest
Actualiza la entrada proporcionada con un nuevo valor.
Atributos
El valor para actualizar la entrada.Si el valor de entrada supera el valor máximo admitido por int64, que es 9,223,372,036,854,775,807, la solicitud falla con un error de error 400 Bad Request.