Method: courses.studentGroups.list

返回课程中的群组列表。

此方法会返回以下错误代码：

  • 如果课程不存在，则返回 NOT_FOUND。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

必需。课程的标识符。

查询参数

参数
pageSize

integer

要返回的最大商品数量。如果值为 0 或未指定，则表示服务器可能会分配一个上限，目前设置为 75 项。

服务器返回的结果数可能少于指定的结果数。
pageToken

string

之前 list 调用返回的 nextPageToken 值，表示应返回下一页结果。

list 请求必须与生成此令牌的请求完全相同。
previewVersion

enum (PreviewVersion)

可选。API 的预览版。必须设置此标志，才能访问预览版计划中向开发者提供的新 API 功能。

请求正文

请求正文必须为空。

响应正文

列出学生群组时的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "studentGroups": [
    {
      object (StudentGroup)
    }
  ],
  "nextPageToken": string
}
字段
studentGroups[]

object (StudentGroup)

学生群组。
nextPageToken

string

用于标识要返回的下一页结果的令牌。如果为空，则表示没有更多结果。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

如需了解详情，请参阅授权指南。