Method: courses.students.get

コースの生徒を返します。

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

  • PERMISSION_DENIED: リクエスト元のユーザーにこのコースの受講者の表示が許可されていない場合、またはアクセスエラーが発生している場合。
  • このコースの生徒がリクエストされた ID を持っていない場合、またはコースが存在しない場合は、NOT_FOUND。

HTTP リクエスト

GET https://classroom.googleapis.com/v1/courses/{courseId}/students/{userId}

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

パスパラメータ

パラメータ
courseId

string

コースの識別子。この識別子は、Classroom で割り当てられた識別子または alias です。
userId

string

返却する生徒の識別子。ID は次のいずれかです。

  • ユーザーの数値 ID
  • ユーザーのメールアドレス
  • リクエストしているユーザーを示す文字列リテラル "me"

リクエスト本文

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

レスポンスの本文

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

認可スコープ

次の 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

詳細については、承認ガイドをご覧ください。