Method: userProfiles.guardians.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הפונקציה מחזירה רשימה של הורים או אפוטרופוסים שהמשתמש המבקש מורשה לראות, ומוגבלת לאלה שתואמים לבקשה.
כדי לקבל רשימה של הורים או אפוטרופוסים של כל תלמיד שהמשתמש המבקש יכול לראות את ההורים או האפוטרופוסים שלו, צריך להשתמש בתו - למזהה התלמיד.
השיטה הזו מחזירה את קודי השגיאה הבאים:
PERMISSION_DENIED אם צוין studentId והמשתמש המבקש לא מורשה להציג את פרטי האפוטרופוס של התלמיד/ה, אם צוין "-" כ-studentId והמשתמש לא הוא אדמין דומיין, אם האפוטרופוסים לא מופעלים בדומיין הרלוונטי, אם מסנן invitedEmailAddress הוגדר על ידי משתמש שאינו אדמין דומיין, או בגלל שגיאות גישה אחרות.INVALID_ARGUMENT אם צוין studentId אבל לא ניתן לזהות את הפורמט שלו (הוא לא כתובת אימייל, לא studentId מה-API ולא המחרוזת המילולית me). יכול להיות שהערך הזה יוחזר גם אם צוין pageToken לא תקין.NOT_FOUND אם צוין studentId, ואפשר לזהות את הפורמט שלו, אבל אין ב-Classroom תיעוד של התלמיד או התלמידה.
בקשת HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
| פרמטרים |
studentId |
string
לסנן את התוצאות לפי התלמיד או התלמידה שהאפוטרופוס מקושר אליהם. המזהה יכול להיות אחד מהערכים הבאים:
- המזהה המספרי של המשתמש
- כתובת האימייל של המשתמש
- מחרוזת הליבה
"me", שמציינת את המשתמש המבקש
- מחרוזת הליבה
"-", שמציינת שצריך להחזיר תוצאות לכל התלמידים שלמשתמש המבקש יש גישה לצפייה בהם.
|
פרמטרים של שאילתה
| פרמטרים |
invitedEmailAddress |
string
מסננים את התוצאות לפי כתובת האימייל שאליה נשלחה ההזמנה המקורית, וכך מקבלים את הקישור הזה להורה או לאפוטרופוס. רק מנהלי דומיינים יכולים להשתמש במסנן הזה.
|
pageToken |
string
הערך nextPageToken שהוחזר מקריאה קודמת של list, ומציין שצריך להחזיר את דף התוצאות הבא. הבקשה list חייבת להיות זהה לזו שהובילה ליצירת האסימון הזה, בכל שאר הפרטים.
|
pageSize |
integer
מספר הפריטים המקסימלי להחזרה. אפס או ערך לא מצוין מצביעים על כך שהשרת עשוי להקצות ערך מקסימלי. יכול להיות שהשרת יחזיר פחות מהמספר שצוין של תוצאות.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התגובה כשמציינים את רשימת האפוטרופוסים.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
{
"guardians": [
{
object (Guardian)
}
],
"nextPageToken": string
} |
| שדות |
guardians[] |
object (Guardian)
הורים ואפוטרופוסים בדף התוצאות הזה שעמדו בקריטריונים שצוינו בבקשה.
|
nextPageToken |
string
אסימון שמזהה את דף התוצאות הבא להצגה. אם השדה ריק, אין תוצאות נוספות.
|
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של 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 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],null,["# Method: userProfiles.guardians.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.ListGuardiansResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of guardians that the requesting user is permitted to view, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID.\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 information 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, if the `invitedEmailAddress` filter is set by a user who is not a domain administrator, 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` 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}/guardians`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` Filter results by the student who the guardian is linked to. 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 has access to view. |\n\n### Query parameters\n\n| Parameters ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitedEmailAddress` | `string` Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list#body.ListGuardiansResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list#google.classroom.v1.Guardians.ListGuardians) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/userProfiles.guardians/list#google.classroom.v1.Guardians.ListGuardians) 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 guardians.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"guardians\": [ { object (/workspace/classroom/reference/rest/v1/userProfiles.guardians#Guardian) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `guardians[]` | `object (`[Guardian](/workspace/classroom/reference/rest/v1/userProfiles.guardians#Guardian)`)` Guardians on this page of results that met the criteria specified in the 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.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)."]]
