Method: courses.list

Trả về danh sách các khoá học mà người dùng yêu cầu được phép xem, chỉ những khoá học phù hợp với yêu cầu mới được xem. Các khoá học được trả về được sắp xếp theo thời gian tạo, trong đó khoá học được tạo gần đây nhất sẽ xuất hiện trước tiên.

Phương thức này trả về các mã lỗi sau:

  • PERMISSION_DENIED đối với lỗi truy cập.
  • INVALID_ARGUMENT nếu đối số truy vấn không đúng định dạng.
  • NOT_FOUND nếu không có người dùng nào được chỉ định trong đối số truy vấn.

Yêu cầu HTTP

GET https://classroom.googleapis.com/v1/courses

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
studentId

string

Hạn chế các khoá học được trả về ở những khoá học có học viên có mã nhận dạng được chỉ định. Giá trị nhận dạng có thể là một trong những giá trị sau:

  • giá trị nhận dạng dạng số của người dùng
  • địa chỉ email của người dùng
  • chuỗi cố định "me", cho biết người dùng yêu cầu
teacherId

string

Chỉ trả về những khoá học có giáo viên có mã nhận dạng được chỉ định. Giá trị nhận dạng có thể là một trong những giá trị sau:

  • giá trị nhận dạng dạng số của người dùng
  • địa chỉ email của người dùng
  • chuỗi cố định "me", cho biết người dùng yêu cầu
courseStates[]

enum (CourseState)

Chỉ trả về những khoá học ở một trong các trạng thái đã chỉ định. Giá trị mặc định là ACTIVE (ĐANG CHẠY), ARCHIVED (ĐÃ LƯU KHO), PROVISIONED (ĐÃ CUNG CẤP), DECLINED (ĐÃ TỪ CHỐI).
pageSize

integer

Số lượng mục tối đa cần trả về. Giá trị 0 hoặc không xác định cho biết máy chủ có thể chỉ định giá trị tối đa.

Máy chủ có thể trả về ít hơn số kết quả được chỉ định.
pageToken

string

Giá trị nextPageToken được trả về từ lệnh gọi list trước đó, cho biết rằng trang kết quả tiếp theo sẽ được trả về.

Yêu cầu list phải giống hệt với yêu cầu đã tạo ra mã thông báo này.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nội dung phản hồi khi đăng thông tin về khoá học.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Trường
courses[]

object (Course)

Các khoá học khớp với yêu cầu về danh sách.
nextPageToken

string

Mã thông báo xác định trang kết quả tiếp theo cần trả về. Nếu trống, bạn sẽ không nhận được kết quả nào khác.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.