您的用户是通过 Google Meet 使用 Google 课堂吗?请查看 Apps 脚本快速入门 - 了解如何在 Google Meet 课程中查看学生出席情况

Method: invitations.list

返回发出请求的用户有权查看的邀请列表,仅限与列表请求匹配的邀请。

注意:必须至少提供 userIdcourseId 中的一个。这两个字段都可以提供。

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

HTTP 请求

GET https://classroom.googleapis.com/v1/invitations

网址采用 gRPC 转码语法。

查询参数

参数
userId

string

将返回的邀请限制为特定用户发出的邀请。标识符可以是下列之一:

  • 用户的数字标识符
  • 用户的电子邮件地址
  • 字符串字面量 "me",表示发出请求的用户
courseId

string

将使用课程 ID 返回的邀请限制为课程邀请。

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

有关详情,请参阅 OAuth 2.0 概览