API kaynakları

Bu kılavuzda, Google Classroom API'yi oluşturan birincil bileşenlere genel bir bakış sunulmaktadır. Google Classroom API, kaynaklardan ve hizmetlerden oluşur. Kaynaklar, Google Classroom'daki öğeleri (ör. kurs veya ödev) temsil eder. Hizmetler ise bu kaynakları alır ve yönetir. Bu öğelerin bazılarında, Classroom'da bulunanlara ek olarak API'ye özgü ek özellikler bulunur. Birincil varlık türleri şunlardır:

Varlık Classroom'da gösterimi
Kurslar "M. Smith'in 4. ders matematik".
Takma adlar Dersin alternatif kimliği.
Davetiyeler Kullanıcıları sınıfa ekleme yöntemi.
Öğrenciler Sınıftaki bir öğrenci.
Öğretmenler Sınıftaki bir öğretmen.
Kullanıcı profilleri Öğrenci veya öğretmen bağlamının dışında, daha genel bir kullanıcı.
CourseWork Bir sınıftaki ödev.
StudentSubmissions Öğrencilerin belirli bir ödev (ör. yanıtlar veya çalışma sayfaları) için yaptığı çalışmalar.
CourseWorkMaterials Sınıftaki öğrenciler için materyaller.
Duyurular Sınıftaki öğrencilere yönelik bir duyuru.
AddOnAttachment Ödev veya materyaldeki, genellikle yerleştirilmiş bir iframe olarak görüntülenen içerik ya da etkinlik.
Konular Sınıftaki ödev ve materyallerin görsel olarak gruplandırılmasıdır.
Kayıtlar Sınıf listesi gibi verilerdeki değişikliklerle ilgili olarak uygulamanıza bildirim gönderme talimatı.

Çoğu kaynakta, kaynağın örneklerini okuma, güncelleme ve silme gibi standart işlemler için hizmet yöntemleri bulunur. Bazı kaynaklarda, belirli bir ödev atanmış öğrencilerin listesini değiştirme gibi diğer işlemler için özel yöntemler de bulunur.

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

Kaynak ilişkilerine genel bakış

  • Ders, Google Classroom'daki temel veri nesnesidir.
  • Courses için alternatif tanımlayıcılar olarak takma adlar kullanılır.
  • Davetiyeler, kullanıcı profillerini Course'de öğretmen veya öğrenci olmaya davet etmek için kullanılır ancak kullanıcılar doğrudan Google Workspace for Education alan yöneticileri tarafından da eklenebilir.
  • Öğretmenler akış öğeleri oluşturup bunları kurslarındaki öğrencilerle paylaşabilir. Olası akış öğesi türleri Coursework, CourseWorkMaterials ve Announcements'dır. CourseWork ve CourseWorkMaterials, görsel olarak Konular halinde düzenlenebilir ve AddOnAttachments içerebilir. Öğrenciler CourseWork için StudentSubmissions gönderir.
  • Geliştiriciler, bu verilerin bir kısmı değiştiğinde bildirim almak için Kayıtlar oluşturabilir.

Google Classroom, Google Workspace for Education'a abone olan alanları kullanabilir. Classroom bağlamında alan genellikle bir okul bölgesini temsil eder. Geliştirme amacıyla bir Google Workspace for Education test alanı oluşturabilirsiniz. Bu alan, gerçek kullanıcıları etkilemeden Classroom'un üretim örneğini kontrol etmenizi sağlar.

Kurslar ve takma adlar

Courses, "M. Smith'in 4. ders matematik", atanan öğretmenler, öğrenci listesi ve meta verileri. Her kurs, sunucu tarafından atanan benzersiz bir kimlikle tanımlanır. Course kaynağı, özellikle kursla ilgili tüm meta verileri (ör. ad, açıklama, konum ve saat) kapsar. Ders listeleri, Öğrenci, Öğretmen ve Davet kaynakları ve yöntemleri aracılığıyla yönetilir.

Aliases, bir sınıf için kursla ilişkilendirilebilecek ve benzersiz kimliğin yerine kullanılabilecek alternatif tanımlayıcılardır. Her takma ad, kimlerin oluşturabileceğini ve görüntüleyebileceğini kısıtlayan bir ad alanında bulunur. İki ad alanı desteklenir:

  • Alan: Alan 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, bir dersin alternatif girişleri (ör. MATH 127 ve COMSCI 127) alan ad alanı adında oluşturulmalıdır. Alan adlandırma alanındaki takma adlar yalnızca alan yöneticileri tarafından oluşturulabilir ancak alan adındaki 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 kullanışlıdır. Örneğin, kurslar için alternatif tanımlayıcılar kullanan bir uygulama, tanımlayıcısını Classroom kurslarıyla eşlemek için takma adlar oluşturabilir. Bu ad alanında oluşturulan takma adlar belirli bir Google API Konsolu'na bağlıdır. Bir uygulamanın tüm kullanıcıları, söz konusu uygulamanın geliştirici projesinin ad alanında takma ad 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 başlıklı makaleyi inceleyin.

