Google 课堂插件现已面向开发者正式推出!如需了解详情,请参阅
插件文档。
REST Resource: userProfiles.guardianInvitations
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
资源:GuardianInvitation
向指定电子邮件地址发送了成为指定用户的监护人的邀请。
JSON 表示法 |
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum (GuardianInvitationState ),
"creationTime": string
} |
字段 |
studentId |
string
学生的 ID(采用标准格式)
|
invitationId |
string
相应邀请的唯一标识符。 只读。
|
invitedEmailAddress |
string
邀请的接收方电子邮件地址。此字段仅对网域管理员可见。
|
state |
enum (GuardianInvitationState )
相应邀请所处的状态。
|
creationTime |
string (Timestamp format)
相应邀请的创建时间。 只读。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z" 、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30" 。
|
GuardianInvitationState
枚举 |
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
绝不应返回。 |
PENDING |
邀请处于有效状态,正在等待回复。 |
COMPLETE |
邀请已失效。该邀请可能已被接受、拒绝、撤消或已过期。 |
方法 |
|
创建监护人邀请,并向监护人发送电子邮件,要求其确认自己是学生的监护人。 |
|
返回特定的监护人邀请。 |
|
返回请求用户有权查看的监护人邀请列表,并按提供的参数进行过滤。 |
|
修改监护人邀请。 |
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-08-26。
[null,null,["最后更新时间 (UTC):2025-08-26。"],[],[],null,["- [Resource: GuardianInvitation](#GuardianInvitation)\n - [JSON representation](#GuardianInvitation.SCHEMA_REPRESENTATION)\n- [GuardianInvitationState](#GuardianInvitationState)\n- [Methods](#METHODS_SUMMARY)\n\nResource: GuardianInvitation An invitation to become the guardian of a specified user, sent to a specified email address.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"studentId\": string, \"invitationId\": string, \"invitedEmailAddress\": string, \"state\": enum (/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState), \"creationTime\": string } ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` ID of the student (in standard format) |\n| `invitationId` | `string` Unique identifier for this invitation. Read-only. |\n| `invitedEmailAddress` | `string` Email address that the invitation was sent to. This field is only visible to domain administrators. |\n| `state` | `enum (`[GuardianInvitationState](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState)`)` The state that this invitation is in. |\n| `creationTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` The time that this invitation was created. Read-only. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\nGuardianInvitationState State of a guardian invitation.\n\n| Enums ||\n|-----------------------------------------|------------------------------------------------------------------------------------------------------------|\n| `GUARDIAN_INVITATION_STATE_UNSPECIFIED` | Should never be returned. |\n| `PENDING` | The invitation is active and awaiting a response. |\n| `COMPLETE` | The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired. |\n\n| Methods ||\n|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| [create](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/create) | Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. |\n| [get](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/get) | Returns a specific guardian invitation. |\n| [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list) | Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. |\n| [patch](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/patch) | Modifies a guardian invitation. |"]]