Method: courses.studentGroups.list

Trả về danh sách các nhóm trong một khoá học.

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.

Yêu cầu HTTP

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

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

Tham số đường dẫn

Thông số
courseId

string

Bắt buộc. Giá trị nhận dạng của khoá học.

Tham số truy vấn

Thông số
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 một giá trị tối đa, hiện được đặt là 75 mặt hàng.

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 thử.

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 nhóm 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 
{
  "studentGroups": [
    {
      object (StudentGroup)
    }
  ],
  "nextPageToken": string
}
Trường
studentGroups[]

object (StudentGroup)

Các nhóm học viên.
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.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

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