Kurs listeleri ve kullanıcılar

Students ve Teachers, kullanıcı profili ile kurs arasında belirli eşlemelerdir ve kullanıcının kurstaki rolünü temsil eder. Öğrenci ve öğretmen atamaları genel değildir: Bir kullanıcı bir derste öğretmen, başka bir derste öğrenci olarak atanabilir. "Öğrenci" veya "öğretmen" ifadesi, belirli bir kurstaki belirli bir kullanıcı için bir izin grubunu temsil eder. Bir kursta birden fazla öğretmen veya hiç öğrenci olmayabilir. Öğretmenler ve öğrenciler diledikleri zaman kursa eklenebilir veya kurstan çıkarılabilir.

Öğrenciler

Student kaynağı, belirli bir kursa öğrenci olarak kayıtlı bir kullanıcıyı temsil eder.

Öğrencilerin, ders ayrıntılarını ve dersin öğretmenlerini görüntülemesine izin verilir.

Öğretmenler

Teacher kaynağı, belirli bir kursu veren bir kullanıcıyı temsil eder.

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

Invitations ve ilişkili yöntemleri, öğrencilere ve öğretmenlere kurs eklemenin kolay bir yolunu sunar. Davetiye oluşturmak, kullanıcıları öğretmen ve öğrenci kaynakları üzerinden doğrudan eklemek yerine kullanıcıların bir kursa katılıp katılmayacağını seçmelerine olanak tanır.

UserProfiles, Directory API tarafından döndürülen kullanıcının benzersiz kimliği veya e-posta adresi ile tanımlanan bir kullanıcının alan profiliyle eşlemeyi temsil eder. Mevcut kullanıcı, "me" kısayolunu kullanarak kendi kimliğine de atıfta bulunabilir.

UserProfiles hizmeti, öğrenci ile veli arasındaki eşleme olan Guardians öğelerini yönetmek ve davet etmek için de kullanılabilir. Classroom'daki veliler, ödevleri gibi bazı öğrenci bilgilerine erişebilir.

Listeleri yönetme hakkında daha fazla bilgi için Öğretmenleri ve Öğrencileri Yönetme başlıklı makaleyi inceleyin.

Akış öğeleri

Akış öğeleri, bir kursun üyeleriyle paylaşılan, yayınlanan içerik parçalarıdır. Geliştiriciler ve öğretmenler üç yayın öğesi türü oluşturabilir: Announcement, CourseWork ve CourseWorkMaterial.

Öğretmenler, Classroom kullanıcı arayüzündeki Akış sayfasının en üstünde Announcements oluşturur. Öğretmenler, sınıf çalışmaları sekmesinde Oluştur düğmesini tıklayarak CourseWork ve CourseWorkMaterials oluşturur. Geliştiriciler, tüm yayın öğesi türlerini Classroom API aracılığıyla programlı olarak oluşturabilir.

Akış öğeleri için aşağıdakiler geçerlidir:

  • Tüm canlı yayın öğeleri; Google Drive dosyaları, YouTube videoları, Google Formlar, URL köprüleri ve Classroom eklentisi ekleri gibi ek materyaller içerebilir.
  • Tüm akış öğeleri, kurstaki öğrencilerin bir alt kümesine atanabilir.
  • CourseWork notlu veya notsuz olabilir. Öğretmenler, CourseWork ödevlerinin notlandırma durumunu istedikleri zaman değiştirebilir.
  • Bir akış öğesinin birden fazla eki olabilir.
  • Bir akış öğesinin farklı türde ekleri olabilir. Örneğin, bir CourseWork ödevinde Google Drive dosyaları, YouTube videoları ve Classroom eklentisi ekleri aynı anda bulunabilir.
  • Bir yayın öğesinde birden fazla geliştiricinin eklenti ekleri olabilir.
  • Geliştiriciler, eklenti eklerinden birine sahip olan tüm akış öğesi kaynaklarıyla ilgili ayrıntıları alıp değiştirebilir.
  • Geliştiriciler, eklenti eklerinden birini içeren bir CourseWork ödevi için öğrenci gönderimini teslim edebilir, geri alabilir veya iade edebilir.
  • Geliştiriciler, yalnızca kendi oluşturdukları ödevlerdeki öğrenci gönderimlerinin notlarını kesinleştirebilir.

