Armazenamentos de dados padrão

*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 padrão.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.

Datastores

https://apis.roblox.com/datastores

Os seguintes endpoints estão disponíveis em caminhos relativos à URL base.

Lista de armazenamentos de dados

GET /v1/universes/{universeId}/standard-datastores

Retorna uma lista de armazenamentos de dados de uma experiência.

Parâmetros

universeId number

O identificador da experiência com armazenamentos de dados que você deseja acesso.Você pode copiar o ID do Universo da sua experiência no Painel do Criador .

Path

Obrigatório

cursor string

Forneça para solicitar o próximo conjunto de dados. Veja Cursors.

limit number

O número máximo de itens a retornar.Cada chamada só lê uma partição, então ela pode retornar menos do que o valor dado quando ficar sem objetivos em uma partição.

prefix string

Forneça para retornar apenas armazenamentos de dados com esse prefixo.

Solicitação

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "prefix=Player" \
-d "limit=5"

Resposta

200 - OK

Retorna um(a) object

application/json

{
  "datastores": [
    {
      "name": "PlayerInventory",
      "createdTime": "2022-02-18T22:38:59.9244932Z"
    },
    {
      "name": "PlayerExperience",
      "createdTime": "2022-02-18T23:00:10.4773508Z"
    },
    {
      "name": "PlayerWeapons",
      "createdTime": "2022-02-18T23:00:22.3725681Z"
    },
    {
      "name": "PlayerArmor",
      "createdTime": "2022-02-18T22:59:33.8472882Z"
    },
    {
      "name": "PlayerHP",
      "createdTime": "2022-02-18T22:58:47.6904028Z"
    }
  ],
  "nextPageCursor": "..."
}

data array<object>

Uma variedade de armazenamentos de dados na experiência alvo.

nextPageCursor string

Indica que há mais dados disponíveis no configurarde resultados solicitado. Veja Cursors.

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.

Listar armazenamento de dados

Entries

https://apis.roblox.com/datastores

Os seguintes endpoints estão disponíveis em caminhos relativos à URL base.

Listar Entradas

GET /v1/universes/{universeId}/standard-datastores/datastore/entries

Retorna uma lista de chaves de entrada dentro de um lojade dados.

Parâmetros

universeId number

O identificador da experiência com armazenamentos de dados que você deseja acesso.Você pode copiar o ID do Universo da sua experiência no Painel do Criador .

Path

Obrigatório

datastoreName string

O nome do armazenamento de dados.

scope string

O valor é global por padrão. Veja Escopos .

allScopes boolean

Defina como verdadeiro para retornar chaves de todos os escopos.

prefix string

Forneça para retornar apenas chaves com esse prefixo.

cursor string

Forneça para solicitar o próximo conjunto de dados. Veja Cursors.

limit number

O número máximo de itens a retornar.Cada chamada só lê uma partição, então ela pode retornar menos do que o valor dado quando ficar sem objetivos em uma partição.

Solicitação

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "prefix=" \
-d "limit=5"

Resposta

200 - OK

Retorna um(a) object

application/json

{
  "keys": [
    {
      "key": "269323"
    }
  ],
  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"
}

keys array<string>

Um conjunto de chaves de entrada dentro do armazenamento de dados alvo.

nextPageCursor string

Indica que há mais dados disponíveis no configurarde resultados solicitado. Veja Cursors.

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.

Listar chaves de entradas

Obter Entrada

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Retorna o valor e os metadados associados a uma entrada.

Metadados podem ser encontrados nos cabeçalhos de resposta como o seguindo:


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

| Cabeceio | Descrição | |---|---| | content-md5 | O resumo MD5 codificado em base-64 do conteúdo.Veja Conteúdo-MD5.| | roblox-entry-version | A versão da entrada retornada.| | roblox-entry-created-time | A hora em que a entrada foi criada.| | roblox-entry-version-created-time | A hora em que esta versão específica foi criada.| | roblox-entry-attributes | Atributos rotulados com a entrada.Objeto de mapa JSON serializado.| | roblox-entry-userids | Lista separada por vírgula de IDs de usuário do Roblox marcados com a entrada. |

