Method: courses.students.get

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

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

  • PERMISSION_DENIED: リクエストしたユーザーがこのコースの生徒を表示できない場合、またはアクセス エラーの場合。
  • NOT_FOUND: このコースの学生にリクエストされた ID がないか、コースが存在しない場合。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

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

string

返却する生徒の ID。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

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