Method: invitations.list

傳回要求使用者可查看的邀請清單，僅限於符合清單要求的邀請。

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

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

HTTP 要求

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

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

查詢參數

參數
userId

string

將傳回的邀請限制為特定使用者。識別碼可以是下列任一項：

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

string

將傳回的邀請限制為指定 ID 課程的邀請。
pageSize

integer

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

伺服器傳回的結果數量可能少於指定數量。
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

詳情請參閱授權指南。