Method: userProfiles.guardians.list

İstekte bulunan kullanıcının görüntülemesine izin verilen, istekle eşleşenlerle sınırlı olmak üzere velilerin listesini döndürür.

İstekte bulunan kullanıcının velilerini görebileceği tüm öğrencilerin velilerini listelemek için öğrenci kimliğinde - değişmez karakterini kullanın.

Bu yöntem aşağıdaki hata kodlarını döndürür:

  • Bir studentId belirtilmişse ve istekte bulunan kullanıcının söz konusu öğrencinin veli bilgilerini görüntülemesine izin verilmiyorsa ("-", studentId olarak belirtilmişse ve kullanıcı alan yöneticisi değilse), söz konusu alan için veliler etkinleştirilmemişse, invitedEmailAddress filtresi alan yöneticisi olmayan bir kullanıcı tarafından ayarlanmışsa veya başka erişim hataları söz konusu olduğunda PERMISSION_DENIED.
  • Bir studentId belirtilmişse ancak biçimi tanınmıyorsa (bu bir e-posta adresi, API'den gelen bir studentId veya me değişmez dizesi değilse) INVALID_ARGUMENT. Geçersiz pageToken sağlandığında da döndürülebilir.
  • NOT_FOUND bir studentId belirtilmişse ve biçimi tanınabiliyorsa ancak Classroom'da bu öğrenciyle ilgili kayıt bulunmamaktadır.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
studentId

string

Sonuçları velinin bağlı olduğu öğrenciye göre filtreleyin. Tanımlayıcı aşağıdakilerden biri olabilir:

  • kullanıcının sayısal tanımlayıcısı
  • kullanıcının e-posta adresi
  • istekte bulunan kullanıcıyı gösteren "me" dize değeri
  • İstekte bulunan kullanıcının görüntüleme erişimine sahip olduğu tüm öğrenciler için sonuçların döndürülmesi gerektiğini belirten "-" dize dizesi.

Sorgu parametreleri

Parametreler
invitedEmailAddress

string

Sonuçları, veli bağlantısı için orijinal davetiyenin gönderildiği e-posta adresine göre filtreleyin. Bu filtre yalnızca alan adı yöneticileri tarafından kullanılabilir.
pageToken

string

nextPageToken değeri, sonraki sonuç sayfasının döndürülmesi gerektiğini belirten önceki bir list çağrısından döndürüldü.

list isteği, aksi takdirde bu jetonla sonuçlanan istekle aynı olmalıdır.
pageSize

integer

Döndürülecek maksimum öğe sayısı. Sıfır veya belirtilmedi, sunucunun bir maksimum değer atayabileceğini gösterir.

Sunucu, belirtilen sayıdan daha az sonuç döndürebilir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Veliler listelenirken verilecek yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Alanlar
guardians[]

object (Guardian)

Bu sonuç sayfasındaki, istekte belirtilen ölçütleri karşılayan veliler.
nextPageToken

string

Döndürülecek bir sonraki sonuç sayfasını tanımlayan jeton. Boş bırakılırsa başka sonuç yok.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • 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

Daha fazla bilgi için Yetkilendirme kılavuzuna göz atın.