Google Cloud projesi yapılandırması

Bu sayfada, Classroom eklentileri için Google Cloud projeleri oluşturma ve yapılandırma hakkında bilmeniz gereken bilgiler bulunmaktadır. Google Cloud projeleri; OAuth 2.0 (Google TOA) üzerinden Google Tek Oturum Açma'yı uygulamak, eklentiniz tarafından yapılan istekleri yetkilendirmek ve Google Workspace Marketplace mağazasındaki bir eklenti girişini yönetmek için kullanılır.

Marketplace'te eklenti yayınlama hakkında daha fazla genel bilgi için Uygulama yayınlama bölümüne bakın.

Google Cloud projesi oluşturma

Oluşturulacak iki tür proje vardır: Geliştirme için kullanılan özel bir proje ve son kullanıcıların erişebileceği herkese açık bir proje. "Herkese açık" ve "gizli" etiketler, uygulamanızın Google Workspace Marketplace'te görünürlüğünü ifade eder. Özel bir Marketplace uygulaması yalnızca oluşturulduğu alandaki kullanıcılar tarafından yüklenebilir. Herkese açık bir Marketplace uygulaması ise tüm Google Workspace alanlarında kullanılabilir. Bir proje hem herkese açık hem de özel olamayacağından bunlar iki ayrı uygulama olmalıdır. Herkese açık başvurular, pazarda kullanıma sunulmadan önce incelenip onaylanmalıdır.

Google Cloud projesi oluşturma ile ilgili genel bilgiler için Google Cloud projesi oluşturma sayfasını ziyaret edin.

Özel bir Google Cloud projesi oluşturun

Bu gizli proje, geliştirme için kullanılan eklenti uygulamasını temsil eder. Oluşturulduğu alanın dışındaki kullanıcılar tarafından erişilemez durumdadır, ancak yüklemeden önce onaylanması gerekmez. Bu nedenle Google, eklentinizi kontrollü bir ortamda geliştirmek ve test etmek için bu projeyi kullanmanızı önerir.

Özel proje oluşturmak için Teaching & Learning veya Plus lisansına sahip olan bir Google Workspace for Education alanına erişiminiz olmalıdır. Böyle bir alana erişiminiz yoksa bir Google Workspace for Education demo alan adı oluşturmak, alanı Plus lisansına yükseltmek ve Classroom eklentileri API'sine erişmesine izin vermek için şu adımları uygulayın:

  1. Geliştirici test alanı alma adımlarını tamamlayın.
  2. Demo alanında yönetici olarak oturumunuz açıkken yeni bir Google Cloud projesi oluşturun.

  3. Classroom API'yi etkinleştirin.

  4. Google Workspace Marketplace SDK'sını etkinleştirin.

  5. Marketplace SDK Uygulama Yapılandırması Uygulama Görünürlüğü'nü gizli olarak ayarlayın.

  6. Demo alan yükseltme istek formunu doldurup gönderin. Bu formu gönderdiğinizde Google, demo alanınızı on lisansla Google Workspace for Education Plus'a yükseltmesini ister ve Cloud projenizin Classroom eklentileri API'sine eklenmesine izin verir.

Herkese açık bir Google Cloud projesi oluşturma

Bu proje; yöneticiler, öğretmenler ve öğrencilerin erişebildiği eklenti uygulamasını temsil eder.

  1. Yeni bir Google Cloud projesi oluşturun ve Google Workspace Marketplace SDK'sını etkinleştirin. Marketplace SDK Uygulama Yapılandırması Uygulama Görünürlüğü'nü herkese açık ve liste dışı olarak ayarlayın. Dahili test sırasında kullanılan özel projeyi paylaşamaz veya dönüştüremezsiniz. Proje numarası yeni bir proje numarası olmalıdır.
  2. Projeyi eklenti izin verilenler listesine eklemek için Google Cloud proje kimliğini Google iş ortağınızla paylaşın. Bu işlem, projenin Classroom API'nin yeni eklenti özelliklerine erişmesini sağlar.
  3. Eklentiniz onaylandıktan sonra, öğretmenlerin mağazada bulabilmesi için "liste dışı" olan eklentiyi "listelendi" olarak değiştirir.

