Method: userProfiles.guardianInvitations.list

傳回要求使用者可查看的監護人邀請清單，並根據提供的參數進行篩選。

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

  • PERMISSION_DENIED 如果已指定 studentId，且要求使用者無法查看該學生的監護人邀請；如果 "-" 已指定為 studentId，且使用者不是網域管理員；如果未為相關網域啟用監護人功能；或發生其他存取錯誤。
  • INVALID_ARGUMENT：如果指定 studentId，但系統無法辨識其格式 (不是電子郵件地址、不是 API 中的 studentId，也不是文字字串 me)。如果提供無效的 pageToken 或 state，系統也可能會傳回此錯誤。
  • NOT_FOUND 指定 studentId 且系統可辨識其格式，但 Classroom 沒有該學生的記錄。

HTTP 要求

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

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

路徑參數

參數
studentId

string

要傳回監護人邀請的學生 ID。識別碼可以是下列任一項：

  • 使用者的數字 ID
  • 使用者的電子郵件地址
  • 字串常值 "me"，表示要求使用者
  • 字串文字 "-"，表示應針對要求使用者可查看家長邀請的所有學生傳回結果。

查詢參數

參數
invitedEmailAddress

string

如果指定，系統只會傳回含有指定 invitedEmailAddress 的結果。
states[]

enum (GuardianInvitationState)

如果指定了 state 值，系統只會傳回含有指定 state 值的結果。否則，系統會傳回 state 為 PENDING 的結果。
pageToken

string

先前 list 呼叫傳回的 nextPageToken 值，表示應傳回後續的結果頁面。

list 要求必須與產生此權杖的要求相同。
pageSize

integer

傳回的項目數量上限。零或未指定的值表示伺服器可能會指派最大值。

伺服器傳回的結果數量可能少於指定數量。

要求主體

要求主體必須為空白。

回應主體

列出監護人邀請時的回應。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
欄位
guardianInvitations[]

object (GuardianInvitation)

符合清單要求的監護人邀請。
nextPageToken

string

用於識別要傳回的下一頁結果的符記。如果留空，表示沒有其他結果。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。