Google Classroom eklentileri artık geliştiricilerin genel kullanımına sunuldu! Daha fazla bilgi edinmek için lütfen
eklenti belgelerini inceleyin.
Method: userProfiles.guardianInvitations.patch
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Veli davetiyesini değiştirir.
Şu anda tek geçerli değişiklik, state değerinin PENDING yerine COMPLETE olarak değiştirilmesidir. Bu işlem, davetin geri çekilmesine neden olur.
Bu yöntem aşağıdaki hata kodlarını döndürür:
- Mevcut kullanıcının velileri yönetme izni yoksa, veliler söz konusu alan için etkinleştirilmediyse veya başka erişim hataları varsa
PERMISSION_DENIED.
FAILED_PRECONDITION, veli bağlantısı PENDING durumunda değilse.- Sağlanan öğrenci kimliğinin biçimi tanınamıyorsa (e-posta adresi veya bu API'den bir
userId değilse) veya iletilen GuardianInvitation'de COMPLETE dışında bir state varsa ya da state dışındaki alanları değiştiriyorsa INVALID_ARGUMENT.
- Sağlanan öğrenci kimliği geçerli bir öğrenci kimliğiyse ancak Classroom'da bu öğrenciyle ilgili kayıt yoksa veya
id alanı, Classroom'da bilinen bir veli davetini belirtmiyorsa NOT_FOUND.
HTTP isteği
PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
| Parametreler |
studentId |
string
Veli davetiyesi değiştirilecek öğrencinin kimliği.
|
invitationId |
string
Değiştirilecek GuardianInvitation öğesinin id alanı.
|
Sorgu parametreleri
| Parametreler |
updateMask |
string (FieldMask format)
Kurstaki hangi alanların güncelleneceğini tanımlayan maske. Güncelleme yapmak için bu alanın doldurulması gerekir. Geçersiz alanlar belirtilirse güncelleme başarısız olur. Aşağıdaki alanlar geçerlidir:
Bu alan, sorgu parametresinde ayarlandığında şu şekilde belirtilmelidir: updateMask=<field1>,<field2>,...
Bu, alanların tam nitelikli adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".
|
İstek içeriği
İstek metni, GuardianInvitation öğesinin bir örneğini içerir.
Yanıt gövdesi
Başarılıysa yanıt metni, GuardianInvitation öğesinin bir örneğini içerir.
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamını gerektirir:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-25 UTC.
[null,null,["Son güncelleme tarihi: 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)."]]
