Method: courses.get

یک دوره را برمی‌گرداند.

این متد کدهای خطای زیر را برمی‌گرداند:

  • اگر کاربر درخواست‌کننده اجازه دسترسی به دوره درخواستی را نداشته باشد یا خطاهای دسترسی رخ دهد، PERMISSION_DENIED .
  • اگر هیچ دوره‌ای با شناسه درخواستی وجود نداشته باشد، NOT_FOUND .

درخواست HTTP

GET https://classroom.googleapis.com/v1/courses/{id}

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
id

string

شناسه‌ی دوره‌ای که باید برگردانده شود. این شناسه می‌تواند شناسه‌ی اختصاص داده شده توسط کلاس درس یا یک alias باشد.

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

پارامترها
previewVersion

enum ( PreviewVersion )

اختیاری. نسخه پیش‌نمایش API. این گزینه باید تنظیم شود تا بتوان به قابلیت‌های جدید API که در برنامه پیش‌نمایش در اختیار توسعه‌دهندگان قرار گرفته است، دسترسی پیدا کرد.

درخواست بدنه

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

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از Course است.

دامنه‌های مجوز

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

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

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