概览

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

一些典型用例包括：

Classroom API 是否适合我？

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

场景	推荐的解决方案
我想定期管理大量课程、用户或其他 Google 课堂资源。我擅长编写代码和维护软件基础架构。	编写使用 Google 课堂 API 的应用。
我希望不定期管理少量 Google 课堂资源。我可以轻松自如地编写少量代码，并且开销很低	通过 Google Apps 脚本使用 Classroom API。
我想不时更改 Google 课堂中的个别资源。我可以自如地使用终端命令	使用 Google Apps Manager。
我想要大量报告，其中包含 Google 课堂中事件的详细信息。	使用 BigQuery Data Transfer Service。
我想调查用户的活动。	在管理控制台中生成报告或使用 Reports API 生成报告。

场景	推荐的解决方案
我想让教师和学生在 Google 课堂中查看和启动我的资源。	构建 Google 课堂插件。
我希望教师点击我的网站或应用上嵌入了 Google 课堂内容的按钮。	构建 Google 课堂插件，并以编程方式创建附件。
我想让教师点击我网站或应用上的按钮，以便在 Google 课堂中关联到我的内容。	使用 Google 课堂 API 创建课业或嵌入分享到课堂按钮。
我希望 Google 课堂教师能够与我的学生信息系统同步或导入信息。	实现 OneRoster for SIS，或使用 Classroom API 创建和访问资源。

我们建议新开发者在开始新项目之前做到以下几点：

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

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

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