插件要求

1.1 版,2024 年 12 月 5 日。

本页面中的条件适用于所有 Google 课堂插件。您的插件必须满足所有适用的必需项,才能获批在 Google Workspace Marketplace 中列出,并成为“适用于 Google 课堂”的插件。

本文档中的关键字“必须”“不得”“必需”“会”“不会”“应”“不应”“建议”“可以”和“可选”应按照 RFC 2119 中的描述进行解释。

要求

ID 类型
1.0 最终用户许可(如适用)
  1.1 当用户没有许可时,系统应向用户显示一条用户友好的消息。消息应明确说明无法使用该插件的原因,并建议用户采取相应措施来解决问题。 推荐
  1.3 插件的 Google Workspace Marketplace 详情应指定使用该插件可能需要的许可和订阅要求。如果插件有付费层级,则 Marketplace 商品详情应提供指向网页的链接,以便用户详细了解价格或如何联系销售人员。 推荐
2.0 最终用户登录
  2.1 教师用户必须使用 Google SSO 登录加购项。
如果系统要求学生用户登录加购项,他们必须使用 Google SSO 登录。
必需
  2.2 该插件必须使用 Google SSO 在后续访问中自动登录用户,而无需显示登录提示。
如果登录提示与当前登录的用户不匹配,该插件必须向用户显示登录按钮,并将 login_hint 传递给身份验证库,以过滤掉无效的账号。
必需
  2.7 如果 Classroom 用户尚未登录到插件(通过查看登录提示来确定),插件必须显示“使用 Google 账号登录”按钮,以便用户通过明确的操作触发登录流程。
注意:这是为了符合 Google 品牌推广指南,也有助于避免弹出式窗口拦截器。
必需
  2.8 插件应显示当前登录的用户。 推荐
3.0 常规
  3.1 插件必须遵守一般的 Google Workspace Marketplace 审批指南 必需
  3.2 如果从任何 iframe 流程中启动的任务进入了新标签页或窗口,则该任务应提供一条用户友好的消息,以便返回到 Google 课堂。 推荐
  3.3 用户必须仅使用加购项工作流完成整个流程,不得切换到 courseWork 工作流或使用“Google 课堂”分享按钮。 必需
  3.4 本地化选择:语言应基于浏览器设置的本地偏好设置(如果可用)。 推荐
  3.5 如果插件定义了 maxPoints,则在学生使用存储的教师凭据完成提交(推荐)时,或者在教师在“学生作业检查”iframe 中打开提交内容时,插件还必须设置 pointsEarned 必需
  3.9 插件应符合 WCAG 2.1 AA 级无障碍指南。插件开发者将在提交时自行报告是否满足此要求,并报告插件是否会继续符合插件的未来变更。 推荐
  3.10 用户遇到的任何错误都应采用人类可读懂的格式。 推荐
  3.11 如果 studentViewUriteacherViewUristudentWorkViewUri 是从复制的作业或课程启动的,则该插件不得在 iframe 中显示错误页面。 必需
4.0 附件发现
  4.1 如果附件需要学生提交内容,则该附件必须包含 studentWorkReviewUri,以便将其视为活动类型附件,而不是内容类型附件。 必需
  4.2 附件发现 iframe 必须提供至少包含以下一项内容的用户界面:
  • 创建要附加的新内容
  • 浏览、选择和附加内容库中的内容
  • 有关如何附加您网站或其他产品中的内容的说明
必需
  4.3 教师应能够找到并访问可供教师使用的所有内容/活动。 推荐
  4.4 教师应能够在承诺将内容/活动附加到作业之前预览该内容/活动。 推荐
  4.5 如果教师需要先创建内容/活动,然后才能附加,则应在 iframe 中完成该工作。 推荐
5.0 学生视图
  5.1 启动 studentViewUri 时,插件不应将用户弹出 iframe 以完成任务。
如果插件确实将用户弹出 iframe,则必须向学生显示一条消息或其他指示,以便他们返回 Google 课堂。
推荐
  5.2 如果插件 activity 从 iframe 中弹出,则 iframe 中应显示有关该任务的预览。 推荐
  5.3 如果存在,activity 中标记为提交的按钮或链接必须导致 API 请求提交学生作业以供教师查看。 必需
