Method: userProfiles.guardians.list

Menampilkan daftar wali yang boleh dilihat oleh pengguna yang meminta, terbatas pada wali yang cocok dengan permintaan tersebut.

Untuk menampilkan daftar wali siswa yang mungkin dilihat walinya oleh pengguna yang meminta, gunakan karakter literal - untuk ID siswa.

Metode ini menampilkan kode error berikut:

  • PERMISSION_DENIED jika studentId ditentukan, dan pengguna yang meminta tidak diizinkan untuk melihat informasi wali siswa tersebut, jika "-" ditetapkan sebagai studentId dan pengguna bukan administrator domain, jika wali tidak diaktifkan untuk domain yang dimaksud, jika filter invitedEmailAddress disetel oleh pengguna yang bukan administrator domain, atau untuk error akses lainnya.
  • INVALID_ARGUMENT jika studentId ditentukan, tetapi formatnya tidak dapat dikenali (ini bukan alamat email, atau studentId dari API, atau string literal me). Juga dapat ditampilkan jika pageToken yang tidak valid diberikan.
  • NOT_FOUND jika studentId ditentukan, dan formatnya dapat dikenali, tetapi Classroom tidak memiliki data siswa tersebut.

Permintaan HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
studentId

string

Filter hasil berdasarkan siswa yang ditautkan oleh wali. ID dapat berupa salah satu dari berikut:

  • ID numerik untuk pengguna
  • alamat email pengguna
  • literal string "me", yang menunjukkan pengguna yang meminta
  • literal string "-", yang menunjukkan bahwa hasil harus ditampilkan untuk semua siswa yang aksesnya dimiliki oleh pengguna yang meminta.

Parameter kueri

Parameter
invitedEmailAddress

string

Filter hasil menurut alamat email yang dikirimi undangan asli, sehingga menghasilkan link wali ini. Filter ini hanya dapat digunakan oleh administrator domain.
pageToken

string

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

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

integer

Jumlah item maksimum untuk ditampilkan. Nol atau tidak ditentukan menunjukkan bahwa server dapat menetapkan nilai maksimum.

Server mungkin menampilkan lebih sedikit dari jumlah hasil yang ditetapkan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons saat mencantumkan wali.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Kolom
guardians[]

object (Guardian)

Wali di halaman ini hasil yang memenuhi kriteria yang ditentukan dalam 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.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Untuk informasi selengkapnya, lihat Panduan otorisasi.