返回发出请求的用户可以查看的监护人邀请列表(按提供的参数过滤)。
此方法会返回以下错误代码:
PERMISSION_DENIED
(如果指定了studentId
,提出请求的用户无权查看该学生的监护人邀请)、指定"-"
为studentId
且该用户不是网域管理员、相关网域未启用监护人或出现其他访问错误。- 如果指定了
studentId
,但无法识别其格式(它不是电子邮件地址,也不是 API 中的studentId
,或字面量字符串me
),则返回INVALID_ARGUMENT
。如果提供的pageToken
或state
无效,也可能会返回INVALID_ARGUMENT
。 - 如果指定了
studentId
且系统可识别其格式,但 Google 课堂没有该学生的记录,则为NOT_FOUND
。
HTTP 请求
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
studentId |
要返回其监护人邀请的学生的 ID。该标识符可以是以下其中一项:
|
查询参数
参数 | |
---|---|
invitedEmailAddress |
如果指定,则仅返回具有指定 |
states[] |
如果指定,则仅返回具有指定 |
pageToken |
从上一个 否则, |
pageSize |
要返回的最大项数。零或未指定表示服务器可以分配最大值。 服务器返回的结果数可能少于指定的数量。 |
请求正文
请求正文必须为空。
响应正文
在列出监护人邀请时的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"guardianInvitations": [
{
object ( |
字段 | |
---|---|
guardianInvitations[] |
与列表请求匹配的监护人邀请。 |
nextPageToken |
标识要返回结果的下一页的令牌。如果为空,则没有可用的结果。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
有关详情,请参阅授权指南。