افزونه های Google Classroom اکنون به طور کلی در دسترس توسعه دهندگان هستند! لطفاً برای اطلاعات بیشتر به
اسناد افزونه ها مراجعه کنید.
Method: userProfiles.guardianInvitations.list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
فهرستی از دعوت‌نامه‌های نگهبان را که کاربر درخواست‌کننده مجاز به مشاهده آن‌ها است، با پارامترهای ارائه‌شده فیلتر می‌کند.
این روش کدهای خطای زیر را برمی گرداند:
-
PERMISSION_DENIED در صورتی که studentId مشخص شده باشد، و کاربر درخواست کننده مجاز به مشاهده دعوت نامه های سرپرست آن دانش آموز نباشد، اگر "-" به عنوان studentId مشخص شده باشد و کاربر مدیر دامنه نباشد، اگر محافظان برای دامنه مورد نظر فعال نشده باشند، یا برای سایر خطاهای دسترسی . - اگر
studentId مشخص شده باشد، INVALID_ARGUMENT ، اما قالب آن قابل شناسایی نیست (این یک آدرس ایمیل، نه یک studentId از API، و نه رشته تحت اللفظی me است). همچنین در صورت ارائه pageToken یا state نامعتبر ممکن است برگردانده شود. -
NOT_FOUND اگر studentId مشخص شده باشد و قالب آن قابل شناسایی باشد، اما Classroom هیچ سابقه ای از آن دانش آموز ندارد.
درخواست HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
studentId | string شناسنامه دانش آموزی که قرار است دعوتنامه سرپرست او برگردانده شود. شناسه می تواند یکی از موارد زیر باشد: - شناسه عددی برای کاربر
- آدرس ایمیل کاربر
- رشته تحت اللفظی
"me" که کاربر درخواست کننده را نشان می دهد - رشته تحت اللفظی
"-" ، نشان می دهد که نتایج باید برای همه دانش آموزان بازگردانده شود که کاربر درخواست کننده مجاز به مشاهده دعوت نامه های نگهبان است.
|
پارامترهای پرس و جو
| پارامترها |
|---|
invitedEmailAddress | string در صورت مشخص شدن، فقط نتایج با invitedEmailAddress مشخص شده برگردانده می‌شوند. |
states[] | enum ( GuardianInvitationState ) در صورت مشخص شدن، فقط نتایج با مقادیر state مشخص شده برگردانده می شوند. در غیر این صورت، نتایج با state PENDING برگردانده می شوند. |
pageToken | string مقدار nextPageToken برگردانده شده از فراخوانی list قبلی، نشان می دهد که صفحه بعدی نتایج باید برگردانده شود. در غیر این صورت، درخواست list باید با درخواستی که منجر به این نشانه شده است، یکسان باشد. |
pageSize | integer حداکثر تعداد اقلام برای بازگشت. صفر یا نامشخص نشان می دهد که سرور ممکن است حداکثر را اختصاص دهد. سرور ممکن است کمتر از تعداد مشخص شده نتایج را برگرداند. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
هنگام فهرست کردن دعوت نامه های قیم پاسخ دهید.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"guardianInvitations": [
{
object (GuardianInvitation)
}
],
"nextPageToken": string
} |
| فیلدها |
|---|
guardianInvitations[] | object ( GuardianInvitation ) دعوت‌نامه‌های نگهبان که با درخواست فهرست مطابقت داشتند. |
nextPageToken | string نشانه شناسایی صفحه بعدی نتایج برای بازگشت. اگر خالی باشد، هیچ نتیجه دیگری در دسترس نیست. |
محدوده مجوز
به یکی از حوزه های 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.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListGuardianInvitationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if a `studentId` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `\"-\"` is specified as the `studentId` and the user is not a domain administrator, 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`). May also be returned if an invalid `pageToken` or `state` is provided.\n- `NOT_FOUND` if a `studentId` is specified, and its format can be recognized, but Classroom has no record of that student.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations`\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 invitations are to be returned. The identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user - the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. |\n\n### Query parameters\n\n| Parameters ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitedEmailAddress` | `string` If specified, only results with the specified `invitedEmailAddress` are returned. |\n| `states[]` | `enum (`[GuardianInvitationState](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitationState)`)` If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list#body.ListGuardianInvitationsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list#google.classroom.v1.GuardianInvitations.ListGuardianInvitations) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations/list#google.classroom.v1.GuardianInvitations.ListGuardianInvitations) request must be otherwise identical to the one that resulted in this token. |\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing guardian invitations.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"guardianInvitations\": [ { object (/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `guardianInvitations[]` | `object (`[GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation)`)` Guardian invitations that matched the list request. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\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)."]]
