Google Classroom API

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

服务：classroom.googleapis.com

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

发现文档

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

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点，下面的所有 URI 都与此服务端点相关：

  • https://classroom.googleapis.com

REST 资源：v1.courses

方法
checkAddOnCreationEligibility GET /v1/courses/{courseId}:checkAddOnCreationEligibility
返回用户是否有资格在指定课程中创建插件附件。
checkGradingPeriodsSetupEligibility GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
返回用户是否有资格在给定课程中更新 GradingPeriodSettings。
create POST /v1/courses
创建课程。
delete DELETE /v1/courses/{id}
删除课程。
get GET /v1/courses/{id}
返回课程。
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
返回课程中的评分周期设置。
list GET /v1/courses
返回发出请求的用户可以查看的课程列表，仅限与请求相匹配的课程。
patch PATCH /v1/courses/{id}
更新课程中的一个或多个字段。
update PUT /v1/courses/{id}
更新课程。
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
更新课程的评分周期设置。

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}
返回通知。
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
获取特定帖子上下文中 Google 课堂插件的元数据。
list GET /v1/courses/{courseId}/announcements
返回允许请求者查看的公告列表。
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
修改分配对象模式和通知选项。
patch PATCH /v1/courses/{courseId}/announcements/{id}
更新通知的一个或多个字段。

REST 资源：v1.courses.announcements.addOnAttachments

方法
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
在帖子下创建插件附件。
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
删除插件附件。
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
返回插件附件。
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
返回相应帖子下的插件创建的所有附件。
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
更新插件附件。

REST 资源：v1.courses.courseWork

方法
create POST /v1/courses/{courseId}/courseWork
创建课程作业。
delete DELETE /v1/courses/{courseId}/courseWork/{id}
删除课程作业。
get GET /v1/courses/{courseId}/courseWork/{id}
返回课程作业。
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
获取特定帖子上下文中 Google 课堂插件的元数据。
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.addOnAttachments

方法
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
在帖子下创建插件附件。
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
删除插件附件。
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
返回插件附件。
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
返回相应帖子下的插件创建的所有附件。
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
更新插件附件。

REST 资源：v1.courses.courseWork.addOnAttachments.studentSubmissions

方法
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
将学生提交的插件附件返回给学生。
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
更新与插件附件提交相关联的数据。

REST 资源：v1.courses.courseWork.rubrics

方法
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
创建评分准则。
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
删除评分准则。
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
返回评分准则。
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
返回允许请求者查看的评分准则列表。
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{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}
返回课程作业资料。
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
获取特定帖子上下文中 Google 课堂插件的元数据。
list GET /v1/courses/{courseId}/courseWorkMaterials
返回允许请求者查看的课程作业资料列表。
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
更新课程作业资料的一个或多个字段。

REST 资源：v1.courses.courseWorkMaterials.addOnAttachments

方法
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
在帖子下创建插件附件。
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
删除插件附件。
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
返回插件附件。
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
返回相应帖子下的插件创建的所有附件。
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
更新插件附件。

REST 资源：v1.courses.posts

方法
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
获取特定帖子上下文中 Google 课堂插件的元数据。

REST 资源：v1.courses.posts.addOnAttachments

方法
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
在帖子下创建插件附件。
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
删除插件附件。
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
返回插件附件。
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
返回相应帖子下的插件创建的所有附件。
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
更新插件附件。

REST 资源：v1.courses.posts.addOnAttachments.studentSubmissions

方法
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
将学生提交的插件附件返回给学生。
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
更新与插件附件提交相关联的数据。

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 课堂开始将提供的 feed 中的通知发送到 cloudPubSubTopic 中提供的目标位置。
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
返回发出请求的用户可以查看的监护人的列表（仅限与请求相匹配的监护人）。