ユーザーが Classroom と Google Meet を使用している場合は、Google Meet コースの生徒の出席状況を確認する Apps Script クイックスタートをご覧ください。

Method: userProfiles.get

ユーザー プロフィールを返します。

このメソッドは、次のエラーコードを返します。

  • PERMISSION_DENIED: リクエスト元のユーザーがこのユーザー プロファイルへのアクセスを許可されていない場合、リクエストされた ID を持つプロファイルが存在しない場合、またはアクセスエラーの場合。

HTTP リクエスト

GET https://classroom.googleapis.com/v1/userProfiles/{userId}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userId

string

返されるプロファイルの ID。ID は次のいずれかです。

  • ユーザーの数値識別子
  • ユーザーのメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には UserProfile のインスタンスが含まれます。

認証スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

詳しくは、OAuth 2.0 の概要をご覧ください。