插件要求

版本 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 如果 Google 课堂用户尚未登录该插件(通过查看登录提示确定),该插件必须显示“使用 Google 账号登录”按钮,以便用户执行明确的操作来触发登录流程。
注意:为遵守 Google 品牌推广指南,此操作是必要的,同时也有助于避免弹出式窗口拦截器。
必填
  2.8 该插件应显示当前登录用户的身份。 推荐
3.0 常规
  3.1 该插件必须遵守常规的 Google Workspace Marketplace 审批准则 必填
  3.2 如果任务从任何 iframe 历程中启动到新标签页或窗口,则应提供方便用户返回 Google 课堂的友好消息。 推荐
  3.3 用户必须仅使用插件工作流完成此流程,不得切换到课程工作流或使用 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 当 Google 课堂移动应用启动 teacherViewUristudentViewUristudentWorkReviewUri 时,网址必须打开合作伙伴的移动原生应用或合作伙伴的移动网站应用,并且在任何情况下都必须深层链接到正确的视图。如果设备不受支持,必须向用户显示一条消息,告知他们设备不受支持,最好还能告知用户受支持的设备。 必填
  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 添加了一条建议,建议在以编程方式创建课程作业时默认创建插件附件。
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 日
  初始版本。