Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat
dokumentasi add-on untuk informasi selengkapnya.
REST Resource: userProfiles.guardianInvitations
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Resource: GuardianInvitation
Undangan untuk menjadi wali pengguna tertentu, yang dikirim ke alamat email tertentu.
| Representasi JSON |
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum (GuardianInvitationState),
"creationTime": string
} |
| Kolom |
studentId |
string
ID siswa (dalam format standar)
|
invitationId |
string
ID unik untuk undangan ini. Hanya baca.
|
invitedEmailAddress |
string
Alamat email yang dituju untuk mengirimkan undangan. Kolom ini hanya dapat dilihat oleh administrator domain.
|
state |
enum (GuardianInvitationState)
Status undangan ini.
|
creationTime |
string (Timestamp format)
Waktu saat undangan ini dibuat. Hanya baca. Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
|
GuardianInvitationState
| Enum |
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
Tidak boleh dikembalikan. |
PENDING |
Undangan aktif dan menunggu respons. |
COMPLETE |
Undangan tidak aktif lagi. Undangan mungkin telah diterima, ditolak, dibatalkan, atau habis masa berlakunya. |
Metode |
|
|
Membuat undangan wali, dan mengirim email kepada wali yang meminta mereka mengonfirmasi bahwa mereka adalah wali siswa. |
|
|
Menampilkan undangan wali tertentu. |
|
|
Menampilkan daftar undangan wali yang diizinkan untuk dilihat oleh pengguna yang meminta, yang difilter menurut parameter yang diberikan. |
|
|
Mengubah undangan wali. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-08-26 UTC.
[null,null,["Terakhir diperbarui pada 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. |"]]
