概览

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

一些典型用例包括：

Classroom API 是否适合我？

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

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

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

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

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

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

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