Armazenamentos de dados ordenados (Beta)
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
Esta página inclui documentação de referência para trabalhar com armazenamentos de dados ordenados.Para mais informações sobre o uso da API (Interface de Programação para Aplicações), veja lidar com solicitações de API para armazenamentos de dados e o guia de uso.
OrderedDataStores
Lista
Retorna uma lista de entradas de um armazenamento de dados loja.
Parâmetros
O identificador da experiência com armazenamentos de dados encomendados que você deseja acesso.Veja ID do Universo sobre como copiá-lo no Painel do Criador.
O nome do armazenamento de dados alvo solicitado.
O nome do escopo da armazenagem de dados. Veja Escopos.
O número máximo de entradas a retornar.O serviço pode retornar menos que esse valor.O valor padrão é 10 .O valor máximo é 100 , e qualquer entrada acima de 100 é coagida para 100 .
Um token de página recebido de uma chamada anterior List .Forneça isso para recuperar a página posterior.Ao paginar, todos os outros parâmetros fornecidos a List devem corresponder à chamada que fornece o token da página.
A direção de enumeração. A ordem padrão é ascendente. Insira um sufixo desc para descer.
O alcance de valores qualificadores de entradas para retornar. Veja Filtros.
Solicitação
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \
--header 'x-api-key: <insert-api-key>'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Criar
Cria uma nova entrada com o valor de conteúdo fornecido.
Parâmetros
O identificador da experiência com armazenamentos de dados encomendados que você deseja acesso.Veja ID do Universo sobre como copiá-lo no Painel do Criador.
O nome do armazenamento de dados solicitado.
O nome do escopo da armazenagem de dados. Veja Escopos.
O nome da entrada.
Solicitação
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>
}'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Pegue
Obtém e retorna a entrada especificada.
Parâmetros
O identificador da experiência com armazenamentos de dados encomendados que você deseja acesso.Veja ID do Universo sobre como copiá-lo no Painel do Criador.
O nome do armazenamento de dados solicitado.
O nome do escopo da armazenagem de dados. Veja Escopos.
O ID de entrada.
Solicitação
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>'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Excluir
Exclui a entrada especificada.
Parâmetros
O identificador da experiência com armazenamentos de dados encomendados que você deseja acesso.Veja ID do Universo sobre como copiá-lo no Painel do Criador.
O nome do armazenamento de dados solicitado.
O nome do escopo da armazenagem de dados. Veja Escopos.
O ID de entrada.
Solicitação
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>'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Atualizar
Atualiza um valor de entrada e retorna a entrada atualizada.
Parâmetros
O identificador da experiência com armazenamentos de dados encomendados que você deseja acesso.Veja ID do Universo sobre como copiá-lo no Painel do Criador.
O nome do armazenamento de dados solicitado.
O nome do escopo da armazenagem de dados. Veja Escopos.
O ID de entrada.
A bandeira para permitir a criação de uma entrada se a entrada não existir. Veja Permitir bandeiras ausentes.
Solicitação
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>
}'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Incremento
Aumenta o valor da chave pelo valor fornecido e retorna a entrada atualizada.
Problema conhecido: Os valores de entrada podem incrementar além do alcance válido e isso pode persistir no backend. Os valores retornados se encaixarão no alcance válido.
Parâmetros
O identificador da experiência com armazenamentos de dados encomendados que você deseja acesso.Veja ID do Universo sobre como copiá-lo no Painel do Criador.
O nome do armazenamento de dados solicitado.
O nome do escopo da armazenagem de dados. Veja Escopos.
O ID de entrada.
Solicitação
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>
}'Resposta
Permissões necessárias
As seguintes permissões de chave API são requeridas para chamar este endpoint. Para mais informações sobre gerar chaves apropriadas, veja Gerenciando chaves API.
Objetos
Os seguintes objetos descrevem payloads que são aceitos ou retornados. Veja cada endpoint para mais informações sobre quando esses objetos são usados.
CreateEntryRequest
Cria uma nova entrada com o valor fornecido.
Atributos
O valor para definir a nova entrada.Se o valor de entrada exceder o valor máximo suportado por int64, que é 9,223,372,036,854,775,807, a solicitação falha com um erro de solicitação 400 Bad.
Entry
Representa uma entrada.
Atributos
O nome da entrada
O caminho de recursos da solicitar / pedir.
O valor da entrada.
IncrementEntryRequest
Aumenta o valor de entrada de incrementos.
Atributos
A quantidade a incrementar pelo valor de entrada.Se o valor de entrada exceder o valor máximo suportado por int64, que é 9,223,372,036,854,775,807, a solicitação falha com um erro de solicitação 400 Bad.
ListEntriesResponse
Uma lista de entradas na coleçõespai.
Atributos
As entradas do escopo especificado.
Um token, que pode ser enviado como page_token para recuperar a próxima página. Se este campo for omitido, não há páginas subsequentes.
UpdateEntryRequest
Atualiza a entrada fornecida com um novo valor.
Atributos
O valor para atualizar a entrada.Se o valor de entrada exceder o valor máximo suportado por int64, que é 9,223,372,036,854,775,807, a solicitação falha com um erro de solicitação 400 Bad.