OAuth 2.0

Classroom API'ye erişim için kullanıcı verilerine erişim izni gerekir. Bunlar, oturum açmış kullanıcı için Google'ın OAuth kapsamlarına erişimi isteyerek ve daha sonra Google Classroom'a API çağrıları yapmak için kullanılabilecek bir jeton alarak elde edilir. Kapsamlar, Google Workspace Marketplace mağaza girişinde yapılandırılmalıdır. Böylece, alan yöneticileri eklentiyi yüklerse alan kullanıcıları adına izin verebilir.

Kullanılabilir tüm kapsamların ve bunların kullanımlarının ayrıntılı listesi için Google API'leri için OAuth Kapsamları sayfasına bakın. Genel OAuth yapılandırma bilgileri için Workspace dokümanlarındaki OAuth sayfasını yapılandırma bölümüne bakın.

Kullanıcı izinleri

Web uygulamanız aşağıdaki kapsamlardan en az birini istemelidir:

  • https://www.googleapis.com/auth/userinfo.email: Bu, bir uygulamanın kullanıcının e-posta adresini görüntülemesine olanak tanır.
  • https://www.googleapis.com/auth/userinfo.profile.

Bir kullanıcı eklentinizde bu kapsamlardan birini yetkilendirdikten sonra, bunlar login_hint sorgu parametresi ile tanımlanır. Bu parametre, bir iframe açıldığında web uygulamanızın URL'lerinden herhangi birine iletilir. Bir kullanıcı bu kapsamlardan birini yetkilendirmediyse bunun yerine hd ("barındırılan alan") parametresi, web uygulamanızın URL'lerine iletilir.

login_hint ve hd, Google ile Oturum Açma özelliğini kullanırken veya OAuth jetonu isterken isteğe bağlı olarak Google'a iletebileceğiniz standart OpenID Connect parametreleridir. Bu API'lerin amacı, son kullanıcı için yetkilendirme deneyimini daha sorunsuz hale getirmektir.

Classroom eklentileri kapsamları

Aşağıdaki kapsamlar Classroom eklentilerine özeldir:

  • https://www.googleapis.com/auth/classroom.addons.teacher tüm API yöntemlerine erişim sağlar.
  • https://www.googleapis.com/auth/classroom.addons.student API'sini kullanabilirsiniz.

Kullanıcının kimlik bilgilerini belirten geçerli bir OAuth erişim jetonu kullanılsa bile, API çağrıları ek gerekliliklerle karşılanır:

  • Tüm yöntemler, kullanıcının istekte courseId tarafından belirtilen derste öğretmen veya öğrenci olmasını gerektirir.
  • Ek oluşturma, güncelleme, silme ve not geri verme işlemleri için kullanıcının öğretmen olması gerekir.
  • Belirli bir Google Classroom yayınına yapılan çağrılar aşağıdaki kontrollerle kontrol edilir.
    • Bir eklentinin bir yayında en az bir eki varsa söz konusu eklenti şu isteklerde bulunabilir:
      • iframe başlatma doğrulaması
      • Ek okuma, güncelleme ve silme işlemleri
      • İlgili yayındaki güncellemelere not ver
    • Ek Keşfi iframe'i ilk açıldığında, eklentinin yayında henüz bir eki olmayabilir. Aşağıdakiler için istekte bulunmak üzere kullanılabilecek bir addOnToken sorgu parametresi sağlanır:
      • Yayının altında ek oluşturma (addOnToken gereklidir)
      • Başlatma doğrulaması (sağlanırsa addOnToken doğrulanır ve eklentinin yayında mevcut bir eki olmadığında gereklidir)

OAuth doğrulaması

Classroom eklentileri, Google kullanıcılarının verilerine erişmek için Google API'lerini kullanır.

Doğrulama süreci hakkında daha fazla bilgi edinmek için OAuth API doğrulamasıyla ilgili SSS sayfasına bakın.

Google Workspace Marketplace girişi

Bu erken erişim programı süresince Classroom eklentileri için Marketplace mağaza girişi oluştururken göz önünde bulundurulması gereken birkaç nokta vardır.

