概览

Google Classroom API 为软件开发者、管理员和学校领导提供了用于管理 Google 课堂资源的编程接口。您可以构建用于创建、检索和修改课堂课程及其内容的软件。

一些典型用例包括：

  • 管理课程、花名册和监护人
  • 添加作业、通知和课程资料
  • 分配成绩和修改评分设置
  • 生成数据以进行分析
  • 使外部提供商的内容或工具在课堂中可被发现和访问

Classroom API 是否适合我？

Google 提供了多种产品来帮助您与课堂互动。以下是一些常见场景以及可能最符合您需求的产品建议。

修改 Google 课堂资源

场景 推荐的解决方案
我想定期管理大量课程、用户或其他课堂资源。我擅长编写代码和维护软件基础架构。 编写使用 Classroom API 的应用。
我想偶尔管理少量课堂资源。我擅长编写少量代码，且开销很小。 将 Classroom API 与 Google Apps 脚本搭配使用。
我想偶尔更改单个课堂资源。我擅长使用终端命令。 使用 Google Apps Manager。
我想要大量报告，其中包含有关课堂中事件的详细信息。 使用 BigQuery Data Transfer Service。
我想调查用户的活动。 在 管理控制台 中生成报告，或使用 Reports API。

与 Google 课堂集成

场景 推荐的解决方案
我希望教师和学生在课堂中看到并启动我的内容。 构建 课堂插件。
我希望教师点击我的网站或应用上的按钮，将我的内容嵌入课堂中。 构建 课堂插件 并以编程方式创建附件 。
我希望教师点击我的网站或应用上的按钮，以链接到课堂中的内容。 使用 Classroom API 创建课程作业，或嵌入 “分享到课堂”按钮 。
我希望课堂教师与我的学生信息系统同步或从中导入信息。 为学生信息系统实现 OneRoster，或 使用 Classroom API 创建和访问资源。

使用入门

我们建议新开发者在开始新项目之前执行以下操作：

如需开始开发，请确保您已完成前提条件步骤。 根据您的需求选择合适的 Classroom API 范围，然后按照以下任一快速入门设置 环境并开始发出请求：

试用 Google APIs Explorer

如需尝试对实时数据调用方法，请尝试使用 Google APIs Explorer。您无需编写任何代码即可开始使用，但请注意，您使用 APIs Explorer 执行的操作可能会修改现有数据。

开始调用方法的一种方式是调用 courses.list() 方法。此方法不需要任何请求参数，您可以从返回的课程列表中检索 id，以用作其他 API 调用的请求参数。如果您没有任何课程，可以使用 courses.create() 方法创建一个课程。

您还可以浏览 Classroom API 参考文档。