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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.

الإمكانية

عنصر Enum لتمثيل الميزة

عمليات التعداد
CAPABILITY_UNSPECIFIED غير مدعوم.
CREATE_ADD_ON_ATTACHMENT إمكانية إنشاء وتعديل AddOnAttachments المرتبطة بمشروع Developer Console الخاص بمعرّف عميل OAuth المستخدَم لتقديم الطلب
UPDATE_GRADING_PERIOD_SETTINGS إمكانية تعديل إعدادات فترة التقييم