Google Classroom API

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

Dịch vụ: classroom.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 các thư viện riêng để gọi dịch vụ này, hãy sử dụng thông tin sau khi bạn thực hiện các yêu cầu API.

Tài liệu khám phá

Tài liệu khám phá là một quy cách có thể đọc được bằng máy để mô tả và sử dụng API REST. Thư viện này được dùng để tạo các 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 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:

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

Điểm cuối dịch vụ là một URL cơ sở chỉ định địa chỉ mạng của một 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 dịch vụ sau và tất cả URI bên dưới đều liên quan đến điểm cuối dịch vụ này:

  • https://classroom.googleapis.com

Tài nguyên REST: v1.courses

Phương thức
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Trả về thông tin về việc người dùng có đủ điều kiện để tạo tệp đính kèm bằng tiện ích bổ sung trong một khoá học nhất định hay không.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Trả về thông tin về việc người dùng có đủ điều kiện để cập nhật GradingPeriodSettings trong một khoá học nhất định hay không.
create POST /v1/courses
Tạo một 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.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Trả về chế độ cài đặt giai đoạn chấm điểm trong 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 khoá học.
update PUT /v1/courses/{id}
Cập nhật một khoá học.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Cập nhật chế độ cài đặt giai đoạn chấm điểm của 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 một biệt hiệu cho khoá học.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Xoá biệt hiệu của một khoá học.
list GET /v1/courses/{courseId}/aliases
Trả về danh sách các biệt hiệu 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 các tiện ích bổ sung của Lớp học trong bối cảnh của một bài đăng cụ thể.
list GET /v1/courses/{courseId}/announcements
Trả về danh sách 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ế độ và các lựa chọn về người được giao của 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 một thông báo.

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

Phương thức
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Tạo một tệp đính kèm có tiện ích bổ sung trong một 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ề một tiện ích bổ sung đính kèm.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Trả về tất cả tệp đính kèm do một tiện ích bổ sung tạo trong bài đăng.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Cập nhật tệp đính kèm của tiện ích bổ sung.

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

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

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

Phương thức
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Tạo một tệp đính kèm có tiện ích bổ sung trong một 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ề một tiện ích bổ sung đính kèm.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Trả về tất cả tệp đính kèm do một tiện ích bổ sung tạo trong bài đăng.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Cập nhật tệp đính kèm của tiện ích bổ sung.

Tài nguyê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 tập đã nộp của học viên cho một tệp đính kèm chứa tiện ích bổ sung.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Cập nhật dữ liệu liên quan đến việc gửi tệp đính kèm của tiện ích bổ sung.

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 các tiêu chí mà người yêu cầu được phép xem.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Cập nhậ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ả lại bài tập đã nộp của học viên.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Trả về danh sách bài tập đã nộp của học viên 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 của bài 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 của bài tập mà học viên đã nộp.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Thay mặt học viên sở hữu bài tập đã nộp, lấy lại bài tập đó.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Trả lại bài tập đã nộp của học viên.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Nộp bài tậ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 trên lớp.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Xoá tài liệu bài tập trên lớp.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Trả về một tài liệu bài tập trên lớp.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Lấy siêu dữ liệu cho các tiện ích bổ sung của Lớp học trong 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 bài tập trên lớp 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 trên lớp.

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

Phương thức
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Tạo một tệp đính kèm có tiện ích bổ sung trong một 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ề một tiện ích bổ sung đính kèm.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Trả về tất cả tệp đính kèm do một tiện ích bổ sung tạo trong bài đăng.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Cập nhật tệp đính kèm của tiện ích bổ sung.

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 các tiện ích bổ sung của Lớp học trong 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 một tệp đính kèm có tiện ích bổ sung trong một 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ề một tiện ích bổ sung đính kèm.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Trả về tất cả tệp đính kèm do một tiện ích bổ sung tạo trong bài đăng.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Cập nhật tệp đính kèm của tiện ích bổ sung.

Tài nguyê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 tập đã nộp của học viên cho một tệp đính kèm chứa tiện ích bổ sung.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Cập nhật dữ liệu liên quan đến việc gửi tệp đính kèm của tiện ích bổ sung.

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

Phương thức
create POST /v1/courses/{courseId}/studentGroups
Tạo một nhóm học viên cho một khoá học.
delete DELETE /v1/courses/{courseId}/studentGroups/{id}
Xoá một nhóm học viên.
list GET /v1/courses/{courseId}/studentGroups
Trả về danh sách các nhóm trong một khoá học.
patch PATCH /v1/courses/{courseId}/studentGroups/{id}
Cập nhật một hoặc nhiều trường trong một nhóm học viên.

Tài nguyên REST: v1.courses.studentGroups.studentGroupMembers

Phương thức
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Tạo một thành viên nhóm học viên cho một nhóm học viên.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
Xoá một thành viên nhóm học viên.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Trả về danh sách học viên trong một nhóm.

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

Phương thức
create POST /v1/courses/{courseId}/students
Thêm 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 khỏi khoá học.
get GET /v1/courses/{courseId}/students/{userId}
Trả về một học viên của 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 một giáo viên của khoá học.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Xoá giáo viên được chỉ định khỏi khoá học được chỉ định.
get GET /v1/courses/{courseId}/teachers/{userId}
Trả về một giáo viên của khoá học.
list GET /v1/courses/{courseId}/teachers
Trả về danh sách 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 một 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 vào danh sách giáo viên hoặc học viên (nếu phù hợp) của khoá học được chỉ định.
create POST /v1/invitations
Tạo lời mời.
delete DELETE /v1/invitations/{id}
Xoá một 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 phù hợp với yêu cầu về danh sách.

Tài nguyên REST: v1.registrations

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

Tài nguyên REST: v1.userProfiles

Phương thức
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Trả về thông tin về việc người dùng có thể sử dụng chức năng Lớp học được chỉ định hay không.
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 cho người giám hộ và 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ề một 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 cho 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 cho 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á một 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ỉ bao gồm những người giám hộ phù hợp với yêu cầu.