6.0 教师视图
  6.1 教师应该能够看到学生在完成作业时会看到的内容。 推荐
7.0 学生作业审核
  7.1 如果启动了 studentWorkReviewUri,插件必须在 iframe 中呈现该学生的作业,供教师查看。补充材料可能会链接到 iframe 之外。 必需
  7.2 该插件不得在 studentWorkReviewUri 视图中启用学生之间的导航。学生之间的切换必须仅在 Google 课堂界面中进行。 必需
8.0 Google 课堂移动应用支持
  8.1 当 Classroom 移动应用启动 teacherViewUristudentViewUristudentWorkReviewUri 时,该网址必须打开合作伙伴的移动原生应用或合作伙伴的移动 Web 应用,并且在任一情况下都必须深层链接到正确的视图。如果设备不受支持,则必须向用户显示一条消息,告知他们设备不受支持,最好还能告知他们哪些设备受支持。 必需
  8.2 学生作业应该能够在移动设备上完成。 推荐
9.0 其他功能
  9.1 如果教师可以将指向您内容的链接粘贴为链接附件,您应该将链接升级为插件附件 推荐
  9.2 如果您使用 CourseWork 集成从 Google 课堂外部创建作业,则应默认创建插件附件,以用于与您的插件兼容的所有链接。 推荐

更新日志

版本 1.1 更新时间:2024 年 12 月 5 日
1.1、1.3、3.2、3.10、4.4、5.2 从“必需”更改为“建议”。
3.12 已移除。
5.3 已重新措辞。最近的一项变更允许插件开发者使用 API 可靠地提交学生提交的内容。
版本 1.0 更新时间:2024 年 4 月 30 日
1.1 将 1.1 和 1.2 合并为一个要求。
2.1 将 2.1 和 2.5 合并为一个要求。
2.2 将 2.2、2.3 和 2.4 合并为一个要求。
3.5 将 3.5、3.6 和 3.7 合并为一个要求。
3.10 新增了要求,即插件绝不能进入无法理解或无法恢复的状态。
3.11、3.12 将 5.5、5.6、6.3、6.4、7.5 和 7.6 合并为两个新要求。
4.2 扩展了对可接受的附件发现体验的说明。
4.3 重新编号,之前为 4.2。还从“必需”更改为“建议”。
4.4 重新编号,之前为 4.3。
4.5 重新编号,之前为 4.4。
5.2 重新编号,之前为 5.3。
5.3 重新编号,之前为 5.2。
9.1 添加了将粘贴的链接升级为附件的建议。
9.2 添加了建议,即在以编程方式创建 CourseWork 作业时,默认创建插件附件。
2.6、3.7、3.8、6.2、7.3、7.4 已移除。
版本 0.3 更新时间:2022 年 11 月 22 日
2.3 更正了登录提示指南。
2.4 纳入了需要实现 hd 的场景。
3.2 重新措辞了“提供路径”。
5.5、5.6、6.3、6.4、7.5、7.6 studentViewUriteacherViewUristudentWorkReviewUri 添加了课程复制必需和推荐指南。
版本 0.2 更新时间:2021 年 10 月 29 日
1.3 调整了文本,使其意图更加明确。
3.1 添加了“该插件必须遵守其网站上提供的一般 GWM 审批指南。”
3.9 WCAG 将“必需”更改为“建议”。
5.1 将“必需”更改为“建议”。
5.3 添加了“如果插件弹出 iframe,则 iframe 中必须有关于任务的预览。”
5.4 添加了“如果插件从 iframe 中弹出,系统应提示学生返回 Google 课堂。”
8.1 添加了“如果设备不受支持,则必须向用户显示一条消息,告知他们设备不受支持,最好还能告知他们哪些设备受支持。”
8.2 移动版学生作业从“必需”更改为“推荐”。
版本 0.1 更新时间:2021 年 9 月 22 日
  初始版本。