Method: userProfiles.get

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

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

  • PERMISSION_DENIED: リクエスト元のユーザーにこのユーザー プロフィールへのアクセス権がない場合、リクエストされた ID のプロフィールが存在しない場合、アクセス エラーの場合。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
userId

string

返すプロファイルの ID。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

詳しくは、認可ガイドをご覧ください。