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 נעשה שימוש בתחביר המרת 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

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