REST Resource: courses.courseWorkMaterials

資源:CourseWorkMaterial

老師為課程學生建立的課程作業教材

JSON 表示法
{
  "courseId": string,
  "id": string,
  "title": string,
  "description": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (CourseWorkMaterialState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string,
  "topicId": string
}
欄位
courseId

string

課程的 ID。

唯讀。

id

string

這項課程作業教材在 Classroom 中指派的 ID,每個課程都不相同。

唯讀。

title

string

這項課程作業教材的名稱。標題必須是有效的 UTF-8 字串,長度介於 1 至 3000 個字元之間。

description

string

這項課程作業教材的說明 (選填)。文字必須是有效的 UTF-8 字串,且不得超過 30,000 個字元。

materials[]

object (Material)

其他資料。

課程作業教材最多只能有 20 個教材項目。

state

enum (CourseWorkMaterialState)

這項課程作業資料的狀態。如未指定,預設狀態為 DRAFT

creationTime

string (Timestamp format)

建立這項課程作業教材的時間戳記。

唯讀。

使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

最近一次變更這項課程作業教材的時間戳記。

唯讀。

使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

scheduledTime

string (Timestamp format)

選填時間戳記,表示預計發布這項課程作業教材的時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

assigneeMode

enum (AssigneeMode)

課程作業教材的指派模式。如未指定,則預設值為 ALL_STUDENTS

individualStudentsOptions

object (IndividualStudentsOptions)

可存取課程作業教材的學生 ID。只有在 assigneeModeINDIVIDUAL_STUDENTS 時,才會設定這個欄位。如果 assigneeModeINDIVIDUAL_STUDENTS,則只有這個欄位中指定的學生可以查看教材。

creatorUserId

string

建立課程作業教材的使用者 ID。

唯讀。

topicId

string

與這項課程作業教材相關聯的主題 ID。必須與課程中的現有主題相符。

CourseWorkMaterialState

課程作業資料的可能狀態

列舉
COURSEWORK_MATERIAL_STATE_UNSPECIFIED 未指定任何州別。系統不會傳回這項資訊。
PUBLISHED 已發布課程作業教材的狀態。這是預設狀態。
DRAFT 尚未發布的課程作業教材狀態。處於這個狀態的課程作業資料,只有課程老師和網域管理員才能查看。
DELETED 已發布但現已刪除的課程作業教材狀態。處於這個狀態的課程作業資料,只有課程老師和網域管理員才能查看。處於這種狀態的課程作業資料會在一段時間後刪除。

方法

create

建立課程作業教材。

delete

刪除課程作業教材。

get

傳回課程作業教材。

getAddOnContext

取得特定貼文的 Classroom 外掛程式中繼資料。

list

傳回要求者有權查看的課程作業資料清單。

patch

更新一或多個課程作業資料欄位。