Method: userProfiles.guardians.list

Zwraca listę opiekunów, które użytkownik wysyłający prośbę może wyświetlać, ograniczoną do tych, którzy pasują do żądania.

Aby wyświetlić listę opiekunów dowolnego ucznia, którego użytkownik może wyświetlić, użyj dosłownego znaku - nazwy legitymacji studenckiej.

Ta metoda zwraca te kody błędów:

  • PERMISSION_DENIED, jeśli określono element studentId, a użytkownik wysyłający prośbę nie może wyświetlić informacji o opiekunach tego ucznia, jeśli "-" został określony jako studentId, a użytkownik nie jest administratorem domeny, jeśli opiekunowie nie są w danej domenie włączone, filtr invitedEmailAddress został ustawiony przez użytkownika, który nie jest administratorem domeny, lub w przypadku innych błędów dostępu.
  • INVALID_ARGUMENT, jeśli określono studentId, ale nie można rozpoznać formatu (to nie jest adres e-mail, studentId z interfejsu API ani literał me). Może być również zwracana, jeśli podano nieprawidłową wartość pageToken.
  • NOT_FOUND, jeśli podano studentId i jego format zostanie rozpoznany, ale w Classroom nie ma danych o uczniu.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
studentId

string

Filtruj wyniki według ucznia, z którym jest połączony opiekun. Może to być jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika,
  • literał ciągu "me", który wskazuje użytkownika wysyłającego żądanie
  • literał ciągu "-", który wskazuje, że wyniki powinny być zwracane wszystkim uczniom, do których dostęp ma użytkownik wysyłający żądanie.

Parametry zapytania

Parametry
invitedEmailAddress

string

Filtruj wyniki według adresu e-mail, na który zostało wysłane oryginalne zaproszenie, aby otrzymać ten link opiekuna. Tego filtra mogą używać tylko administratorzy domeny.
pageToken

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, co oznacza, że powinna zostać zwrócona kolejna strona wyników.

Żądanie list musi być identyczne z żądaniem, które spowodowało wygenerowanie tego tokena.
pageSize

integer

Maksymalna liczba produktów do zwrotu. Wartość 0 lub nieokreślona oznacza, że serwer może przypisać wartość maksymalną.

Serwer może zwrócić mniej wyników niż określona liczba.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania listy opiekunów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Pola
guardians[]

object (Guardian)

Opiekunowie na tej stronie wyników, które spełniają kryteria określone w prośbie.
nextPageToken

string

Token określający następną stronę wyników do zwrócenia. Jeśli pole jest puste, nie są dostępne żadne dalsze wyniki.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.