Method: courses.studentGroups.list

傳回課程中的群組清單。

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

  • 如果課程不存在，則為 NOT_FOUND。

HTTP 要求

GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups

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

路徑參數

參數
courseId

string

必要欄位。課程的 ID。

查詢參數

參數
pageSize

integer

要傳回的項目數量上限。如果為零或未指定，伺服器可能會指派上限，目前設為 75 個項目。

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

string

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

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

enum (PreviewVersion)

(選用步驟) API 的預覽版本。您必須設定這個值，才能存取開發人員預覽計畫中提供的新 API 功能。

要求主體

要求主體必須為空白。

回應主體

列出學生群組時的回應。

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

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

object (StudentGroup)

學生群組。
nextPageToken

string

用來識別要傳回的下一頁結果。如果這個欄位留空，表示沒有其他結果。

授權範圍

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

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

詳情請參閱授權指南。