Method: courses.list

Menampilkan daftar kursus yang diizinkan untuk dilihat oleh pengguna yang meminta, terbatas pada kursus yang cocok dengan permintaan. Kursus yang dikembalikan diurutkan berdasarkan waktu pembuatan, dan kursus yang paling baru dibuat akan muncul terlebih dahulu.

Metode ini menampilkan kode error berikut:

  • PERMISSION_DENIED untuk error akses.
  • INVALID_ARGUMENT jika format argumen kueri salah.
  • NOT_FOUND jika pengguna yang ditentukan dalam argumen kueri tidak ada.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
studentId

string

Membatasi kursus yang ditampilkan untuk kursus yang memiliki siswa dengan ID yang ditentukan. ID dapat berupa salah satu dari berikut:

  • ID numerik untuk pengguna
  • alamat email pengguna
  • literal string "me", yang menunjukkan pengguna yang meminta
teacherId

string

Membatasi kursus yang ditampilkan untuk kursus yang memiliki pengajar dengan ID yang ditentukan. ID dapat berupa salah satu dari berikut:

  • ID numerik untuk pengguna
  • alamat email pengguna
  • literal string "me", yang menunjukkan pengguna yang meminta
courseStates[]

enum (CourseState)

Membatasi kursus yang dikembalikan pada kursus di salah satu status yang ditentukan Nilai default-nya adalah ACTIVE, ARDIP, PROVISIONED, RejectD.
pageSize

integer

Jumlah item maksimum untuk ditampilkan. Nol atau tidak ditentukan menunjukkan bahwa server dapat menetapkan nilai maksimum.

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

string

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

Permintaan list harus sama dengan permintaan yang menghasilkan token ini.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons saat mencantumkan kursus.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Kolom
courses[]

object (Course)

Kursus 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.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.