Method: invitations.list

返回发出请求的用户可以查看的邀请列表（仅限与列表请求相匹配的邀请）。

注意：必须至少提供 userId 或 courseId 中的一个。两个字段均可提供。

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

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

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