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 إمكانية إنشاء مجموعات الطلاب وتعديلها وتعديل أعضائها