Google Classroom API

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

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

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

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

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

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

ปลายทางบริการคือ URL พื้นฐานที่ระบุที่อยู่เครือข่ายของบริการ 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}
อัปเดตช่องอย่างน้อย 1 ช่องในหลักสูตร
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.announcements

เมธอด
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}
อัปเดตช่องประกาศอย่างน้อย 1 ช่อง

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

แหล่งข้อมูล 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}
ส่งคืนสื่อการเรียนการสอนของชั้นเรียน
list GET /v1/courses/{courseId}/courseWorkMaterials
แสดงรายการเนื้อหางานในหลักสูตรที่ผู้ขอได้รับอนุญาตให้ดู
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
อัปเดตช่องของสื่อการเรียนการสอนของชั้นเรียนอย่างน้อย 1 ช่อง

ทรัพยากรของ 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

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