Method: courses.list

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

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

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
studentId

string

指定された ID を持つ生徒が登録されているコースのみを返します。ID は次のいずれかです。

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

string

指定された ID の教師が割り当てられているコースのみを返します。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

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