Method: invitations.list

傳回提出要求的使用者能看到的邀請清單，僅限符合清單要求的參與者。

注意：至少須提供 userId 或 courseId 其中之一。這兩個欄位皆可提供。

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

HTTP 要求

GET https://classroom.googleapis.com/v1/invitations

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

查詢參數

參數
userId

string

限制只傳回特定使用者的邀請。ID 可以是下列其中一項：

  • 使用者的數字 ID
  • 使用者的電子郵件地址
  • 字串常值 "me"，表示提出要求的使用者
courseId

string

限制只有具備指定 ID 的課程傳回的邀請。
pageSize

integer

要傳回的項目數上限。如未指定，則預設值為 500；未指定 0。

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

string

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

list 要求必須與產生這個權杖的要求相同。

要求主體

要求主體必須為空白。

回應主體

列出邀請時的回應。

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

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

object (Invitation)

符合清單要求的邀請。
nextPageToken

string

用於識別下一頁結果的權杖。如果留空，系統就不會顯示進一步結果。

授權範圍

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

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

詳情請參閱授權指南。