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

User

Representa qualquer usuário registrado do Roblox.

Atributos

pathstring

O caminho de recursos do usuário.

Formato: users/{user_id}.

createTimestring
Apenas saída

O horário em que o usuário foi criado. Esta cadeia de caracteres é formatada como um Timestamp.

idstring
Apenas saída

ID exclusivo que identifica um usuário no Roblox.

namestring

Nome de usuário exclusivo para um usuário no Roblox.

displayNamestring

Nome de exibição para o usuário.

aboutstring

Informações definidas pelo usuário sobre si mesmos.

localestring

Local atual selecionado pelo usuário. Retorna código de idioma do IETF.

premiumboolean
Apenas saída

Se o usuário é um usuário premium.

idVerifiedboolean
Apenas saída

Especifica se o usuário está verificado de identidade. A verificação inclui, mas não se limita a números de telefone não VoIP ou IDs do governo.

Para acessar esses dados, você precisa de uma chave de API/token OAuth com o seguinte escopo: user.advanced:read.

socialNetworkProfilesobject

Perfis de rede social e visibilidade do usuário.

URL base

https://apis.roblox.com
O recurso User

{
"path": "users/123",
"createTime": "2023-07-05T12:34:56Z",
"id": "123456",
"name": "exampleUser",
"displayName": "userDefinedName",
"about": "Example User's bio",
"locale": "en-US",
"premium": true,
"idVerified": true,
"socialNetworkProfiles": {
"facebook": "string",
"twitter": "string",
"youtube": "string",
"twitch": "string",
"guilded": "string",
"visibility": "SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED"
}
}

User

Obter Usuário
Beta

GET /cloud/v2/users/{user_id}

Obtém as informações básicas e avançadas de um usuário.

Para acessar a informação pública de um usuário, não são necessários mais escopos adicionais.

Para acessar o status de verificação de um usuário, você precisa dos seguintes escopos:

  • user.advanced:read

Para acessar as informações da conta social de um usuário, você precisa dos seguintes escopos:

  • user.social:read
SolicitaçãoParâmetros de endereço
user_idstring
Obrigatório

O ID do usuário.

RespostaUser
GET /cloud/v2/users/{user_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user_id}' \
-H 'x-api-key: {your-api-key}'
Resposta

{
"path": "users/123",
"createTime": "2023-07-05T12:34:56Z",
"id": "123456",
"name": "exampleUser",
"displayName": "userDefinedName",
"about": "Example User's bio",
"locale": "en-US",
"premium": true,
"idVerified": true,
"socialNetworkProfiles": {
"facebook": "string",
"twitter": "string",
"youtube": "string",
"twitch": "string",
"guilded": "string",
"visibility": "SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED"
}
}

User

Gerar Imagem de Perfil do Usuário
Beta

GET /cloud/v2/users/{user_id}:generateThumbnail

Gera e retorna o URL da miniatura do avatar do usuário.

SolicitaçãoParâmetros de endereço
user_idstring
Obrigatório

O ID do usuário.

Parâmetros da consulta
sizenumber

Tamanho da miniatura gerada. A miniatura gerada terá size * size dimensão.

Valores atualmente suportados: 48, 50, 60, 75, 100, 110, 150, 180, 352, 420, 720 O padrão é 420.

formatEnum<string>

Especifique o formato da miniatura gerada. O padrão é PNG .

Valores possíveis:

| Valor | Descrição | | --- | --- | | FORMAT_UNSPECIFIED | Formato Padrão de Imagem de Usuário -- definido para png | | PNG | Gerar miniatura no formato .png | | JPEG | Gerar miniatura no formato .jpg |. Valores possíveis:

shapeEnum<string>

Especifique a forma da miniatura. O padrão é ROUND (circular).

Valores possíveis:

| Valor | Descrição | | --- | --- | | SHAPE_UNSPECIFIED | Forma padrão de usuário de imagem -- definida para redonda | | ROUND | Gerar miniatura como um círculo.| | SQUARE | Gerar miniatura como um retângulo. |. Valores possíveis:

Resposta

Este método é assíncrono e retorna uma "Operação", que representa o estado atual da operação. Ele contém um caminho de endpoint que você pode solicitar para obter a resposta real e os metadados aplicáveis. Veja o documentation em operações de longo prazo para obter mais informações.

As seções a seguir descrevem os objetos de resposta e metadados que são fornecidos quando uma operação se completa.

Resposta

Retorna o URL para a miniatura do avatar do usuário.

imageUristring

URI para a miniatura gerada.

Metadados

Nenhum

GET /cloud/v2/users/{user_id}:generateThumbnail

curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user_id}:generateThumbnail?size={integer}&format={string}&shape={string}' \
-H 'x-api-key: {your-api-key}'