Google Workspace Marketplace SDK'sı yapılandırma bilgileri için Google Workspace Marketplace SDK'sını etkinleştirme ve yapılandırma ve Google Workspace Marketplace mağaza girişi oluşturma başlıklı makaleleri inceleyin.

Giriş yaparken dikkat edilmesi gereken noktalar

Herkese açık Google Cloud projenizin Marketplace SDK Store Listelemesi, uygulamanızın son kullanıcılara yönelik adını ve açıklamalarını belirtir. Bu ayrıntıları Uygulama Ayrıntıları altında birden fazla dilde sağlayabilirsiniz.

Girişlerinizde aşağıdaki kurallara uyun:

  • Uygulama Ayrıntıları altında:

    • Uygulama Adı'nda noktalama işareti kullanmaktan kaçının. Örneğin, "Şirketim: Eklentim" veya "Şirketim tarafından sunulan Eklenti" yerine "Şirketimin Eklentisi" kullanın.

    • Kısa Açıklama ve Ayrıntılı Açıklama, tam olarak aynı metni içermemelidir.

    • Fiyatlandırma alanı için bir değer seçtiğinizden emin olun. Bu alanda Ücretsiz, Ücretsiz denemeyle ücretli, Ücretsiz özelliklerle ücretli ve Ücretli fiyatlandırma seçenekleri bulunur. Marketplace girişinde maliyet tutarını belirtmeniz gerekmez.

    • Kategori alanı için bir değer seçtiğinizden emin olun. Akademik Kaynaklar veya Öğretmen ve Yönetici Araçları, Classroom eklentisi için iyi birer seçenek olabilir.

    • Daha fazla bilgi için Marketplace'in Uygulama ayrıntıları açıklamasında listelenen öğelere bakın.

Google'ın lisanslama ve faturalandırma hizmetleriyle entegrasyon

Google Workspace Marketplace uygulamalarınızın Google'ın lisanslama ve faturalandırma hizmetleriyle entegre olmasına izin vermek istiyorsanız Marketplace API sayfasını ziyaret edin.

Yükleme ayarları

Eklentiler, yönetici kurulumuna ek olarak tek tek yüklemeye izin verebilir. Bu sayfada, iki yükleme türü arasındaki bazı farklılıklar vurgulanmaktadır. Bu iki yükleme türü de tanıtılmamaktadır. Google Workspace Marketplace SDK'sı Uygulama Yapılandırması sayfasından ayrı ayrı yüklemeye izin verip vermemeyi seçebilirsiniz.

Yönetici yüklemesi

Yönetici yüklemeleri, yöneticinin bir alandaki tüm hesaplara veya belirli erişim gruplarına ya da kuruluş birimlerine eklenti eklemesine olanak tanır. Yönetici kurulumunu yalnızca alan yöneticisi gerçekleştirebilir. Yönetici, isteğe bağlı olarak alandaki tüm kullanıcılar adına tüm erişim kapsamlarına izin verebilir. Yönetici izin verirse kullanıcılardan herhangi bir erişim kapsamını kabul etmeleri istenmez.

Yönetici kurulumuyla ilgili göz önünde bulundurulması gereken bazı noktalar aşağıda verilmiştir.

  • Daha sıkı denetimler. Yöneticiler bir eklentiye hangi kullanıcıların erişebileceğini kısıtlayabilir.
  • Lisanslamayla uyumluluk. Uygulamanız lisans gerektiriyorsa, yüklemeleri bir yönetici aracılığıyla yönlendirmek, lisansların ilgili kurumla uygun şekilde dağıtılmasını ve kullanılabilmesini sağlamaya yardımcı olabilir.
  • Son kullanıcıların yükünü azaltır. Yönetici yüklemesi, öğretmenler ve öğrenciler için kurulum yükünü azaltır. Bu sayede, daha az tıklama ile daha az kafa karışıklığı fırsatı sunan daha sorunsuz bir kullanıcı deneyimi sağlayabilirsiniz.

Yönetici yüklemelerinin nasıl gerçekleştirileceği hakkında daha fazla bilgi edinmek için Marketplace uygulamalarını alanınıza yükleme başlıklı makaleyi inceleyin. Kuruluş birimleri ve erişim grupları hakkında daha fazla bilgi için ise Kuruluş yapısının işleyiş şekli başlıklı makaleyi inceleyin.

