Method: courses.students.list

Trả về danh sách học viên của khoá học mà người yêu cầu được phép xem.

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

  • NOT_FOUND nếu khoá học không tồn tại.
  • PERMISSION_DENIED đối với lỗi truy cập.

Yêu cầu HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/students

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

Tham số đường dẫn

Thông số
courseId

string

Giá trị nhận dạng của khoá học. Giá trị nhận dạng này có thể là giá trị nhận dạng do Lớp học chỉ định hoặc alias.

Tham số truy vấn

Thông số
pageSize

integer

Số lượng mục tối đa cần trả về. Giá trị mặc định là 30 nếu không được chỉ định hoặc 0.

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

Phản hồi khi liệt kê học viên.

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 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
Trường
students[]

object (Student)

Những học viên 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, 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.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

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