Method: courses.students.list

リクエスト元に閲覧が許可されているこのコースの受講者のリストを返します。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

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

クエリ パラメータ

パラメータ
pageSize

integer

返されるアイテムの最大数。指定しない場合のデフォルトは 30、または 0 です。

サーバーが返す結果の数は、指定した数より少ないことがあります。
pageToken

string

前回の list 呼び出しから返された nextPageToken 値。結果の次のページを返す必要があることを示します。

それ以外の点では、list リクエストは、このトークンの生成元となったリクエストと同じである必要があります。

リクエスト本文

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

レスポンスの本文

生徒を一覧表示する場合のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
フィールド
students[]

object (Student)

リストのリクエストに合致する生徒。
nextPageToken

string

返される結果の次のページを識別するトークン。空の場合、これ以上結果はありません。

認可スコープ

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

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