Classroom API یک رابط RESTful برای مدیریت دوره‌ها و فهرست‌ها در Google Classroom فراهم می‌کند. علاوه بر این، دکمه اشتراک‌گذاری Classroom به توسعه‌دهندگان و صاحبان محتوا اجازه می‌دهد تا محتوای خود را در Classroom به اشتراک بگذارند.
چه کسی می تواند از API استفاده کند؟
سرپرستان دامنه Google Workspace for Education می‌توانند از API برای ارائه برنامه‌نویسی دوره‌ها از طرف معلمان، همگام‌سازی سیستم‌های اطلاعات دانش‌آموز با Classroom، و مشاهده اولیه کلاس‌هایی که در دامنه خود تدریس می‌شوند، استفاده کنند.
توسعه دهندگان برنامه می توانند از Classroom API برای ادغام برنامه های خود با Classroom استفاده کنند. این برنامه‌ها باید از OAuth 2.0 برای درخواست مجوز برای مشاهده کلاس‌ها و فهرست‌ها از معلمان استفاده کنند. سرپرستان می‌توانند محدود کنند که آیا معلمان و دانش‌آموزان در دامنه‌شان می‌توانند به برنامه‌ها اجازه دسترسی به داده‌های Google Classroom خود را بدهند.
صاحبان وب‌سایت و توسعه‌دهندگان محتوا می‌توانند از دکمه اشتراک‌گذاری Classroom استفاده کنند تا به دانش‌آموزان و معلمان اجازه دهند محتوا را به Classroom به اشتراک بگذارند.
همه ادغام‌های API و دکمه اشتراک‌گذاری Classroom باید از دستورالعمل‌های برند Classroom پیروی کنند.
نمای کلی API
Classroom API از چندین نوع موجودی تشکیل شده است که مربوط به کلاس‌ها، معلمان و دانش‌آموزان در رابط Classroom است. برخی از این موجودیت‌ها علاوه بر آنچه در Classroom وجود دارد، دارای ویژگی‌های اضافی مخصوص API هستند. انواع موجودیت اولیه عبارتند از:
- دوره های آموزشی
- نام مستعار
- دعوت نامه ها
- دانش آموزان
- معلمان
- پروفایل های کاربر
- کار درسی
- موضوعات
- ارسالی دانش آموزان
برای اطلاعات دقیق در مورد منابع و روش‌های API، به مرجع Classroom API مراجعه کنید.
فراداده و نام مستعار دوره
دوره‌ها یک کلاس را نشان می‌دهند، مانند «ریاضی دوره چهارم ام. اسمیت» و معلمان تعیین‌شده، فهرست دانش‌آموزان و ابرداده‌ها. هر دوره با یک شناسه منحصر به فرد اختصاص داده شده توسط سرور شناسایی می شود. منبع دوره به طور خاص تمام ابرداده های مربوط به دوره، مانند نام، توضیحات، مکان و زمان را در بر می گیرد. فهرست دوره ها از طریق منابع دانشجو ، معلم و دعوت و روش های آنها مدیریت می شود.
نام مستعار، شناسه های جایگزین برای یک کلاس هستند که ممکن است با یک دوره مرتبط باشد و به جای شناسه منحصر به فرد استفاده شود. هر نام مستعار در یک فضای نام وجود دارد که افراد می توانند آن را ایجاد و مشاهده کنند. دو فضای نام پشتیبانی می شود:
- دامنه: فضای نام دامنه برای ایجاد نام مستعار مفید است که همه کاربران نیاز به دسترسی به آنها دارند، اما مختص هیچ برنامه ای نیستند. به عنوان مثال، لیست های جایگزین برای یک دوره، مانند MATH 127 و COMSCI 127، باید در فضای نام دامنه ایجاد شود. نام مستعار در فضای نام دامنه فقط توسط مدیران دامنه ایجاد می شود اما برای همه کاربران یک دامنه قابل مشاهده است.
- پروژه توسعه دهنده: فضای نام پروژه توسعه دهنده برای مدیریت نام مستعار خاص یک برنامه کاربردی مفید است. به عنوان مثال، برنامه‌ای که از شناسه‌های جایگزین برای دوره‌ها استفاده می‌کند، می‌تواند نام مستعار ایجاد کند تا شناسه خود را به دوره‌های Classroom نگاشت کند. نام مستعار ایجاد شده در این فضای نام به یک کنسول API خاص Google گره خورده است. هر کاربر یک برنامه کاربردی می تواند نام مستعار را در فضای نام پروژه توسعه دهنده آن برنامه ایجاد و مشاهده کند.
برای اطلاعات بیشتر در مورد مدیریت فراداده و نام های مستعار دوره، به مدیریت دوره ها مراجعه کنید.
فهرست دوره ها و کاربران
دانش‌آموزان و معلمان نگاشت‌های خاصی بین نمایه کاربر و یک دوره هستند که نشان‌دهنده نقش آن کاربر در دوره هستند. تعیین دانش آموز و معلم جهانی نیست: یک کاربر می تواند به عنوان معلم برای یک دوره و یک دانش آموز در درس دیگر اختصاص داده شود. نام "دانشجو" یا "معلم" مجموعه ای از مجوزها را برای یک کاربر خاص در یک دوره خاص نشان می دهد.
- دانش آموزان
یک منبع دانشجو نشان دهنده کاربری است که به عنوان دانشجو در آن ثبت نام کرده است
یک دوره خاص دانش آموزان مجاز به مشاهده جزئیات دوره و اساتید آن دوره هستند.
- معلمان
یک منبع معلم نشان دهنده کاربری است که دوره خاصی را تدریس می کند.
معلمان مجاز به مشاهده و تغییر جزئیات دوره، مشاهده معلمان و دانش آموزان و مدیریت معلمان و دانش آموزان اضافی هستند.
دعوت‌نامه‌ها و روش‌های مرتبط با آنها راهی مناسب برای اضافه کردن دانش‌آموزان و معلمان به دوره‌ها را فراهم می‌کنند. ایجاد دعوت‌نامه‌ها به کاربران این امکان را می‌دهد که انتخاب کنند به یک دوره بپیوندند یا نه، نه اینکه مستقیماً آنها را از طریق منابع معلم و دانش‌آموز اضافه کنید.
UserProfiles نشان دهنده یک نگاشت به نمایه دامنه کاربر است که توسط شناسه منحصر به فرد یا آدرس ایمیل کاربر بازگردانده شده توسط Directory API شناسایی شده است. کاربر فعلی همچنین ممکن است با استفاده از خلاصه "me" به شناسه خود مراجعه کند.
برای اطلاعات بیشتر در مورد مدیریت فهرست‌ها، به مدیریت معلمان و دانش‌آموزان مراجعه کنید.
کارهای درسی و ارسالی دانشجویان
یک آیتم CourseWork یک وظیفه واحد را نشان می دهد که به گروهی از دانش آموزان در یک دوره اختصاص داده شده است. این شامل جزئیاتی مانند توضیحات، تاریخ مقرر، و مواد و همچنین ابرداده مانند زمان ایجاد است. مواد شامل عنوان، تصویر کوچک، و URL، و همچنین یک شناسه است که می تواند با API های مناسب (مانند Drive، YouTube) استفاده شود.
موارد CourseWork یکی از انواع وظایف زیر را توصیف می کند:
- تکلیفی که دانش‌آموزان با ارسال کاربرگ‌ها یا پیوست‌های دیگر تکمیل می‌کنند.
- یک سوال پاسخ کوتاه یا یک سوال چند گزینه ای.
کار دانشجویی برای یک مورد CourseWork با ارسال دانشجو نشان داده می شود. این شامل یک پاسخ و ابرداده اضافی مانند وضعیت و درجه اختصاص یافته است.
محتویات ارسال دانشجو به نوع مورد مربوط به دوره کار بستگی دارد:
- کاربرگ‌ها و پیوست‌هایی که برای یک تکلیف ارسال می‌شوند، شامل عنوان، تصویر کوچک و نشانی اینترنتی آنها، و همچنین شناسه‌هایی که می‌توانند با APIهای مناسب مانند Drive یا YouTube استفاده شوند.
- پاسخ به یک سوال پاسخ کوتاه یا سوال چند گزینه ای.
برای اطلاعات بیشتر درباره مدیریت کارهای درسی و ارسال‌های دانش‌آموز، به مدیریت کار کلاسی مراجعه کنید.
افزونه های کلاس درس
افزونه یک رابط کاربری است که توسط شریک ارائه می‌شود و معمولاً در iframe نمایش داده می‌شود. افزونه‌ها به صورت پیوست روی یک پست ظاهر می‌شوند که می‌توانند Announcements ، CourseWork یا CourseWorkMaterials باشند.
پیوست‌های افزودنی می‌توانند یک فعالیت یا محتوا باشند.
- پیوست‌های فعالیت از دانش‌آموز می‌خواهد که یک ارسال فردی را تکمیل و تحویل دهد. به عنوان مثال می توان به آزمون ها، نقاشی ها یا بازی ها اشاره کرد. یک فعالیت ارسالی می تواند به صورت اختیاری درجه بندی شود.
- پیوست های محتوا نیازی به ارسال دانشجو ندارد. دانش آموز نیازی به تحویل پیوست ندارد و نمره گذاری نمی شود. به عنوان مثال می توان به عکس ها، مقالات و فیلم ها اشاره کرد.
برای اطلاعات بیشتر به راهنمای توسعه افزونه ها مراجعه کنید.
شروع سریع
برای راه‌اندازی محیط خود و شروع سریع با API، یکی از شروع‌های سریع را امتحان کنید:
با Google APIs Explorer آزمایش کنید
برای آزمایش روش‌های فراخوانی روی داده‌های زنده، از Google APIs Explorer استفاده کنید. برای شروع نیازی به نوشتن کدی ندارید، اما توجه داشته باشید که اقداماتی که با استفاده از APIs Explorer انجام می دهید می توانند داده های موجود را تغییر دهند.
یک راه برای شروع فراخوانی متدها، فراخوانی متد courses.list() است. این روش به هیچ پارامتر درخواستی نیاز ندارد و شما می توانید یک id از لیست دوره های برگشتی بازیابی کنید تا به عنوان پارامتر درخواست برای سایر فراخوانی های API استفاده کنید. اگر هیچ دوره ای ندارید، می توانید با استفاده از متد courses.create() ایجاد کنید.
همچنین می توانید مرجع API را کاوش کنید.