Method: userProfiles.checkUserCapability

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

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

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

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

בקשת HTTP

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

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

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

פרמטרים
userId

string

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

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

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

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

פרמטרים
capability

enum (Capability)

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

enum (PreviewVersion)

אופציונלי. גרסת הטרום-השקה של ה-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 היכולת ליצור ולשנות קבצים מצורפים של תוספים שמשויכים לפרויקט ב-Developer Console של מזהה הלקוח ב-OAuth ששימש לשליחת הבקשה.
CREATE_RUBRIC היכולת ליצור ולשנות קריטריונים להערכה.
UPDATE_GRADING_PERIOD_SETTINGS היכולת לשנות את ההגדרות של התקופה למתן הציונים.
CREATE_STUDENT_GROUP היכולת ליצור ולשנות קבוצות תלמידים ואת החברים בהן.