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

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

  • PERMISSION_DENIED để biết lỗi truy cập.
  • INVALID_ARGUMENT nếu đối số truy vấn không đúng định dạng.
  • Là giá trị NOT_FOUND nếu có bất kỳ người dùng nào được chỉ định trong các đối số truy vấn đều 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

Tham số
studentId

string

Chỉ cho phép trả về những khoá học có học viên với giá trị nhận dạng đã 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ưới dạng số cho người dùng
  • địa chỉ email của người dùng
  • giá trị cố định kiểu chuỗi "me", cho biết người dùng đưa ra yêu cầu
teacherId

string

Chỉ cho phép trả về những khoá học có giáo viên với giá trị 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ưới dạng số cho người dùng
  • địa chỉ email của người dùng
  • giá trị cố định kiểu chuỗi "me", cho biết người dùng đưa ra yêu cầu
courseStates[]

enum (CourseState)

Chỉ cho phép những khoá học được trả về ở một trong những trạng thái được chỉ định
pageSize

integer

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

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

string

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

Nếu không, 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)

Những khoá học khớp với yêu cầu trong 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, không có thêm kết quả nào.

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.