插件要求

版本 0.3. 2022 年 11 月 22 日

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

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

要求

ID 类型
1.0 最终用户许可(如适用)
  1.1 当用户没有许可时,必须向用户显示一条便于理解的消息。 必需
  1.2 该消息必须明确说明插件无法使用的原因,并建议用户应采取的补救措施。 必需
  1.3 该插件的 GWM 列表必须指定有关使用该插件可能需满足的许可要求的详细信息。如果该插件具有付费层级,GWM 商品详情必须提供网页链接,该网页应提供有关定价的更多信息或如何与销售人员联系。 必需
2.0 最终用户登录
  2.1 对于教师登录,该插件必须使用 Google 登录。 必需
  2.2 该插件必须使用 Google SSO 自动让教师在后续访问时进行登录,而不显示登录提示。 必需
  2.3 当登录提示没有与当前已登录的用户匹配时,该插件必须提示用户使用登录按钮,并将 login_hint 传递给身份验证库以过滤掉无效帐号。 必需
  2.4 如果提供了 hd,该插件必须提示用户使用登录按钮,并将 hd 参数传递给 auth 库以过滤掉无效帐号。 必需
  2.5 如果要求学生登录,该插件必须在后续访问时使用 Google 登录和 Google 单点登录,而不显示登录提示。 必需
  2.6 如果附件支持学生的作业,则学生应登录其帐号,以便系统可以请求 submitId 并将其用于将学生与作业关联起来。 推荐
  2.7 当 Google 课堂用户尚未登录该插件(通过查看登录提示确定)时,该插件必须提供“使用 Google 帐号登录”按钮,以便用户明确执行用于触发登录流程的操作。注意:这是符合 Google 品牌推广指南的必要步骤,但也有助于避免弹出式窗口拦截器。 必需
  2.8 该插件应显示当前登录的用户是谁。 推荐
3.0 常规
  3.1 该插件必须遵循常规 GWM 审批准则 必需
  3.2 如果某个任务从任意 iframe 历程启动到新标签页或窗口中,则必须提供一条便于用户返回 Google 课堂的消息。 必需
  3.3 用户只能使用插件工作流完成课程学习,而不能切换到课程工作流程或使用“课堂”分享按钮。 必需
  3.4 本地化选择:语言应基于浏览器所设置的本地偏好设置(如果可用)。 推荐
  3.5 如果某个插件定义了 maxPoints,则必须实现成绩回传。 必需
  3.6 如果某个插件实现了成绩回传,则该插件应在学生完成某项活动时使用存储的教师凭据实现成绩回传。 推荐
  3.7 如果插件实现了成绩回传,可在教师查看学生作业时,使用教师的凭据实现成绩回传。 可选
  3.8 插件不得在 iframe 内水平滚动。 必需
  3.9 插件应符合 WCAG 2.1 级 AA 级无障碍功能指南。插件开发者会在提交时自行报告此要求已满足,并且插件将来仍会更新。 推荐
4.0 附件发现
  4.1 如果附件支持学生作业,该附件必须包含 studentWorkReviewUri,以便系统将其视为活动类型,而不是内容类型。 必需
  4.2 教师必须能够访问教师可用的所有内容/活动 必需
  4.3 在承诺将相应内容/活动附加到作业中之前,教师必须能够预览相应内容/活动。 必需
  4.4 如果老师需要创建内容/活动才能附加内容/活动,相应工作应在 iframe 中完成。 推荐
  4.5 教师应能够使用多种方式搜索或浏览内容/活动,例如:文本搜索、“最近”、我的内容、类别或过滤器。 推荐
5.0 studentViewUri
  5.1 如果 studentViewUri 已启动,该插件不应将用户弹出 iframe 以完成任务。 推荐
  5.2 如果某个活动需要学生执行操作才能将作业标记为已完成,则不得将该按钮标记为“上交”,以免与“课堂上交”按钮混淆。 必需
  5.3 如果插件 activity 从 iframe 中弹出,则 iframe 中必须显示相应任务的预览。 必需
  5.4 如果插件 activity 从 iframe 中弹出,应提示学生返回 Google 课堂。 推荐
  5.5 如果 studentViewUri 是通过复制的作业或复制的课程启动的,插件不得在 iframe 中显示错误页面。 必需
  5.6 如果 studentViewUri 是从复制的作业或复制的课程启动的,该插件应在 iframe 中显示学生对之前作业或课程的回答,以供学生完成。 推荐
6.0 版 teacherViewUri
  6.1 教师必须能够查看学生做作业时会看到的内容。 必需
  6.2 教师可以查看与作业相关的其他信息(例如备注、注释、答案表等)。 可选
  6.3 如果 teacherViewUri 是通过复制的作业或复制的课程启动的,插件不得在 iframe 中显示错误页面。 必需
  6.4 如果 teacherViewUri 是通过复制的作业或复制的课程启动的,教师应能够在 iframe 中预览插件附件。 推荐
7.0 studentWorkReviewUri
  7.1 如果“studentWorkReviewUri”已启动,该插件必须在 iframe 中呈现相应学生的作业以供教师审核。补充资料可能会链接到 iframe 之外。 必需
  7.2 插件不得在此视图中允许在学生之间导航。学生之间的导航只能在 Google 课堂界面中进行。 必需
  7.3 该插件可以显示与作业相关的其他信息(例如备注、注释、应答键等)。 可选
  7.4 该插件可能会显示作业级别的数据分析(例如平均成绩、常见错误答案等)。 可选
  7.5 如果 studentWorkReviewUri 是通过复制的作业或复制的课程启动的,插件不得在 iframe 中显示错误页面。 必需
  7.6 如果 studentWorkReviewUri 是从复制的作业或复制的课程启动的,该插件应显示正确的学生回答,并且不应在 iframe 中显示学生对之前作业或课程的回答。 推荐
8.0 Google 课堂移动设备支持
  8.1 当 Google 课堂移动应用启动 teacherViewUristudentViewUristudentWorkReviewUri 时,相应网址必须打开合作伙伴的移动原生应用或移动网络应用,并在这两种情况下都提供指向正确视图的深层链接。如果设备不受支持,必须向用户显示一条消息,让用户知道该设备不受支持,最好是支持哪些设备。 必需
  8.2 学生的作业应能在移动设备上完成。 推荐

更新日志

版本 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 已将“REQUIRED”更改为“RECOMMENDED”。
5.3 添加了“如果插件弹出 iframe,则必须提供关于 iframe 中任务的预览。”
5.4 添加了“如果插件从 iframe 中弹出,应提示学生返回 Google 课堂”。
8.1 添加了“如果设备不受支持,必须向用户显示一条消息,让用户知道该设备不受支持,最好是支持哪些设备。”
8.2 在移动设备上,学生的作业已从“必需”更改为“建议”。
版本 0.1 更新时间:2021 年 9 月 22 日
  初始版本。