Method: userProfiles.guardianInvitations.patch

修改監護人邀請。

目前唯一有效的修改方式，是將 state 從 PENDING 變更為 COMPLETE。這會撤銷邀請。

這個方法會傳回下列錯誤代碼：

  • PERMISSION_DENIED 如果目前使用者沒有管理監護人的權限、如果未為相關網域啟用監護人，或發生其他存取錯誤。
  • FAILED_PRECONDITION 如果監護人連結未處於 PENDING 狀態。
  • INVALID_ARGUMENT：如果系統無法辨識所提供的學生 ID 格式 (不是電子郵件地址，也不是這個 API 的 userId)，或是傳遞的 GuardianInvitation 有 COMPLETE 以外的 state，或是修改 state 以外的欄位。
  • NOT_FOUND：如果提供的學生 ID 有效，但 Classroom 沒有該學生的記錄，或是 id 欄位未提及 Classroom 已知的監護人邀請。

HTTP 要求

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
studentId

string

要修改監護人邀請函的學生 ID。
invitationId

string

要修改的 GuardianInvitation 的 id 欄位。

查詢參數

參數
updateMask

string (FieldMask format)

用於識別要更新的課程欄位。這是更新時的必填欄位。如果指定無效欄位，更新作業就會失敗。以下欄位有效：

  • state

在查詢參數中設定時，應將此欄位指定為

updateMask=<field1>,<field2>,...

這是以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

要求主體

要求主體包含 GuardianInvitation 的例項。

回應主體

如果成功，回應主體會包含 GuardianInvitation 的執行例項。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。