Dodatki do Google Classroom są teraz ogólnie dostępne dla programistów. Więcej informacji znajdziesz w
dokumentacji dodatków.
Method: userProfiles.guardians.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
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.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 2025-07-25 UTC."],[],[],null,["# Method: userProfiles.guardians.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListGuardiansResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of guardians that the requesting user is permitted to view, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if a `studentId` is specified, and the requesting user is not permitted to view guardian information for that student, if `\"-\"` is specified as the `studentId` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invitedEmailAddress` filter is set by a user who is not a domain administrator, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if a `studentId` is specified, but its format cannot be recognized (it is not an email address, nor a `studentId` from the API, nor the literal string `me`). May also be returned if an invalid `pageToken` is provided.\n- `NOT_FOUND` if a `studentId` is specified, and its format can be recognized, but Classroom has no record of that student.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` Filter results by the student who the guardian is linked to. The identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user - the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user has access to view. |\n\n### Query parameters\n\n| Parameters ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitedEmailAddress` | `string` Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list#body.ListGuardiansResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list#google.classroom.v1.Guardians.ListGuardians) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list#google.classroom.v1.Guardians.ListGuardians) request must be otherwise identical to the one that resulted in this token. |\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing guardians.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"guardians\": [ { object (/workspace/classroom/reference/rest/v1/userProfiles.guardians#Guardian) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `guardians[]` | `object (`[Guardian](/workspace/classroom/reference/rest/v1/userProfiles.guardians#Guardian)`)` Guardians on this page of results that met the criteria specified in the request. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly`\n- `\n https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly`\n- `\n https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
