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

string

相应课程作业材料的 Classroom 分配的标识符,每个课程均唯一。

只读。

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)

有权访问课程作业资料的学生的标识符。只有当 assigneeModeINDIVIDUAL_STUDENTS 时,系统才会设置此字段。如果 assigneeModeINDIVIDUAL_STUDENTS,则只有此字段中指定的学生才能看到课程作业材料。

creatorUserId

string

创建课程作业资料的用户的标识符。

只读。

topicId

string

相应课程作业材料所关联的主题的标识符。必须与课程中的现有主题相匹配。

CourseWorkMaterialState

课程作业材料的可能状态

枚举
COURSEWORK_MATERIAL_STATE_UNSPECIFIED 未指定状态。此值永远不会返回。
PUBLISHED 已发布的课程作业资料的状态。这是默认状态。
DRAFT 尚未发布的课程作业资料的状态。处于此状态的课程作业材料仅对课程教师和网域管理员可见。
DELETED 已发布但现已删除的课程作业资料的状态。处于此状态的课程作业材料仅对课程教师和网域管理员可见。处于此状态的课程作业材料会在一段时间后被删除。

方法

create

创建课程作业材料。

delete

删除课程作业材料。

get

返回课程作业材料。

getAddOnContext

获取特定帖子上下文中 Google 课堂插件的元数据。

list

返回请求者有权查看的课程作业资料列表。

patch

更新课程作业资料的一个或多个字段。