Genel bakış

Classroom API, Google Classroom'da dersleri ve öğrenci listelerini yönetebilmeniz için RESTful bir arayüz sağlar. Ayrıca Classroom paylaş düğmesi, geliştiricilerin ve içerik sahiplerinin içeriklerinin Classroom'da paylaşılmasını etkinleştirmelerine olanak tanır.

API'yi kimler kullanabilir?

Google Workspace for Education alan yöneticileri, API'yi kullanarak öğretmenler adına derslerin programlı olarak sağlanmasını sağlayabilir, öğrenci bilgi sistemlerini Classroom ile senkronize edebilir ve alanlarında eğitim verilen sınıflara dair temel görünürlük elde edebilir.

Uygulama geliştiriciler, uygulamalarını Classroom'a entegre etmek için Classroom API'yı kullanabilir. Bu uygulamaların, öğretmenlerden sınıfları ve öğrenci listelerini görüntüleme izni istemek için OAuth 2.0 kullanması gerekir. Alanlarındaki öğretmen ve öğrencilerin, uygulamalara kendi Google Classroom verilerine erişmesi için yetki verip veremeyeceğini yöneticiler kısıtlayabilir.

Web sitesi sahipleri ve içerik geliştiricileri, öğrencilerin ve öğretmenlerin tekrar Classroom'da içerik paylaşmasına izin vermek için Classroom paylaşım düğmesini kullanabilir.

Tüm API ve Classroom paylaşım düğmesi entegrasyonları Classroom marka yönergelerine uygun olmalıdır.

API'ye genel bakış

Classroom API, Classroom arayüzündeki sınıflara, öğretmenlere ve öğrencilere karşılık gelen çeşitli varlık türlerinden oluşur. Bu varlıklardan bazılarının, Classroom'da mevcut olanların yanı sıra API'ye özel ek özellikleri de vardır. Birincil varlık türleri şunlardır:

API kaynakları ve yöntemleri hakkında ayrıntılı bilgi için Classroom API referansı sayfasına bakın.

Kurs meta verileri ve takma adları

Dersler, "M. 4. dönem matematiği" ve atanan öğretmenler, öğrenci listesi ve meta veriler. Her kurs, sunucu tarafından atanan benzersiz bir kimlikle tanımlanır. Kurs kaynağı, özellikle kursla ilgili ad, açıklama, konum ve saat gibi tüm meta verileri içerir. Ders listeleri; Öğrenci, Öğretmen ve Davet kaynakları ve yöntemleri aracılığıyla yönetilir.

Takma adlar, bir sınıfla ilişkilendirilebilecek ve benzersiz kimlik yerine kullanılabilecek alternatif tanımlayıcılardır. Her takma ad, kendisini kimlerin oluşturabileceğini ve görüntüleyebileceğini kısıtlayan bir ad alanında bulunur. İki ad alanı desteklenir:

  • Alan adı: Alan adı ad alanı, tüm kullanıcıların erişmesi gereken ancak herhangi bir programa özel olmayan takma adlar oluşturmak için kullanışlıdır. Örneğin, alan ad alanında MATH 127 ve COMSCI 127 gibi alternatif girişler oluşturulmalıdır. Alan ad alanındaki takma adlar yalnızca alan yöneticileri tarafından oluşturulabilir ancak bir alandaki tüm kullanıcılar tarafından görülebilir.
  • Geliştirici projesi: Geliştirici projesi ad alanı, bir uygulamaya özgü takma adları yönetmek için yararlıdır. Örneğin, dersler için alternatif tanımlayıcılar kullanan bir uygulama, tanımlayıcısını Classroom dersleriyle eşlemek için takma adlar oluşturabilir. Bu ad alanında oluşturulan takma adlar belirli bir Google API Konsolu'na bağlanır. Bir uygulamanın kullanıcıları, uygulamanın geliştirici projesinin ad alanında takma adlar oluşturabilir ve görüntüleyebilir.

Kurs meta verilerini ve takma adlarını yönetme hakkında daha fazla bilgi için Kursları Yönetme bölümüne bakın.

Ders listeleri ve kullanıcıları

Öğrenciler ve Öğretmenler, kullanıcı profili ile ders arasındaki özel eşlemelerdir ve ilgili kullanıcının kurstaki rolünü temsil eder. Öğrenci ve öğretmen atamaları genel değildir: Bir kullanıcı bir kursun öğretmeni, başka bir dersin öğrencisi olarak atanabilir. "Öğrenci" veya "öğretmen" atamaları, belirli bir kurstaki belirli bir kullanıcı için bir dizi izin temsil eder.

Öğrenciler

Öğrenci kaynağı, şu kurumda öğrenci olarak kaydolmuş bir kullanıcıyı temsil eder:

