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

string

僅允許老師具有指定 ID 的老師查看課程。ID 可以是下列其中一項：

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

enum (CourseState)

限制只傳回其中一個指定狀態的課程，預設值為 ACTIVE、ARCHIVED、PROVISIONED、DECLINED。
pageSize

integer

要傳回的項目數上限。0 或未指定時，表示伺服器可能會指派上限。

伺服器傳回的結果數量可能會少於指定數量。
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

詳情請參閱授權指南。