REST Resource: courses.courseWork

资源：CourseWork

教师为课程学生创建的课程作业。

JSON 表示法 
{
  "courseId": string,
  "id": string,
  "title": string,
  "description": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (CourseWorkState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "dueDate": {
    object (Date)
  },
  "dueTime": {
    object (TimeOfDay)
  },
  "scheduledTime": string,
  "maxPoints": number,
  "workType": enum (CourseWorkType),
  "associatedWithDeveloper": boolean,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "submissionModificationMode": enum (SubmissionModificationMode),
  "creatorUserId": string,
  "topicId": string,
  "gradeCategory": {
    object (GradeCategory)
  },
  "previewVersion": enum (PreviewVersion),

  // Union field details can be only one of the following:
  "assignment": {
    object (Assignment)
  },
  "multipleChoiceQuestion": {
    object (MultipleChoiceQuestion)
  }
  // End of list of possible types for union field details.
  "gradingPeriodId": string
}
字段
courseId

string

课程的标识符。

只读。
id

string

相应课程作业的 Google 课堂分配的标识符，每个课程均唯一。

只读。
title

string

相应课程作业的标题。标题必须是有效的 UTF-8 字符串，长度介于 1 到 3000 个字符之间。
description

string

此课程作业的可选说明。如果设置，说明必须是有效的 UTF-8 字符串，且不得超过 30,000 个字符。
materials[]

object (Material)

其他资料。

CourseWork 不得包含超过 20 个素材项。
state

enum (CourseWorkState)

相应课程作业的状态。如果未指定，则默认状态为 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"。
dueDate

object (Date)

可选日期（以 UTC 为单位），表示相应课程作业的提交截止日期。如果指定了 dueTime，则必须指定此参数。
dueTime

object (TimeOfDay)

可选时间（以世界协调时间 [UTC] 为单位），表示相应课程作业的提交截止时间。如果指定了 dueDate，则必须指定此参数。
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"。
maxPoints

number

相应课程作业的最高成绩。如果为零或未指定，则此作业被视为不计分。此值必须为非负整数值。
workType

enum (CourseWorkType)

相应课程作业的类型。

类型是在创建课程作业时设置的，无法更改。
associatedWithDeveloper

boolean

相应课程作业项是否与发出请求的开发者控制台项目相关联。

如需了解详情，请参阅 courseWork.create。

只读。
assigneeMode

enum (AssigneeMode)

课程作业的分配对象模式。如果未指定，则默认值为 ALL_STUDENTS。
individualStudentsOptions

object (IndividualStudentsOptions)

有权访问课程作业的学生的标识符。只有当 assigneeMode 为 INDIVIDUAL_STUDENTS 时，系统才会设置此字段。如果 assigneeMode 为 INDIVIDUAL_STUDENTS，则只有此字段中指定的学生会被分配作业。
submissionModificationMode

enum (SubmissionModificationMode)

用于确定学生何时可以修改提交的作业的设置。如果未指定，则默认值为 MODIFIABLE_UNTIL_TURNED_IN。
creatorUserId

string

布置作业的用户的标识符。

只读。
topicId

string

相应作业所属主题的标识符。必须与课程中的现有主题相匹配。
gradeCategory

object (GradeCategory)

相应课程作业的成绩所贡献的类别。仅当已为课程作业选择类别时才会显示。可能用于计算总成绩。

只读。
previewVersion

enum (PreviewVersion)

仅限输出。用于检索相应资源的 API 的预览版本。
联合字段 details。特定于某种课程作业的其他详细信息。details 只能是下列其中一项：
assignment

object (Assignment)

分配详情。仅当 workType 为 ASSIGNMENT 时，系统才会填充此字段。

只读。
multipleChoiceQuestion

object (MultipleChoiceQuestion)

单选题详细信息。对于读取操作，仅当 workType 为 MULTIPLE_CHOICE_QUESTION 时，系统才会填充此字段。对于写入操作，如果创建的课业的 workType 为 MULTIPLE_CHOICE_QUESTION，则必须指定此字段；否则不得设置此字段。
gradingPeriodId

string

与课程作业关联的评分周期的标识符。

  • 在创建时，如果未指定，系统将根据 dueDate（或 scheduledTime，如果未设置 dueDate）设置评分周期 ID。
  • 如需表示不与任何成绩评定周期相关联，请将此字段设置为空字符串 ("")。
  • 如果指定了此参数，则必须与课程中现有的评分周期 ID 一致。

CourseWorkState

课程作业的可能状态。

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

SubmissionModificationMode

学生提交内容可能采用的修改模式。

枚举
SUBMISSION_MODIFICATION_MODE_UNSPECIFIED 未指定修改模式。此值永远不会返回。
MODIFIABLE_UNTIL_TURNED_IN 您可以在提交作业之前修改作业。
MODIFIABLE 您可以随时修改提交的内容。

作业

作业的其他详细信息。

JSON 表示法 
{
  "studentWorkFolder": {
    object (DriveFolder)
  }
}
字段
studentWorkFolder

object (DriveFolder)

云端硬盘文件夹，用于存放学生提交的作业中的附件。此字段仅针对课程教师和管理员填充。

MultipleChoiceQuestion

选择题的其他详细信息。

JSON 表示法 
{
  "choices": [
    string
  ]
}
字段
choices[]

string

可能的选择。

方法

create

 创建课程作业。

delete

 删除课程作业。

get

 返回课程作业。

getAddOnContext

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

list

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

modifyAssignees

 修改课程作业的分配对象模式和选项。

patch

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