Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat
dokumentasi add-on untuk informasi selengkapnya.
Method: userProfiles.guardianInvitations.patch
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mengubah undangan wali.
Saat ini, satu-satunya modifikasi yang valid adalah mengubah state dari PENDING menjadi COMPLETE. Tindakan ini akan membatalkan undangan.
Metode ini menampilkan kode error berikut:
PERMISSION_DENIED jika pengguna saat ini tidak memiliki izin untuk mengelola wali, jika wali tidak diaktifkan untuk domain yang dimaksud, atau untuk error akses lainnya.FAILED_PRECONDITION jika link wali tidak dalam status PENDING.INVALID_ARGUMENT jika format tanda pengenal siswa yang diberikan tidak dapat dikenali (bukan alamat email, atau userId dari API ini), atau jika GuardianInvitation yang diteruskan memiliki state selain COMPLETE, atau jika mengubah kolom selain state.NOT_FOUND jika kartu pelajar yang diberikan adalah kartu pelajar yang valid, tetapi Classroom tidak memiliki data siswa tersebut, atau jika kolom id tidak merujuk ke undangan wali yang diketahui oleh Classroom.
Permintaan HTTP
PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
studentId |
string
ID siswa yang undangan walinya akan diubah.
|
invitationId |
string
Kolom id dari GuardianInvitation yang akan diubah.
|
Parameter kueri
| Parameter |
updateMask |
string (FieldMask format)
Mask yang mengidentifikasi kolom di kursus yang akan diperbarui. Kolom ini wajib diisi untuk melakukan pembaruan. Pembaruan akan gagal jika kolom yang ditentukan tidak valid. Kolom berikut valid:
Jika ditetapkan dalam parameter kueri, kolom ini harus ditentukan sebagai updateMask=<field1>,<field2>,...
Ini adalah daftar dipisahkan koma yang berisi nama-nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".
|
Isi permintaan
Isi permintaan memuat instance GuardianInvitation.
Isi respons
Jika berhasil, isi respons memuat instance GuardianInvitation.
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.patch\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nModifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n- `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}`\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 invitation is to be modified. |\n| `invitationId` | `string` The `id` field of the `GuardianInvitation` to be modified. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: - `state` When set in a query parameter, this field should be specified as `updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\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 an 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)."]]
