Zwraca listę zaproszeń do grupy opiekunów, które użytkownik może wyświetlić, odfiltrowane według podanych parametrów.
Ta metoda zwraca te kody błędów:
PERMISSION_DENIED, jeśli podano studentId, a użytkownik nie ma uprawnień do wyświetlania zaproszeń dla opiekunów danego ucznia, jeśli "-" jest podana jako studentId, a użytkownik nie jest administratorem domeny, jeśli opiekunowie nie są włączeni w danej domenie lub z innych powodów związanych z błędami dostępu.
INVALID_ARGUMENT, jeśli podano wartość studentId, ale jej format nie może zostać rozpoznany (nie jest to adres e-mail, ani studentId z interfejsu API, ani ciąg znaków me). Może być zwracany również w przypadku podania nieprawidłowej wartości pageToken lub state.
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}/guardianInvitations
Identyfikator ucznia, którego zaproszenia do opiekuna mają zostać zwrócone. 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ąg znaków "-", która wskazuje, że wyniki powinny być zwracane dla wszystkich uczniów, których użytkownik może wyświetlać zaproszenia od opiekuna.
Parametry zapytania
Parametry
invitedEmailAddress
string
Jeśli jest określony, zwracane są tylko wyniki z określonym invitedEmailAddress.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2025-07-25 UTC."],[],[],null,["# Method: userProfiles.guardianInvitations.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.ListGuardianInvitationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.\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 invitations 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, 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` or `state` 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}/guardianInvitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` The ID of the student whose guardian invitations are to be returned. 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 is permitted to view guardian invitations. |\n\n### Query parameters\n\n| Parameters ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitedEmailAddress` | `string` If specified, only results with the specified `invitedEmailAddress` are returned. |\n| `states[]` | `enum (`[GuardianInvitationState](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState)`)` If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list#body.ListGuardianInvitationsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list#google.classroom.v1.GuardianInvitations.ListGuardianInvitations) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list#google.classroom.v1.GuardianInvitations.ListGuardianInvitations) 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 guardian invitations.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"guardianInvitations\": [ { object (/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `guardianInvitations[]` | `object (`[GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation)`)` Guardian invitations that matched the list 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.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)."]]
