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

Google Classroom API

管理 Google 课堂中的课程、学生名单和邀请。

服务:classroom.googleapis.com

要调用此服务,我们建议您使用 Google 提供的客户端库。如果您的应用需要使用自己的库来调用此服务,请在发出 API 请求时使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。该服务提供以下发现文档:

服务端点

服务端点是一个基本网址,用于指定 API 服务的网络地址。一个服务可能有多个服务端点。该服务有以下服务端点,且以下所有 URI 均与该服务端点相关:

  • https://classroom.googleapis.com

REST 资源:v1.courses

方法
create POST /v1/courses
创建课程。
delete DELETE /v1/courses/{id}
删除课程。
get GET /v1/courses/{id}
返回课程。
list GET /v1/courses
返回请求者可以查看的课程列表,仅限与请求匹配的课程。
patch PATCH /v1/courses/{id}
更新课程中的一个或多个字段。
update PUT /v1/courses/{id}
更新课程。

REST 资源:v1.courses.aliases

方法
create POST /v1/courses/{courseId}/aliases
为课程创建别名。
delete DELETE /v1/courses/{courseId}/aliases/{alias}
删除课程的别名。
list GET /v1/courses/{courseId}/aliases
返回课程的别名列表。

REST 资源:v1.courses.announcements

方法
create POST /v1/courses/{courseId}/announcements
创建通知。
delete DELETE /v1/courses/{courseId}/announcements/{id}
删除通知。
get GET /v1/courses/{courseId}/announcements/{id}
返回通知。
list GET /v1/courses/{courseId}/announcements
返回请求者可以查看的通知列表。
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
修改通知的分配对象模式和选项。
patch PATCH /v1/courses/{courseId}/announcements/{id}
更新通知的一个或多个字段。

REST 资源:v1.courses.courseWork

方法
create POST /v1/courses/{courseId}/courseWork
创建课程作业。
delete DELETE /v1/courses/{courseId}/courseWork/{id}
删除课程作业。
get GET /v1/courses/{courseId}/courseWork/{id}
返回课程作业。
list GET /v1/courses/{courseId}/courseWork
返回请求者可以查看的课程作业列表。
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
修改作业对象的分配模式和选项。
patch PATCH /v1/courses/{courseId}/courseWork/{id}
更新课程作业的一个或多个字段。

REST 资源:v1.courses.courseWork.studentSubmissions

方法
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
返回学生提交的作业。
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
返回请求者可查看的学生提交内容列表(将请求的 OAuth 范围考虑在内)。
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
修改学生提交的附件。
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
更新学生提交的一个或多个字段。
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
代表拥有学生的学生收回其提交内容。
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
返回学生提交的作业。
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
上交学生提交的作业。

REST 资源:v1.courses.courseWorkMaterials

方法
create POST /v1/courses/{courseId}/courseWorkMaterials
创建课程作业资料。
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
删除课程作业资料。
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
返回课程作业资料。
list GET /v1/courses/{courseId}/courseWorkMaterials
返回请求者可以查看的课程作业资料列表。
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
更新课程作业资料的一个或多个字段。

REST 资源:v1.courses.students

方法
create POST /v1/courses/{courseId}/students
将用户添加为课程学生。
delete DELETE /v1/courses/{courseId}/students/{userId}
删除课程的学生。
get GET /v1/courses/{courseId}/students/{userId}
返回课程的学生。
list GET /v1/courses/{courseId}/students
返回请求者可以查看此课程的学生列表。

REST 资源:v1.courses.teachers

方法
create POST /v1/courses/{courseId}/teachers
创建课程的教师。
delete DELETE /v1/courses/{courseId}/teachers/{userId}
从指定的课程中移除指定的教师。
get GET /v1/courses/{courseId}/teachers/{userId}
返回课程的教师。
list GET /v1/courses/{courseId}/teachers
返回请求者可以查看此课程的教师列表。

REST 资源:v1.courses.topics

方法
create POST /v1/courses/{courseId}/topics
创建一个主题。
delete DELETE /v1/courses/{courseId}/topics/{id}
删除主题。
get GET /v1/courses/{courseId}/topics/{id}
返回主题。
list GET /v1/courses/{courseId}/topics
返回请求者可以查看的主题列表。
patch PATCH /v1/courses/{courseId}/topics/{id}
更新主题的一个或多个字段。

REST 资源:v1.invitations

方法
accept POST /v1/invitations/{id}:accept
接受邀请,移除邀请并将受邀用户添加到指定课程的教师或学生(如适用)。
create POST /v1/invitations
创建邀请。
delete DELETE /v1/invitations/{id}
删除邀请。
get GET /v1/invitations/{id}
返回邀请。
list GET /v1/invitations
返回允许请求用户查看的邀请列表(仅限与列表请求匹配的邀请)。

REST 资源:v1.registrations

方法
create POST /v1/registrations
创建 Registration,让 Google 课堂开始从提供的 feedcloudPubSubTopic 中提供的目的地发送通知。
delete DELETE /v1/registrations/{registrationId}
删除 Registration,导致 Google 课堂停止发送关于该Registration的通知。

REST 资源:v1.userProfiles

方法
get GET /v1/userProfiles/{userId}
返回用户个人资料。

REST 资源:v1.userProfiles.guardianInvitations

方法
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
创建监护人邀请,并向监护人发送一封电子邮件,要求他们确认他们是学生的监护人。
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
返回特定的监护人邀请。
list GET /v1/userProfiles/{studentId}/guardianInvitations
根据请求的参数过滤,允许发出请求的用户查看监护人邀请列表。
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
修改监护人邀请。

REST 资源:v1.userProfiles.guardians

方法
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
删除监护人。
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
返回特定的监护人。
list GET /v1/userProfiles/{studentId}/guardians
返回允许的用户列表(仅限与请求相匹配的监护人查看)的监护人列表。