Method: userProfiles.guardians.list

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

Aby wyświetlić listę opiekunów dowolnego ucznia, którego opiekuna prawnego może wyświetlić użytkownik wysyłający prośbę, użyj znaku - jako legitymacji studenckiej.

Ta metoda zwraca następujące kody błędów:

  • PERMISSION_DENIED, jeśli określono studentId, a użytkownik wysyłający prośbę nie ma uprawnień do wyświetlania informacji o opiekunie tego ucznia, jeśli "-" jest określony jako studentId, a użytkownik nie jest administratorem domeny, jeśli opiekunowie nie są włączone w danej domenie, filtr invitedEmailAddress został ustawiony przez użytkownika, który nie jest administratorem domeny, lub z powodu wystąpienia innych błędów dostępu.
  • INVALID_ARGUMENT, jeśli element studentId został określony, ale nie udało się rozpoznać jego formatu (nie jest to adres e-mail, studentId z interfejsu API ani ciąg literału me). Może też zostać zwrócona w przypadku podania nieprawidłowej wartości pageToken.
  • NOT_FOUND, jeśli określono studentId i udało się rozpoznać jego format, ale Classroom nie ma informacji o tym 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 on być:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika
  • literał ciągu znaków "me", który wskazuje użytkownika wysyłającego żądanie
  • literał ciągu znaków "-", który wskazuje, że wyniki powinny być zwracane dla wszystkich uczniów, do których dostępu ma mieć użytkownik wysyłający żądanie.

Parametry zapytania

Parametry
invitedEmailAddress

string

Wyniki możesz filtrować według adresu e-mail, na który zostało wysłane pierwotne zaproszenie, co pozwoli uzyskać ten link dla opiekuna. Tego filtra mogą używać tylko administratorzy domeny.
pageToken

string

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

Żądanie list musi być pod innymi względami identyczne z żądaniem, które wygenerowało ten token.
pageSize

integer

Maksymalna liczba elementów do zwrócenia. Wartość 0 lub nieokreślona oznacza, że serwer może przypisać maksimum.

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź do 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 tej strony wyników, którzy spełniają kryteria określone w żądaniu.
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli pole jest puste, kolejne wyniki nie są dostępne.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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 po autoryzacji.