Method: userProfiles.guardians.get

הפונקציה מחזירה אפוטרופוס ספציפי.

השיטה הזו מחזירה את קודי השגיאה הבאים:

  • PERMISSION_DENIED אם אין משתמש שתואם ל-studentId שסופק למשתמש המבקש, אם למשתמש המבקש אין הרשאה להציג את פרטי האפוטרופוס של התלמיד שזוהה באמצעות studentId, אם האפוטרופוסים לא מופעלים בדומיין הרלוונטי או בגלל שגיאות גישה אחרות.
  • INVALID_ARGUMENT אם צוין studentId, אבל לא ניתן לזהות את הפורמט שלו (הוא לא כתובת אימייל, לא studentId מה-API ולא המחרוזת המילולית me).
  • NOT_FOUND אם למשתמש המבקש יש הרשאה להציג את האפוטרופוסים של studentId המבוקש, אבל לא קיים רשומת Guardian של התלמיד הזה שתואמת ל-guardianId שסופק.

בקשת HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
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

מידע נוסף זמין במדריך ההרשאות.