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

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