öğrenebilirsiniz. Öğrencilerin kurs ayrıntılarını ve öğretmenlerini görüntülemesine izin verilir.

Öğretmenler

Öğretmen kaynağı, belirli bir dersi veren kullanıcıyı temsil eder.

Öğretmenlerin kurs ayrıntılarını görüntülemesine ve değiştirmesine, öğretmen ve öğrencileri görüntülemesine, ek öğretmen ve öğrencileri yönetmesine izin verilir.

Davetler ve ilişkili yöntemler, öğrencileri ve öğretmenleri kurslara eklemek için kolay bir yol sunar. Davetiye oluşturduğunuzda doğrudan öğretmen ve öğrenci kaynakları aracılığıyla değil kullanıcılar bir derse katılıp katılmayacaklarını seçebilirler.

UserProfiles, kullanıcının Directory API tarafından döndürülen benzersiz kimliği veya e-posta adresiyle tanımlanan alan profiliyle yapılan eşlemeyi temsil eder. Geçerli kullanıcı, "me" kısaltmasını kullanarak kendi kimliğine de başvurabilir.

Öğrenci listelerini yönetme hakkında daha fazla bilgi için Öğretmenleri ve Öğrencileri Yönetme başlıklı makaleye göz atın.

Sınıf çalışması ve öğrenci gönderimleri

CourseWork öğesi, bir dersteki bir grup öğrenciye atanmış tek bir görevi temsil eder. Açıklama, teslim tarihi ve malzemelerin yanı sıra oluşturulma zamanı gibi meta verileri içerir. Materyaller arasında başlık, küçük resim ve URL'nin yanı sıra uygun API'lerle (ör. Drive, YouTube) kullanılabilecek bir tanımlayıcı yer alır.

CourseWork öğeleri aşağıdaki görev türlerinden birini tanımlar:

  • Öğrencilerin çalışma sayfaları veya başka ekler göndererek tamamladıkları bir ödev.
  • Kısa yanıtlı bir soru veya çoktan seçmeli bir soru.

Bir CourseWork öğesi için öğrenci çalışmaları, StudentSubmission ile temsil edilir. Bir yanıtın yanı sıra durum ve atanan not gibi ek meta verilerden oluşur.

StudentSubmission'ın içeriği, ilgili CourseWork öğesinin türüne bağlıdır:

  • Başlık, küçük resim ve URL'nin yanı sıra Drive veya YouTube gibi uygun API'lerle kullanılabilecek tanımlayıcılar dahil olmak üzere ödev için gönderilen çalışma sayfaları ve ekler.
  • Kısa yanıtlı veya çoktan seçmeli bir soruya verilen yanıt.

Sınıf çalışmalarını ve öğrenci gönderimlerini yönetme hakkında daha fazla bilgi edinmek için Sınıf Çalışmaları sayfasını yönetme başlıklı makaleyi inceleyin.

Classroom eklentileri

Eklenti, genellikle bir iframe'de görüntülenen, iş ortağı tarafından sunulan bir kullanıcı arayüzü ve arka uçtur. Eklentiler bir yayında ek olarak görünür. Bu ekler Announcements, CourseWork veya CourseWorkMaterials biçiminde olabilir.

Eklenti ekleri, bir etkinlik veya içerik olabilir.

  • Etkinlik ekleri için öğrencinin tek bir gönderimini tamamlaması ve teslim etmesi gerekir. Testler, çizimler veya oyunlar örnek olarak verilebilir. Bir etkinlik gönderimine isteğe bağlı olarak not verilebilir.
  • Eklerin gönderiminde öğrencilerin gönderilmesi gerekmez. Öğrencinin eki teslim etmesi gerekmez ve eke not verilmez. Örneğin fotoğraflar, makaleler ve videolar.

Daha fazla bilgi için eklenti geliştirme kılavuzlarına bakın.

Hızlı Başlangıç Kılavuzları

Ortamınızı ayarlamak ve API'yi hemen kullanmaya başlamak için hızlı başlangıç kılavuzlarından birini deneyin:

Google API Gezgini ile denemeler yapma

Canlı veriler üzerinde çağrı yöntemlerini denemek için Google API Gezgini'ni kullanmayı deneyin. Başlamak için herhangi bir kod yazmanız gerekmez, ancak API Gezgini'ni kullanarak yaptığınız işlemlerin mevcut verileri değiştirebileceğini unutmayın.

Yöntemleri çağırmaya başlamanın bir yolu, courses.list() yöntemine çağrı yapmaktır. Bu yöntem için herhangi bir istek parametresi gerekmez ve döndürülen kurs listesinden bir id alarak diğer API çağrıları için istek parametresi olarak kullanabilirsiniz. Hiç kursunuz yoksa courses.create() yöntemini kullanarak bir kurs oluşturabilirsiniz.

Ayrıca API referansını da inceleyebilirsiniz.