Method: courses.list

リクエストを行うユーザーが表示を許可されているコースのリストを返します。リクエストに一致するコースのみが返されます。返されるコースは作成時間順に並べられ、最も新しいコースが最初に表示されます。

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

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
studentId

string

返されるコースを、指定された識別子を持つ生徒がいるコースに制限します。識別子には次のいずれかを指定できます。

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

指定する場合は、teacherId は空にする必要があります。
teacherId

string

返されるコースを、指定された識別子を持つ教師がいるコースに制限します。識別子には次のいずれかを指定できます。

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

指定する場合は、studentId は空にする必要があります。
courseStates[]

enum (CourseState)

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

integer

返されるアイテムの最大数。ゼロまたは未指定の場合、サーバーが最大数を割り当てることがあります。

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

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