建立監護人邀請,並傳送電子郵件給監護人,要求對方確認他們是學生的監護人。
監護人接受邀請後,他們的state
就會變更為 COMPLETED
,並開始接收監護人通知。系統也會建立 Guardian
資源來代表目前的監護人。
要求物件必須設定 studentId
和 invitedEmailAddress
欄位。如未設定這些欄位,或是在要求中設定任何其他欄位,就會導致錯誤。
這個方法會傳回下列錯誤代碼:
PERMISSION_DENIED
(如果目前的使用者沒有管理監護人的權限、有問題的監護人已經拒絕了該學生的過多要求、相關網域尚未啟用監護人,或其他存取錯誤)。RESOURCE_EXHAUSTED
。INVALID_ARGUMENT
:如果監護人電子郵件地址無效 (例如過長),或是系統無法辨識學生 ID 的格式 (非電子郵件地址,也不是這個 API 的userId
),則為INVALID_ARGUMENT
。如果設定了唯讀欄位,或state
欄位設為PENDING
以外的值,系統也會傳回這個錯誤。- 如果提供的學生 ID 是有效的學生 ID,但 Classroom 沒有該學生的記錄,則為
NOT_FOUND
。 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
詳情請參閱授權指南。