افزونه های Google Classroom اکنون به طور کلی در دسترس توسعه دهندگان هستند! لطفاً برای اطلاعات بیشتر به
اسناد افزونه ها مراجعه کنید.
Method: userProfiles.guardianInvitations.get
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
دعوت نامه قیم خاصی را برمی گرداند.
این روش کدهای خطای زیر را برمی گرداند:
-
PERMISSION_DENIED در صورتی که کاربر درخواست کننده مجاز به مشاهده دعوت نامه های سرپرست دانش آموز شناسایی شده توسط studentId نباشد، اگر سرپرستان برای دامنه مورد نظر فعال نشده باشند، یا برای سایر خطاهای دسترسی . - اگر
studentId مشخص شده باشد، INVALID_ARGUMENT ، اما قالب آن قابل شناسایی نیست (این یک آدرس ایمیل، نه یک studentId از API، و نه رشته تحت اللفظی me است). -
NOT_FOUND اگر Classroom نتواند سابقه ای از دانش آموز یا invitationId پیدا کند. در صورت وجود دانش آموز نیز ممکن است برگردانده شود، اما کاربر درخواست کننده دسترسی به دیدن آن دانش آموز را ندارد.
درخواست HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
studentId | string شناسه دانش آموزی که دعوت نامه سرپرست وی درخواست شده است. |
invitationId | string فیلد id GuardianInvitation در حال درخواست است. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه از GuardianInvitation است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly -
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.get\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\nReturns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `studentId`, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if a `studentId` is specified, but its format cannot be recognized (it is not an email address, nor a `studentId` from the API, nor the literal string `me`).\n- `NOT_FOUND` if Classroom cannot find any record of the given student or `invitationId`. May also be returned if the student exists, but the requesting user does not have access to see that student.\n\n### HTTP request\n\n`GET 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 being requested. |\n| `invitationId` | `string` The `id` field of the `GuardianInvitation` being requested. |\n\n### Request body\n\nThe request body must be empty.\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 one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly`\n- `\n https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
