管理 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.studentGroups
- REST 資源：v1.courses.studentGroups.studentGroupMembers
- REST 資源：v1.courses.students
- REST 資源：v1.courses.teachers
- REST 資源：v1.courses.topics
- REST 資源：v1.invitations
- REST 資源：v1.registrations
- REST 資源：v1.userProfiles
- REST 資源：v1.userProfiles.guardianInvitations
- REST 資源：v1.userProfiles.guardians
服務：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 取得特定貼文的 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 建立評分量表。 |
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 取得特定貼文的 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.studentGroups
| 方法 | |
|---|---|
create |
POST /v1/courses/{courseId}/studentGroups 為課程建立學生群組。 |
delete |
DELETE /v1/courses/{courseId}/studentGroups/{id} 刪除學生群組。 |
list |
GET /v1/courses/{courseId}/studentGroups 傳回課程中的群組清單。 |
patch |
PATCH /v1/courses/{courseId}/studentGroups/{id} 更新學生群組中的一或多個欄位。 |
REST 資源：v1.courses.studentGroups.studentGroupMembers
| 方法 | |
|---|---|
create |
POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers 為學生群組建立學生群組成員。 |
delete |
DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId} 刪除學生群組成員。 |
list |
GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers 傳回群組中的學生清單。 |
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
| 方法 | |
|---|---|
checkUserCapability |
GET /v1/userProfiles/{userId}:checkUserCapability 傳回使用者是否可以使用指定的 Classroom 功能。 |
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 傳回要求使用者可查看的監護人清單，但僅限符合要求的監護人。 |