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

Method: courses.list

リクエストしているユーザーに閲覧を許可するコースのリストを返します。ただし、リクエストに一致するコースに限定されます。返却されたコースは、作成日時の新しいものから順に表示されます。

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

  • PERMISSION_DENIED: アクセスエラー
  • クエリ引数の形式が正しくない場合は、INVALID_ARGUMENT
  • クエリ引数で指定されたユーザーが存在しない場合は NOT_FOUND

HTTP リクエスト

GET https://classroom.googleapis.com/v1/courses

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

クエリ パラメータ

パラメータ
studentId

string

指定された ID の学生がいるコースのみを返します。ID は次のいずれかです。

  • ユーザーの数値識別子
  • ユーザーのメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"
teacherId

string

指定された ID を持つ教師のコースのみを返すように制限します。ID は次のいずれかです。

  • ユーザーの数値識別子
  • ユーザーのメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"
courseStates[]

enum (CourseState)

返されるコースを、指定した状態のコースに限定します。デフォルト値は ACTIVE、ARCHIVED、PROVISIONED、DECLINED です。

pageSize

integer

返されるアイテムの最大数。0 または未指定は、サーバーが最大値を割り当てる可能性があることを示します。

サーバーから返された結果の数が指定した数より少なくなる場合があります。

pageToken

string

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

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

リクエスト本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

コースを一覧表示する際に表示されるレスポンス。

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

object (Course)

リストのリクエストに一致するコース。

nextPageToken

string

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

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