插件要求

版本 1.0,2024 年 4 月 30 日。

本页列出的条件适用于所有 Google 课堂插件。您的插件必须满足所有适用的必需内容,才能获准在 Google Workspace Marketplace 上架。

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

使用要求

ID 类型
1.0 最终用户许可(如适用)
  1.1 当用户没有许可时,必须向用户显示一条便于理解的消息。消息必须明确说明插件无法使用的原因,并建议用户应采取的补救措施。 必填
  1.3 该插件的 Google Workspace Marketplace 产品详情必须详细说明使用该插件可能必须满足的许可要求。如果该插件具有付费层级,则 Marketplace 产品详情必须提供网页链接,该网页可详细了解定价或销售人员的联系方式。 必填
2.0 最终用户登录
  2.1 教师用户必须使用 Google SSO 登录该插件。
如果学生用户需要登录该插件,则必须使用 Google 单点登录登录。
必填
  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 中显示错误页面。 必填
  3.12 如果通过复制的作业或复制的课程启动 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 如果某个活动需要学生执行某项操作才能将作业标记为已完成,则该按钮不得标记为“上交”,以免与 Google 课堂的“上交”按钮混淆。 必填
6.0 版 教师视图
  6.1 教师应能够看到学生做作业时会看到的内容。 推荐
7.0 版 学生作业评阅
  7.1 如果 studentWorkReviewUri 已启动,该插件必须在 iframe 中呈现相应学生的作业以供教师审核。补充材料可能会链接到 iframe 之外。 必填
  7.2 该插件不得在 studentWorkReviewUri 视图中启用学生之间的导航功能。学生之间的导航只能在 Google 课堂界面中进行。 必填
8.0 版 Google 课堂移动设备支持
  8.1 当 Google 课堂移动应用启动 teacherViewUristudentViewUristudentWorkReviewUri 时,该网址必须打开合作伙伴的移动原生应用或合作伙伴的移动 Web 应用,并且在这两种情况下,都必须提供指向正确视图的深层链接。如果设备不受支持,必须向用户显示一条消息,让用户知道此设备不受支持,最好是支持哪些设备。 必填
  8.2 学生的作业应能在移动设备上完成。 推荐
9.0 版 其他功能
  9.1 如果教师可以将指向您内容的链接作为链接附件粘贴,您应将链接升级为插件附件 推荐
  9.2 如果您使用 CourseWork 集成在 Google 课堂之外创建作业,则应针对与您的插件兼容的所有链接默认创建插件附件 推荐

更新日志

版本 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。此外,已从 REQUIRED 更改为 RECOMMENDED。
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 添加了针对“studentViewUri”“teacherViewUri”和“studentWorkReviewUri”的必需课程副本和建议指南。
版本 0.2 更新时间:2021 年 10 月 29 日
1.3 微调了文本,使其更加清晰明确。
3.1 添加了“该插件必须遵循其网站上的常规 GWM 审批指南”。
3.9 WCAG 已由“必需”更改为“建议”。
5.1 已将“REQUIRED”更改为“RECOMMENDED”。
5.3 添加了“如果插件从 iframe 中弹出,则必须预览 iframe 中的任务。”
5.4 添加了“如果插件从 iframe 中弹出,应提示学生返回课堂”。
8.1 添加了“如果设备不受支持,必须向用户显示一条消息,让用户知道此设备不受支持,最好能显示支持哪些设备。”
8.2 使用移动设备的学生作业已从“必填”更改为“推荐”。
版本 0.1 更新时间:2021 年 9 月 22 日
  初始版本。