Google Classroom API

Quản lý lớp học, danh sách và lời mời trong Google Lớp học.

Dịch vụ: class.googleapis.com

Để gọi dịch vụ này, bạn nên sử dụng thư viện ứng dụng do Google cung cấp. Nếu ứng dụng của bạn cần sử dụng thư viện của riêng bạn để gọi dịch vụ này, hãy sử dụng thông tin sau đây khi bạn gửi yêu cầu API.

Tài liệu khám phá

Tài liệu khám phá là một thông số kỹ thuật mà máy có thể đọc được để mô tả và sử dụng các API REST. Thư viện này dùng để xây dựng thư viện ứng dụng, trình bổ trợ IDE và các công cụ khác tương tác với các API của Google. Một dịch vụ có thể cung cấp nhiều tài liệu khám phá. Dịch vụ này cung cấp tài liệu khám phá sau đây:

Điểm cuối dịch vụ

Điểm cuối của dịch vụ là một URL cơ sở chỉ định địa chỉ mạng của dịch vụ API. Một dịch vụ có thể có nhiều điểm cuối dịch vụ. Dịch vụ này có điểm cuối của dịch vụ như sau và tất cả các URI bên dưới đều liên quan đến điểm cuối của dịch vụ này:

  • https://classroom.googleapis.com

Tài nguyên REST: v1.courses

Phương thức
checkAddOnCreationEligibility GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Trả về việc người dùng có đủ điều kiện để tạo tiện ích bổ sung đính kèm trong một khoá học nhất định hay không.
create POST /v1/courses
Tạo khoá học.
delete DELETE /v1/courses/{id}
Xoá một khoá học.
get GET /v1/courses/{id}
Trả về một khoá học.
list GET /v1/courses
Trả về danh sách các khoá học mà người dùng yêu cầu được phép xem, chỉ giới hạn ở những khoá học phù hợp với yêu cầu.
patch PATCH /v1/courses/{id}
Cập nhật một hoặc nhiều trường trong một khoá học.
update PUT /v1/courses/{id}
Cập nhật một khoá học.

Tài nguyên REST: v1.courses.aliases

Phương thức
create POST /v1/courses/{courseId}/aliases
Tạo bí danh cho một khoá học.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Xoá bí danh của một khoá học.
list GET /v1/courses/{courseId}/aliases
Trả về danh sách email đại diện của một khoá học.

Tài nguyên REST: v1.courses.announcements

Phương thức
create POST /v1/courses/{courseId}/announcements
Tạo thông báo.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Xoá một thông báo.
get GET /v1/courses/{courseId}/announcements/{id}
Trả về một thông báo.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Lấy siêu dữ liệu cho tiện ích bổ sung của Lớp học theo bối cảnh của một bài đăng cụ thể.
list GET /v1/courses/{courseId}/announcements
Trả về danh sách các thông báo mà người yêu cầu được phép xem.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Sửa đổi chế độ người được giao và các lựa chọn của một thông báo.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Cập nhật một hoặc nhiều trường của thông báo.

Tài nguyên Kiến trúc chuyển trạng thái đại diện (REST): v1.courses.announcements.addOnAttachments

Phương thức
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Tạo tiện ích bổ sung đính kèm bên dưới bài đăng.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Xoá tệp đính kèm của tiện ích bổ sung.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Trả về tệp đính kèm của tiện ích bổ sung.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Trả về tất cả tệp đính kèm do tiện ích bổ sung tạo ra bên dưới bài đăng.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Cập nhật một tiện ích bổ sung đính kèm.

Tài nguyên REST: v1.courses.courseWork

Phương thức
create POST /v1/courses/{courseId}/courseWork
Tạo bài tập trong khoá học.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Xoá bài tập trong khoá học.
get GET /v1/courses/{courseId}/courseWork/{id}
Trả về bài tập trong khoá học.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Lấy siêu dữ liệu cho tiện ích bổ sung của Lớp học theo bối cảnh của một bài đăng cụ thể.
list GET /v1/courses/{courseId}/courseWork
Trả về danh sách bài tập trong khoá học mà người yêu cầu được phép xem.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Sửa đổi chế độ người được giao và các lựa chọn của một bài tập trong khoá học.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Cập nhật một hoặc nhiều trường của một bài tập trong khoá học.

