Method: courses.students.list

リクエスト元が閲覧を許可されている、このコースの生徒のリストを返します。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

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

クエリ パラメータ

パラメータ
pageSize

integer

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

サーバーが指定した結果数よりも少ない結果を返すことがあります。
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

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