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

Method: userProfiles.guardians.list

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

返回请求者有权查看的监护人列表，仅限与请求匹配的监护人。

如需列出发出请求的用户可以查看监护人的任何学生的监护人，请为该学生 ID 使用文本字符 -。

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

  • 如果指定了 studentId，且请求的用户无法查看该学生的监护人信息（如果 "-" 被指定为 studentId 且该用户不是网域管理员），或者相关网域未启用监护人、如果网域过滤器用户设置了 invitedEmailAddress 过滤器或其他访问错误，则系统会使用 PERMISSION_DENIED。
  • INVALID_ARGUMENT 如果已指定 studentId，但系统无法识别其格式（它不是电子邮件地址、API 中的 studentId 和字面量字符串 me）。如果提供的 pageToken 无效，也可能会返回。
  • 如果指定了 studentId 且可以识别其格式，但 Google 课堂没有该学生的记录，则返回 NOT_FOUND。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
studentId

string

按监护人关联的学生过滤结果。该标识符可以是以下其中一项：

  • 用户的数字标识符
  • 用户的电子邮件地址
  • 字符串字面量 "me"，表示发出请求的用户
  • 字符串字面量 "-"，用于指示应针对发出请求的用户有权查看的所有学生返回结果。

查询参数

参数
invitedEmailAddress

string

按接收原始邀请的电子邮件地址过滤结果，从而生成此监护人链接。只有网域管理员可以使用此过滤条件。
pageToken

string

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

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

integer

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

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

请求正文

请求正文必须为空。

响应正文

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

列出监护人时的响应。

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

object (Guardian)

此页面上有符合请求中指定的条件的结果中的监护人。
nextPageToken

string

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

授权范围

需要以下 OAuth 范围之一：

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

有关详情，请参阅 OAuth 2.0 概览。