تتوفّر الآن إضافات Google Classroom بشكل عام للمطوّرين. يُرجى الاطّلاع على
مستندات الإضافات للحصول على مزيد من المعلومات.
Method: userProfiles.guardianInvitations.create
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
إنشاء دعوة للأوصياء وإرسال رسالة إلكترونية إليهم لتأكيد أنّهم الأوصياء على الطالب
بعد قبول الوصي الدعوة، ستتغيّر حالته إلى state ويبدأ تلقّي إشعارات الوصي.COMPLETED سيتم أيضًا إنشاء مرجع Guardian لتمثيل الوصي النشط.
يجب ضبط الحقلين studentId وinvitedEmailAddress في عنصر الطلب. سيؤدي عدم ضبط هذه الحقول أو ضبط أي حقول أخرى في الطلب إلى حدوث خطأ.
تُرجع هذه الطريقة رموز الأخطاء التالية:
PERMISSION_DENIED إذا لم يكن لدى المستخدم الحالي إذن لإدارة الأوصياء، أو إذا رفض الوصي المعنيّ عددًا كبيرًا جدًا من الطلبات لهذا الطالب، أو إذا لم يتم تفعيل الأوصياء في النطاق المعنيّ، أو بسبب أخطاء وصول أخرى.RESOURCE_EXHAUSTED إذا تجاوز الطالب أو ولي الأمر الحد الأقصى لعدد روابط الحسابات التي يمكن لولي الأمر الوصول إليهاINVALID_ARGUMENT إذا لم يكن عنوان البريد الإلكتروني الخاص بأحد الوصيّين صالحًا (على سبيل المثال، إذا كان طويلاً جدًا)، أو إذا تعذّر التعرّف على تنسيق مستند تعريف الطالب المقدَّم (ليس عنوان بريد إلكتروني، ولا userId من واجهة برمجة التطبيقات هذه). سيتم أيضًا عرض هذا الخطأ في حال ضبط حقول للقراءة فقط أو في حال ضبط الحقل state على قيمة غير PENDING.NOT_FOUND إذا كان رقم تعريف الطالب الذي تم تقديمه صالحًا، ولكن لا يتضمّن Classroom سجلّاً لهذا الطالبALREADY_EXISTS إذا كانت هناك دعوة وصي في انتظار المراجعة للطالب وinvitedEmailAddress المقدَّمة، أو إذا كان invitedEmailAddress المقدَّم يتطابق مع حساب Google الخاص بأحد Guardian الحاليين لهذا المستخدم.
طلب HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
| المعلمات |
guardianInvitation.studentId |
string
رقم تعريف الطالب (بالتنسيق العادي)
|
نص الطلب
يحتوي نص الطلب على مثال GuardianInvitation.
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثيل تم إنشاؤه حديثًا من GuardianInvitation.
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/classroom.guardianlinks.students
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],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)."]]