Parâmetros

universeId number

O identificador da experiência com armazenamentos de dados que você deseja acesso.Você pode copiar o ID do Universo da sua experiência no Painel do Criador .

Path

Obrigatório

datastoreName string

O nome do armazenamento de dados.

entryKey string

A chave que identifica a entrada.

scope string

O valor é global por padrão. Veja Escopos .

Solicitação

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

Resposta

200 - OK

Recuperado com sucesso a entrada.

Retorna um(a) object

204 - No Content

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.

Ler Entrada

Definir Entrada

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Define o valor, metadados e IDs de usuário associados a uma entrada.

Parâmetros

universeId number

O identificador da experiência com armazenamentos de dados que você deseja acesso.Você pode copiar o ID do Universo da sua experiência no Painel do Criador .

Path

Obrigatório

datastoreName string

O nome do armazenamento de dados.

entryKey string

A chave que identifica a entrada.

matchVersion string

Forneça para atualizar apenas se a versão atual corresponder a isso.

exclusiveCreate boolean

Crie a entrada somente se ela não existir.

scope string

O valor é global por padrão. Veja Escopos .

roblox-entry-attributes string

Atributos a serem associados à nova versão da entrada. Serializados por objetos de mapa JSON. Se não for fornecido, os atributos existentes são limpados.

Header

roblox-entry-userids string

Lista separada por vírgula de IDs de usuário do Roblox marcados com a entrada. Se não for fornecido, os IDs de usuário existentes são limpados.

Header

content-md5 string

O resumo de MD5 codificado em base-64 do conteúdo. Veja Conteúdo-MD5.

Header

Solicitação

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323" \
--header "x-api-key: ${API_KEY}" \
--header "content-md5: IGPBYI1uC6+AJJxC4r5YBA==" \
--header "content-type: application/json" \
--header "roblox-entry-userids: [269323]" \
--header "roblox-entry-attributes: {}" \
--d "value"

Resposta

200 - OK

Retorna um(a) object

version string

O nome da versão da entrada qualificada.

deleted boolean

Indica se a entrada foi excluída.

contentLength number

O comprimento do conteúdo.

createdTime string

O horário de quando a versão foi criada no formato de tempo da ISO.

objectCreatedTime string

O timestamp de quando o armazenamento de dados foi criado no formato de tempo ISO.

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 Entrada
Atualizar entrada

Apagar Entrada

DELETE /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Marca a entrada como excluída ao criar uma versão de lápide. As entradas são excluídas permanentemente após 30 dias.

Parâmetros

universeId number

O identificador da experiência com armazenamentos de dados que você deseja acesso.Você pode copiar o ID do Universo da sua experiência no Painel do Criador .

Path

Obrigatório

datastoreName string

O nome do armazenamento de dados.

entryKey string

A chave que identifica a entrada.

scope string

O valor é global por padrão. Veja Escopos .

Solicitação

curl

curl --include --location --request DELETE "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

Resposta

204 - No Content

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 entrada

Entrada de Incremento

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment

Aumenta o valor para uma entrada em uma quantia dada ou cria uma nova entrada com essa quantia. Retorna a entrada e o metadado.

Metadados podem ser encontrados nos cabeçalhos de resposta como o seguindo:


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

Parâmetros

universeId number

O identificador da experiência com armazenamentos de dados que você deseja acesso.Você pode copiar o ID do Universo da sua experiência no Painel do Criador .

Path

Obrigatório

datastoreName string

O nome do armazenamento de dados.

entryKey string

A chave que identifica a entrada.

incrementBy number

A quantidade pelo qual a entrada deve ser incrementada ou o valor inicial se não existir.

scope string

O valor é global por padrão. Veja Escopos .

roblox-entry-attributes string

Atributos a serem associados à nova versão da entrada. Serializados por objetos de mapa JSON. Se não for fornecido, os atributos existentes são limpados.

Header

roblox-entry-userids string

Uma lista separada por vírgula de IDs de usuário do Roblox com os quais a entrada é marcada. Se não for fornecida, os IDs de usuário existentes são limpados.

Header

