Armazenamento de Dados Ordenado (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 referência à documentação de trabalho com armazenamentos de dados ordenados. Para mais informações sobre o uso da API (Interface de Programação para Aplicações), see Manuseando solicitações de API para armazenamentos de dados e o Guia de Uso.

OrderedDataStores

https://apis.roblox.com/ordered-data-stores

Lista

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Retorna uma lista de entradas de um lojade dados solicitado.

Parâmetros

universeId string

O identificador da experiência com dados ordenados que você deseja acesso. Veja ID do Universo em como copiá-lo em Painel do Criador.

Path
Obrigatório
orderedDataStore string

O nome do armazenamento de dados alvo pedido.

Path
Obrigatório
scope string

O nome do alcance do armazenamento de dados. Veja Escopos .

Path
Obrigatório
max_page_size number

O número máximo de entradas a serem retornadas. 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 é forçada a 100 .

page_token string

Um token de página recebido de uma chamada anterior List. Forneça isso para recuperar a página seguinte. Ao pagar, todos os outros parâmetros fornecidos à List devem corresponder à chamada que fornece o token de página.

order_by string

A direção de lista. A ordem padrão é a subida. Insira um desc prefixo para a subida.

filter string

O conjunto de valores de qualificação das entradas para retornar. Veja Filtros.

Solicitação

curl
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

200 - OK
Tudo bem
Retorna um(a) object
entries array<object>

As Entradas do âmbito especificado.

nextPageToken string

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.

Criar

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Cria uma nova entrada com o valor de conteúdo fornecido.

Parâmetros

universeId string

O identificador da experiência com dados ordenados que você deseja acesso. Veja ID do Universo em como copiá-lo em Painel do Criador.

Path
Obrigatório
orderedDataStore string

O nome do armazenamento de dados solicitado.

Path
Obrigatório
scope string

O nome do alcance do armazenamento de dados. Veja Escopos .

Path
Obrigatório
id string

O nome da entrada.

Obrigatório
CreateEntryRequest

Cria uma nova entrada com o valor fornecido.

Body
Obrigatório

Solicitação

curl
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

200 - OK
Tudo bem
Retorna um(a) object
id string

O nome da entrada

path string

O caminho de recursos da solicitar / pedir.

value number

O valor da entrada.

Obter

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Obtém e retorna o item especificado.

Parâmetros

universeId string

O identificador da experiência com dados ordenados que você deseja acesso. Veja ID do Universo em como copiá-lo em Painel do Criador.

Path
Obrigatório
orderedDataStore string

O nome do armazenamento de dados solicitado.

Path
Obrigatório
scope string

O nome do alcance do armazenamento de dados. Veja Escopos .

Path
Obrigatório
entry string

O ID da entrada.

Path
Obrigatório

Solicitação

curl
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

200 - OK
Tudo bem
Retorna um(a) object
id string

O nome da entrada

path string

O caminho de recursos da solicitar / pedir.

value number

O valor da entrada.

Excluir

DELETE /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Exclui a entrada especificada.

Parâmetros

universeId string

O identificador da experiência com dados ordenados que você deseja acesso. Veja ID do Universo em como copiá-lo em Painel do Criador.

Path
Obrigatório
orderedDataStore string

O nome do armazenamento de dados solicitado.

Path
Obrigatório
scope string

O nome do alcance do armazenamento de dados. Veja Escopos .

Path
Obrigatório
entry string

O ID da entrada.

Path
Obrigatório

Solicitação

curl
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

Atualizar

PATCH /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Atualiza um valor de entrada e retorna o valor atualizado.

Parâmetros

universeIdId string

O identificador da experiência com dados ordenados que você deseja acesso. Veja ID do Universo em como copiá-lo em Painel do Criador.

Path
Obrigatório
orderedDataStore string

O nome do armazenamento de dados solicitado.

Path
Obrigatório
scope string

O nome do alcance do armazenamento de dados. Veja Escopos .

Path
Obrigatório
entry string

O ID da entrada.

Path
Obrigatório
UpdateEntryRequest

Atualiza a entrada fornecida com um novo valor.

Body
Obrigatório
allow_missing boolean

A bandeira para permitir a criação de uma entrada se a entrada não existir. Veja Permitir bandeiras faltando.

Solicitação

curl
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

200 - OK
Tudo bem
Retorna um(a) object
id string

O nome da entrada

path string

O caminho de recursos da solicitar / pedir.

value number

O valor da entrada.

Incrementar

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment

Aumenta o valor da chave pela quantia fornecida e retorna a entrada atualizada.

Problema conhecido: Os valores de entrada podem incrementar além do alcance válido e isso pode persistir no back-end. Os valores retornados clamarão ao alcance válido.

Parâmetros

universeId string

O identificador da experiência com dados ordenados que você deseja acesso. Veja ID do Universo em como copiá-lo em Painel do Criador.

Path
Obrigatório
orderedDataStore string

O nome do armazenamento de dados solicitado.

Path
Obrigatório
scope string

O nome do alcance do armazenamento de dados. Veja Escopos .

Path
Obrigatório
entry string

O ID da entrada.

Path
Obrigatório
incrementEntryRequest

Aumenta o valor de entrada.

Body
Obrigatório

Solicitação

curl
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

200 - OK
Tudo bem
Retorna um(a) object
id string

O nome da entrada

path string

O caminho de recursos da solicitar / pedir.

value number

O valor da entrada.

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

value number

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 de 400.

Entry

Representa uma entrada.

Atributos

id string

O nome da entrada

path string

O caminho de recursos da solicitar / pedir.

value number

O valor da entrada.

IncrementEntryRequest

Aumenta o valor de entrada.

Atributos

amount number

A quantia a ser incrementada pelo valor da 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 pedido de 400.

ListEntriesResponse

Uma lista de Entradas na coleçõespai.

Atributos

entries array<object>

As Entradas do âmbito especificado.

nextPageToken string

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

value number

O valor para atualizar o registro. 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 pedido 400.