与附件互动

本页将介绍创建附件和处理学生提交内容的实现细节。请注意,在发出这些请求时,您可能需要提供与附件相关的参数

创建连接

向相应的 courses.*.addOnAttachments.create 端点发出 CREATE 请求以创建附件。您的请求必须在请求正文中包含 AddOnAttachment 实例。

创建附件时,以下字段是必填字段:

  • title:附件的字符串名称。
  • teacherViewUri:附件的教师视图的 URI。
  • studentViewUri:附件的学生视图的 URI。
  • studentWorkReviewUri:教师查看学生在附件中所做作业的 URI。此字段仅适用于活动类型的附件。

您可能需要添加以下某些选填字段:

  • dueDatedueTime(如果要指定附件的截止期限)。
  • maxPoints:附件的最高分数。如果您想支持成绩回传,则必须为非零值。仅适用于活动类型的附件。

如需详细了解这些字段,请参阅 AddOnAttachment 资源参考文档。

学生提交内容的详细信息

典型的提交工作流程遵循以下步骤:

  1. 学生启动 studentViewUri 以完成活动。
  2. 该插件使用学生凭据从 getAddOnContext 方法检索 submissionId
  3. submissionIdattachmentId 由附加组件存储 开发者作为学生作品的唯一标识符。 如果教师在 Google 课堂中复制作业,您可以使用这两个参数的复合键在复制的作业中显示新的附件。如需了解详情,请参阅我们关于被复制的内容的页面。
  4. 有意查看学生作业的教师会启动 studentWorkReviewUri。请求包含以下查询参数:courseIditemIditemTypeattachmentIdsubmissionId
  5. 插件开发者使用这四个 ID 检索学生作业。使用 courses.courseWork.addOnAttachments.studentSubmissions 端点检索或修改学生提交内容的相关信息。

检测提交状态

courses.courseWork.addOnAttachments.studentSubmissions 端点发出 GET 请求,以获取特定 submissionId 的详细信息。您会收到一个 AddOnAttachmentStudentSubmission 对象,其中包含提交内容的分数 (pointsEarned) 和当前状态 (postSubmissionState)。提交内容状态可以是以下值之一:

  • NEW(如果学生从未访问过相应提交内容)。
  • CREATED,如果学生创建了提交内容,但尚未提交。
  • TURNED_IN,如果学生已向老师提交作业。
  • RETURNED,如果教师已将提交内容发回给学生。
  • RECLAIMED_BY_STUDENT,如果学生已“未提交”作业。

您可以使用此端点在您的插件中检测学生作业的状态。然后,您可以根据返回的状态调整向学生提供的视图或选项。这可能包括以下功能:

  • 在您的插件中显示作业的交付状态。这有助于学生避免可能的混淆,并确保他们不会误以为自己未提交作业。
  • 限制提交内容的修改权限。如果作业的状态为 CREATEDRECLAIMED_BY_STUDENT,学生或许可以修改其提交的内容。如果作业的状态为 TURNED_INRETURNED,学生可能无法修改其提交的内容。

成绩和多个附件

只能使用一个插件附件来为单个作业设置成绩。如果教师创建了多个提供 maxPoints 值的活动类型附件,则只有第一个此类附件可以设置作业成绩。如需停用附件的成绩回传,请将 maxPoints 值保持未设置状态或将其设置为零。

为提交内容设置成绩

您可以向 courses.courseWork.addOnAttachments.studentSubmissions 端点发送 PATCH 请求来修改学生提交的内容。请求正文必须包含包含修改后的值的 AddOnAttachmentStudentSubmission 实例。设置 pointsEarned 字段可修改提交内容的分数。在 pointsEarned 中传递的值会成为教师在 Google 课堂界面中看到的草稿评分。教师可以在将作业发回给学生之前修改初始成绩。如需详细了解成绩会以何种方式向教师显示,请参阅Google 课堂界面中的评分概览

请注意,只有在满足以下条件时,您才能使用 pointsEarned 设置成绩:

  • 附件必须具有正 maxPoints 值。
  • 该插件必须是附件的原创作者。

另请注意,您可以通过向 addOnAttachments 端点发出 PATCH 请求来修改已创建的 AddOnAttachmentmaxPoints 值。

何时设置成绩

您可以选择何时将成绩回传到 Google 课堂。关键区别在于您是否选择存储教师的凭据,因为只有教师可以修改成绩。

您可以在两个附加时间点将成绩传递到 Google 课堂:学生完成作业时,或教师在“学生作业评价”iframe 中打开学生的作业时。

如果您想在学生完成作业时设置成绩,则必须存储教师的离线凭据,然后在学生完成作业时检索这些凭据并使用它们修改成绩。这种方法具有一些潜在优势:

  • 提供无缝的成绩更新。教师无需执行任何特殊操作,即可在 Google 课堂界面中填充成绩。
  • 实时了解全班学生在完成作业方面的进度。 在学生完成附件后设置成绩,教师无需打开每一份提交内容,即可了解学生的理解程度。

请注意,此方法还允许使用异步方法进行评分同步。您可以定期轮询 AddOnAttachmentStudentSubmission 端点,以检测学生何时提交了作业。提交作业后,使用存储的凭据设置提交作业的成绩。

如果您不想在学生会话期间加载教师的凭据,则可以在教师在“学生作业评阅”iframe 中加载学生提交的作业时使用当前教师的凭据。不过,这可能无法提供特别顺畅的用户体验,因为 Google 课堂界面中的成绩不会实时更新,并且教师需要打开每份提交内容的“学生作业评价”iframe。

检测作业成绩的变化

教师可以在创建作业后在 Google 课堂中修改成绩设置。此类修改可能包括:

  • 更改分配的分值。
  • 更改分配的 maxPoints 值。
  • 更改是否应为作业评分。

如需查看作业的当前评分设置,我们建议您向 courses.courseWork 端点发送 GET 请求。响应包含当前的 maxPoints 值。未评分的作业具有 null 或零 maxPoints 值。

如果您已将成绩传回 Google 课堂,请使用 courses.courseWork.addOnAttachments.studentSubmissions 端点提取或更改插件附件的成绩。成绩值使用 pointsEarned 字段设置。如果您的产品允许教师修改学生在特定活动中的得分,不妨考虑检查此值并视需要进行更新。