本页介绍了即将推出的 Google 课堂 API 功能,并详细介绍了如何参与开发者预览版计划。
预览 Classroom API
通过预览 Classroom API 功能,开发者可以通过反馈来影响功能开发的形态,并在正式发布之前让集成做好面向公众使用的准备。
预览生命周期
开发者可以选择启用包含向后兼容的新功能的 API 版本。这些“预览版”至少要公开发布 90 天。然后,根据反馈,将预览版及其功能纳入现有的 v1 API。预览版至少会再提供 90 天,然后才会停用。
如果预览版收到的反馈足够强烈,需要进行破坏性更改,我们会创建一个新版本来支持现有功能。这两个版本至少会同时提供 90 天,以便开发者进行迁移。加入 Classroom API 开发者预览邮寄名单,及时了解预览版变更;订阅通告名单,获取更多常规 Classroom API 更新。
参与 Classroom API 预览版计划
如需参与,请加入 Google Workspace 开发者预览版计划。可用的公开预览版功能列在 Google Workspace 有效的开发者预览版中。如果您要测试的是一项私享预览版功能,则可能不会在任何公开文档中看到该功能。
即将发布的功能
以下是预计推出的 API 功能及其时间表。该列表会定期更新。
预览版本值表示该版本的初始预览版发布日期。如需了解如何使用预览版,请参阅访问预览版 API。
功能 | 说明 | 预览目标 | 适用于 Google Analytics 的目标 | 预览版本 |
---|---|---|---|---|
评分周期 | 代表管理员和教师创建、读取、更新和删除评分周期。 | 2024 年上半年 | TBD |
V1_20240401_PREVIEW |
用户功能 | 检查用户是否有权使用某些 Google 课堂功能。 | 2024 年第 4 季度 | 2025 年上半年 | V1_20240930_PREVIEW |
先前版本
新功能经过验证后,会纳入 v1 API 中,相应的预览版会关闭。在预览版停用之前,开发者至少有 90 天的时间进行迁移。
功能 | 说明 | 已纳入 GA | 目标预览停用日期 | 预览版本 |
---|---|---|---|---|
分类 CRUD | 代表教师创建、读取、更新和删除课堂评分标准。 | 2024 年 12 月 5 日 | 2025 年 4 月 1 日 | V1_20231110_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 GA API,请移除 previewVersion
参数:
rubric = service.courses().courseWork().rubrics().create(
courseId=course_id, courseWorkId=coursework_id, body=body,
).execute()
如果您使用的是专门用于访问给定预览版功能的静态生成的客户端库,并且未使用其他预览版 API 功能,请改用适用于您所用语言的默认客户端库。如需了解详情,请参阅访问预览版 API。
反馈
如需针对预览版功能提供反馈,请访问 Google Workspace Developer Preview 计划概览页面中的有效的开发者预览版部分,通过关联的问题跟踪器提供反馈。
在生产环境中使用 Classroom API 预览版功能
如果您希望面向最终用户(包括任何真实的教师、管理员或学生)使用 Classroom API 预览版功能,则必须填写并提交此表单,同意对 Google Workspace 开发者预览版计划条款进行针对 Classroom 的修订: