Method: courses.list

Menampilkan daftar kursus yang diizinkan untuk dilihat oleh pengguna yang meminta, yang dibatasi pada kursus yang cocok dengan permintaan. Kursus yang ditampilkan diurutkan berdasarkan waktu pembuatan, dengan kursus yang baru dibuat ditampilkan terlebih dahulu.

Metode ini menampilkan kode error berikut:

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

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
studentId

string

Membatasi kursus yang ditampilkan hanya pada 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

Jika ditentukan, teacherId harus kosong.
teacherId

string

Membatasi kursus yang ditampilkan hanya pada 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

Jika ditentukan, studentId harus kosong.
courseStates[]

enum (CourseState)

Membatasi kursus yang ditampilkan ke kursus dalam salah satu status yang ditentukan. Nilai defaultnya adalah ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize

integer

Jumlah maksimum item yang akan ditampilkan. Nol atau tidak ditentukan menunjukkan bahwa server dapat menetapkan maksimum.

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.

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 lainnya 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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.