Dodatki do Google Classroom są teraz ogólnie dostępne dla programistów. Więcej informacji znajdziesz w
dokumentacji dodatków.
REST Resource: userProfiles.guardianInvitations
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zasób: GuardianInvitation
Zaproszenie do zostania opiekunem określonego użytkownika wysłane na określony adres e-mail.
| Zapis JSON |
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum (GuardianInvitationState),
"creationTime": string
} |
| Pola |
studentId |
string
Identyfikator ucznia (w formacie standardowym)
|
invitationId |
string
Unikalny identyfikator tego zaproszenia. Tylko do odczytu.
|
invitedEmailAddress |
string
Adres e-mail, na który zostało wysłane zaproszenie. To pole jest widoczne tylko dla administratorów domeny.
|
state |
enum (GuardianInvitationState)
Stan zaproszenia.
|
creationTime |
string (Timestamp format)
Czas utworzenia tego zaproszenia. Tylko do odczytu. Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i używają 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
|
GuardianInvitationState
Stan zaproszenia opiekuna.
| Wartości w polu enum |
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
Nigdy nie powinna być zwracana. |
PENDING |
Zaproszenie jest aktywne i oczekuje na odpowiedź. |
COMPLETE |
Zaproszenie nie jest już aktywne. Mogło zostać zaakceptowane, odrzucone, wycofane lub mogło wygasnąć. |
Metody |
|
|
Tworzy zaproszenie dla opiekuna i wysyła do niego e-maila z prośbą o potwierdzenie, że jest opiekunem ucznia. |
|
|
Zwraca konkretne zaproszenie opiekuna. |
|
|
Zwraca listę zaproszeń dla opiekunów, które użytkownik wysyłający żądanie może wyświetlić, odfiltrowaną według podanych parametrów. |
|
|
Modyfikuje zaproszenie opiekuna. |
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-08-26 UTC.
[null,null,["Ostatnia aktualizacja: 2025-08-26 UTC."],[],[],null,["- [Resource: GuardianInvitation](#GuardianInvitation)\n - [JSON representation](#GuardianInvitation.SCHEMA_REPRESENTATION)\n- [GuardianInvitationState](#GuardianInvitationState)\n- [Methods](#METHODS_SUMMARY)\n\nResource: GuardianInvitation An invitation to become the guardian of a specified user, sent to a specified email address.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"studentId\": string, \"invitationId\": string, \"invitedEmailAddress\": string, \"state\": enum (/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState), \"creationTime\": string } ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` ID of the student (in standard format) |\n| `invitationId` | `string` Unique identifier for this invitation. Read-only. |\n| `invitedEmailAddress` | `string` Email address that the invitation was sent to. This field is only visible to domain administrators. |\n| `state` | `enum (`[GuardianInvitationState](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState)`)` The state that this invitation is in. |\n| `creationTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` The time that this invitation was created. Read-only. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\nGuardianInvitationState State of a guardian invitation.\n\n| Enums ||\n|-----------------------------------------|------------------------------------------------------------------------------------------------------------|\n| `GUARDIAN_INVITATION_STATE_UNSPECIFIED` | Should never be returned. |\n| `PENDING` | The invitation is active and awaiting a response. |\n| `COMPLETE` | The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired. |\n\n| Methods ||\n|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| [create](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/create) | Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. |\n| [get](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/get) | Returns a specific guardian invitation. |\n| [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list) | Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. |\n| [patch](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/patch) | Modifies a guardian invitation. |"]]
