*此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下這裡。

User

代表任何已註冊的 Roblox 使用者。

特性

pathstring

使用者的資源路徑。

格式：users/{user_id}.

createTimestring
僅限輸出

使用者創建時的時戳。. 此字串的格式為 Timestamp。

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 | 預設使用者縮略圖形狀 -- 設為圓形 | | 圓形 | 生成縮略圖為圓形。| | 廣場 | 生成縮略圖為長方形。 |. 可能的值：

回應

此方法不同步且會傳回一個「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}'