Method: courses.topics.list

返回请求者可以查看的主题列表。

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

  • 如果发出请求的用户无权访问所请求的课程或存在访问错误，则为 PERMISSION_DENIED；
  • 如果请求格式不正确，则为 INVALID_ARGUMENT。
  • 如果所请求的课程不存在，则为 NOT_FOUND。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

课程的标识符。此标识符可以是 Google 课堂分配的标识符，也可以是 alias。

查询参数

参数
pageSize

integer

要返回的最大项数。零或未指定，表示服务器可以分配最大值。

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

string

nextPageToken 值从上一个 list 调用返回，表示应返回后续页面结果。

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

请求正文

请求正文必须为空。

响应正文

列出主题时的响应。

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

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

object (Topic)

与请求匹配的主题项。
nextPageToken

string

标识要返回的下一页结果的令牌。如果为空，表示没有进一步的结果。

授权范围

需要以下 OAuth 作用域：

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

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