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

Method: userProfiles.guardianInvitations.list

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

根据请求提供的参数过滤,返回允许发出请求的用户查看的监护人邀请列表。

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

  • 如果指定了 studentId,且请求的用户不允许查看该学生的监护人邀请(如果将 "-" 指定为 studentId,并且该用户不是网域管理员),或者未针对相关网域启用监护人或其他访问错误,则系统会使用 PERMISSION_DENIED
  • 如果指定了 studentId,但无法识别其格式(INVALID_ARGUMENT 不是电子邮件地址、API 中的 studentId 和字面量字符串 me),则会返回 INVALID_ARGUMENT。如果提供的 pageTokenstate 无效,也可能会返回。
  • 如果指定了 studentId 且可以识别其格式,但 Google 课堂没有该学生的记录,则返回 NOT_FOUND

HTTP 请求

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations

网址采用 gRPC 转码语法。

路径参数

参数
studentId

string

要发回监护人邀请的学生的 ID。该标识符可以是以下其中一项:

  • 用户的数字标识符
  • 用户的电子邮件地址
  • 字符串字面量 "me",表示发出请求的用户
  • 字符串字面量 "-",表示应为所有请求的用户返回结果,允许发出请求的用户查看监护人邀请。

查询参数

参数
invitedEmailAddress

string

如果指定,则仅返回具有指定 invitedEmailAddress 的结果。

states[]

enum (GuardianInvitationState)

如果指定,则仅返回具有指定 state 值的结果。否则,将返回 statePENDING 的结果。

pageToken

string

从上一个 list 调用返回的 nextPageToken 值,表示应返回后续的结果页。

否则,list 请求必须与生成此令牌的请求完全相同。

pageSize

integer

要返回的商品数量上限。零或未指定则表示服务器可以指定最大值。

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

请求正文

请求正文必须为空。

响应正文

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

列出监护人邀请时的响应。

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

object (GuardianInvitation)

与列表请求匹配的监护人邀请。

nextPageToken

string

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

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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