Google 课堂插件现已面向开发者正式推出!如需了解详情,请参阅
插件文档。
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
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],[],null,["# Method: courses.aliases.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCourseAliasesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if the course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` The identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.aliases/list#body.ListCourseAliasesResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.aliases/list#google.classroom.v1.Courses.ListCourseAliases) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.aliases/list#google.classroom.v1.Courses.ListCourseAliases) request must be otherwise identical to the one that resulted in this token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing course aliases.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"aliases\": [ { object (/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------|\n| `aliases[]` | `object (`[CourseAlias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias)`)` The course aliases. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n- `\n https://www.googleapis.com/auth/classroom.courses.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]