- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Wypróbuj
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ślonostudentId
, a użytkownik wysyłający prośbę nie może wyświetlić informacji o opiekunie tego ucznia, jeśli"-"
jest określony jakostudentId
, a użytkownik nie jest administratorem domeny, jeśli opiekunowie nie są włączony w danej domenie, filtrinvitedEmailAddress
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ślonostudentId
, 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łume
). Ten parametr może też być zwracany, jeśli podana jest nieprawidłowa wartośćpageToken
.NOT_FOUND
, jeśli określonostudentId
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 |
Filtruj wyniki według ucznia, z którym jest połączony opiekun. Może on mieć jeden z tych identyfikatorów:
|
Parametry zapytania
Parametry | |
---|---|
invitedEmailAddress |
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 |
Wartość Żądanie |
pageSize |
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 ( |
Pola | |
---|---|
guardians[] |
Opiekunowie tej strony z wynikami, które spełniają kryteria określone w żądaniu. |
nextPageToken |
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.