建立監護人邀請,並傳送電子郵件給監護人,要求他們確認自己是學生的監護人。
監護人接受邀請後,其 state 會變更為 COMPLETED,並開始收到監護人通知。系統也會建立 Guardian 資源,用來代表有效的監護人。
要求物件必須設定 studentId 和 invitedEmailAddress 欄位。如果未設定這些欄位,或在要求中設定任何其他欄位,都會導致錯誤。
這個方法會傳回下列錯誤代碼:
- PERMISSION_DENIED如果目前使用者沒有管理監護人的權限、相關監護人已拒絕太多該名學生的要求、相關網域未啟用監護人功能,或發生其他存取錯誤,就會發生此問題。
- RESOURCE_EXHAUSTED學生或家長已超過家長連結上限。
- INVALID_ARGUMENT監護人的電子郵件地址無效 (例如太長),或是系統無法辨識提供的學生證件格式 (不是電子郵件地址,也不是這個 API 中的- userId)。如果設定唯讀欄位,或將- state欄位設為- PENDING以外的值,系統也會傳回這個錯誤。
- NOT_FOUND:如果提供的學生 ID 有效,但 Classroom 沒有該學生的記錄。
- ALREADY_EXISTS如果學生已收到待處理的監護人邀請,且已提供- invitedEmailAddress,或是已提供的- invitedEmailAddress與此使用者現有- Guardian的 Google 帳戶相符。
HTTP 要求
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
這個網址使用 gRPC 轉碼語法。
路徑參數
| 參數 | |
|---|---|
| guardianInvitation.studentId | 
 學生 ID (標準格式) | 
要求主體
要求主體包含 GuardianInvitation 的例項。
回應主體
如果成功,回應主體會包含新建立的 GuardianInvitation 例項。
授權範圍
需要下列 OAuth 範圍:
- https://www.googleapis.com/auth/classroom.guardianlinks.students
詳情請參閱授權指南。