您的用户是通过 Google Meet 使用 Google 课堂吗?请查看 Apps 脚本快速入门,了解如何查看 Google Meet 课程中的学生出席情况

概览

Classroom API 提供了 RESTful 接口,可用于管理 Google 课堂中的课程和学生名单。此外,“课堂”分享按钮可让开发者和内容所有者将其内容分享到“课堂”。

哪些人可以使用该 API ?

G Suite 教育版网域管理员可以使用 API 代表教师以编程方式配置课程,将学生信息系统与 Google 课堂同步,并基本了解网域内所教授的课程。

应用开发者可以使用 Classroom API 将其应用与 Google 课堂集成。这些应用需要使用 OAuth 2.0 向教师申请查看课程和学生名单的权限。管理员可以限制网域中的教师和学生是否可以授权应用访问 Google 课堂数据。

网站所有者和内容开发者可以使用“课堂”分享按钮让学生和教师将内容发回 Google 课堂。

所有 API 和“课堂”分享按钮集成都应遵循 Google 课堂品牌推广指南

API 概览

Classroom API 由若干实体类型组成,这些类型与 Google 课堂界面中的课程、教师和学生相对应。除了 Google 课堂中存在的实体外,其中一些实体还具有特定于该 API 的其他属性。主要实体类型如下:

如需详细了解该 API 的资源和方法,请参阅 Classroom API 参考

课程元数据和别名

课程代表一个课程,例如“M。Smith 第四期数学”及其指定的教师、学生名单和元数据。每个课程都由服务器分配的唯一 ID 进行标识。具体而言,课程资源封装了课程的所有元数据,例如名称、说明、位置和时间。课程学生名单可通过学生教师邀请资源及其方法进行管理。

别名是类的备用标识符,可与课程关联,用于代替唯一 ID。每个别名都存在于一个命名空间中,限制谁可以创建和查看该别名。支持两种命名空间:

  • 网域:网域命名空间可用于创建所有用户需要访问但并非特定于任何程序的别名。例如,应在网域命名空间中创建课程的备用商品详情(例如 MATH 127 和 COMSCI 127)。网域命名空间中的别名只能由网域管理员创建,但对网域中的所有用户可见。
  • 开发者项目:开发者项目命名空间可用于管理特定于应用的别名。例如,使用备用标识符学习课程的应用可以创建别名,以将其标识符映射到 Google 课堂课程。在此命名空间中创建的别名与特定的 Google API 控制台相关联。应用的任何用户都可以在命名空间中为该应用的开发者项目创建和查看别名。

如需详细了解如何管理课程元数据和别名,请参阅管理课程

课程的学生名单和用户

学生教师是用户个人资料和课程之间的具体对应关系,它们表示用户在课程中的角色。学生和教师的标识不具有全局性:用户可以为一门课程分配教师,而为另一门课程分配学生。名称“学生”或“教师”表示特定用户对特定课程中的一组权限。

学生
学生资源表示在特定课程中以学生身份注册的用户。学生可以查看该课程的详细信息和该课程的教师。
教师
Teacher 资源表示讲授特定课程的用户。教师可以查看和更改课程详细信息,查看教师和学生,以及管理其他教师和学生。

邀请及其关联方法提供了一种为学生添加教师和教师的便捷方式。创建邀请后,用户可以选择是否加入课程,而不是通过教师和学生资源直接添加。

UserProfiles 表示映射到用户的网域个人资料,该网域由 Google Admin SDK 返回的用户的唯一 ID 或电子邮件地址标识。 }当前用户还可以使用 "me" 缩写来指代自己的 ID。

如需详细了解如何管理学生名单,请参阅管理教师和学生

课程作业和学生提交的作业

CourseWork 项表示为课程中的一组学生分配的单个任务。它包含说明、截止日期和资料等详细信息,以及创建时间等元数据。资料包括标题、缩略图和网址,以及可与相应 API(即 Google 云端硬盘、YouTube)搭配使用的标识符。

CourseWork 内容描述了以下任一类型的任务:

  • 学生通过提交工作表或其他附件来完成的作业。
  • 简答题或选择题。

CourseWork 内容的学生作业由 StudentSubmission 表示。 它由响应和额外的元数据(例如状态和分配的成绩)组成。

StudentSubmission 中的内容取决于相应的 CourseWork 项的类型:

  • 为作业提交的工作表和附件,包括标题、缩略图和网址,以及可与相应的 API(如 Drive 或 YouTube)搭配使用的标识符。
  • 简答题或单选题的回复。

如需详细了解如何管理课程作业和学生提交的作业,请参阅管理课业

开始使用

如需设置您的环境并立即开始使用该 API,请尝试以下任一快速入门:

您还可以查看 API 参考