Method: courses.courseWorkMaterials.list

Menampilkan daftar materi tugas mata pelajaran yang diizinkan untuk dilihat oleh pemohon.

Siswa mata pelajaran hanya dapat melihat materi tugas mata pelajaran PUBLISHED. Pengajar mata pelajaran dan administrator domain dapat melihat semua materi tugas mata pelajaran.

Metode ini menampilkan kode error berikut:

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

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
courseId

string

ID mata pelajaran. ID ini dapat berupa ID yang ditetapkan Classroom atau alias.

Parameter kueri

Parameter
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

Pembatasan status tugas yang akan ditampilkan. Hanya materi tugas mata pelajaran yang cocok yang akan ditampilkan. Jika tidak ditentukan, item dengan status tugas PUBLISHED akan ditampilkan.
orderBy

string

Pengurutan hasil opsional. 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 nilai maksimum.

Server dapat menampilkan hasil yang 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.
materialDriveId

string

Pemfilteran opsional untuk materi tugas mata pelajaran dengan setidaknya satu materi Drive yang ID-nya cocok dengan string yang diberikan. Jika materialLink juga ditentukan, materi tugas mata pelajaran harus memiliki materi yang cocok dengan kedua filter.
previewVersion

enum (PreviewVersion)

Opsional. Versi pratinjau API. Parameter ini harus ditetapkan agar dapat mengakses kemampuan API baru yang tersedia untuk developer dalam Program Pratinjau.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons saat mencantumkan materi tugas mata pelajaran.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "courseWorkMaterial": [
    {
      object (CourseWorkMaterial)
    }
  ],
  "nextPageToken": string
}
Kolom
courseWorkMaterial[]

object (CourseWorkMaterial)

Item materi tugas mata pelajaran 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.courseworkmaterials
  • https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.