Method: courses.list

リクエストに一致するコースに限定して、リクエスト ユーザーが閲覧できるコースのリストを返します。返されるコースは作成時間で並べ替えられ、最も新しいものが最初に表示されます。

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

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
studentId

string

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

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

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

string

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

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

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

enum (CourseState)

返されるコースを、指定された状態のいずれかのコースに制限します。指定しない場合は、すべての状態のコースが返されます。
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

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