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

课堂为此课程作业分配的标识符，每个课程都是唯一的。

只读。
title

string

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

string

此课程作业的可选说明。如果设置，说明必须是有效的 UTF-8 字符串，长度不超过 3 万个字符。
materials[]

object (Material)

其他资料。

课程作业不得超过 20 个 Material 项。
state

enum (CourseWorkState)

本课程的作业状态。如果未指定，则默认状态为 DRAFT。
creationTime

string (Timestamp format)

创建此课程作业时的时间戳。

只读。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

此课程作业最近更改的时间戳。

只读。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
dueDate

object (Date)

（可选）提交此课程作业的截止日期（世界协调时间）。如果指定了 dueTime，则必须指定此字段。
dueTime

object (TimeOfDay)

可选时间（采用世界协调时间），这是课程作业的提交截止日期。如果指定了 dueDate，则必须指定此字段。
scheduledTime

string (Timestamp format)

安排发布此课程作业的时间（可选）。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
maxPoints

number

此课程作业的最高成绩。如果为零或未指定，系统会将此作业视为不计分。此值必须是非负整数值。
workType

enum (CourseWorkType)

此课程作业的类型。

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

boolean

此课程工作项是否与发出请求的 Developer Console 项目相关联。

如需了解详情，请参阅 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 时，系统才会填充此字段。对于写入操作，必须使用 MULTIPLE_CHOICE_QUESTION 的 workType 创建课程作业时指定此字段，否则不得设置此字段。
gradingPeriodId

string

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

  • 如果未指定，系统将根据 dueDate 设置评分周期 ID（如果未设置 dueDate，则根据 scheduledTime 设置）。
  • 要指明与任何评分周期均无关联，请将此字段设置为空字符串 ("")。
  • 如果指定，则必须与课程中现有的评分周期 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

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