מחזירה רשימה של אפוטרופוסים שהמשתמש ששלח את הבקשה מורשה לצפות בהם. האפוטרופוסים מוגבלים לאפוטרופוסים שתואמים לבקשה.
כדי להציג רשימה של אפוטרופוסים של תלמידים שהמשתמש ששלח את הבקשה יכול לראות אותם, צריך להשתמש בתו המילולי -
עבור מזהה התלמיד.
השיטה הזו מחזירה את קודי השגיאה הבאים:
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 |
אפשר לסנן את התוצאות לפי התלמיד/ה שאליו מקושר האפוטרופוס. המזהה יכול להיות אחד מהבאים:
|
פרמטרים של שאילתה
פרמטרים | |
---|---|
invitedEmailAddress |
אפשר לסנן את התוצאות לפי כתובת האימייל שאליה נשלחה ההזמנה המקורית, וכתוצאה מכך יופיע הקישור הזה לאפוטרופוס. רק מנהלי דומיין יכולים להשתמש במסנן הזה. |
pageToken |
הערך בכל מקרה אחר, הבקשה של |
pageSize |
מספר הפריטים המרבי להחזרה. הערך 'אפס' או 'לא צוין' מציין שהשרת עשוי להקצות ערך מקסימלי. השרת עשוי להחזיר פחות ממספר התוצאות שצוין. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
תשובה כשרושמים אפוטרופוסים.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"guardians": [
{
object ( |
שדות | |
---|---|
guardians[] |
אפוטרופוסים בדף זה של תוצאות שעמדו בקריטריונים שצוינו בבקשה. |
nextPageToken |
אסימון שמזהה את הדף הבא של התוצאות שיוחזרו. אם השדה ריק, אין תוצאות נוספות זמינות. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של 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
למידע נוסף, ניתן לעיין במדריך ההרשאות.