Tài nguyên REST: v1.courses.courseWork.addOnAttachments

Phương thức
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Tạo tiện ích bổ sung đính kèm bên dưới bài đăng.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Xoá tệp đính kèm của tiện ích bổ sung.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Trả về tệp đính kèm của tiện ích bổ sung.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Trả về tất cả tệp đính kèm do tiện ích bổ sung tạo ra bên dưới bài đăng.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Cập nhật một tiện ích bổ sung đính kèm.

Tài nguyên Kiến trúc chuyển trạng thái đại diện (REST): v1.courses.courseWork.addOnAttachments.studentSubmissions

Phương thức
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Trả về bài nộp của học viên có chứa tiện ích bổ sung đính kèm.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Cập nhật dữ liệu liên quan đến một tệp đính kèm của tiện ích bổ sung đã gửi.

Tài nguyên REST: v1.courses.courseWork.rubrics

Phương thức
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Tạo tiêu chí chấm điểm.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Xoá tiêu chí chấm điểm.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Trả về một tiêu chí chấm điểm.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Trả về danh sách tiêu chí chấm điểm mà người yêu cầu được phép xem.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Cập nhật một tiêu chí chấm điểm.

Tài nguyên REST: v1.courses.courseWork.studentSubmissions

Phương thức
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Trả về bài nộp của học viên.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Trả về danh sách các bài tập mà học viên đã nộp mà người yêu cầu được phép xem, có tính đến phạm vi OAuth của yêu cầu.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Sửa đổi tệp đính kèm trong bài tập học viên nộp.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Cập nhật một hoặc nhiều trường trong bài tập mà học viên nộp.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Xác nhận lại bài nộp của học viên thay mặt cho học viên sở hữu bài nộp đó.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Trả về bài nộp của học viên.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Nộp bài mà học viên nộp.

Tài nguyên REST: v1.courses.courseWorkMaterials

Phương thức
create POST /v1/courses/{courseId}/courseWorkMaterials
Tạo tài liệu bài tập cho khoá học.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Xoá tài liệu của bài tập trong khoá học.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Trả về tài liệu của bài tập trong khoá học.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Lấy siêu dữ liệu cho tiện ích bổ sung của Lớp học theo bối cảnh của một bài đăng cụ thể.
list GET /v1/courses/{courseId}/courseWorkMaterials
Trả về danh sách tài liệu về bài tập trong khoá học mà người yêu cầu được phép xem.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Cập nhật một hoặc nhiều trường của tài liệu bài tập trong khoá học.

Tài nguyên Kiến trúc chuyển trạng thái đại diện (REST): v1.courses.courseWorkMaterials.addOnAttachments

Phương thức
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Tạo tiện ích bổ sung đính kèm bên dưới bài đăng.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Xoá tệp đính kèm của tiện ích bổ sung.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Trả về tệp đính kèm của tiện ích bổ sung.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Trả về tất cả tệp đính kèm do tiện ích bổ sung tạo ra bên dưới bài đăng.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Cập nhật một tiện ích bổ sung đính kèm.

Tài nguyên REST: v1.courses.posts

Phương thức
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Lấy siêu dữ liệu cho tiện ích bổ sung của Lớp học theo bối cảnh của một bài đăng cụ thể.

Tài nguyên REST: v1.courses.posts.addOnAttachments

Phương thức
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Tạo tiện ích bổ sung đính kèm bên dưới bài đăng.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Xoá tệp đính kèm của tiện ích bổ sung.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Trả về tệp đính kèm của tiện ích bổ sung.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Trả về tất cả tệp đính kèm do tiện ích bổ sung tạo ra bên dưới bài đăng.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Cập nhật một tiện ích bổ sung đính kèm.

