Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat
dokumentasi add-on untuk informasi selengkapnya.
Method: userProfiles.guardianInvitations.create
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Membuat undangan wali, dan mengirim email kepada wali untuk meminta mereka mengonfirmasi bahwa mereka adalah wali siswa.
Setelah wali menerima undangan, state-nya akan berubah menjadi COMPLETED dan ia akan mulai menerima notifikasi wali. Resource Guardian juga akan dibuat untuk merepresentasikan wali aktif.
Objek permintaan harus memiliki kolom studentId dan invitedEmailAddress yang ditetapkan. Kegagalan dalam menetapkan kolom ini, atau menetapkan kolom lain dalam permintaan, akan mengakibatkan error.
Metode ini menampilkan kode error berikut:
PERMISSION_DENIED jika pengguna saat ini tidak memiliki izin untuk mengelola wali, jika wali yang dimaksud telah menolak terlalu banyak permintaan untuk siswa tersebut, jika wali tidak diaktifkan untuk domain yang dimaksud, atau untuk error akses lainnya.RESOURCE_EXHAUSTED jika siswa atau wali telah melampaui batas penautan wali.INVALID_ARGUMENT jika alamat email wali tidak valid (misalnya, jika terlalu panjang), atau jika format tanda pengenal siswa yang diberikan tidak dapat dikenali (bukan alamat email, atau userId dari API ini). Error ini juga akan ditampilkan jika kolom hanya baca ditetapkan, atau jika kolom state ditetapkan ke nilai selain PENDING.NOT_FOUND jika ID siswa yang diberikan adalah ID siswa yang valid, tetapi Classroom tidak memiliki data siswa tersebut.ALREADY_EXISTS jika sudah ada undangan wali yang tertunda untuk siswa dan invitedEmailAddress yang diberikan, atau jika invitedEmailAddress yang diberikan cocok dengan Akun Google dari Guardian yang ada untuk pengguna ini.
Permintaan HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
guardianInvitation.studentId |
string
ID siswa (dalam format standar)
|
Isi permintaan
Isi permintaan memuat instance GuardianInvitation.
Isi respons
Jika berhasil, isi respons memuat instance GuardianInvitation yang baru dibuat.
Cakupan otorisasi
Memerlukan cakupan OAuth berikut:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Untuk informasi selengkapnya, lihat Panduan otorisasi.
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-07-25 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-25 UTC."],[],[],null,["# Method: userProfiles.guardianInvitations.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `studentId` and `invitedEmailAddress` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit.\n- `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student.\n- `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invitedEmailAddress` provided, or if the provided `invitedEmailAddress` matches the Google account of an existing `Guardian` for this user.\n\n### HTTP request\n\n`POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------------------------|-------------------------------------------------|\n| `guardianInvitation.studentId` | `string` ID of the student (in standard format) |\n\n### Request body\n\nThe request body contains an instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
