您的使用者是透過 Classroom 使用 Google Meet 嗎?請參閱 Apps Script 快速入門,瞭解如何查看學生在 Google Meet 課程中的出席狀況

Google Classroom API

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

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

服務: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.noticements

方法
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」後,Classroom 就會開始將「feed」提供的通知傳送到「cloudPubSubTopic」提供的目的地。
delete DELETE /v1/registrations/{registrationId}
刪除「Registration」,導致 Classroom 停止傳送通知到這個「Registration」。

REST 資源:v1.userProfiles

方法
get GET /v1/userProfiles/{userId}
傳回使用者設定檔。

REST 資源:v1.userProfiles.guardianinvites

方法
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
傳回要求清單的受監護使用者清單,只有提出要求的使用者才能查看,且只有提出要求的監護人才能查看。