Method: courses.students.list

Menampilkan daftar siswa mata pelajaran ini yang boleh dilihat pemohon.

Metode ini akan menampilkan kode error berikut:

  • NOT_FOUND jika kursus tidak ada.
  • PERMISSION_DENIED untuk error akses.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
courseId

string

ID kursus. ID ini dapat berupa ID yang ditetapkan Classroom atau alias.

Parameter kueri

Parameter
pageSize

integer

Jumlah item maksimum yang akan ditampilkan. Nilai defaultnya adalah 30 jika tidak ditentukan atau 0.

Server mungkin menampilkan lebih sedikit dari jumlah hasil yang ditentukan.
pageToken

string

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

Permintaan list harus sama persis dengan permintaan yang menghasilkan token ini.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons saat menampilkan daftar siswa.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
Kolom
students[]

object (Student)

Siswa yang cocok dengan permintaan daftar.
nextPageToken

string

Token yang mengidentifikasi halaman hasil berikutnya yang akan ditampilkan. Jika kosong, tidak ada hasil lebih lanjut 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
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

Untuk informasi selengkapnya, lihat Panduan otorisasi.