نمای کلی

رابط برنامه‌نویسی کاربردی (API) کلاس درس گوگل (Google Classroom API) یک رابط برنامه‌نویسی برای توسعه‌دهندگان نرم‌افزار، مدیران و مدیران مدارس فراهم می‌کند تا منابع کلاس درس گوگل را مدیریت کنند. شما می‌توانید نرم‌افزاری بسازید که دوره‌های کلاس درس و محتوای آنها را ایجاد، بازیابی و اصلاح کند.

برخی از موارد استفاده معمول عبارتند از:

  • مدیریت دوره‌ها، فهرست‌ها و سرپرستان
  • اضافه کردن تکالیف، اطلاعیه‌ها و مطالب درسی
  • اختصاص نمرات و تغییر تنظیمات نمره‌دهی
  • تولید داده‌ها برای تحلیل
  • قابل کشف و دسترسی کردن به محتوا یا ابزارهای یک ارائه‌دهنده خارجی در داخل کلاس درس

آیا Classroom API راه حل مناسبی برای من است؟

گوگل چندین محصول برای کمک به شما در تعامل با Classroom ارائه می‌دهد. در ادامه چند سناریوی رایج و توصیه‌هایی برای محصولاتی که ممکن است به بهترین وجه با نیازهای شما مطابقت داشته باشند، آورده شده است.

اصلاح منابع کلاس درس گوگل

سناریو راهکارهای پیشنهادی
می‌خواهم به‌طور منظم حجم بالایی از دوره‌ها، کاربران یا سایر منابع کلاس درس را مدیریت کنم. در کدنویسی و نگهداری زیرساخت نرم‌افزاری راحت هستم. برنامه‌هایی بنویسید که از Classroom API استفاده می‌کنند.
من می‌خواهم گاهی اوقات حجم کمی از منابع کلاس درس را مدیریت کنم. من با نوشتن کدهای کم با سربار کم راحت هستم. استفاده از Classroom API با Google Apps Script
می‌خواهم گاهی اوقات تغییراتی در منابع کلاس درس ایجاد کنم. من با دستورات ترمینال راحت هستم. از مدیر برنامه‌های گوگل استفاده کنید.
من حجم زیادی از گزارش‌ها را با جزئیات مربوط به رویدادهای کلاس درس می‌خواهم. از سرویس انتقال داده BigQuery استفاده کنید.
می‌خواهم فعالیت کاربرانم را بررسی کنم. گزارش‌ها را در کنسول مدیریت ایجاد کنید یا از API گزارش‌ها استفاده کنید.

ادغام با کلاس درس گوگل

سناریو راهکارهای پیشنهادی
می‌خواهم معلمان و دانش‌آموزان محتوای من را در کلاس درس ببینند و راه‌اندازی کنند. یک افزونه برای کلاس درس بسازید.
من می‌خواهم معلمان روی دکمه‌ای در وب‌سایت یا اپلیکیشن من کلیک کنند که محتوای من را در کلاس درس جاسازی می‌کند. یک افزونه‌ی کلاس درس بسازید و به صورت برنامه‌نویسی‌شده پیوست‌ها را ایجاد کنید .
می‌خواهم معلمان روی دکمه‌ای در وب‌سایت یا اپلیکیشن من کلیک کنند تا به محتوای من در کلاس درس لینک شوند. با استفاده از Classroom API یا تعبیه دکمه‌های اشتراک‌گذاری در Classroom، تکالیف درسی ایجاد کنید .
می‌خواهم معلمان کلاس درس با سیستم اطلاعات دانش‌آموزی من همگام‌سازی شوند یا اطلاعات را از آن وارد کنند. OneRoster را برای SIS پیاده‌سازی کنید یا با استفاده از Classroom API منابع را ایجاد و به آنها دسترسی داشته باشید.

شروع به کار

به توسعه‌دهندگان جدید توصیه می‌شود قبل از شروع یک پروژه جدید، موارد زیر را انجام دهند:

برای شروع توسعه، مطمئن شوید که مراحل پیش‌نیاز را انجام داده‌اید. محدوده‌های API کلاس درس مناسب با نیازهای خود را انتخاب کنید، سپس محیط خود را راه‌اندازی کنید و با دنبال کردن یکی از مراحل سریع، درخواست‌ها را ارسال کنید:

با Google APIs Explorer آزمایش کنید

برای آزمایش فراخوانی متدها روی داده‌های زنده، از Google APIs Explorer استفاده کنید. برای شروع لازم نیست هیچ کدی بنویسید، اما توجه داشته باشید که اقداماتی که با استفاده از APIs Explorer انجام می‌دهید می‌تواند داده‌های موجود را تغییر دهد.

یک راه برای شروع فراخوانی متدها، فراخوانی متد courses.list() است. این متد به هیچ پارامتر درخواستی نیاز ندارد و می‌توانید یک id از لیست برگشتی دوره‌ها بازیابی کنید تا به عنوان پارامتر درخواست برای سایر فراخوانی‌های API استفاده کنید. اگر هیچ دوره‌ای ندارید، می‌توانید با استفاده از متد courses.create() یکی ایجاد کنید.

همچنین می‌توانید مرجع Classroom API را بررسی کنید.