本页面介绍了 Classroom API 即将推出的功能,并详细说明了如何参与开发者预览版计划。
预览 Classroom API
通过预览 Classroom API 功能,开发者可以提供反馈来影响功能开发的方向,并可以在正式发布之前准备好集成,以供公开使用。
预览生命周期
开发者可以选择使用包含向后兼容的新功能的 API 版本。这些“预览版本”至少会公开提供 90 天。根据反馈,预览版本及其功能随后会纳入现有的 v1 API 中。预览版本至少还会再提供 90 天,然后才会关闭。
如果对预览版本的反馈足够强烈,需要进行重大更改,则会创建一个新版本来支持现有功能。这两个版本至少会提供 90 天,以便开发者进行迁移。加入 Classroom API 开发者预览版邮件列表,及时了解预览版变更;订阅通知 列表,了解更多常规 Classroom API 更新。
参与 Classroom API 预览版计划
如需参与,请加入 Google Workspace 开发者预览版 计划。Google Workspace 活跃开发者预览版中列出了可用的公开预览版功能。如果您正在测试私密预览版功能,则可能不会在任何公开文档中看到该功能。
即将发布的功能
这是我们预计推出的 API 功能及其时间表的路线图。我们会定期更新此路线图。
预览版本值表示该版本预计首次提供预览版的日期。如需了解如何使用预览版本 ,请参阅访问预览版 API。
| 功能 | 说明 | 预览版目标日期 | 正式版目标日期 | 预览版本 |
|---|---|---|---|---|
| 用户功能 | 检查用户是否有权使用某些 Classroom 功能。 | 2024 年第 4 季度 | 2025 年上半年 | V1_20240930_PREVIEW |
| 学习目标 | 在课程中设置学业标准,在课程作业和评分准则中设置学习目标。 | 2026 年第 3 季度 | 2026 年第 4 季度 | V1_20260316_PREVIEW |
先前版本
新功能经过验证后,该功能会纳入 v1 API 中,相应的预览版本也会关闭。在预览版本关闭之前,开发者至少有 90 天的时间进行迁移。
| 功能 | 说明 | 纳入正式版 | 预览版目标关闭日期 | 预览版本 |
|---|---|---|---|---|
| 评分标准 CRUD | 代表教师创建、读取、更新和删除课堂评分标准。 | 2024 年 12 月 5 日 | 2025 年 4 月 1 日 | V1_20231110_PREVIEW |
| 评分周期 | 代表管理员和教师创建、读取、更新和删除评分周期。 | 2025 年 4 月 8 日 | 2025 年 8 月 1 日 | V1_20240401_PREVIEW |
| 学生小组 | 代表管理员和教师管理学生小组及其成员。 | 2026 年 1 月 26 日 | 2026 年 6 月 1 日 | V1_20250630_PREVIEW |
迁移指南
预览版本中的功能纳入 v1 API 后,请从相关 API 调用中移除 previewVersion 实参,以确保应用继续按预期运行。例如,如果您要访问 V1_20231110_PREVIEW 版本中引入的评分标准创建功能,您的 API 调用可能如下所示:
rubric = service.courses().courseWork().rubrics().create(
courseId=course_id, courseWorkId=coursework_id, body=body,
# Specify the preview version. Rubrics CRUD capabilities are
# supported in V1_20231110_PREVIEW and later.
previewVersion="V1_20231110_PREVIEW"
).execute()
如需迁移到 v1 正式版 API,请移除 previewVersion 实参:
rubric = service.courses().courseWork().rubrics().create(
courseId=course_id, courseWorkId=coursework_id, body=body,
).execute()
如果您使用的是专门用于访问给定预览版本功能的静态生成的客户端库,并且未使用其他预览版 API 功能,请转换为适用于您所用语言的默认客户端库。如需了解详情,请参阅 访问预览版 API。
反馈
如需分享对预览版功能的反馈,请通过 Google Workspace 开发者预览版计划概览页面的 活跃开发者预览版部分中链接的 IssueTracker 来分享。
在生产环境中使用 Classroom API 预览版功能
如果您想让最终用户(包括任何真实教师、管理员或学生)使用 Classroom API 预览版功能,则必须同意对 Google Workspace Google Workspace 开发者预览版计划条款的 Classroom 专用修正案,方法是填写并提交此表单: