تتوفّر الآن إضافات Google Classroom بشكل عام للمطوّرين. يُرجى الاطّلاع على
مستندات الإضافات للحصول على مزيد من المعلومات.
Method: userProfiles.checkUserCapability
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
تعرض هذه الدالة ما إذا كان بإمكان المستخدم استخدام إمكانية Classroom المحدّدة. على سبيل المثال، يمكن استخدام نقطة النهاية هذه للتحقّق مما إذا كان بإمكان المستخدم إنشاء مرفقات إضافات.يمكن للمستخدم الذي يقدّم الطلب التحقّق من الإمكانات الخاصة به فقط.
تُرجع هذه الطريقة رموز الخطأ التالية:
-
PERMISSION_DENIED إذا لم يكن مسموحًا للمستخدم الذي يرسل الطلب بالتحقّق من أهلية المستخدم المحدّد.
INVALID_ARGUMENT إذا كان الطلب غير صالح
طلب HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability
يستخدِم عنوان URL بنية تحويل الترميز gRPC.
مَعلمات المسار
| المعلمات |
userId |
string
مطلوب. معرّف المستخدم عند تحديد هذا المعرّف كمعلَمة في الطلب، يمكن أن يكون أحد ما يلي:
- المعرّف الرقمي للمستخدم
- عنوان البريد الإلكتروني للمستخدم
- السلسلة الحرفية
"me" التي تشير إلى المستخدم الذي يرسل الطلب
|
مَعلمات طلب البحث
| المعلمات |
capability |
enum (Capability)
مطلوب. تشير هذه السمة إلى الإذن الذي يجب التحقّق من توفّره لدى المستخدم. على سبيل المثال، للتحقّق ممّا إذا كان بإمكان المستخدم إنشاء مرفق إضافة، اضبط هذا الحقل على CREATE_ADD_ON_ATTACHMENT.
|
previewVersion |
enum (PreviewVersion)
اختياريّ. إصدار المعاينة من واجهة برمجة التطبيقات
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
الردّ من التحقّق من إمكانات المستخدم
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل 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
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
إمكانية
| عمليات التعداد |
CAPABILITY_UNSPECIFIED |
غير مدعوم. |
CREATE_ADD_ON_ATTACHMENT |
إمكانية إنشاء وتعديل AddOnAttachments المرتبطة بمشروع 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 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-08-06 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],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. |"]]
