您的用户是通过 Google Meet 使用 Google 课堂吗?请查看 Apps 脚本快速入门 - 了解如何在 Google Meet 课程中查看学生出席情况

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)

与 list 请求匹配的课程。

nextPageToken

string

用于标识下一页返回结果的令牌。如果留空,则没有其他结果。

授权范围

需要以下 OAuth 范围之一:

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

有关详情,请参阅 OAuth 2.0 概览