افزونه های Google Classroom اکنون به طور کلی در دسترس توسعه دهندگان هستند! لطفاً برای اطلاعات بیشتر به
اسناد افزونه ها مراجعه کنید.
Method: userProfiles.guardians.get
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
یک قیم خاص را برمی گرداند.
این روش کدهای خطای زیر را برمی گرداند:
-
PERMISSION_DENIED
اگر هیچ کاربری مطابق با studentId
ارائه شده برای کاربر درخواستکننده قابل مشاهده نباشد، اگر کاربر درخواستکننده مجاز به مشاهده اطلاعات سرپرست دانشآموز شناساییشده توسط studentId
نباشد، اگر محافظان برای دامنه مورد نظر فعال نشده باشند، یا برای سایر خطاهای دسترسی ، PERMISSION_DENIED میشود. - اگر
studentId
مشخص شده باشد، INVALID_ARGUMENT
، اما قالب آن قابل شناسایی نیست (این یک آدرس ایمیل، نه یک studentId
از API، و نه رشته تحت اللفظی me
است). -
NOT_FOUND
اگر کاربر درخواست کننده مجاز به مشاهده سرپرستان studentId
درخواستی باشد، اما هیچ سابقه Guardian
برای آن دانش آموز وجود نداشته باشد که با شناسه guardianId
ارائه شده مطابقت داشته باشد.
درخواست HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
studentId | string دانش آموزی که سرپرست او درخواست می شود. یکی از موارد زیر: - شناسه عددی برای کاربر
- آدرس ایمیل کاربر
- رشته تحت اللفظی
"me" که کاربر درخواست کننده را نشان می دهد
|
guardianId | string فیلد id از یک Guardian . |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه از Guardian
است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
-
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.guardians.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.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if no user that matches the provided `studentId` is visible to the requesting user, if the requesting user is not permitted to view guardian information 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 the requesting user is permitted to view guardians for the requested `studentId`, but no `Guardian` record exists for that student that matches the provided `guardianId`.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` The student whose guardian is being requested. One of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `guardianId` | `string` The `id` field from a `Guardian`. |\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 [Guardian](/workspace/classroom/reference/rest/v1/userProfiles.guardians#Guardian).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly`\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)."]]