Method: courses.aliases.list

返回课程的别名列表。

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

  • 如果发出请求的用户无权访问课程或出现访问错误，则使用 PERMISSION_DENIED。
  • 如果课程不存在，则返回 NOT_FOUND。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

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

查询参数

参数
pageSize

integer

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

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

string

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

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

请求正文

请求正文必须为空。

响应正文

在列出课程别名时的响应。

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

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

object (CourseAlias)

课程别名。
nextPageToken

string

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

授权范围

需要以下 OAuth 范围之一：

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

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