*此内容使用人工智能（Beta）翻译，可能包含错误。若要查看英文页面，请点按 此处。

User

代表任何注册用户的 Roblox。

属性

pathstring

用户的资源路径。

格式：users/{user_id}.

createTimestring
仅输出

用户创建时的时戳。. 此字符串格式为 FieldMask。

idstring
仅输出

在 Roblox 中识别用户的唯一 ID。.

namestring

Roblox 中用户的唯一用户名。.

displayNamestring

用户的显示名称。.

aboutstring

用户对自己的定义信息。.

localestring

用户选择的当前本地。返回 IETF 语言代码。.

premiumboolean
仅输出

用户是否是高级用户。.

idVerifiedboolean
仅输出

指定用户是否验证身份。验证包括但不限于非 VoIP 电话号码或政府身份证。

要访问这些数据，您需要具有以下范围的 API 钥匙/OAuth 代币：user.advanced:read.

socialNetworkProfilesobject

用户的社交网络个人资料和可见度。.

基本网址
https://apis.roblox.com
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

获取用户
Beta

GET /cloud/v2/users/{user_id}

获取用户的基本和高级信息。

要访问用户的公共信息，不需要额外的范围。

要访问用户的验证状态，您需要以下范围：

  • 用户.高级：阅读

要访问用户的社交帐户信息，您需要以下范围：

  • 用户.social：阅读
请求路径参数
user_idstring
必填

用户ID。.

答复User
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}'
答复
{

  "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

生成用户缩略图
Beta

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

生成并返回用户的头像缩略图的 URL。

请求路径参数
user_idstring
必填

用户ID。.

查询参数
sizenumber

生成的缩略图大小。生成的缩略图将有 size * size 维度。

目前支持的值：48、50、60、75、100、110、150、180、352、420、720 默认值为 420。.

formatEnum<string>

指定生成的缩略图格式。默认值为 PNG 。

可能的值：

| 值 | 描述 | | --- | --- | | FORMAT_UNSPECIFIED | 默认用户缩略图格式 -- 设置为png | | PNG | 在 .png 格式生成缩略图 | | JPEG | 在 .jpg 格式生成缩略图 |. 可能的值：

shapeEnum<string>

指定缩略图的形状。默认值为 ROUND （圆形）。

可能的值：

| 值 | 描述 | | --- | --- | | SHAPE_UNSPECIFIED | 默认用户缩略图形状--设置为圆形| | ROUND |将缩略图生成为圆形。| | 广场 | 生成缩略图为长方形。 |. 可能的值：

答复

此方法是异步的，会返回一个Operation对象，该对象表示操作的当前状态。它包含一个端点路径，您可以轮询该路径以获取实际响应和相关的元数据。有关长时间运行操作的更多信息，请参阅文档。

以下部分描述了操作完成时提供的响应和元数据对象。

答复

返回用户的虚拟形象缩略图的 URL。

imageUristring

生成的缩略图的 URI。.

元数据

无

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