插件要求

版本 1.0,2024 年 4 月 30 日。

本页中的条件适用于所有 Google 课堂插件。您的插件必须满足所有适用的必需内容,才能获准在 Google Workspace Marketplace 中上架,以及“与 Google 课堂搭配使用”的插件。

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

要求

ID 类型
1.0 最终用户许可(如适用)
  1.1 当用户没有许可时,必须向用户显示简单易懂的消息。该消息必须明确说明无法使用该插件的原因,并建议用户采取补救措施。 必填
  1.3 插件在 Google Workspace Marketplace 中的产品详情必须指定与使用该插件可能需要的许可要求相关的详细信息。如果该插件具有付费层级,则 Marketplace 产品详情必须提供一个网页链接,其中应提供有关定价或如何联系销售人员的更多信息。 必填
2.0 最终用户登录
  2.1 教师用户必须使用 Google 单点登录功能登录该插件。
如果系统要求学生用户登录该插件,他们必须使用 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 用户只能使用插件工作流完成该历程,而不能切换到 CourseWork 流程或使用 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 添加了 studentViewUriteacherViewUristudentWorkReviewUri 所需的课程副本和推荐指南。
版本 0.2 更新时间:2021 年 10 月 29 日
1.3 调整了文本,使其更加清晰。
3.1 添加了“该插件必须遵循其网站上提供的 GWM 常规审批准则。”
3.9 WCAG 将 REQUIRED 更改为 RECOMMENDED。
5.1 已将 REQUIRED 更改为 RECOMMENDED。
5.3 添加了“如果插件从 iframe 中弹出,必须在 iframe 中显示任务预览。”
5.4 添加了“如果插件从 iframe 中弹出,应该提示学生返回 Google 课堂”。
8.1 添加了“如果设备不受支持,必须向用户显示一条消息,告知用户设备不受支持,最好说明支持哪些设备。”
8.2 学生的移动作业已从“必需”更改为“推荐”。
版本 0.1 更新时间:2021 年 9 月 22 日
  初始版本。