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

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