*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
Uma entrada de chave-valor em um armazenamento de dados.
O caminho de recursos da entrada do armazenamento de dados.
Formatos:
O timestamp quando a entrada do armazenamento de dados foi criada. Esta cadeia de caracteres é formatada como um Timestamp.
O ID de revisão da entrada do armazenamento de dados.
Uma nova revisão é comprometida sempre que a entrada do armazenamento de dados for alterada de qualquer maneira.
O formato é uma string arbitrária. Exemplo: "foo".
O timestamp quando a revisão foi criada. Esta cadeia de caracteres é formatada como um Timestamp.
O estado da entrada do armazenamento de dados.
Valores possíveis:
| Valor | Descrição | | --- | --- | | Estado_não_especificado | O valor padrão.Este valor é usado se o estado for omitido.| | ATIVO | O estado padrão de uma entrada de armazenamento de dados recém-criada.| | DELETADO | A entrada do armazenamento de dados é marcada como excluída. Em algum momento no futuro, será excluído permanentemente. |. Valores possíveis:
Esta soma de verificação é calculada pelo servidor com base no valor de outros campos e pode ser enviada em solicitações de atualização e exclusão (e potencialmente em métodos personalizados específicos) para garantir que o cliente tenha um valor atualizado antes de proceder.
O valor da entrada.
Um valor JSON pode ser null, boolean, string, number, array, ou object.
O ID de recurso da entrada.
Isso corresponde ao último segmento do caminho de recursos e é fornecido apenas para conveniência.
Usuários associados à entrada.
Um conjunto arbitrário de atributos associados à 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"
}Retorna uma lista de entidades de um armazenamento de dados.
Apenas os campos path e id são preenchidos; use GetDataStoreEntry para recuperar outros campos.
Especifique o escopo de wildcard ( - ) para listar entradas de todos os escopos.
O ID do universo.
O ID do armazenamento de dados.
O número máximo de entradas de armazenamento de dados a retornar.O serviço pode retornar menos que esse valor.Se não especificado, no máximo 10 entradas no armazenamento de dados são retornadas.O valor máximo é 256 e valores maiores são definidos como 256.
Um token de página, recebido de uma chamada anterior, para recuperar uma página posterior.
Ao paginar, todos os outros parâmetros fornecidos à chamada posterior devem corresponder à chamada que forneceu o token da página.
Este campo pode ser definido para filtrar os recursos retornados.
O campo filter suporta um subconjunto muito pequeno de CEL:
Exemplo de filtro: id.startsWith("foo").
Se for verdadeiro, recursos marcados para exclusão pendente serão incluídos nos resultados.
Uma lista de DataStoreEntries na coleção pai.
Os DataStoreEntries do armazenamento de dados especificado ou do escopo de armazenamento de dados.
Um token que você pode enviar como um parâmetro pageToken para recuperar a próxima página. Se este campo for omitido, não há páginas subsequentes.
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"
}Cria uma entrada com o ID e o valor fornecidos.
Retorna um pedido 400 ruim se a entrada existir.
O ID do universo.
O ID do armazenamento de dados.
O ID a usar para a entrada do armazenamento de dados, que se tornará o componente final do caminho de recursos da entrada do armazenamento de dados.
Este valor deve ser uma string de 1 a 50 caracteres. Recomendamos fortemente usar apenas letras minúsculas, números e hifens.
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"
}Obtém a entrada especificada.
Para obter a entrada em uma revisão específica, adicione @<revisionId> ao fim do caminho.
Por exemplo, para obter my-entry na ID de revisão 08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01, use o caminho /v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01.
Se o ID de entrada contiver um ou mais caracteres @ e você quiser obter a versão mais recente em vez de em qualquer revisão específica, adicione o ID de revisão especial @latest ao final do caminho.Caso contrário, o segmento do ID de entrada após o último @ será interpretado como um ID de revisão.
Por exemplo, para obter a última revisão de my-entry, use o caminho /v2/universes/1234/data-stores/5678/entries/my@entry@latest.
Para obter a entrada que estava ativa em um momento específico, adicione @latest:<timestamp> ao final do caminho, onde <timestamp> é formatado no RFC-3339.O tempo de data dado deve ser após a era Unix (1/1/1970) e não mais de dez minutos no futuro.
Por exemplo, para obter a revisão de my-entry que estava ativa em 12/2/2024 às 06:00 UTC, use o caminho /v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z.
O ID do universo.
O ID do armazenamento de dados.
O 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 a entrada especificada para exclusão.
Entradas não são excluídas imediatamente; em vez disso, o campo state será definido como DELETED. A exclusão permanente ocorre após 30 dias.
Ao sucesso, retorna 200 OK. Se a entrada não existir, retorna 404 Não Encontrado.
O ID do universo.
O ID do armazenamento de dados.
O 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}'Atualiza o valor, os atributos e os usuários de uma entrada.
Atualizar revisões específicas da entrada é não suportado .Se você especificar um ID de revisão no caminho e allow_missing for true, a solicitação de atualização criará, em vez disso, uma nova entrada com o sufixo @<revisionId> como parte da chave.
Atualização parcial é não suportada .Se os atributos ou usuários não forem fornecidos ao atualizar o valor, eles serão limpados.O valor deve ser sempre fornecido ao atualizar uma entrada.
O ID do universo.
O ID do armazenamento de dados.
O ID de entrada.
Se definido como verdadeiro e a entrada do armazenamento de dados não for encontrada, uma entrada de armazenamento de dados é criada.
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"
}Aumenta o valor da entrada especificada. O valor existente e a quantidade de incremento devem ser inteiros.
Se a entrada não existir, cria uma entrada com o valor especificado.
Incrementar revisões específicas da entrada é não suportado .Se você especificar um ID de revisão no caminho, o pedido de incremento criará uma nova entrada com o sufixo @<revisionId> como parte da chave.
Problema conhecido: o valor pode ser incrementado após a faixa válida de valores.Quando isso acontece, o valor retornado será clampado ao alcance válido, mas o backend pode persistir o valor original.Este comportamento é mantido por razões de compatibilidade com versões anteriores, mas pode mudar em uma versão futura desta API.
O ID do universo.
O ID do armazenamento de dados.
O ID de entrada.
A quantidade pelo qual aumentar o valor de entrada. Ambos o valor existente e a quantidade de incremento devem ser inteiros.
Usuários associados à entrada.
Se isso não for fornecido, os IDs de usuário existentes são limpados.
Um conjunto arbitrário de atributos associados à entrada.
Se isso não for fornecido, os atributos existentes são limpados.
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"
}Listar revisões da entrada do armazenamento de dados.
Este método retorna entradas de armazenamento de dados parciais.
Em particular, apenas os campos path, id, createTime, revisionCreateTime, revisionId, etag e state são preenchidos.Os campos path e id terão um sufixo @<version>.
Para obter a entrada completa em uma revisão, você pode usar o campo fornecido path na metodologia GetDataStoreEntry , ou seja, GET /v1/universes/1234/data-stores/5678/entries/my-entry@<version>.
O ID do universo.
O ID do armazenamento de dados.
O ID de entrada.
O número máximo de revisões a retornar por página.
O serviço pode retornar menos que o número máximo de revisões.Se não especificado, no máximo 10 revisões são retornadas.O valor máximo é de 100 valores e valores mais altos são definidos como 100.
Um token de página, recebido de uma chamada anterior, para recuperar uma página posterior.
Ao paginar, todos os outros parâmetros fornecidos à chamada posterior devem corresponder à chamada que forneceu o token da página.
Suporta o seguinte subconjunto do CEL:
Por exemplo:
"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z".
Uma lista de revisões de uma entrada de armazenamento de dados.
As revisões do data_store_entry.
Um token que você envia como um parâmetro pageToken para recuperar a próxima página. Se este campo for omitido, não há páginas subsequentes.
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"
}