- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Wypróbuj
Zwraca listę zaproszeń opiekunów, które może wyświetlić użytkownik wysyłający prośbę, przefiltrowaną według podanych parametrów.
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ć zaproszeń dla opiekunów, jeśli"-"
jest określony jakostudentId
, a użytkownik nie jest administratorem domeny, jeśli w danej domenie opiekun nie jest włączony, 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 anistudentId
z interfejsu API ani ciąg literałume
). Ten parametr może też być zwracany, jeśli podana jest nieprawidłowa wartośćpageToken
lubstate
.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}/guardianInvitations
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
studentId |
Identyfikator ucznia, którego zaproszenia mają zostać zwrócone. Może on mieć jeden z tych identyfikatorów:
|
Parametry zapytania
Parametry | |
---|---|
invitedEmailAddress |
Jeśli jest określony, zwracane są tylko wyniki z podanym elementem |
states[] |
Jeśli jest określony, zwracane są tylko wyniki z określonymi wartościami |
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ę zaproszeń dla opiekunów.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"guardianInvitations": [
{
object ( |
Pola | |
---|---|
guardianInvitations[] |
Zaproszenia opiekunów, które pasują do żądania listy. |
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.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
Więcej informacji znajdziesz w przewodniku po autoryzacji.