Method: courses.list

返回允许发出请求的用户查看的课程列表（仅限与请求匹配的课程）。返回的课程按创建时间排序，最近创建的课程放在最前面。

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

  • PERMISSION_DENIED 表示访问错误。
  • 如果查询参数的格式不正确，则返回 INVALID_ARGUMENT。
  • 如果查询参数中指定的任何用户不存在，则返回 NOT_FOUND。

HTTP 请求

GET https://classroom.googleapis.com/v1/courses

网址采用 gRPC 转码语法。

查询参数

参数
studentId

string

仅返回具有指定标识符的学生的课程。标识符可以是以下值之一：

  • 用户的数字标识符
  • 用户的电子邮件地址
  • 字符串字面量 "me"，表示发出请求的用户
teacherId

string

仅返回拥有指定标识符的教师的课程。标识符可以是以下值之一：

  • 用户的数字标识符
  • 用户的电子邮件地址
  • 字符串字面量 "me"，表示发出请求的用户
courseStates[]

enum (CourseState)

将返回的课程限制为处于某种指定状态的课程。默认值为 ACTIVE、ARCHIVED、PROVISIONED、DECLINED。
pageSize

integer

要返回的项数上限。零或未指定表示服务器可以分配上限。

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

string

从上一个 list 调用返回的 nextPageToken 值，表示应返回下一页结果。

list 请求在其他方面必须与生成此令牌的请求相同。

请求正文

请求正文必须为空。

响应正文

列出课程时的响应。

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

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

object (Course)

与列表请求匹配的课程。
nextPageToken

string

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

授权范围

需要以下 OAuth 范围之一：

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

有关详情，请参阅授权指南。