API Lớp học cung cấp giao diện RESTful để bạn quản lý các khoá học và danh sách trong Google Lớp học. Ngoài ra, nút chia sẻ Lớp học cho phép các nhà phát triển và chủ sở hữu nội dung chia sẻ nội dung của họ với Lớp học.
Ai có thể sử dụng API?
Quản trị viên miền Google Workspace for Education có thể sử dụng API này để thay mặt giáo viên cung cấp các khoá học theo phương thức lập trình, đồng bộ hoá hệ thống thông tin học sinh với Lớp học và xem thông tin cơ bản về các lớp học đang được giảng dạy trong miền của họ.
Nhà phát triển ứng dụng có thể sử dụng API Lớp học để tích hợp ứng dụng của họ với Lớp học. Những ứng dụng này cần sử dụng OAuth 2.0 để yêu cầu quyền xem lớp học và danh sách từ giáo viên. Quản trị viên có thể hạn chế việc giáo viên và học viên trong miền của họ có thể cho phép các ứng dụng truy cập vào dữ liệu Google Lớp học của họ hay không.
Chủ sở hữu trang web và nhà phát triển nội dung có thể sử dụng nút chia sẻ Lớp học để cho phép học viên và giáo viên chia sẻ nội dung trở lại Lớp học.
Mọi công cụ tích hợp nút chia sẻ API và Lớp học đều phải tuân thủ Nguyên tắc sử dụng thương hiệu của Lớp học.
Tổng quan về API
API Lớp học bao gồm một số loại thực thể tương ứng với lớp học, giáo viên và học viên trong giao diện Lớp học. Một số thực thể trong số này có các thuộc tính bổ sung dành riêng cho API ngoài các thuộc tính có trong Lớp học. Các loại pháp nhân chính là:
- Khoá học
- Email đại diện
- Lời mời
- Học viên
- Giáo viên
- Hồ sơ người dùng
- Tài liệu môn học
- Chủ đề
- Bài tập do học viên nộp
Để biết thông tin chi tiết về các tài nguyên và phương thức API, hãy tham khảo Tài liệu tham khảo về API Lớp học.
Siêu dữ liệu và bí danh khoá học
Khoá học đại diện cho một lớp, chẳng hạn như "M. Bài toán học kỳ 4 của Smith", cùng với giáo viên được chỉ định, danh sách học sinh và siêu dữ liệu. Mỗi khoá học được xác định bằng một mã nhận dạng duy nhất do máy chủ chỉ định. Tài nguyên Khoá học bao gồm cụ thể tất cả siêu dữ liệu về khoá học, chẳng hạn như tên, nội dung mô tả, địa điểm và thời gian. Danh sách khoá học được quản lý thông qua tài nguyên dành cho Học viên, Giáo viên và Lời mời cũng như phương pháp của họ.
Bí danh là giá trị nhận dạng thay thế cho một lớp có thể được liên kết với một khoá học và được dùng thay cho mã nhận dạng duy nhất. Mỗi bí danh tồn tại trong một không gian tên hạn chế những người có thể tạo và xem bí danh đó. Hai không gian tên được hỗ trợ:
- Miền: Không gian tên miền rất hữu ích trong việc tạo các bí danh mà tất cả người dùng cần truy cập, nhưng không dành riêng cho bất kỳ chương trình nào. Ví dụ: bạn nên tạo trang thông tin thay thế cho một khoá học, chẳng hạn như MATH 127 và COMSCI 127 trong không gian tên miền. Chỉ quản trị viên miền mới có thể tạo các bí danh trong không gian tên miền, nhưng tất cả người dùng trong miền đều có thể nhìn thấy các bí danh.
- Dự án dành cho nhà phát triển: Không gian tên dự án dành cho nhà phát triển rất hữu ích để quản lý các bí danh dành riêng cho một ứng dụng. Ví dụ: một ứng dụng sử dụng giá trị nhận dạng thay thế cho các khoá học có thể tạo các bí danh để liên kết giá trị nhận dạng đó với các khoá học trên Lớp học. Các bí danh được tạo trong không gian tên này được liên kết với một Google API Console cụ thể. Bất kỳ người dùng ứng dụng nào cũng có thể tạo và xem bí danh trong không gian tên của dự án dành cho nhà phát triển của ứng dụng đó.
Để biết thêm thông tin về cách quản lý siêu dữ liệu và email đại diện của khoá học, hãy xem phần Quản lý khoá học.
Danh sách và người dùng khoá học
Học viên và Giáo viên là các đối tượng liên kết cụ thể giữa hồ sơ người dùng và khoá học, thể hiện vai trò của người dùng đó trong khoá học. Chỉ định học viên và giáo viên không mang tính chung: người dùng có thể được chỉ định làm giáo viên trong một khoá học và học viên trong một khoá học khác. Chỉ định "student" hoặc "teacher" (giáo viên) thể hiện một nhóm quyền cho một người dùng cụ thể trong một khoá học cụ thể.
- Học sinh
Tài nguyên của học viên đại diện cho một người dùng đăng ký với tư cách là học viên trong
một khoá học cụ thể. Học viên được phép xem thông tin chi tiết về khoá học và giáo viên của khoá học đó.
- Giáo viên
Tài nguyên giáo viên đại diện cho một người dùng dạy một khoá học cụ thể.
Giáo viên được phép xem và thay đổi thông tin chi tiết về khoá học, xem giáo viên và học viên, cũng như quản lý giáo viên và học viên khác.
Lời mời và các phương thức liên quan giúp bạn thêm học viên và giáo viên vào các khoá học một cách thuận tiện. Khi tạo lời mời, người dùng có thể chọn tham gia khoá học hay không, thay vì bạn trực tiếp thêm họ thông qua tài nguyên của giáo viên và học viên.
UserProfiles thể hiện mối liên kết đến hồ sơ miền của người dùng, được xác định bằng mã nhận dạng duy nhất hoặc địa chỉ email của người dùng do API Thư mục trả về. Người dùng hiện tại cũng có thể tham chiếu đến mã nhận dạng của riêng họ bằng cách sử dụng cú pháp viết tắt "me".
Để biết thêm thông tin về cách quản lý danh sách, hãy xem phần Quản lý giáo viên và học viên.
Bài tập và bài tập học viên đã nộp
Mục CourseWork đại diện cho một nhiệm vụ duy nhất được giao cho một nhóm học viên trong một khoá học. Tệp này chứa các thông tin chi tiết như nội dung mô tả, ngày đến hạn, tài liệu và siêu dữ liệu như thời gian tạo. Tài liệu bao gồm tiêu đề, hình thu nhỏ và URL, cũng như giá trị nhận dạng có thể dùng với các API thích hợp (ví dụ: Drive, YouTube).
Mục CourseWork mô tả một trong những loại nhiệm vụ sau:
- Một bài tập mà học viên hoàn thành bằng cách gửi trang tính hoặc các tệp đính kèm khác.
- Một câu hỏi trả lời ngắn hoặc câu hỏi trắc nghiệm.
Bài tập của học viên trong một mục CourseWork được biểu thị bằng StudentSubmission (Nội dung gửi của học viên). Dữ liệu này bao gồm phản hồi và siêu dữ liệu bổ sung như trạng thái và điểm đã chỉ định.
Nội dung của Bài tập mà học viên nộp phụ thuộc vào loại mục Bài tập tương ứng:
- Các trang tính và tệp đính kèm đã nộp cho một bài tập, bao gồm tiêu đề, hình thu nhỏ và URL, cũng như giá trị nhận dạng có thể dùng với các API thích hợp như Drive hoặc YouTube.
- Câu trả lời cho một câu hỏi dạng câu trả lời ngắn hoặc câu hỏi trắc nghiệm.
Để biết thêm thông tin về cách quản lý tài liệu môn học và bài tập mà học viên đã nộp, hãy xem bài viết Quản lý bài tập trên lớp.
Tiện ích bổ sung dành cho Lớp học
Tiện ích bổ sung là giao diện người dùng và phần phụ trợ do đối tác phân phát thường hiển thị trong iframe. Tiện ích bổ sung xuất hiện dưới dạng tệp đính kèm trên một bài đăng, có thể là Announcements, CourseWork hoặc CourseWorkMaterials.
Tiện ích bổ sung đính kèm có thể là một hoạt động hoặc nội dung.
- Tệp đính kèm hoạt động yêu cầu học viên phải hoàn thành và nộp bài nộp cá nhân. Ví dụ bao gồm bài đố vui, bản vẽ hoặc trò chơi. Bạn có thể tuỳ ý chấm điểm một hoạt động gửi.
- Tài liệu đính kèm không yêu cầu học viên phải nộp. Học viên không cần nộp tệp đính kèm và tệp sẽ không được chấm điểm. Ví dụ bao gồm ảnh, bài viết và video.
Hãy xem hướng dẫn phát triển tiện ích bổ sung để biết thêm thông tin.
Bắt đầu nhanh
Để thiết lập môi trường và bắt đầu sử dụng API này ngay lập tức, hãy thử một trong những cách bắt đầu nhanh sau đây:
Thử nghiệm với Trình khám phá API của Google
Để thử nghiệm các phương thức gọi trên dữ liệu trực tiếp, hãy thử sử dụng Trình khám phá API của Google. Bạn không cần phải viết bất cứ mã nào để bắt đầu, nhưng xin lưu ý rằng các thao tác bạn thực hiện bằng APIs Explorer có thể sửa đổi dữ liệu hiện có.
Một cách để bắt đầu gọi các phương thức này là gọi phương thức courses.list(). Phương thức này không đòi hỏi bất kỳ tham số yêu cầu nào và bạn có thể truy xuất id từ danh sách khoá học được trả về để dùng làm tham số yêu cầu cho các lệnh gọi API khác. Nếu không có khoá học nào, bạn có thể tạo một khoá học bằng phương thức courses.create().
Bạn cũng có thể khám phá tài liệu tham khảo API.