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ỉ bao gồm những khoá học phù hợp với yêu cầu. Các khoá học được trả về sẽ đượ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 đầu tiên.

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 có định dạng không chính xác.
  • 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

Giới hạn các khoá học được trả về cho những khoá học có học viên có 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ạng số cho người dùng
  • địa chỉ email của người dùng
  • giá trị cố định của chuỗi "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ề cho những khoá học có giáo viên có 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ạng số cho người dùng
  • địa chỉ email của người dùng
  • giá trị cố định của chuỗi "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)

Hạn chế các khoá học được trả về trong một trong các trạng thái được chỉ định. Nếu không chỉ định, các Khoá học ở mọi trạng thái sẽ được trả về.
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 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 hệt với yêu cầu dẫn đến mã thông báo này.
previewVersion

enum (PreviewVersion)

Không bắt buộc. Phiên bản xem trước của API. Bạn phải đặt giá trị này để truy cập vào các chức năng API mới được cung cấp cho nhà phát triển trong Chương trình dùng trước.

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 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, tức là 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 uỷ quyền.