*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

User

Roblox に登録されたユーザーを代表します。

属性

pathstring

ユーザーのリソースパス。

形式: users/{user_id}.

createTimestring
出力のみ

ユーザーが作成された時刻のタイムスタンプ。. この文字列は Timestamp としてフォーマットされています。

idstring
出力のみ

Roblox でユーザーを識別するユニークなID。.

namestring

Roblox のユーザーのユニークなユーザー名。.

displayNamestring

ユーザーの表示名。.

aboutstring

自分に関するユーザー定義の情報。.

localestring

ユーザーが選択した現在のローカル。IETF 言語コードを返します。.

premiumboolean
出力のみ

ユーザーがプレミアムユーザーか否か。.

idVerifiedboolean
出力のみ

ユーザーが身分証明されているかどうかを指定します。認証には、VoIP 電話番号や政府のID などが含まれますが、限定されていません。

このデータにアクセスするには、次のスコープを持つ API キー/OAuth トークンが必要です:user.advanced:read.

socialNetworkProfilesobject

ユーザーのソーシャルネットワークプロフィールと視認性。.

ベース URL

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

ユーザーを取得
ベータ版

GET /cloud/v2/users/{user_id}

ユーザーの基本および詳細情報を取得します。

ユーザーの公開情報にアクセスするには、追加のスコープは必要ありません。

ユーザーの認証ステータスにアクセスするには、次のスコープが必要です:

  • user.advanced:読み込み

ユーザーのソーシャルアカウント情報にアクセスするには、次のスコープが必要です:

  • user.social:read
リクエストパスのパラメータ
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

ユーザーのサムネイルを生成する
ベータ版

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