Method: courses.announcements.list

Menampilkan daftar pengumuman yang diizinkan untuk dilihat oleh pemohon.

Siswa kursus hanya dapat melihat PUBLISHED pengumuman. Pengajar kursus dan administrator domain dapat melihat semua pengumuman.

Metode ini menampilkan kode error berikut:

  • PERMISSION_DENIED jika pengguna yang meminta tidak diizinkan untuk mengakses kursus yang diminta atau karena error akses.
  • INVALID_ARGUMENT jika permintaan memiliki format yang salah.
  • NOT_FOUND jika kursus yang diminta tidak ada.

Permintaan HTTP

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

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
announcementStates[]

enum (AnnouncementState)

Pembatasan pada state pengumuman yang ditampilkan. Jika argumen ini tidak ditentukan, nilai defaultnya adalah PUBLISHED.
orderBy

string

Urutan pengurutan opsional untuk hasil. Daftar kolom yang dipisahkan koma dengan kata kunci arah pengurutan opsional. Kolom yang didukung adalah updateTime. Kata kunci arah yang didukung adalah asc dan desc. Jika tidak ditentukan, updateTime desc adalah perilaku default. Contoh: updateTime asc, updateTime
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 tugas kursus.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
Kolom
announcements[]

object (Announcement)

Item pengumuman yang cocok dengan permintaan.
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.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.