افزونه های Google Classroom اکنون به طور کلی در دسترس توسعه دهندگان هستند! لطفاً برای اطلاعات بیشتر به
اسناد افزونه ها مراجعه کنید.
Method: userProfiles.guardianInvitations.create
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
یک دعوت نامه برای سرپرست ایجاد می کند، و یک ایمیل برای سرپرست ارسال می کند و از آنها می خواهد تأیید کند که سرپرست دانش آموز هستند.
هنگامی که سرپرست دعوت نامه را پذیرفت، state آنها به COMPLETED تغییر می کند و آنها شروع به دریافت اعلان های قیم خواهند کرد. یک منبع Guardian نیز برای نمایندگی قیم فعال ایجاد خواهد شد.
شی درخواست باید دارای فیلدهای studentId و invitedEmailAddress باشد. تنظیم نکردن این فیلدها یا تنظیم هر فیلد دیگری در درخواست منجر به خطا می شود.
این روش کدهای خطای زیر را برمی گرداند:
-
PERMISSION_DENIED اگر کاربر فعلی مجوز مدیریت سرپرستان را نداشته باشد، اگر سرپرست مورد نظر قبلاً درخواست‌های زیادی را برای آن دانش‌آموز رد کرده باشد، اگر سرپرستان برای دامنه مورد نظر فعال نشده باشند، یا برای سایر خطاهای دسترسی . -
RESOURCE_EXHAUSTED اگر دانش آموز یا سرپرست از حد مجاز پیوند قیم فراتر رفته باشد. - اگر آدرس ایمیل سرپرست معتبر نباشد (به عنوان مثال، اگر خیلی طولانی
INVALID_ARGUMENT )، یا اگر قالب شناسه دانشجویی ارائه شده قابل شناسایی نباشد (این آدرس ایمیل یا userId از این API نیست). اگر فیلدهای فقط خواندنی تنظیم شده باشند، یا اگر فیلد state روی مقداری غیر از PENDING تنظیم شده باشد، این خطا نیز برگردانده خواهد شد. -
NOT_FOUND اگر شناسه دانشجویی ارائه شده یک شناسه دانشجویی معتبر باشد، اما Classroom هیچ سابقه ای از آن دانش آموز ندارد. - اگر قبلاً دعوت‌نامه سرپرست معلقی برای دانش‌آموز وجود داشته باشد و
invitedEmailAddress ارائه شده باشد، یا اگر invitedEmailAddress با حساب Google یک Guardian موجود برای این کاربر مطابقت داشته باشد، ALREADY_EXISTS .
درخواست HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
guardianInvitation.studentId | string شناسه دانشجو (در قالب استاندارد) |
درخواست بدن
بدنه درخواست شامل یک نمونه از GuardianInvitation است.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه جدید از GuardianInvitation است.
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/classroom.guardianlinks.students
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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)."]]
