Method: courses.courseWorkMaterials.list

傳回允許要求者查看的課程作品清單。

課程學生只能查看 PUBLISHED 門課程的作業教材。課程老師和網域管理員可以查看所有課程作業教材，

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

  • PERMISSION_DENIED：要求的使用者無法存取要求的課程，或是存取錯誤。
  • 如果要求格式錯誤，則為 INVALID_ARGUMENT。
  • 如果要求的課程不存在，則為 NOT_FOUND。

HTTP 要求

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials

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

路徑參數

參數
courseId

string

課程的 ID。這個 ID 可以是 Classroom 指派的 ID 或 alias。

查詢參數

參數
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

要傳回的工作狀態限制。系統只會傳回相符的課程作業教材。如未指定，系統會傳回工作狀態為 PUBLISHED 的項目。
orderBy

string

結果的排序排序 (選用)。以半形逗號分隔的欄位清單，其中包含選用的排序方向關鍵字。支援的欄位為「updateTime」。支援的方向關鍵字為 asc 和 desc。如未指定，updateTime desc 為預設行為。範例：updateTime asc、updateTime
pageSize

integer

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

伺服器傳回的結果數量可能會少於指定數量。
pageToken

string

從先前的 list 呼叫傳回的 nextPageToken 值，表示應傳回後續頁面的結果。

list 要求必須與產生這個權杖的要求相同。
materialDriveId

string

可選擇篩選課程作業教材，其中至少有一項雲端硬碟教材的 ID 與指定字串相符。如果也指定了 materialLink，課程作業教材的教材就必須同時符合兩種篩選器。

要求主體

要求主體必須為空白。

回應主體

列出課程作業教材時的回應。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "courseWorkMaterial": [
    {
      object (CourseWorkMaterial)
    }
  ],
  "nextPageToken": string
}
欄位
courseWorkMaterial[]

object (CourseWorkMaterial)

符合要求的課程教材項目。
nextPageToken

string

用於識別下一頁結果的權杖。如果留空，系統就不會顯示進一步結果。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/classroom.courseworkmaterials
  • https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly

詳情請參閱授權指南。