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

OrderedDataStoreEntry

Una entrada de clave-valor en un almacén de datos ordenado.

Atributos

pathstring

El camino de recursos de la entrada del almacén de datos solicitado.

Formato: universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{ordered_data_store_scope_id}/entries/{ordered_data_store_entry_id}.

valuenumber

El valor de la entrada.

Siempre redondeado al entero más cercano.

idstring
Solo salida

El nombre de la entrada.

URL base

https://apis.roblox.com
El recurso OrderedDataStoreEntry

{
"path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",
"value": "number",
"id": "string"
}

OrderedDataStoreEntry

Lista de entradas de almacén de datos ordenadas
Beta

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

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

Ámbitos
universe.ordered-data-store.scope.entry:read
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

ordered_data_store_idstring
Obligatorio

El ID del almacén de datos ordenado.

scope_idstring
Obligatorio

El ID del alcance.

Parámetros de consulta
maxPageSizenumber

El número máximo de entradas de almacén de datos solicitadas para devolver.El servicio podría devolver menos que este valor.Si no se especifica, se devuelven un máximo de 10 entradas de almacén de datos ordenadas.El valor máximo es 100 y los valores más altos se establecen en 100.

pageTokenstring

Una ficha de página, recibida de una llamada anterior, para recuperar una página posterior.

Al paginar, todos los demás parámetros proporcionados a la llamada siguiente deben coincidir con la llamada que proporcionó el token de página.

orderBystring

Si se especifica, los resultados se ordenan según los campos especificados.

Los valores deben ser una lista separada por comas de campos, con un sufijo "desc" opcional por campo para ordenar por valores descendientes en lugar de ascendentes.Puedes acceder a subcampos con un operador ..

Los resultados se pueden ordenar por los siguientes campos: valor.

Ejemplo: "value desc".

filterstring

Este campo se puede configurar para filtrar los recursos devueltos.

Soportamos dos operadores de comparación para esta operación: <= y >=. Estos operadores de comparación actúan como un minValue y un maxValue para los valores devueltos.Si se necesita filtrar para un valor entre un minValue y un maxValue, el usuario puede usar el operador lógico &&.Todos los tokens en la expresión de filtro deben estar separados por un solo espacio.

Filtros de ejemplo: entry <= 10 ; entry >= 10 && entry <= 30.

Respuesta

Una lista de entradas de OrderedDataStore en la colección padre.

orderedDataStoreEntriesarray<OrderedDataStoreEntry>

Los elementos de almacén de datos ordenados de la especificada alcance de almacén de datos ordenados.

nextPageTokenstring

Una token que puedes enviar como parámetro pageToken para recuperar la siguiente página. Si este campo se omite, no hay páginas posteriores.

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries?maxPageSize=10&pageToken={string}&orderBy={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
Respuesta

{
"orderedDataStoreEntries": [
{
"path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",
"value": "number",
"id": "string"
}
],
"nextPageToken": "string"
}

OrderedDataStoreEntry

Crear entrada de almacén de datos ordenados
Beta

POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

Crea una entrada con el ID y el valor proporcionados.

Devuelve una solicitud 400 incorrecta si la entrada existe.

Ámbitos
universe.ordered-data-store.scope.entry:write
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

ordered_data_store_idstring
Obligatorio

El ID del almacén de datos ordenado.

scope_idstring
Obligatorio

El ID del alcance.

Parámetros de consulta
idstring

El ID para usar para la entrada del almacén de datos solicitado, que se convertirá en el camino de recursos final de la entrada del almacén de datos solicitado.

Este valor debe ser una cadena de caracteres de 1 a 63. Recomendamos encarecidamente utilizar sólo letras minúsculas, números numéricos y guiones.

Solicitar cuerpoOrderedDataStoreEntry
POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries?id=my-entry' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"value": "number"
}'
Respuesta

{
"path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",
"value": "number",
"id": "string"
}

OrderedDataStoreEntry

Obtener entrada de almacén de datos ordenados
Beta

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

Obtiene la entrada especificada.

Ámbitos
universe.ordered-data-store.scope.entry:read
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

ordered_data_store_idstring
Obligatorio

El ID del almacén de datos ordenado.

scope_idstring
Obligatorio

El ID del alcance.

entry_idstring
Obligatorio

El ID de entrada.

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

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

{
"path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",
"value": "number",
"id": "string"
}

OrderedDataStoreEntry

Eliminar entrada de almacén de datos ordenados
Beta

DELETE /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

Elimina la entrada especificada.

Al tener éxito, devuelve 200 OK. Si la entrada no existe, devuelve 404 No encontrado.

Ámbitos
universe.ordered-data-store.scope.entry:write
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

ordered_data_store_idstring
Obligatorio

El ID del almacén de datos ordenado.

scope_idstring
Obligatorio

El ID del alcance.

entry_idstring
Obligatorio

El ID de entrada.

DELETE /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

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

OrderedDataStoreEntry

Actualizar la entrada del almacén de datos ordenados
Beta

PATCH /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

Actualiza el valor de una entrada.

Ámbitos
universe.ordered-data-store.scope.entry:write
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

ordered_data_store_idstring
Obligatorio

El ID del almacén de datos ordenado.

scope_idstring
Obligatorio

El ID del alcance.

entry_idstring
Obligatorio

El ID de entrada.

Parámetros de consulta
allowMissingboolean

Si se establece en verdadero y no se encuentra la entrada del almacén de datos solicitada, se crea una entrada de almacén de datos solicitada.

Solicitar cuerpoOrderedDataStoreEntry
PATCH /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}?allowMissing={boolean}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"value": "number"
}'
Respuesta

{
"path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",
"value": "number",
"id": "string"
}

OrderedDataStoreEntry

Entrada de almacén de datos ordenados de incremento
Beta

POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment

Incrementa el valor de la entrada especificada. Tanto el valor existente como la cantidad de incremento deben ser enteros.

Si la entrada no existe, crea una entrada con el valor especificado.

Problema conocido: el valor puede incrementarse más allá del rango válido de valores.Cuando esto suceda, el valor devuelto se clamará al rango válido, pero el backend puede persistir el valor original.Este comportamiento se mantiene por razones de compatibilidad hacia atrás, pero puede cambiar en una futura versión de esta API.

Ámbitos
universe.ordered-data-store.scope.entry:write
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

ordered_data_store_idstring
Obligatorio

El ID del almacén de datos ordenado.

scope_idstring
Obligatorio

El ID del alcance.

entry_idstring
Obligatorio

El ID de entrada.

Solicitar cuerpo
amountnumber

La cantidad con la que incrementar el valor de entrada. Tanto el valor existente como la cantidad de incremento deben ser enteros.

POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"amount": "number"
}'
Respuesta

{
"path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",
"value": "number",
"id": "string"
}