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.create
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Veli davetiyesi oluşturur ve veliye, öğrencinin velisi olduğunu onaylamasını isteyen bir e-posta gönderir.
Veli daveti kabul ettikten sonra state
durumu COMPLETED
olarak değişir ve veli bildirimleri almaya başlar. Etkin koruyucuyu temsil etmek için bir Guardian
kaynağı da oluşturulur.
İstek nesnesinde studentId
ve invitedEmailAddress
alanları ayarlanmalıdır. Bu alanların ayarlanmaması veya istekteki başka alanların ayarlanması hatayla sonuçlanır.
Bu yöntem aşağıdaki hata kodlarını döndürür:
- Mevcut kullanıcının velileri yönetme izni yoksa, söz konusu veli bu öğrenci için çok fazla istek reddettiyse, veliler söz konusu alan için etkinleştirilmediyse veya başka erişim hataları varsa
PERMISSION_DENIED
.
RESOURCE_EXHAUSTED
Öğrenci veya veli, veli bağlantısı sınırını aştıysa.
- Veli e-posta adresi geçerli değilse (örneğin, çok uzunsa) veya sağlanan öğrenci kimliğinin biçimi tanınamıyorsa (e-posta adresi veya bu API'den alınan bir
userId
değilse) INVALID_ARGUMENT
. Bu hata, salt okunur alanlar ayarlanmışsa veya state
alanı PENDING
dışında bir değere ayarlanmışsa da döndürülür.
NOT_FOUND
, sağlanan öğrenci kimliği geçerli bir öğrenci kimliğiyse ancak Classroom'da bu öğrenciyle ilgili kayıt yoksa.
- Öğrenci için bekleyen bir veli davetiyesi varsa ve
invitedEmailAddress
sağlandıysa veya sağlanan invitedEmailAddress
, bu kullanıcının mevcut bir Guardian
hesabının Google Hesabı ile eşleşiyorsa ALREADY_EXISTS
.
HTTP isteği
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler |
guardianInvitation.studentId |
string
Öğrencinin kimliği (standart biçimde)
|
İstek içeriği
İstek metni, GuardianInvitation
öğesinin bir örneğini içerir.
Yanıt gövdesi
Başarılı olursa yanıt metni, yeni oluşturulmuş bir GuardianInvitation
örneği 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.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)."]]