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

要傳回的項目數量上限。如果為零或未指定，伺服器可能會指派上限。

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

string

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

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

string

選用篩選器，可篩選出至少有一項 Google 雲端硬碟資料的課程作業資料，且該資料的 ID 符合提供的字串。如果同時指定了 materialLink，課程作業資料必須符合這兩個篩選條件。
previewVersion

enum (PreviewVersion)

(選用步驟) API 的預覽版本。如要存取搶先體驗方案中提供給開發人員的新 API 功能，就必須設定這項屬性。

要求主體

要求主體必須為空白。

回應主體

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

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

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

詳情請參閱授權指南。