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. Những khoá học được trả lại sẽ được sắp xếp theo thời gian tạo, trong đó khoá học tạo gần đây nhất sẽ xuất hiện trước.
Phương thức này trả về các mã lỗi sau:
PERMISSION_DENIED
do 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 các đố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
Các tham số | |
---|---|
studentId |
Chỉ cung cấp khoá học đã trả về những 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:
|
teacherId |
Chỉ những khoá học có giáo viên mới được trả về 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:
|
courseStates[] |
Hạn chế trả về các khoá học đối với những khoá học ở một trong các trạng thái đã chỉ định. Giá trị mặc định là HOẠT ĐỘNG, LƯU TRỮ, ĐÃ ĐƯỢC CUNG CẤP, ĐÃ TỪ CHỐI. |
pageSize |
Số lượng mục tối đa cần trả lại. 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ố kết quả đã chỉ định. |
pageToken |
Giá trị Yêu cầu |
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 ( |
Các trường | |
---|---|
courses[] |
Các khoá học khớp với yêu cầu về danh sách. |
nextPageToken |
Mã thông báo xác định trang kết quả tiếp theo cần trả về. Nếu trống, sẽ 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.