Method: courses.studentGroups.list

Menampilkan daftar grup dalam kursus.

Metode ini menampilkan kode error berikut:

  • NOT_FOUND jika kursus tidak ada.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
courseId

string

Wajib. ID kursus.

Parameter kueri

Parameter
pageSize

integer

Jumlah maksimum item yang akan ditampilkan. Nol atau tidak ditentukan menunjukkan bahwa server dapat menetapkan maksimum, yang saat ini ditetapkan ke 75 item.

Server dapat menampilkan lebih sedikit hasil daripada jumlah yang ditentukan.
pageToken

string

Nilai nextPageToken yang ditampilkan dari panggilan list sebelumnya, yang menunjukkan bahwa halaman hasil berikutnya harus ditampilkan.

Permintaan list harus identik dengan permintaan yang menghasilkan token ini.
previewVersion

enum (PreviewVersion)

Opsional. Versi pratinjau API. Setelan ini harus ditetapkan untuk mengakses kemampuan API baru yang tersedia bagi developer dalam Program Pratinjau.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons saat mencantumkan grup siswa.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "studentGroups": [
    {
      object (StudentGroup)
    }
  ],
  "nextPageToken": string
}
Kolom
studentGroups[]

object (StudentGroup)

Grup siswa.
nextPageToken

string

Token yang mengidentifikasi halaman hasil berikutnya yang akan ditampilkan. Jika kosong, tidak ada hasil lainnya yang tersedia.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.