Method: userProfiles.get

מחזיר פרופיל משתמש.

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

  • PERMISSION_DENIED אם המשתמש ששלח את הבקשה לא מורשה לגשת לפרופיל המשתמש הזה, אם לא קיים פרופיל עם המזהה המבוקש, או במקרה של שגיאות גישה.

בקשת HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{userId}

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

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

פרמטרים
userId

string

מזהה הפרופיל שיש להחזיר. המזהה יכול להיות אחד מהבאים:

  • המזהה המספרי של המשתמש
  • כתובת האימייל של המשתמש
  • ליטרל המחרוזת "me", שמציין את המשתמש ששלח את הבקשה

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של UserProfile.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

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