Method: userProfiles.guardians.get

Menampilkan wali tertentu.

Metode ini menampilkan kode error berikut:

  • PERMISSION_DENIED jika tidak ada pengguna yang cocok dengan studentId yang diberikan yang terlihat oleh pengguna yang meminta, jika pengguna yang meminta tidak diizinkan untuk melihat informasi wali bagi siswa yang diidentifikasi oleh studentId, jika wali tidak diaktifkan untuk domain yang dimaksud, atau untuk error akses lainnya.
  • INVALID_ARGUMENT jika studentId ditentukan, tetapi formatnya tidak dapat dikenali (bukan alamat email, studentId dari API, atau string literal me).
  • NOT_FOUND jika pengguna yang meminta diizinkan untuk melihat wali untuk studentId yang diminta, tetapi tidak ada data Guardian untuk siswa tersebut yang cocok dengan guardianId yang diberikan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
studentId

string

Siswa yang walinya diminta. Salah satu dari berikut ini:

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

string

Kolom id dari Guardian.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance Guardian.

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.