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

詳情請參閱授權指南。