Method: courses.list

傳回要求使用者可查看的課程清單，但僅限於符合要求的課程。系統會依建立時間排序傳回的課程，最近建立的課程會排在最前面。

這個方法會傳回下列錯誤代碼：

  • PERMISSION_DENIED，瞭解存取錯誤。
  • 如果查詢引數格式有誤，則為 INVALID_ARGUMENT。
  • NOT_FOUND 如果查詢引數中指定的任何使用者不存在。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
studentId

string

將傳回的課程限制為有指定 ID 學生參與的課程。ID 可以是下列任一項：

  • 使用者的數字 ID
  • 使用者的電子郵件地址
  • 字串常值 "me"，表示要求的使用者

如果指定，teacherId 必須留空。
teacherId

string

將傳回的課程限制為具有指定 ID 老師的課程。ID 可以是下列任一項：

  • 使用者的數字 ID
  • 使用者的電子郵件地址
  • 字串常值 "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

詳情請參閱授權指南。