افزونه های Google Classroom اکنون به طور کلی در دسترس توسعه دهندگان هستند! لطفاً برای اطلاعات بیشتر به
اسناد افزونه ها مراجعه کنید.
REST Resource: userProfiles.guardianInvitations
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
منبع: GuardianInvitation
دعوتنامه ای برای تبدیل شدن به سرپرست یک کاربر مشخص، که به یک آدرس ایمیل مشخص ارسال شده است.
| نمایندگی JSON |
|---|
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum (GuardianInvitationState),
"creationTime": string
} |
| فیلدها |
|---|
studentId | string شناسه دانشجو (در قالب استاندارد) |
invitationId | string شناسه منحصر به فرد برای این دعوت. فقط خواندنی |
invitedEmailAddress | string آدرس ایمیلی که دعوتنامه به آن ارسال شده است. این فیلد فقط برای مدیران دامنه قابل مشاهده است. |
state | enum ( GuardianInvitationState ) وضعیتی که این دعوتنامه در آن است. |
creationTime | string ( Timestamp format) زمانی که این دعوت نامه ایجاد شد. فقط خواندنی از RFC 3339 استفاده می کند، که در آن خروجی تولید شده همیشه با Z نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "Z" نیز پذیرفته می شود. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" . |
GuardianInvitationState
| Enums |
|---|
GUARDIAN_INVITATION_STATE_UNSPECIFIED | هرگز نباید برگردانده شود. |
PENDING | دعوتنامه فعال است و در انتظار پاسخ است. |
COMPLETE | دعوت دیگر فعال نیست. ممکن است پذیرفته شده، رد شده باشد، پس گرفته شده باشد یا ممکن است منقضی شده باشد. |
روش ها |
|---|
| یک دعوت نامه برای سرپرست ایجاد می کند، و یک ایمیل برای سرپرست ارسال می کند و از آنها می خواهد تأیید کند که سرپرست دانش آموز هستند. |
| دعوت نامه خاصی از قیم را برمی گرداند. |
| فهرستی از دعوت‌نامه‌های نگهبان را که کاربر درخواست‌کننده مجاز به مشاهده آنها است، با پارامترهای ارائه‌شده فیلتر می‌کند. |
| دعوت نامه سرپرست را اصلاح می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-26 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-26 بهوقت ساعت هماهنگ جهانی."],[],[],null,["- [Resource: GuardianInvitation](#GuardianInvitation)\n - [JSON representation](#GuardianInvitation.SCHEMA_REPRESENTATION)\n- [GuardianInvitationState](#GuardianInvitationState)\n- [Methods](#METHODS_SUMMARY)\n\nResource: GuardianInvitation An invitation to become the guardian of a specified user, sent to a specified email address.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"studentId\": string, \"invitationId\": string, \"invitedEmailAddress\": string, \"state\": enum (/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState), \"creationTime\": string } ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` ID of the student (in standard format) |\n| `invitationId` | `string` Unique identifier for this invitation. Read-only. |\n| `invitedEmailAddress` | `string` Email address that the invitation was sent to. This field is only visible to domain administrators. |\n| `state` | `enum (`[GuardianInvitationState](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState)`)` The state that this invitation is in. |\n| `creationTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` The time that this invitation was created. Read-only. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\nGuardianInvitationState State of a guardian invitation.\n\n| Enums ||\n|-----------------------------------------|------------------------------------------------------------------------------------------------------------|\n| `GUARDIAN_INVITATION_STATE_UNSPECIFIED` | Should never be returned. |\n| `PENDING` | The invitation is active and awaiting a response. |\n| `COMPLETE` | The invitation is no longer active. It may have been accepted, declined, withdrawn or it may have expired. |\n\n| Methods ||\n|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| [create](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/create) | Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. |\n| [get](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/get) | Returns a specific guardian invitation. |\n| [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list) | Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. |\n| [patch](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/patch) | Modifies a guardian invitation. |"]]
