Classroom API 提供了一个 RESTful 接口,供您管理 Google 课堂中的课程和学生名单。此外,开发者和内容所有者还可以使用 课堂分享按钮将内容分享到 Google 课堂。
哪些人可以使用该 API ?
Google Workspace 教育版网域管理员可以使用该 API 代表教师以编程方式配置课程,将学生信息系统与 Google 课堂同步,并基本了解其网域中所讲课程的内容。
应用开发者可以使用 Classroom API 将其应用与“课堂”集成。这些应用需要使用 OAuth 2.0 向教师请求查看课程和学生名单的权限。管理员可以限制网域中的教师和学生是否可以授权应用访问其 Google 课堂数据。
网站所有者和内容开发者可以使用 Google 课堂分享按钮让学生和教师将内容分享回 Google 课堂。
所有 API 和 Google 课堂分享按钮集成都应遵循 Google 课堂品牌推广指南。
API 概览
Classroom API 包含若干实体类型,分别对应于 Google 课堂界面中的班级、教师和学生。除了 Google 课堂中的属性之外,其中一些实体还具有特定于该 API 的其他属性。主要实体类型包括:
如需详细了解 API 资源和方法,请参阅 Classroom API 参考文档。
课程元数据和别名
Courses 表示一个类,例如“M. Smith 第四年的数学”,以及为其分配的教师、学生名单和元数据。每门课程都由服务器分配的唯一 ID 进行标识。课程资源具体封装了有关课程的所有元数据,例如名称、说明、地点和时间。课程学生名单通过学生、教师和邀请资源及其方法进行管理。
别名是类的替代标识符,可能与课程相关联并用于代替唯一 ID。每个别名都存在于一个命名空间中,该命名空间限制了谁可以创建和查看该别名。支持两个命名空间:
- 网域:网域命名空间用于创建所有用户都需要访问(但不限于任何计划)的别名。例如,应在网域命名空间中创建课程的备用商品详情(如 MATH 127 和 COMSCI 127)。网域命名空间中的别名只能由网域管理员创建,但对网域中的所有用户可见。
- 开发者项目:开发者项目命名空间用于管理特定于应用的别名。例如,为课程使用备用标识符的应用可以创建别名,将其标识符映射到 Google 课堂课程。在此命名空间中创建的别名与特定的 Google API 控制台相关联。应用的任何用户都可以在该应用的开发者项目的命名空间中创建和查看别名。
如需详细了解如何管理课程元数据和别名,请参阅管理课程。
课程学生名单和用户
学生和教师是用户个人资料与课程之间的具体映射关系,表示用户在课程中担任的角色。指定学生和教师并不是全球性的:您可以将用户指定为一门课程的教师,而将某位用户指定为另一门课程的学生。“学生”或“教师”标识代表特定课程中特定用户的一组权限。
- 学生
学生资源代表以学生身份注册的
特定课程。学生可以查看课程详细信息和该课程的教师。
- 教师
教师资源代表教授特定课程的用户。
教师可以查看和更改课程详细信息、查看教师和学生,以及管理其他教师和学生。
邀请及其关联方法提供了一种将学生和教师添加到课程的便捷方式。创建邀请可让用户选择是否加入课程,而不是您通过教师和学生的资源直接添加邀请。
UserProfiles 表示与用户网域个人资料的映射,由 Directory API 返回的用户的电子邮件地址标识。UserProfiles当前用户还可以使用 "me"
简写形式引用自己的 ID。
如需详细了解如何管理学生名单,请参阅管理教师和学生。
课程作业和学生提交的作业
CourseWork 项表示分配给课程中的一组学生的单个任务。它包含说明、截止日期和资料等详细信息,以及创建时间等元数据。这些材料包括标题、缩略图和网址,以及可用于相应 API(例如 Google 云端硬盘、YouTube)的标识符。
课程作业内容描述了以下任务类型之一:
- 学生通过提交工作表或其他附件完成的作业。
- 简答题或单选题。
CourseWork 内容的学生作业由 StudentSubmission 表示。它包含回答和其他元数据(例如状态和布置的成绩)。
Student Submission 的内容取决于相应 CourseWork 项的类型:
- 为作业提交的工作表和附件,包括标题、缩略图和网址,以及可用于相应 API(如云端硬盘或 YouTube)的标识符。
- 对简答题或单选题的回复。
如需详细了解如何管理课程作业和学生提交的作业,请参阅管理课业。
课堂插件
插件是合作伙伴提供的界面和后端,通常显示在 iframe 中。插件以附件的形式显示在帖子上,可以是 Announcements
、CourseWork
或 CourseWorkMaterials
。
插件附件可以是 activity 或内容。
- 活动连接要求学生完成并上交个人提交的内容。示例包括测验、绘图或游戏。提交的活动可以选择评分。
- 内容附件不需要学生提交。学生无需上交附件,我们就不会对附件评分。例如照片、文章和视频。
有关详情,请参阅插件开发指南。
快速入门
如需设置您的环境并立即开始使用该 API,请尝试以下某个快速入门:
使用 Google APIs Explorer 进行实验
如需尝试针对实时数据调用方法,请尝试使用 Google APIs Explorer。您无需编写任何代码即可开始使用,但请注意,使用 API Explorer 执行的操作可以修改现有数据。
如需开始调用方法,一种方法是调用 courses.list()
方法。此方法不需要任何请求参数,您可以从返回的课程列表中检索 id
,以用作其他 API 调用的请求参数。如果您没有任何课程,可以使用 courses.create()
方法创建一个。
您也可以浏览 API 参考文档。