Method: courses.studentGroups.list

コース内のグループのリストを返します。

このメソッドは、次のエラーコードを返します。

  • コースが存在しない場合は NOT_FOUND。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
courseId

string

必須。コースの識別子。

クエリ パラメータ

パラメータ
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

詳しくは、承認ガイドをご覧ください。