ユーザーが Classroom と Google Meet を使用している場合は、Google Meet コースの生徒の出席状況を確認する Apps Script クイックスタートをご覧ください。

Method: courses.students.list

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

コースの識別子。この ID は、Classroom によって割り当てられた ID または 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

詳しくは、OAuth 2.0 の概要をご覧ください。