Method: invitations.list

Menampilkan daftar undangan yang boleh dilihat oleh pengguna yang meminta, terbatas untuk undangan yang cocok dengan permintaan daftar.

Catatan: Setidaknya satu userId atau courseId harus diberikan. Kedua kolom dapat diberikan.

Metode ini akan menampilkan kode error berikut:

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
userId

string

Membatasi menampilkan undangan untuk pengguna tertentu. ID dapat berupa salah satu dari hal berikut:

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

string

Restricts menampilkan undangan untuk undangan kursus dengan ID yang ditentukan.
pageSize

integer

Jumlah item maksimum yang akan ditampilkan. Nilai defaultnya adalah 500 jika tidak ditentukan atau 0.

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

string

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

Permintaan list harus sama persis dengan permintaan yang menghasilkan token ini.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons saat mencantumkan undangan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ],
  "nextPageToken": string
}
Kolom
invitations[]

object (Invitation)

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.