Tổng quan

API Google Lớp học cung cấp giao diện lập trình để các nhà phát triển phần mềm, quản trị viên và lãnh đạo trường học quản lý tài nguyên của Google Lớp học. Bạn có thể tạo phần mềm để tạo, truy xuất và sửa đổi các khoá học trên Lớp học cũng như nội dung của các khoá học đó.

Sau đây là một số trường hợp sử dụng thường gặp:

  • Quản lý các khoá học, danh sách và người giám hộ
  • Thêm bài tập, thông báo và tài liệu của khoá học
  • Chỉ định điểm và sửa đổi chế độ cài đặt điểm
  • Tạo dữ liệu để phân tích
  • Cho phép người dùng khám phá và truy cập vào nội dung hoặc công cụ của một nhà cung cấp bên ngoài trong Lớp học

API lớp học có phải là giải pháp phù hợp với tôi không?

Google cung cấp một số sản phẩm giúp bạn tương tác với Lớp học. Sau đây là một số trường hợp phổ biến và đề xuất cho những sản phẩm có thể phù hợp nhất với nhu cầu của bạn.

Sửa đổi tài nguyên trên Google Lớp học

Trường hợp Giải pháp đề xuất
Tôi muốn thường xuyên quản lý một số lượng lớn các khoá học, người dùng hoặc các tài nguyên khác trong Lớp học. Tôi cảm thấy thoải mái khi viết mã và duy trì cơ sở hạ tầng phần mềm. Viết các ứng dụng sử dụng API Lớp học.
Thỉnh thoảng, tôi muốn quản lý một lượng nhỏ tài nguyên trong Lớp học. Tôi cảm thấy thoải mái khi viết các đoạn mã nhỏ với chi phí thấp. Sử dụng API Lớp học với Google Apps Script.
Thỉnh thoảng, tôi muốn thay đổi các tài nguyên riêng lẻ trong Lớp học. Tôi cảm thấy thoải mái khi xử lý các lệnh đầu cuối. Sử dụng Trình quản lý Google Apps.
Tôi muốn có một lượng lớn báo cáo có thông tin chi tiết về các sự kiện trong lớp học. Sử dụng Dịch vụ chuyển dữ liệu của BigQuery.
Tôi muốn điều tra hoạt động của người dùng. Tạo báo cáo trong Bảng điều khiển dành cho quản trị viên hoặc sử dụng API báo cáo.

Tích hợp với Google Lớp học

Trường hợp Giải pháp đề xuất
Tôi muốn giáo viên và học viên xem và chạy nội dung của tôi trong Lớp học. Xây dựng một tiện ích bổ sung cho Lớp học.
Tôi muốn giáo viên nhấp vào một nút trên trang web hoặc ứng dụng nhúng nội dung của tôi vào Lớp học. Tạo một tiện ích bổ sung cho Lớp học và tạo tệp đính kèm theo phương thức lập trình.
Tôi muốn giáo viên nhấp vào một nút trên trang web hoặc ứng dụng của tôi để liên kết đến nội dung của tôi trong Lớp học. Tạo tài liệu môn học bằng API Lớp học hoặc nhúng các nút Chia sẻ với Lớp học.
Tôi muốn giáo viên trong Lớp học đồng bộ hoá hoặc nhập thông tin từ Hệ thống thông tin học sinh của tôi. Triển khai OneRoster cho SIS hoặc tạo và truy cập vào tài nguyên bằng API Lớp học.

Bắt đầu

Nhà phát triển mới nên làm những việc sau trước khi bắt đầu một dự án mới:

Để bắt đầu phát triển, hãy đảm bảo bạn đã hoàn tất các bước tiên quyết. Chọn phạm vi API của Lớp học phù hợp với nhu cầu của bạn, sau đó thiết lập môi trường và bắt đầu tạo yêu cầu bằng cách làm theo một trong các hướng dẫn nhanh sau:

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 mã nào để bắt đầu, nhưng hãy lưu ý rằng các thao tác bạn thực hiện bằng Trình khám phá API có thể sửa đổi dữ liệu hiện có.

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 yêu cầu 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ề để sử dụng làm tham số yêu cầu cho các lệnh gọi API khác. Nếu chưa có khoá học nào, bạn có thể tạo 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 về API Lớp học.