Google 课堂插件现已面向开发者正式推出!如需了解详情,请参阅
插件文档。
Method: invitations.list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
返回请求用户有权查看的邀请列表,仅限与列表请求匹配的邀请。
注意:必须至少提供 userId
或 courseId
之一。您可以同时提供这两个字段。
此方法会返回以下错误代码:
PERMISSION_DENIED
表示访问错误。
HTTP 请求
GET https://classroom.googleapis.com/v1/invitations
网址采用 gRPC 转码语法。
查询参数
参数 |
userId |
string
将返回的邀请限制为特定用户的邀请。标识符可以是以下各项之一:
- 用户的数字标识符
- 用户的电子邮件地址
- 字符串字面量
"me" ,表示请求用户
|
courseId |
string
将返回的邀请限制为具有指定标识符的课程的邀请。
|
pageSize |
integer
要返回的最大项数。如果未指定,则默认为 500 或 0 。 服务器返回的结果数量可能少于指定数量。
|
pageToken |
string
上一次 list 调用返回的 nextPageToken 值,表示应返回后续的结果页。 否则,list 请求必须与生成此令牌的请求相同。
|
响应正文
列出邀请时的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
{
"invitations": [
{
object (Invitation )
}
],
"nextPageToken": string
} |
字段 |
invitations[] |
object (Invitation )
与列表请求匹配的邀请。
|
nextPageToken |
string
标识要返回的下一页结果的令牌。如果为空,则表示没有更多结果。
|
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],[],null,["# Method: invitations.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListInvitationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request.\n\n*Note:* At least one of `userId` or `courseId` must be supplied. Both fields can be supplied.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/invitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` Restricts returned invitations to those for a specific user. The identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `courseId` | `string` Restricts returned invitations to those for a course with the specified identifier. |\n| `pageSize` | `integer` Maximum number of items to return. The default is 500 if unspecified or `0`. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/invitations/list#body.ListInvitationsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/invitations/list#google.classroom.v1.Invitations.ListInvitations) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/invitations/list#google.classroom.v1.Invitations.ListInvitations) 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 invitations.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"invitations\": [ { object (/workspace/classroom/reference/rest/v1/invitations#Invitation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `invitations[]` | `object (`[Invitation](/workspace/classroom/reference/rest/v1/invitations#Invitation)`)` Invitations that match the list request. |\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.rosters`\n- `\n https://www.googleapis.com/auth/classroom.rosters.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]