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

詳情請參閱 OAuth 2.0 總覽