Solicitação

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/increment" \
--header "x-api-key: ${API_KEY}" \
--header 'content-length: 0' \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "incrementBy=3"

Resposta

200 - OK

Retorna a versão mais recente da entrada depois que ela foi incrementada.

Retorna um(a) object

204 - No Content

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 Entrada
Atualizar entrada

Obtenha a versão de entrada

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version

Retorna o valor e os metadados de uma versão específica de uma entrada.

Metadados podem ser encontrados nos cabeçalhos de resposta como o seguindo:


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

Parâmetros

universeId number

O identificador da experiência com armazenamentos de dados que você deseja acesso.Você pode copiar o ID do Universo da sua experiência no Painel do Criador .

Path

Obrigatório

datastoreName string

O nome do armazenamento de dados.

entryKey string

A chave que identifica a entrada.

versionId string

A versão para inspecionar.

scope string

O valor é global por padrão. Veja Escopos .

Solicitação

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions/version" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "versionId=08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01"

Resposta

200 - OK

Recuperado com sucesso a entrada.

Retorna um(a) object

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.

Ler versão

Limites

Por chave de API: 5000 solicitações a cada 60 segundos por endereço IP

Listar Versões de Entrada

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions

Retorna uma lista de versões para uma entrada.

Parâmetros

universeId number

O identificador da experiência com armazenamentos de dados que você deseja acesso.Você pode copiar o ID do Universo da sua experiência no Painel do Criador .

Path

Obrigatório

datastoreName string

O nome do armazenamento de dados.

entryKey string

A chave que identifica a entrada.

scope string

O valor é global por padrão. Veja Escopos .

cursor string

Forneça para solicitar o próximo conjunto de dados (veja Cursors).

startTime string

Forneça para não incluir versões anteriores a este timestamp.

endTime string

Forneça para não incluir versões posteriores a esse timestamp.

sortOrder string

Ou Ascending (versões anteriores primeiro) ou Descending (versões posteriores primeiro).

limit number

O número máximo de itens a retornar.Cada chamada só lê uma partição, então ela pode retornar menos do que o valor dado quando ficar sem objetivos em uma partição.

Solicitação

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "limit=5"

Resposta

200 - OK

Retorna um(a) object

version string

O nome da versão da entrada qualificada.

deleted boolean

Indica se a entrada foi excluída.

contentLength number

O comprimento do conteúdo.

createdTime string

O horário de quando a versão foi criada no formato de tempo da ISO.

objectCreatedTime string

O timestamp de quando o armazenamento de dados foi criado no formato de tempo ISO.

Outros códigos de status

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.

Listar versões

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.

DataStore

O objeto armazenamento de dados com seu nome e tempo de criação.

Atributos

name string

O nome do seu lojade dados.

createdTime string

O timestamp de quando o armazenamento de dados foi criado no formato de tempo ISO.

EntryVersion

O objeto de versão de entrada retornado pelo método List Entry Versions.

Atributos

version string

O nome da versão da entrada qualificada.

deleted boolean

Indica se a entrada foi excluída.

contentLength number

O comprimento do conteúdo.

createdTime string

O horário de quando a versão foi criada no formato de tempo da ISO.

objectCreatedTime string

O timestamp de quando o armazenamento de dados foi criado no formato de tempo ISO.

Armazenamentos de dados padrão

Datastores

Lista de armazenamentos de dados

Parâmetros

Solicitação

Resposta

Permissões necessárias

Entries

Listar Entradas

Parâmetros

Solicitação

Resposta

Permissões necessárias

Obter Entrada

Parâmetros

Solicitação

Resposta

Permissões necessárias

Definir Entrada

Parâmetros

Solicitação

Resposta

Permissões necessárias

Apagar Entrada

Parâmetros

Solicitação

Resposta

Permissões necessárias

Entrada de Incremento

Parâmetros

Solicitação

Resposta

Permissões necessárias

Obtenha a versão de entrada

Parâmetros

Solicitação

Resposta

Permissões necessárias

Limites

Listar Versões de Entrada

Parâmetros

Solicitação

Resposta

Permissões necessárias

Objetos

DataStore

Atributos

EntryVersion

Atributos

Nesta página