Method: courses.aliases.list

Menampilkan daftar alias untuk kursus.

Metode ini menampilkan kode error berikut:

  • PERMISSION_DENIED jika pengguna yang meminta tidak diizinkan untuk mengakses kursus atau karena error akses.
  • NOT_FOUND jika kursus tidak ada.

Permintaan HTTP

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

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 maksimum item yang akan ditampilkan. Nol atau tidak ditentukan menunjukkan bahwa server dapat menetapkan maksimum.

Server mungkin menampilkan lebih sedikit dari jumlah hasil 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 alias kursus.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "aliases": [
    {
      object (CourseAlias)
    }
  ],
  "nextPageToken": string
}
Kolom
aliases[]

object (CourseAlias)

Alias kursus.

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.