*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

OrderedDataStoreEntry

Uma entrada de chave-valor em um armazenamento de dados ordenado.

Atributos

pathstring

O caminho de recursos da entrada do armazenamento de dados 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

O valor da entrada.

Sempre arredondado para o inteiro mais próximo.

idstring
Apenas saída

O nome da entrada.

URL base
https://apis.roblox.com
O 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 armazenamento de dados ordenadas
Beta

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

Retorna uma lista de entradas de um armazenamento de dados ordenado.

Escopos
universe.ordered-data-store.scope.entry:read
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

ordered_data_store_idstring
Obrigatório

O ID da loja de dados solicitada.

scope_idstring
Obrigatório

O ID do escopo.

Parâmetros da consulta
maxPageSizenumber

O número máximo de entradas de armazenamento de dados solicitadas para retornar.O serviço pode retornar menos que esse valor.Se não especificado, no máximo 10 entradas de armazenamento de dados solicitadas são retornadas.O valor máximo é 100 e valores mais altos são definidos como 100.

pageTokenstring

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.

orderBystring

Se especificado, os resultados são ordenados de acordo com os campos especificados.

Os valores devem ser uma lista separada por vírgula de campos, com um sufixo "desc" opcional por campo para classificar por valores decrescentes em vez de ascendentes.Você pode acessar subcampos com um operador ..

Os resultados podem ser ordenados pelos seguintes campos: valor.

Exemplo: "value desc".

filterstring

Este campo pode ser definido para filtrar os recursos retornados.

Suportamos dois operadores de comparação para essa operação: <= e >=. Esses operadores de comparação atuam como um minValue e maxValue para os valores retornados.Se for necessário filtrar um valor entre um minValue e um maxValue, o usuário pode usar o operador lógico &&.Todos os tokens na expressão de filtro devem ser separados por um único espaço.

Exemplos de filtros: entry <= 10; entry >= 10 && entry <= 30.

Resposta

Uma lista de OrderedDataStoreEntries na coleção pai.

orderedDataStoreEntriesarray<OrderedDataStoreEntry>

Os OrderedDataStoreEntries do especificado OrderedDataStoreScope.

nextPageTokenstring

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.

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}'
Resposta
{

  "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

Criar Entrada de Armazenamento de Dados Ordenados
Beta

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

Cria uma entrada com o ID e o valor fornecidos.

Retorna um pedido 400 ruim se a entrada existir.

Escopos
universe.ordered-data-store.scope.entry:write
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

ordered_data_store_idstring
Obrigatório

O ID da loja de dados solicitada.

scope_idstring
Obrigatório

O ID do escopo.

Parâmetros da consulta
idstring

O ID para usar na entrada do armazenamento de dados solicitado, que se tornará o componente final do caminho de recursos da entrada do armazenamento de dados solicitado.

Este valor deve ser uma string de caracteres de 1 a 63. Recomendamos fortemente usar apenas letras minúsculas, números e hifens.

Requisitar corpoOrderedDataStoreEntry
RespostaOrderedDataStoreEntry
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"

}'
Resposta
{

  "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

Obter Entrada de Armazenamento de Dados Ordenados
Beta

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

Obtém a entrada especificada.

Escopos
universe.ordered-data-store.scope.entry:read
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

ordered_data_store_idstring
Obrigatório

O ID da loja de dados solicitada.

scope_idstring
Obrigatório

O ID do escopo.

entry_idstring
Obrigatório

O ID de entrada.

RespostaOrderedDataStoreEntry
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}'
Resposta
{

  "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

Excluir Entrada da Loja de Dados Ordenados
Beta

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

Exclui a entrada especificada.

Ao sucesso, retorna 200 OK. Se a entrada não existir, retorna 404 Não Encontrado.

Escopos
universe.ordered-data-store.scope.entry:write
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

ordered_data_store_idstring
Obrigatório

O ID da loja de dados solicitada.

scope_idstring
Obrigatório

O ID do escopo.

entry_idstring
Obrigatório

O 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

Atualizar Entrada da Loja de Dados Ordenados
Beta

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

Atualiza o valor de uma entrada.

Escopos
universe.ordered-data-store.scope.entry:write
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

ordered_data_store_idstring
Obrigatório

O ID da loja de dados solicitada.

scope_idstring
Obrigatório

O ID do escopo.

entry_idstring
Obrigatório

O ID de entrada.

Parâmetros da consulta
allowMissingboolean

Se definido como verdadeiro e a entrada de armazenamento de dados solicitada não for encontrada, uma entrada de armazenamento de dados solicitada é criada.

Requisitar corpoOrderedDataStoreEntry
RespostaOrderedDataStoreEntry
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"

}'
Resposta
{

  "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 da Loja de Dados Ordenada de Incremento
Beta

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

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.

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.

Escopos
universe.ordered-data-store.scope.entry:write
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

ordered_data_store_idstring
Obrigatório

O ID da loja de dados solicitada.

scope_idstring
Obrigatório

O ID do escopo.

entry_idstring
Obrigatório

O ID de entrada.

Requisitar corpo
amountnumber

A quantidade pelo qual aumentar o valor de entrada. Ambos o valor existente e a quantidade de incremento devem ser inteiros.

RespostaOrderedDataStoreEntry
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"

}'
Resposta
{

  "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"

}