Google Classroom アドオンの一般提供が開始されました。詳しくは、
アドオンのドキュメントをご覧ください。
REST Resource: userProfiles
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
リソース: UserProfile
JSON 表現 |
{
"id": string,
"name": {
object (Name )
},
"emailAddress": string,
"photoUrl": string,
"permissions": [
{
object (GlobalPermission )
}
],
"verifiedTeacher": boolean
} |
フィールド |
id |
string
ユーザーの ID。 読み取り専用です。
|
name |
object (Name )
ユーザーの名前。 読み取り専用です。
|
emailAddress |
string
ユーザーのメールアドレス。 このフィールドをレスポンス本文に入力するには、https://www.googleapis.com/auth/classroom.profile.emails スコープをリクエストする必要があります。 読み取り専用です。
|
photoUrl |
string
ユーザーのプロフィール写真の URL。 このフィールドをレスポンス本文に入力するには、https://www.googleapis.com/auth/classroom.profile.photos スコープをリクエストする必要があります。 読み取り専用です。
|
permissions[] |
object (GlobalPermission )
ユーザーのグローバル権限。 読み取り専用です。
|
verifiedTeacher |
boolean
Google Workspace for Education ユーザーのドメイン管理者が、そのユーザーが教師であることを明示的に確認したかどうかを表します。ユーザーが Google Workspace for Education ドメインのメンバーでない場合、このフィールドは常に false になります。 読み取り専用
|
名前
JSON 表現 |
{
"givenName": string,
"familyName": string,
"fullName": string
} |
フィールド |
givenName |
string
ユーザーの名。 読み取り専用です。
|
familyName |
string
ユーザーの姓。 読み取り専用です。
|
fullName |
string
ユーザーのフルネームは、姓と名の値を連結して作成されます。 読み取り専用です。
|
権限
列挙型 |
PERMISSION_UNSPECIFIED |
権限が指定されていません。これは返されず、有効な値ではありません。 |
CREATE_COURSE |
ユーザーはコースを作成できます。 |
メソッド |
|
ユーザーが指定された Classroom 機能を使用できるかどうかを返します。 |
|
ユーザー プロフィールを返します。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# REST Resource: userProfiles\n\n- [Resource: UserProfile](#UserProfile)\n - [JSON representation](#UserProfile.SCHEMA_REPRESENTATION)\n - [Name](#UserProfile.Name)\n - [JSON representation](#UserProfile.Name.SCHEMA_REPRESENTATION)\n - [GlobalPermission](#UserProfile.GlobalPermission)\n - [JSON representation](#UserProfile.GlobalPermission.SCHEMA_REPRESENTATION)\n - [Permission](#UserProfile.Permission)\n- [Methods](#METHODS_SUMMARY)\n\nResource: UserProfile\n---------------------\n\nGlobal information for a user.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"name\": { object (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Name) }, \"emailAddress\": string, \"photoUrl\": string, \"permissions\": [ { object (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.GlobalPermission) } ], \"verifiedTeacher\": boolean } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier of the user. Read-only. |\n| `name` | `object (`[Name](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Name)`)` Name of the user. Read-only. |\n| `emailAddress` | `string` Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only. |\n| `photoUrl` | `string` URL of user's profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only. |\n| `permissions[]` | `object (`[GlobalPermission](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.GlobalPermission)`)` Global permissions of the user. Read-only. |\n| `verifiedTeacher` | `boolean` Represents whether a Google Workspace for Education user's domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only |\n\n### Name\n\nDetails of the user's name.\n\n| JSON representation |\n|---------------------------------------------------------------------------|\n| ``` { \"givenName\": string, \"familyName\": string, \"fullName\": string } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------|\n| `givenName` | `string` The user's first name. Read-only. |\n| `familyName` | `string` The user's last name. Read-only. |\n| `fullName` | `string` The user's full name formed by concatenating the first and last name values. Read-only. |\n\n### GlobalPermission\n\nGlobal user permission description.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------|\n| ``` { \"permission\": enum (/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Permission) } ``` |\n\n| Fields ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------|\n| `permission` | `enum (`[Permission](/workspace/classroom/reference/rest/v1/userProfiles#UserProfile.Permission)`)` Permission value. |\n\n### Permission\n\nPossible permissions that a user may have.\n\n| Enums ||\n|--------------------------|----------------------------------------------------------------------------|\n| `PERMISSION_UNSPECIFIED` | No permission is specified. This is not returned and is not a valid value. |\n| `CREATE_COURSE` | User is permitted to create a course. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [checkUserCapability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability) | | **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20240930_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more. Returns whether a user may use the specified Classroom capability. |\n| ### [get](/workspace/classroom/reference/rest/v1/userProfiles/get) | Returns a user profile. |"]]