Google Classroom API

จัดการชั้นเรียน บัญชีรายชื่อ และคำเชิญใน Google Classroom

บริการ: classroom.googleapis.com

หากต้องการเรียกใช้บริการนี้ เราขอแนะนำให้ใช้ไลบรารีของไคลเอ็นต์ที่ Google มีให้ หากแอปพลิเคชันของคุณต้องใช้ไลบรารีของคุณเองเพื่อเรียกใช้บริการนี้ ให้ใช้ข้อมูลต่อไปนี้เมื่อส่งคำขอ API

เอกสารการค้นพบ

เอกสารการค้นพบเป็นข้อกำหนดที่เครื่องอ่านได้สำหรับการอธิบายและใช้ REST API โดยใช้เพื่อสร้างไลบรารีของไคลเอ็นต์, ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google APIs บริการหนึ่งๆ อาจให้เอกสารการค้นพบได้หลายรายการ บริการนี้มีเอกสารการค้นพบต่อไปนี้

ปลายทางของบริการ

ปลายทางบริการคือ URL พื้นฐานที่ระบุที่อยู่เครือข่ายของบริการ API บริการหนึ่งๆ อาจมีปลายทางบริการหลายรายการ บริการนี้มีปลายทางบริการดังต่อไปนี้ และ URI ทั้งหมดด้านล่างจะเกี่ยวข้องกับปลายทางบริการนี้

  • https://classroom.googleapis.com

ทรัพยากร REST: v1.courses

เมธอด
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
แสดงผลว่าผู้ใช้มีสิทธิ์สร้างไฟล์แนบของส่วนเสริมในหลักสูตรที่ระบุหรือไม่
checkGradingPeriodsSetupEligibility
(deprecated)		 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}
อัปเดตช่องอย่างน้อย 1 ช่องในหลักสูตร
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}
อัปเดตช่องอย่างน้อย 1 ช่องของประกาศ

ทรัพยากร 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}
อัปเดตช่องของงานในหลักสูตรอย่างน้อย 1 ช่อง

ทรัพยากร 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}
อัปเดตช่องอย่างน้อย 1 ช่องของงานที่นักเรียนส่ง
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}
อัปเดตเนื้อหางานในหลักสูตรอย่างน้อย 1 ช่อง

ทรัพยากร 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}
อัปเดตช่องอย่างน้อย 1 ช่องของหัวข้อ

ทรัพยากร 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
แสดงรายการผู้ปกครองที่ผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดู โดยจำกัดไว้เฉพาะผู้ปกครองที่ตรงกับคำขอ