Google Classroom API

在 Google Classroom 中管理課程、學生名單和邀請。

• REST 資源：v1.courses
• REST 資源：v1.courses.aliases
• REST 資源：v1.courses.announcements
• REST 資源：v1.courses.announcements.addOnAttachments
• REST 資源：v1.courses.courseWork
• REST 資源：v1.courses.courseWork.addOnAttachments
• REST 資源：v1.courses.courseWork.addOnAttachments.studentSubmissions
• REST 資源：v1.courses.courseWork.rubrics
• REST 資源：v1.courses.courseWork.studentSubmissions
• REST 資源：v1.courses.courseWorkMaterials
• REST 資源：v1.courses.courseWorkMaterials.addOnAttachments
• REST 資源：v1.courses.posts
• REST 資源：v1.courses.posts.addOnAttachments
• REST 資源：v1.courses.posts.addOnAttachments.studentSubmissions
• REST 資源：v1.courses.students
• REST 資源：v1.courses.teachers
• REST 資源：v1.courses.topics
• REST 資源：v1.invitations
• REST 資源：v1.enrolls
• REST 資源：v1.userProfiles
• REST 資源：v1.userProfiles.guardian 比例 s
• REST 資源：v1.userProfiles.guardians

服務：classroom.googleapis.com

如要呼叫這項服務，建議您使用 Google 提供的用戶端程式庫。如果應用程式需要使用您自己的程式庫呼叫這項服務，請在發出 API 要求時使用下列資訊。

探索文件

探索文件是一種機器可解讀的規格，用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式，以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。這項服務提供下列探索文件：

• https://classroom.googleapis.com/$discovery/rest?version=v1

服務端點

服務端點是指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點。這項服務有以下服務端點，且下方的 URI 皆以此服務端點為基準：

• https://classroom.googleapis.com

REST 資源：v1.courses

方法
checkAddOnCreationEligibility	GET /v1/courses/{courseId}:checkAddOnCreationEligibility 傳回使用者是否有資格在特定課程中建立外掛程式附件。
checkGradingPeriodsSetupEligibility	GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。這項功能適用於 V1_20240401_PREVIEW 以上版本。詳情請參閱「存取預覽版 API」。 傳回使用者是否有資格在特定課程中更新 GradingPeriodSettings。
create	POST /v1/courses 建立課程。
delete	DELETE /v1/courses/{id} 刪除課程。
get	GET /v1/courses/{id} 傳回課程。
getGradingPeriodSettings	GET /v1/courses/{courseId}/gradingPeriodSettings 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。這項功能適用於 V1_20240401_PREVIEW 以上版本。詳情請參閱「存取預覽版 API」。 傳回課程中的評分期間設定。
list	GET /v1/courses 傳回允許要求使用者檢視的課程清單，僅限與要求相符的課程。
patch	PATCH /v1/courses/{id} 更新課程中的一或多個欄位。
update	PUT /v1/courses/{id} 更新課程。
updateGradingPeriodSettings	PATCH /v1/courses/{courseId}/gradingPeriodSettings 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。這項功能適用於 V1_20240401_PREVIEW 以上版本。詳情請參閱「存取預覽版 API」。 更新課程的評分期間設定。

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 取得特定訊息搭配的 Classroom 外掛程式中繼資料。
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 取得特定訊息搭配的 Classroom 外掛程式中繼資料。
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 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。這項功能適用於 V1_20231110_PREVIEW 以上版本。詳情請參閱「存取預覽版 API」。 建立評分量表。
delete	DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。這項功能適用於 V1_20231110_PREVIEW 以上版本。詳情請參閱「存取預覽版 API」。 刪除評分量表。
get	GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。這項功能適用於 V1_20231110_PREVIEW 以上版本。詳情請參閱「存取預覽版 API」。 傳回評分量表。
list	GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。這項功能適用於 V1_20231110_PREVIEW 以上版本。詳情請參閱「存取預覽版 API」。 傳回要求者可查看的評分量表清單。
patch	PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。這項功能適用於 V1_20231110_PREVIEW 以上版本。詳情請參閱「存取預覽版 API」。 更新評分量表。

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 取得特定訊息搭配的 Classroom 外掛程式中繼資料。
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 取得特定訊息搭配的 Classroom 外掛程式中繼資料。

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，讓 Classroom 開始從提供的 feed 傳送通知到 cloudPubSubTopic 提供的目的地。
delete	DELETE /v1/registrations/{registrationId} 刪除Registration，導致 Classroom 停止傳送該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 傳回允許提出要求的使用者查看的監護人清單，僅限符合要求的使用者查看。