Tài nguyên Kiến trúc chuyển trạng thái đại diện (REST): v1.courses.posts.addOnAttachments.studentSubmissions

Phương thức
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Trả về bài nộp của học viên có chứa tiện ích bổ sung đính kèm.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Cập nhật dữ liệu liên quan đến một tệp đính kèm của tiện ích bổ sung đã gửi.

Tài nguyên REST: v1.courses.students

Phương thức
create POST /v1/courses/{courseId}/students
Thêm một người dùng làm học viên của một khoá học.
delete DELETE /v1/courses/{courseId}/students/{userId}
Xoá học viên của một khoá học.
get GET /v1/courses/{courseId}/students/{userId}
Trả về học viên của một khoá học.
list GET /v1/courses/{courseId}/students
Trả về danh sách học viên của khoá học này mà người yêu cầu được phép xem.

Tài nguyên REST: v1.courses.teachers

Phương thức
create POST /v1/courses/{courseId}/teachers
Tạo giáo viên của một khoá học.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Xoá giáo viên đã chỉ định khỏi khoá học đã chỉ định.
get GET /v1/courses/{courseId}/teachers/{userId}
Trả về giáo viên của một khoá học.
list GET /v1/courses/{courseId}/teachers
Trả về danh sách các giáo viên của khoá học này mà người yêu cầu được phép xem.

Tài nguyên REST: v1.courses.topics

Phương thức
create POST /v1/courses/{courseId}/topics
Tạo chủ đề.
delete DELETE /v1/courses/{courseId}/topics/{id}
Xoá một chủ đề.
get GET /v1/courses/{courseId}/topics/{id}
Trả về một chủ đề.
list GET /v1/courses/{courseId}/topics
Trả về danh sách các chủ đề mà người yêu cầu được phép xem.
patch PATCH /v1/courses/{courseId}/topics/{id}
Cập nhật một hoặc nhiều trường của một chủ đề.

Tài nguyên REST: v1.invitations

Phương thức
accept POST /v1/invitations/{id}:accept
Chấp nhận lời mời, xoá lời mời đó và thêm người dùng được mời cho giáo viên hoặc học viên (nếu phù hợp) của khoá học đã chỉ định.
create POST /v1/invitations
Tạo lời mời.
delete DELETE /v1/invitations/{id}
Xoá lời mời.
get GET /v1/invitations/{id}
Trả về một lời mời.
list GET /v1/invitations
Trả về danh sách lời mời mà người dùng yêu cầu được phép xem, chỉ giới hạn ở những lời mời khớp với yêu cầu trong danh sách.

Tài nguyên REST: v1.registrations

Phương thức
create POST /v1/registrations
Tạo Registration, khiến Lớp học bắt đầu gửi thông báo từ feed được cung cấp đến đích đã cung cấp trong cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Xoá Registration, khiến Lớp học ngừng gửi thông báo về Registration đó.

Tài nguyên REST: v1.userProfiles

Phương thức
get GET /v1/userProfiles/{userId}
Trả về hồ sơ người dùng.

Tài nguyên REST: v1.userProfiles.guardianInvitations

Phương thức
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Tạo lời mời là người giám hộ rồi gửi email cho người giám hộ để yêu cầu họ xác nhận rằng họ là người giám hộ của học viên.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Trả về lời mời cụ thể dành cho người giám hộ.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Trả về danh sách lời mời của người giám hộ mà người dùng yêu cầu được phép xem, được lọc theo các tham số đã cung cấp.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Sửa đổi lời mời của người giám hộ.

Tài nguyên REST: v1.userProfiles.guardians

Phương thức
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
Xoá người giám hộ.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Trả về một người giám hộ cụ thể.
list GET /v1/userProfiles/{studentId}/guardians
Trả về danh sách người giám hộ mà người dùng yêu cầu được phép xem, chỉ giới hạn ở những người khớp với yêu cầu.