Method: userProfiles.guardians.list

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

İstekte bulunan kullanıcının velilerini görüntüleyebileceği tüm öğrencilerin velilerini listelemek için öğrenci kimliği olarak - karakterini kullanın.

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

  • studentId belirtilmişse ve istek gönderen kullanıcının ilgili öğ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 diğer erişim hataları için.PERMISSION_DENIED
  • studentId belirtilmişse ancak biçimi tanınamıyorsa (e-posta adresi, API'den bir studentId veya me değişmez dizesi değildir) INVALID_ARGUMENT. Geçersiz bir pageToken sağlanırsa da döndürülebilir.
  • NOT_FOUND, bir studentId belirtilmişse ve biçimi tanınabiliyorsa ancak Classroom'da bu öğrenciyle ilgili kayıt yoksa.

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ı, velisinin 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ıdır.
  • kullanıcının e-posta adresi
  • İstekte bulunan kullanıcıyı belirten "me" değişmez dizesi
  • "-" dize değişmezi. Bu, istek gönderen kullanıcının görüntüleme erişimi olan tüm öğrenciler için sonuçların döndürülmesi gerektiğini belirtir.

Sorgu parametreleri

Parametreler
invitedEmailAddress

string

Sonuçları, orijinal davetin gönderildiği e-posta adresine göre filtreleyerek bu ebeveyn bağlantısını elde edebilirsiniz. Bu filtre yalnızca alan yöneticileri tarafından kullanılabilir.
pageToken

string

Önceki bir list çağrısından döndürülen nextPageToken değeri. Sonuçların sonraki sayfasının döndürülmesi gerektiğini belirtir.

list isteği, bu jetonla sonuçlanan istekte belirtilenlerle aynı olmalıdır.
pageSize

integer

Döndürülecek maksimum öğe sayısı. Sıfır veya belirtilmemiş, sunucunun maksimum bir 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 verilen 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)

Sonuçlar sayfasında, istekte belirtilen ölçütleri karşılayan veliler.
nextPageToken

string

Döndürülecek bir sonraki sonuç sayfasını tanımlayan jeton. Boşsa başka sonuç yoktur.

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 bakın.