Bağımsız kurulum

Bağımsız yüklemeler kullanıcının kendi hesabına bir eklenti ekler. Yükleme sırasında kullanıcıdan eklentinin erişim kapsamlarını kabul etmesi istenir.

Bağımsız yükleme konusunda dikkat edilmesi gereken bazı noktalar aşağıda verilmiştir.

  • Benimseme sürecini kolaylaştırın. Daha fazla kullanıcı Google Workspace Marketplace'ten eklentinizi görüp yükleyebilir. Bireysel kuruluma izin vermek, daha fazla öğretmenin ürününüzü benimsemesini veya desteklemesini sağlayabilir.
  • Yönetici testi. Bir yönetici, bir eklentiyi daha geniş bir grup için onaylamadan veya yüklemeden önce test etmek ya da değerlendirmek amacıyla eklentiyi ayrı ayrı yükleyebilir.

Yöneticiler, kullanıcılar adına eklenti yüklemenin yanı sıra kullanıcıların ayrı ayrı yüklemeye izin veren eklentileri yüklemesine izin vermek için bir izin verilenler listesi de tutabilirler. İzin verilenler listesinde olmayan eklentilerse kullanıcılar, eklenti girişini Google Workspace Marketplace'te görmeye devam edebilir ancak eklentiyi yükleyemezler. Bunun yerine, alan yöneticisi tarafından eklentinin yüklenmesine izin verilmediğini belirten bir mesaj görürler. Bu davranış hakkında daha fazla bilgi edinmek için İzin verilenler listenizdeki Google Workspace Marketplace uygulamalarını yönetme başlıklı makaleye bakın.

Daha fazla bilgi için Google Workspace Marketplace yükleme ayarları dokümanlarını inceleyin.

Uygulama Entegrasyonu

Ek Kurulum URI'si alanına bir başlatma iframe'i URL'si girmelisiniz. Bu URL, Ek Keşfi iframe'i için iframe src değeri olarak kullanılır. Ek Keşfi iframe'i, öğretmenler tarafından ödevlerine eklenecek içerik veya etkinlikleri bulmak için kullanılır.

Eklentinizde eklere izin verilen tüm URI ön eklerini de belirtmeniz gerekir. Bu özellik, yetkisiz kaynaklardan gelen ekleri engelleyerek güvenliği artırır.

Bu alanlarla ilgili daha ayrıntılı bilgi için iframe'ler kılavuzu sayfasına bakın.

Test hesapları

Gizli eklentinizin doğru davranışını doğrulamak için demo alan adınızda test hesapları oluşturun. Öğrenci Çalışması İncelemesi iframe'inde öğrenciler arasında geçişin test edilmesi için iki öğrenci hesabına ihtiyaç vardır.

Önerilen test hesapları:

  • Tammy Öğretmeni, tammy.ogretmen@<demo alanınız>
  • Serkan Öğrenci, ahmet.öğrenci@<demo alanınız>
  • Sally Student, sally.student@<demo alanınız>

Yeni bir test hesabı oluşturmak için şu prosedürü uygulayın:

  1. Yönetici Konsolunuza giriş yapın.
  2. Kullanıcılar'a gidin.
  3. Yeni kullanıcı ekle'yi tıklayın (bkz. Şekil 1).
  4. Kullanıcının bilgilerini girin ve uygun rolleri atayın.

Yeni kullanıcı ekle&#39;yi tıklayın. Şekil 1. Yönetici Konsolu'ndaki Yeni kullanıcı ekle bağlantısının konumu.

Yeni bir test grubu oluşturmak için şu prosedürü uygulayın:

  1. Yönetici Konsolunuza giriş yapın.
  2. Gruplar'a gidin.
  3. Grup oluştur'u tıklayın (Şekil 2'ye bakın).
  4. Grubun üyelerini ve sahiplerini girin.

Grup oluştur&#39;u tıklayın Şekil 2. Yönetici konsolundaki Grup oluştur bağlantısının konumu.