Method: userProfiles.checkUserCapability

הפונקציה מחזירה אם משתמש יכול להשתמש ביכולת שצוינה ב-Classroom. לדוגמה, אפשר להשתמש בנקודת הקצה הזו כדי לבדוק אם משתמש יכול ליצור קבצים מצורפים של תוספים.

משתמש מבקש יכול לבדוק את היכולות רק עבור עצמו.

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

  • PERMISSION_DENIED אם למשתמש המבקש אין הרשאה לבדוק את הזכאות של המשתמש שצוין.
  • INVALID_ARGUMENT אם הבקשה לא תקינה.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
userId

string

חובה. המזהה של המשתמש.

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

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

פרמטרים של שאילתה

פרמטרים
capability

enum (Capability)

חובה. היכולת שצריך לבדוק עבור המשתמש הזה. לדוגמה, כדי לבדוק אם משתמש יכול ליצור קובץ מצורף של תוסף, צריך להגדיר את הערך CREATE_ADD_ON_ATTACHMENT.
previewVersion

enum (PreviewVersion)

זה שינוי אופציונלי. גרסת ה-Preview של ה-API.

גוף הבקשה

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

גוף התשובה

תגובה מהבדיקה של יכולות המשתמש.

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

ייצוג ב-JSON 
{
  "capability": enum (Capability),
  "allowed": boolean
}
שדות
capability

enum (Capability)

היכולת של Classroom.
allowed

boolean

האם המשתמש מורשה להשתמש ביכולת שצוינה.

היקפי הרשאה

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

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

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

פונקציה

טיפוסים בני מנייה (enum) שמייצג את היכולת.

טיפוסים בני מנייה (enum)
CAPABILITY_UNSPECIFIED לא נתמכת.
CREATE_ADD_ON_ATTACHMENT היכולת ליצור ולשנות קבצים מסוג AddOnAttachments שמשויכים לפרויקט ב-Developer Console של מזהה הלקוח ב-OAuth ששימש לשליחת הבקשה.
UPDATE_GRADING_PERIOD_SETTINGS יכולת לשנות את ההגדרות של תקופת המטלות.