Kopyalanan yayın öğeleri

Öğretmenler, bir dersi kopyalayarak, ödevi yeniden kullanarak veya yayın öğesini birden fazla derse yayınlayarak yayın öğelerini kopyalayabilir. Yeni kopyaların farklı tanımlayıcıları olur. Bu, Classroom eklentisi geliştiriyorsanız önemli bir husus olabilir. Eklentilerin bu senaryoları nasıl işleyebileceğini anlamak için kopyalanan içerik ile ilgili kılavuzumuzu okuyun.

CourseWork ve Öğrenci Gönderimleri

CourseWork öğesi, bir kurstaki öğrenci grubu için verilen ödevi temsil eder. Öğrenci gönderimini kabul edebilen tek akış öğesi türüdür. CourseWork kaynağı; açıklama, teslim tarihi, maksimum not gibi ayrıntıları ve oluşturulma zamanı gibi meta verileri içerir.

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

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

CourseWork öğesi için öğrenci çalışması StudentSubmission ile gösterilir. Bir yanıt ve durum ile atanan not gibi ek meta verilerden oluşur.

Bir StudentSubmission öğesinin içeriği, ilgili CourseWork öğesinin türüne bağlıdır ve şunları içerebilir:

  • Bir ödev için gönderilen çalışma sayfaları ve ekler (başlıkları, küçük resimleri ve URL'leri dahil) ile Drive veya YouTube gibi uygun API'lerle kullanılabilen tanımlayıcılar.
  • Kısa yanıtlı veya çoktan seçmeli bir soruya verilen yanıt.

Ödevleri ve öğrenci gönderimlerini yönetme hakkında daha fazla bilgi edinmek için Ödevleri yönetme başlıklı makaleyi inceleyin.

CourseWorkMaterials ve Duyurular

CourseWork'e benzer şekilde CourseWorkMaterials, bir kurstaki öğrenci grubuna atanan içeriği temsil eder. Her kaynakta ek materyallerin yanı sıra başlık ve açıklama gibi ayrıntılar bulunur. Ancak CourseWork'ten farklı olarak CourseWorkMaterials, öğrencilerin herhangi bir yapı göndermesini gerektirmez. Bu nedenle, teslim tarihi yoktur ve CourseWorkMaterials için StudentSubmissions yoktur. Öğretmenler, önerilen okumalar, ders programı veya sınıf kuralları yayınlamak için CourseWorkMaterials simgesini kullanabilir.

Announcements, bir öğrenci grubuyla paylaşılan içerikleri de temsil eder ancak başlık gibi ayrıntılara sahip değildir ve CourseWork veya CourseWorkMaterials gibi Topics'ye göre düzenlenemez. Öğretmenler, sınıfa hatırlatıcı veya bildirim göndermek için bu araçları kullanabilir.

Konular

Topics, sınıftaki CourseWork ve CourseWorkMaterials öğelerini görsel olarak düzenlemek için kullanılır. Bu etiketler, ödevleri "isteğe bağlı" ve "zorunlu" ya da "1. ünite" ve "2. ünite" şeklinde gruplandırmak için kullanılabilir.

Classroom eklentileri

Eklenti, geliştirici tarafından sunulan bir kullanıcı arayüzü ve arka uçtur ve genellikle bir iFrame'de görüntülenir. Eklentiler, bir yayın öğesinde ek olarak görünür. Akış öğesi herhangi bir Announcements, CourseWork veya CourseWorkMaterials olabilir. Eklenti ekleri AddOnAttachment ile gösterilir.

Eklenti ekleri etkinlik veya içerik olabilir.

  • Etkinlik ekleri için öğrencinin ayrı bir gönderim tamamlaması ve göndermesi gerekir. Örnekler arasında testler, çekilişler veya oyunlar yer alır. Etkinlik gönderimleri isteğe bağlı olarak notlandırılabilir.
  • İçerik ekleri için öğrenci gönderimi gerekmez. Öğrencinin eki teslim etmesi gerekmez ve ek notlandırılmaz. Fotoğraflar, makaleler ve videolar buna örnek gösterilebilir.

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

Kayıtlar

Uygulamalar, Google Classroom'da belirli veriler değiştiğinde bildirimlere abone olabilir. Örneğin, bir dersin listesi güncellendiğinde. Registrations, bu bildirimlerin uygulamanıza gönderilmesi için bir talimattır.

Daha fazla bilgi için push bildirimleri kılavuzuna göz atın.

Sonraki
Notlar