*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.
Una entrada clave-valor en un almacén de datos.
El camino de recursos de la entrada del almacén de datos.
Formatos:
La fecha y hora en que se creó la entrada del almacén de datos. Esta cadena está formateada como Timestamp.
El ID de revisión de la entrada del almacén de datos.
Se comete una nueva revisión cada vez que se cambia la entrada del almacén de datos de cualquier manera.
El formato es una cadena arbitraria. Ejemplo: "foo".
La fecha y hora en que se creó la revisión. Esta cadena está formateada como Timestamp.
El estado de la entrada del almacén de datos.
Posibles valores:
| Valor | Descripción | | --- | --- | | Estado_especificado | El valor predeterminado.Este valor se usa si se omitió el estado.| | ACTIVO | El estado predeterminado de una entrada de almacén de datos recién creada.| | ELIMINADO | La entrada del almacén de datos se marca como eliminada. En algún momento en el futuro, se eliminará permanentemente. |. Valores posibles:
Esta suma de comprobación se calcula por el servidor en función del valor de otros campos y se puede enviar en solicitudes de actualización y eliminación (y potencialmente en ciertos métodos personalizados) para asegurar que el cliente tenga un valor actualizado antes de proceder.
El valor de la entrada.
Un valor JSON puede ser null, boolean, string, number, array, u object.
El ID de recurso de la entrada.
Esto coincide con el último segmento del camino de recursos y se proporciona solo por conveniencia.
Usuarios asociados con la entrada.
Un conjunto arbitrario de atributos asociados con la entrada.
https://apis.roblox.com{
"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"
}Devuelve una lista de entradas de un almacén de datos.
Solo los campos path y id están poblados; utilice GetDataStoreEntry para recuperar otros campos.
Especifique el alcance de comodín ( - ) para listar entradas de todos los alcances.
La identificación del universo.
El ID del almacén de datos.
El número máximo de entradas de almacén de datos para devolver.El servicio podría devolver menos que este valor.Si no se especifica, a lo sumo se devuelven 10 entradas de almacén de datos.El valor máximo es 256 y los valores más altos se establecen en 256.
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.
Este campo se puede configurar para filtrar los recursos devueltos.
El campo filter admite un subconjunto muy pequeño de CEL:
Filtro de ejemplo: id.startsWith("foo").
Si es verdadero, los recursos marcados para eliminación pendiente se incluirán en los resultados.
Una lista de entradas de almacén de datos en la colección padre.
Los elementos de almacén de datos de la fuente de datos especificada o del alcance de almacén de datos.
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.
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}'{
"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"
}Crea una entrada con el ID y el valor proporcionados.
Devuelve una solicitud 400 incorrecta si la entrada existe.
La identificación del universo.
El ID del almacén de datos.
El ID para usar para la entrada del almacén de datos, que se convertirá en el componente final del camino de recursos de la entrada del almacén de datos.
Este valor debe ser una cadena de caracteres de 1 a 50. Recomendamos encarecidamente usar sólo letras minúsculas, números numéricos y guiones.
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"
}'{
"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"
}Obtiene la entrada especificada.
Para obtener la entrada en una revisión específica, agregue @<revisionId> al final del camino.
Por ejemplo, para obtener my-entry en el ID de revisión 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01, use el camino /v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01 .
Si tu ID de entrada contiene uno o más caracteres @ y quieres obtener la última versión en lugar de en cualquier revisión específica, añade el ID de revisión especial @latest al final del camino.De lo contrario, el segmento del ID de entrada después del último @ se interpretará como un ID de revisión.
Por ejemplo, para obtener la última revisión de my-entry , use el camino /v2/universes/1234/data-stores/5678/entries/my@entry@latest .
Para obtener la entrada que estaba actual en un momento determinado, agregue @latest:<timestamp> al final del camino, donde <timestamp> está en formato RFC-3339.La marca de tiempo dada debe ser después de la época de Unix (1/1/1970) y no más de diez minutos en el futuro.
Por ejemplo, para obtener la revisión de my-entry que era actual en 12/2/2024 a las 06:00 UTC, use el camino /v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z .
La identificación del universo.
El ID del almacén de datos.
El ID de entrada.
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}'{
"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"
}Marca la entrada especificada para eliminación.
Las entradas no se eliminarán inmediatamente; en cambio, el campo state se establecerá en DELETED. La eliminación permanente ocurre después de 30 días.
Al tener éxito, devuelve 200 OK. Si la entrada no existe, devuelve 404 No encontrado.
La identificación del universo.
El ID del almacén de datos.
El ID de entrada.
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}'Actualiza el valor, los atributos y los usuarios de una entrada.
Actualizar revisiones específicas de la entrada no es compatible .Si especifica un ID de revisión en el camino y allow_missing es true , la solicitud de actualización creará en su lugar una nueva entrada con el sufijo @<revisionId> como parte de la clave.
La actualización parcial no es compatible .Si los atributos o los usuarios no se proporcionan al actualizar el valor, se borrarán.El valor siempre debe proporcionarse al actualizar una entrada.
La identificación del universo.
El ID del almacén de datos.
El ID de entrada.
Si se establece en verdadero y no se encuentra la entrada del almacén de datos, se crea una entrada de almacén de datos.
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"
}'{
"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"
}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.
Incrementar revisiones específicas de la entrada es no admitido .Si especifica un ID de revisión en el camino, la solicitud de incremento creará una nueva entrada con el sufijo @<revisionId> como parte de la clave.
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.
La identificación del universo.
El ID del almacén de datos.
El ID de entrada.
La cantidad con la que incrementar el valor de entrada. Tanto el valor existente como la cantidad de incremento deben ser enteros.
Usuarios asociados con la entrada.
Si esto no se proporciona, se eliminan las ID de usuario existentes.
Un conjunto arbitrario de atributos asociados con la entrada.
Si esto no se proporciona, se eliminan los atributos existentes.
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"
}'{
"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"
}Lista de revisiones de la entrada del almacén de datos.
Este método devuelve entradas de almacén de datos parciales.
En particular, solo los campos path, id, createTime, revisionCreateTime, revisionId, etag y state están poblados.Ambos campos path y id tendrán un sufijo @<version>.
Para obtener la entrada completa en una revisión, puedes usar el campo proporcionado path con el método GetDataStoreEntry, es decir, GET /v1/universes/1234/data-stores/5678/entries/my-entry@<version>.
La identificación del universo.
El ID del almacén de datos.
El ID de entrada.
El número máximo de revisiones para devolver por página.
El servicio podría devolver menos que el número máximo de revisiones.Si no se especifica, se devuelven un máximo de 10 revisiones.El valor máximo es de 100 valores y los valores más altos se establecen en 100.
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.
Soporta el siguiente subconjunto de CEL:
Por ejemplo:
"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z".
Una lista de revisiones de una entrada de almacén de datos.
Las revisiones del data_store_entry.
Una token que envías como parámetro pageToken para recuperar la siguiente página. Si este campo se omite, no hay páginas posteriores.
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}'{
"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"
}