نمای کلی

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

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

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

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

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

منابع Google Classroom را اصلاح کنید

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

با Google Classroom یکپارچه شوید

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

شروع کردن

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

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

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

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

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

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