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 |
היכולת ליצור ולשנות קבוצות תלמידים ואת החברים בהן. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-06 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-06 (שעון UTC)."],[],[],null,["# Method: userProfiles.checkUserCapability\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CheckUserCapabilityResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Capability](#Capability)\n\n\u003cbr /\u003e\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20240930_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more.\nReturns whether a user may use the specified Classroom capability. For example, this endpoint can be used to check whether a user may create add- on attachments.\n\n\u003cbr /\u003e\n\nA requesting user can only check capabilities for themselves.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to check eligibility for the specified user.\n- `INVALID_ARGUMENT` if the request is malformed.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` Required. Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `capability` | `enum (`[Capability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability)`)` Required. The Capability that should be checked for this user. For example, to check whether a user can create an [add-on attachment](https://developers.google.com/workspace/classroom/reference/rest/v1/courses.courseWork.addOnAttachments#resource:-addonattachment), set this to `CREATE_ADD_ON_ATTACHMENT`. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The preview version of the API. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse from checking user capabilities.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"capability\": enum (/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability), \"allowed\": boolean } ``` |\n\n| Fields ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `capability` | `enum (`[Capability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability)`)` The Classroom capability. |\n| `allowed` | `boolean` Whether the specified capability is allowed for the user. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n- `\n https://www.googleapis.com/auth/classroom.courses.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nCapability\n----------\n\nEnum to represent the capability.\n\n| Enums ||\n|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `CAPABILITY_UNSPECIFIED` | Not supported. |\n| `CREATE_ADD_ON_ATTACHMENT` | The capability to create and modify AddOnAttachments associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. |\n| `CREATE_RUBRIC` | The capability to create and modify Rubrics. |\n| `UPDATE_GRADING_PERIOD_SETTINGS` | The capability to modify grading period settings. |\n| `CREATE_STUDENT_GROUP` | The capability to create and modify student groups and their members. |"]]
