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ỉ giới hạn ở những khoá học phù hợp với yêu cầu. Các khoá học được trả về được sắp xếp theo thời gian tạo, với khoá học được tạo gần đây nhất sẽ xuất hiện đầu tiên.

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

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

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

Giới hạn 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. Mã nhận dạng có thể là một trong những mã sau:

  • mã nhận dạng bằng số cho người dùng
  • địa chỉ email của người dùng
  • chuỗi ký tự "me", cho biết người dùng yêu cầu

Nếu được chỉ định, teacherId phải trống.
teacherId

string

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

  • mã nhận dạng bằng số cho người dùng
  • địa chỉ email của người dùng
  • chuỗi ký tự "me", cho biết người dùng yêu cầu

Nếu được chỉ định, studentId phải trống.
courseStates[]

enum (CourseState)

Giới hạn các khoá học được trả về ở những khoá học ở một trong các trạng thái được chỉ định Giá trị mặc định là ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize

integer

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

Máy chủ có thể trả về ít kết quả hơn số lượng đượ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 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

Phản hồi khi liệt kê các 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 phù hợp với yêu cầu 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, thì không 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 về Uỷ quyền.