Method: userProfiles.guardians.list

Zwraca listę opiekunów, którą może wyświetlać użytkownik wysyłający prośbę. Ograniczona liczba opiekunów prawnych pasujących do żądania.

Aby wyświetlić listę opiekunów dowolnego ucznia, który może wyświetlać ich opiekunów, użyj znaku dosłownego - 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 może wyświetlić 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łączony w danej domenie, filtr invitedEmailAddress został ustawiony przez użytkownika, który nie jest administratorem domeny, lub z powodu innych błędów dostępu.
  • INVALID_ARGUMENT, jeśli określono studentId, ale nie można rozpoznać jego formatu (nie jest to adres e-mail, nie jest to adres e-mail, studentId z interfejsu API ani ciąg literału me). Ten parametr może też być zwracany, jeśli podana jest nieprawidłowa wartość pageToken.
  • NOT_FOUND, jeśli określono studentId i można rozpoznać jego format, ale Classroom nie zawiera 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 mieć jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika.
  • literał ciągu znaków "me" wskazujący 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 wyświetlania ma dostęp użytkownik wysyłający prośbę.

Parametry zapytania

Parametry
invitedEmailAddress

string

Wyniki możesz filtrować według adresu e-mail, na który zostało wysłane pierwotne zaproszenie, aby utworzyć 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 z wynikami.

Żądanie list musi być w inny sposób identyczne z żądaniem, które spowodowało ten token.
pageSize

integer

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

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na listę 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 z wynikami, które spełniają kryteria określone w żądaniu.
nextPageToken

string

Token określają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.