Method: userProfiles.guardianInvitations.create
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
יוצרת הזמנה לאפוטרופוס ושולחת לאפוטרופוס אימייל עם בקשה לאשר שהוא האפוטרופוס של התלמיד/ה.
אחרי שהאפוטרופוס יאשר את ההזמנה, הערך של state ישתנה ל-COMPLETED והוא יתחיל לקבל התראות לאפוטרופוסים. ייווצר גם משאב Guardian שמייצג את האפוטרופוס הפעיל.
צריך להגדיר את השדות studentId ו-invitedEmailAddress באובייקט הבקשה. אי הגדרה של השדות האלה או הגדרה של שדות אחרים בבקשה תוביל לשגיאה.
השיטה הזו מחזירה את קודי השגיאה הבאים:
PERMISSION_DENIED אם למשתמש הנוכחי אין הרשאה לנהל הורים או אפוטרופוסים, אם האפוטרופוס הרלוונטי כבר דחה יותר מדי בקשות עבור התלמיד או התלמידה האלה, אם הורים או אפוטרופוסים לא מופעלים בדומיין הרלוונטי או בגלל שגיאות גישה אחרות.RESOURCE_EXHAUSTED אם התלמיד או האפוטרופוס חרג מהמגבלה של קישורים לאפוטרופוסים.INVALID_ARGUMENT אם כתובת האימייל של האפוטרופוס לא תקינה (למשל, אם היא ארוכה מדי), או אם לא ניתן לזהות את הפורמט של תעודת הסטודנט שצוינה (היא לא כתובת אימייל ולא userId מ-API הזה). השגיאה הזו תוחזר גם אם מגדירים שדות לקריאה בלבד, או אם השדה state מוגדר לערך שאינו PENDING.NOT_FOUND אם מזהה התלמיד שסופק הוא מזהה תלמיד תקין, אבל אין ב-Classroom תיעוד של התלמיד הזה.ALREADY_EXISTS אם כבר יש הזמנה בהמתנה לאפוטרופוס של התלמיד או התלמידה עם invitedEmailAddress שצוין, או אם invitedEmailAddress שצוין תואם לחשבון Google של Guardian קיים של המשתמש הזה.
בקשת HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
| פרמטרים |
guardianInvitation.studentId |
string
מזהה התלמיד/ה (בפורמט סטנדרטי)
|
גוף הבקשה
גוף הבקשה מכיל מופע של GuardianInvitation.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של GuardianInvitation.
היקפי הרשאה
נדרש היקף הרשאות OAuth הבא:
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.guardianInvitations.create\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\nCreates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `studentId` and `invitedEmailAddress` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other [access errors](/workspace/classroom/reference/Access.Errors).\n- `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit.\n- `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `userId` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`.\n- `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student.\n- `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invitedEmailAddress` provided, or if the provided `invitedEmailAddress` matches the Google account of an existing `Guardian` for this user.\n\n### HTTP request\n\n`POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------------------------|-------------------------------------------------|\n| `guardianInvitation.studentId` | `string` ID of the student (in standard format) |\n\n### Request body\n\nThe request body contains an instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [GuardianInvitation](/workspace/classroom/reference/rest/v1/userProfiles.guardianInvitations#GuardianInvitation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.guardianlinks.students`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
