Method: userProfiles.guardians.list

Zwraca listę opiekunów, których dane może wyświetlać użytkownik przesyłający żądanie, ograniczoną do tych, którzy pasują do żądania.

Aby wyświetlić listę opiekunów każdego ucznia, którego dane są dostępne dla użytkownika przesyłającego żądanie, użyj znaku - jako identyfikatora ucznia.

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

  • PERMISSION_DENIED, jeśli określono studentId, a użytkownik nie ma uprawnień do wyświetlania informacji o opiekunie danego ucznia, jeśli "-" jest określone jako studentId, a użytkownik nie jest administratorem domeny, jeśli opiekunowie nie są włączeni w danej domenie, jeśli 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 podano parametr studentId, ale nie można rozpoznać jego formatu (nie jest to adres e-mail, parametr studentId z interfejsu API ani ciąg znaków me). Może być też zwracany, jeśli podano nieprawidłowy parametr pageToken.
  • NOT_FOUND jeśli podano studentId i można 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 powiązany opiekun. Identyfikator może być jednym z tych elementów:

  • identyfikator liczbowy użytkownika.
  • adres e-mail użytkownika.
  • ciąg znaków "me" wskazujący użytkownika, który wysłał żądanie;
  • litera ciągu znaków "-", która wskazuje, że wyniki powinny być zwracane dla wszystkich uczniów, do których użytkownik ma dostęp do wyświetlania;

Parametry zapytania

Parametry
invitedEmailAddress

string

Filtrowanie wyników według adresu e-mail, na który zostało wysłane pierwotne zaproszenie, co powoduje pojawienie się tego linku. Z tego filtra mogą korzystać tylko administratorzy domen.
pageToken

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, wskazująca, że należy zwrócić kolejną stronę wyników.

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

integer

Maksymalna liczba elementów do zwrócenia. Wartość 0 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 pytanie o 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órzy spełniają kryteria określone w prośbie.
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli jest puste, nie ma dostępnych dalszych wyników.

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 dotyczącym autoryzacji.