支持 OneRoster 的学生信息系统 (SIS) 集成

Google 课堂支持为许多符合 OneRoster 标准的学生信息系统 (SIS) 导入学生名单和同步成绩册。Google 与符合 Google 指定的 OneRoster 要求的 SIS 平台合作。

图 1. 当学生信息系统 (SIS) 与 Google 课堂合作时,管理员可以在下拉菜单中选择 SIS。

SIS 合作伙伴入门流程

以下是 SIS 合作伙伴新手入门流程的简要介绍:

  1. 表达意向:如果您有兴趣与 Google 课堂合作,请填写意向调查表。

  2. 探索并运行一致性测试:如需了解您的 SIS 是否已准备好与 Google 课堂集成,您可以查看一致性测试,熟悉 Google 的要求。您可以选择在向 Google 课堂团队表达兴趣之前运行一致性测试,以确定您的产品与 Google 要求的符合程度。

  3. 与 Google 课堂团队联系: 在您提交意向调查表后,如果存在合作机会,Google 课堂团队会与您联系。

  4. 分享测试结果并构建端到端集成:在 Google 课堂团队与您联系后,请分享您的合规性测试结果。您的团队将与 Google 合作,验证并完成集成。

一致性测试

Google 定义的一致性测试旨在为 SIS 合作伙伴提供一种方法,用于确定其产品是否符合 Google 的 OneRoster 使用要求,并最大限度地减少用户在 Google 课堂中使用 SIS 集成时可能遇到的错误。这些测试已发布到 GitHub。

访问和运行测试

如需运行测试,您需要满足以下条件:

  • 用于检索 OAuth 2.0 凭证的令牌网址
  • 以 /ims/oneroster/v1p2 结尾的 OneRoster 网址
  • 客户端 ID
  • 客户端密钥
  • 教师邮箱

您可以使用 Google Colab 或 Jupyter 笔记本运行测试。Colab 和 Jupyter 笔记本都支持一次性运行所有测试。这有助于您生成测试结果,以便与 Google 课堂团队分享。

要求和预期行为

请仔细阅读以下有关测试的提示。在 GitHub 中,每项测试都有一个标题,该标题在表格中引用。这些提示有助于澄清问题,但并未涵盖所有测试。请确保您已运行 GitHub 中提供的所有测试,以确保合规性。

测试 指针
Teachers: GetAllTeachers 系统会使用 limit 查询参数调用 GET /teachers 端点。在后续测试中,此参数用于确保您的产品可以支持 10,000 的页面大小。
教师:GetAllTeachers(使用电子邮件过滤条件) 调用 GET /teachers 端点时,会使用 filter 查询参数,该参数用于根据教师电子邮件地址进行过滤。系统将使用您在测试的“凭据”部分中提供的教师电子邮件地址。
Classes: GetClassesForTeacher 系统会使用 filter 查询参数调用 /teachers/{teacher_sourced_id}/classes 端点,该参数用于根据活跃课程进行过滤。
学生:GetStudentsForClass 系统会调用 GET /classes/{class_sourced_id}/students 端点。必须在响应中返回学生电子邮件。
GetGradingPeriodsForTerm 使用 term_sourced_id 测试评分周期支持。此 term_sourced_id 用于通过调用 GET /terms/{term_sourced_id}/gradingPeriods 端点来检索学期中的评分周期。
LineItem:创建 调用 PUT /lineItems/{line_item_sourced_id} 时,评分周期不是必需的。
LineItem: Edit 如果包含较长的作业标题,API 调用不应返回错误。测试包含长度超过 100 个字符的作业标题。
结果:修改 应该可以将 score 设置为大于 resultValueMax 的值,以表示额外加分。
结果:删除 必须提供 DELETE /results/{result_sourced_id} 端点。
LineItem(可选/清理):删除和获取 DELETE /lineItems/{line_item_sourced_id} 端点不是必需的。此参数为可选参数,用于数据清理。后续的 GET /classes/{class_sourced_id}/lineItems 端点也是可选的,用于测试订单项是否已删除。

与 Google 课堂团队分享测试结果

运行测试后,系统会生成一份包含每项测试结果的完整报告。测试结果将用于确定您的产品是否符合 Google 的 OneRoster 1.2 使用要求。下载或截取生成的报告,以便与 Google 课堂团队中的联系人分享。

获取开发者演示域名

在 Google 课堂团队审核您的合规性测试结果后,您可以使用开发者演示网域来验证端到端集成。请注意,成功通过一致性测试并不保证一定能获得合作伙伴关系或集成批准。

开发者演示网域是一个实际运行的 Google 课堂测试环境,可帮助您验证集成是否按预期运行。完成获取开发者演示网域和请求演示网域升级的步骤。升级后,您的网域将获得 10 个 Google Workspace 教育 Plus 版许可。这些许可需要分配给开发者网域中的测试用户,以便他们测试 Google 课堂中的 SIS 集成功能。

常见问题解答

1. Google 课堂希望从 SIS 获得什么数据模型?

Google 课堂遵循 OneRoster 1.2 规范。 如果您的 SIS 使用不同的数据结构,您可能会遇到意外行为。例如,如果您的系统支持评分周期和成绩类别之间的嵌套关系,则这不属于 OneRoster 1.2 规范,您应彻底测试集成,以确保兼容性。

2. 哪些成绩和作业状态会导出到 SIS?

只有已发回的成绩或被标记为“缺交”或“免除”的作业才会导出到 SIS。初始成绩不会导出。

3. 如果在 Google 课堂中删除了作业,SIS 中的相应订单项会发生什么情况?

在 Google 课堂中删除作业不会删除 SIS 中的相应订单项。这样可以防止意外数据丢失和意外级联删除。