จัดการชั้นเรียน บัญชีรายชื่อ และคำเชิญใน 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.addOnattachs
- แหล่งข้อมูล 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.registrations
- ทรัพยากร REST: v1.userProfiles
- ทรัพยากร REST: v1.userProfiles.guardianInvitations
- ทรัพยากร REST: v1.userProfiles.guardians
บริการ: classroom.googleapis.com
ในการเรียกใช้บริการนี้ เราขอแนะนำให้คุณใช้ไลบรารีของไคลเอ็นต์ที่ Google มีให้ หากแอปพลิเคชันของคุณจำเป็นต้องใช้ไลบรารีของคุณเองเพื่อเรียกใช้บริการนี้ ให้ใช้ข้อมูลต่อไปนี้เมื่อคุณส่งคำขอ API
เอกสารการค้นพบ
เอกสาร Discovery เป็นข้อกำหนดที่เครื่องอ่านได้สำหรับอธิบายและการใช้งาน REST API ใช้สำหรับสร้างไลบรารีของไคลเอ็นต์ ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google API บริการหนึ่งอาจมีเอกสารการค้นพบได้หลายรายการ บริการนี้มีเอกสารการค้นพบต่อไปนี้
ปลายทางบริการ
ปลายทางบริการคือ URL พื้นฐานที่ระบุที่อยู่เครือข่ายของบริการ API บริการหนึ่งอาจมีปลายทางบริการหลายรายการ บริการนี้มีปลายทางบริการต่อไปนี้และ URI ด้านล่างทั้งหมดจะเกี่ยวข้องกับปลายทางของบริการนี้
https://classroom.googleapis.com
แหล่งข้อมูลเกี่ยวกับ REST: v1.courses
| วิธีการ | |
|---|---|
checkAddOnCreationEligibility |
GET /v1/courses/{courseId}:checkAddOnCreationEligibility แสดงผลว่าผู้ใช้มีสิทธิ์สร้างไฟล์แนบของส่วนเสริมในหลักสูตรหนึ่งๆ หรือไม่ |
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} แสดงผลประกาศ |
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
| วิธีการ | |
|---|---|
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 แสดงผลรายการผู้ปกครองที่ผู้ใช้ที่ส่งคำขอสามารถดูได้ โดยจำกัดเฉพาะผู้ปกครองที่ตรงกับคำขอเท่านั้น |