จัดการชั้นเรียน บัญชีรายชื่อ และคำเชิญใน Google Classroom
- แหล่งข้อมูล REST: v1.courses
- ทรัพยากร REST: v1.courses.aliases
- แหล่งข้อมูล REST: v1.courses.announcements
- แหล่งข้อมูลของ REST: v1.courses.announcements.addOnattachs
- แหล่งข้อมูล REST: v1.courses.courseWork
- แหล่งข้อมูล REST: v1.courses.courseWork.addOnattachs
- แหล่งข้อมูลของ REST: v1.courses.courseWork.addOnattachs.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.addOnattachs
- แหล่งข้อมูล REST: v1.courses.posts.addOnattachs.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.guardianInvites
- ทรัพยากร REST: v1.userProfiles.guardians
บริการ: classroom.googleapis.com
หากต้องการเรียกใช้บริการนี้ เราขอแนะนำให้คุณใช้ไลบรารีของไคลเอ็นต์ที่ Google จัดเตรียมไว้ให้ หากแอปพลิเคชันของคุณต้องใช้ไลบรารีของคุณเองเพื่อเรียกใช้บริการนี้ ให้ใช้ข้อมูลต่อไปนี้เมื่อคุณส่งคำขอ API
เอกสารการค้นพบ
เอกสารการค้นพบเป็นข้อกำหนดที่เครื่องอ่านได้สำหรับการอธิบายและใช้ REST API โดยใช้เพื่อสร้างไลบรารีของไคลเอ็นต์, ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google APIs บริการเดียวอาจมีเอกสารการค้นพบได้หลายรายการ บริการนี้มีเอกสารการค้นพบต่อไปนี้
ปลายทางบริการ
ปลายทางบริการคือ URL ฐานที่ระบุที่อยู่เครือข่ายของบริการ 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} อัปเดตช่องอย่างน้อย 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
| วิธีการ | |
|---|---|
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 แสดงผลรายการผู้ปกครองที่ผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดู โดยจำกัดไว้เฉพาะผู้ที่ตรงกับคำขอ |