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

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

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

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