Method: userProfiles.checkUserCapability

نشان می دهد که آیا کاربر ممکن است از قابلیت Classroom مشخص شده استفاده کند یا خیر. برای مثال، از این نقطه پایانی می‌توان برای بررسی اینکه آیا کاربر ممکن است پیوست‌های افزودنی ایجاد کند یا خیر، استفاده کرد.

کاربر درخواست کننده فقط می تواند قابلیت ها را برای خود بررسی کند.

این روش کدهای خطای زیر را برمی گرداند:

  • PERMISSION_DENIED اگر کاربر درخواست کننده مجاز به بررسی صلاحیت برای کاربر مشخص شده نباشد.
  • اگر درخواست نادرست باشد INVALID_ARGUMENT .

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
userId

string

مورد نیاز. شناسه کاربر.

هنگامی که به عنوان پارامتر یک درخواست مشخص می شود، این شناسه می تواند یکی از موارد زیر باشد:

  • شناسه عددی برای کاربر
  • آدرس ایمیل کاربر
  • رشته تحت اللفظی "me" که کاربر درخواست کننده را نشان می دهد

پارامترهای پرس و جو

پارامترها
capability

enum ( Capability )

مورد نیاز. قابلیتی که باید برای این کاربر بررسی شود. برای مثال، برای بررسی اینکه آیا کاربر می‌تواند یک پیوست افزودنی ایجاد کند، آن را روی ADD_ON تنظیم کنید.

previewVersion

enum ( PreviewVersion )

اختیاری. نسخه پیش نمایش API.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پاسخ از بررسی قابلیت های کاربر.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "capability": enum (Capability),
  "allowed": boolean
}
فیلدها
capability

enum ( Capability )

قابلیت کلاس درس

allowed

boolean

آیا قابلیت مشخص شده برای کاربر مجاز است یا خیر.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

قابلیت

Enum برای نشان دادن قابلیت.

Enums
CAPABILITY_UNSPECIFIED پشتیبانی نمی شود.
CREATE_ADD_ON_ATTACHMENT قابلیت ایجاد و تغییر AddOnAttachments مرتبط با پروژه Developer Console از شناسه مشتری OAuth که برای درخواست استفاده می شود.
UPDATE_GRADING_PERIOD_SETTINGS قابلیت تغییر تنظیمات دوره درجه بندی.