Bu sayfada, içerik oluşturma ve yönetme hakkında Classroom eklentileri için Google Cloud projelerini yapılandırma. OAuth 2.0 aracılığıyla Google Tek Oturum Açma özelliğini uygulamak için Google Cloud projeleri kullanılır (Google TOA) kullanarak eklentiniz tarafından yapılan istekleri yetkilendirmek ve Google Workspace Marketplace'te eklenti girişi mağaza.
Şu adreste eklenti yayınlama hakkında daha fazla genel bilgi için: Marketplace'te Uygulama yayınlama başlıklı makaleyi inceleyin.
Google Cloud projesi oluşturma
Oluşturulacak iki tür proje vardır: gizli proje: Geliştirme ve son kullanıcıların erişebileceği herkese açık bir proje. "Kamu" ve "gizli" Etiketler, uygulamanızın kullanılabilirliği Google Workspace Marketplace; özel bir pazar yeri Uygulama yalnızca uygulamanın gerçekleştirildiği etki alanındaki kullanıcılar tarafından yüklenebilir. herkese açık bir Marketplace uygulaması olduğunda, tüm Google Workspace alanlarında kullanılabilir. Bunlar iki ayrı uygulamalar hem herkese açık hem de gizli olamaz. Herkese açık uygulamalar Pazar yerinde yayınlanmadan önce incelenmeli ve onaylanmalıdır.
Google Cloud projesi oluşturma ile ilgili genel bilgiler için Bir Google Cloud projesi.
Herkese açık bir Google Cloud projesi oluşturma
Bu proje, yöneticileri, öğretmenleri ve öğrencileri kapsar. Kamuya açık bir proje gözden geçirilmelidir kullanıma sunulmadan önce Google Workspace Marketplace ekibi tarafından yüklendi.
Üretim alanınızda yeni bir Google Cloud projesi oluşturun.
Cloud projenizde Classroom API'yi etkinleştirin.
Cloud projenizde Google Workspace Marketplace SDK'sını etkinleştirin.
Pazar Yeri SDK'sını ayarlama Uygulama Yapılandırması Uygulama Görünürlüğü'nü Herkese Açık olarak değiştirin ve Liste dışı kutusunu işaretleyin.
Marketplace SDK'sındaki zorunlu alanları doldurun Mağaza Girişi sayfasına gidin ve YAYINLA.
Uygulamanız Google Workspace Marketplace ekibi tarafından incelenecektir. Onlar , pazar yeri SDK'sı. Uygulama onaylandıktan sonra Liste dışı kutusunu da kullanabilirsiniz. Böylece öğretmenler ve yöneticiler bu öğeyi Pazar yeri.
Ö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 dosyaya erişemez ancak ve kurulumdan önce onaylanması gerekmez. Bu nedenle Google, kontrollü bir ortamda eklentinizi geliştirip test etmek için bu projeyi kullanabilirsiniz.
Teaching &Service olan bir Google Workspace for Education alanına erişiminiz olması Learning veya Plus özel proje oluşturma lisansına sahip olursunuz. Böyle bir web sitesine zaten erişiminiz yoksa Google Workspace for Education demo alanı oluşturmak için aşağıdaki adımları uygulayın, Ayrıca lisanslama ve Classroom eklentileri API'sine erişmesine izin verme:
- Geliştirici test alanı alma adımlarını tamamlayın.
Demo alanında yönetici olarak oturum açmışken yeni bir Google Cloud projesi.
Google Cloud projesi oluşturma
Google Cloud Console'a erişemiyor veya Cloud projeleri hakkında bilgi edinmek için Yönetici konsolu:
- Hesap ayarları > Yaşa bağlı erişim ayarları sayfası ve "Bu gruptaki veya kuruluş birimindeki tüm kullanıcılar 18 yaşında ya da daha eski.
- Uygulamalar > Ek Google hizmetleri:
- Google Cloud Platform herkes için ETKİN.
- Proje Oluşturma Ayarları Kullanıcıların proje oluşturmasına izin ver'dir.
- Cloud Shell Erişim Ayarları, Cloud Shell'e erişime izin ver şeklindedir.
Demo alanı yeni sürüme geçirme istek formunu doldurup gönderin. Bu gönderiliyor Google'ın, demo alan adınızı 10 erişimli Google Workspace for Education Plus sürümüne geçirmesini lisans verir ve Cloud projenizin Classroom eklentileri API'si.
Yükseltme ve izin verilenler listesi işlemleri tamamlandığında e-posta alacaksınız belirir. Yönetici Konsolu'nda oturum açın. Şunun altında: Dizin > Kullanıcılar, test öğretmeni hesaplarınızı oluşturun veya seçin. Her birinde öğretmenin Lisansları'nda, Google Workspace for Education Plus'ın Atandığını doğrulayın.
Cloud projenizde Classroom API'yi etkinleştirin.
Cloud projenizde Google Workspace Marketplace SDK'sını etkinleştirin.
Pazar Yeri SDK'sını ayarlama Uygulama Yapılandırması Uygulama görünürlüğü ayarı gizli olarak değiştirildi.
Marketplace SDK'sındaki zorunlu alanları doldurun Mağaza Girişi sayfasına gidin ve YAYINLA. Uygulama girişi yayınlandıktan sonra, alandaki kullanıcılar Uygulamayı Google Workspace Marketplace'te bulup yükleyebilir veya Mağaza Girişi sayfasında gösterilen Uygulama URL'sini ziyaret edin.
OAuth 2.0
Classroom API'ye erişim için kullanıcı verilerine erişim izni gerekir. Bu Google'ın OAuth kapsamlarına erişmesini isteyerek elde edilen verileri, almak ve daha sonra Google Classroom Kapsamlar Google Workspace Marketplace mağaza girişini kullanarak alan yöneticisinin Eklentiyi yükleyen alan kullanıcıları adına izin verebilir.
Classroom kapsamları Hassas olduğundan OAuth isteğinde bulunmanız gerekir doğrulayın. Aksi takdirde, kullanıcılar bir uyarı görür uygulamanın doğrulanmamış olduğunu ve yalnızca az sayıda kullanıcının olduğunu bildiren bir mesaj ürününüze erişebilecek. İnceleme dizisine genel bakışı inceleyin. inceleyin.
Mevcut tüm API'lerin ayrıntılı listesi için Google API'leri için OAuth Kapsamları sayfasına bakın. ve kullanım alanlarını ele aldık. Workspace dokümanlarındaki OAuth sayfasını yapılandırma başlıklı makaleyi inceleyin. bakın.
Kullanıcı izinleri
Web uygulamanız aşağıdaki kapsamlardan en az birini istemelidir:
https://www.googleapis.com/auth/userinfo.email
, bir Kullanıcının e-posta adresini görüntülemesi için bir uygulama oluşturur.https://www.googleapis.com/auth/userinfo.profile
, bir portre, ad ve soyadı gibi kişisel bilgileri görme olanağı adlar ve kullanıcının herkese açık olarak paylaştığı diğer kişisel bilgiler kullanılabilir.
Bir kullanıcı eklentinizde bu kapsamlardan birini yetkilendirdikten sonra
login_hint
sorgu parametresiyle tanımlanır. Bu parametre,
web uygulamanızın URL'lerinin bir listesini görüntüler. Kullanıcı yetkilendirme yapmadıysa
bu kapsamların birinde login_hint
gönderilmez.
login_hint
, isteğe bağlı olarak
Google ile Oturum Açma kullanılırken veya OAuth jetonu istendiğinde Google'a iletilir. Google
, son kullanıcı için daha sorunsuz bir yetkilendirme deneyimi sağlamak amacıyla tasarlanmıştır.
Classroom eklentisi kapsamları
Aşağıdaki kapsamlar Classroom eklentilerine özeldir:
https://www.googleapis.com/auth/classroom.addons.teacher
; bu da izin verilen tüm API yöntemlerine erişebilir.https://www.googleapis.com/auth/classroom.addons.student
; bu da izin verilen doğrulama ve ek okuma işlemlerini başlatma erişimi.
Kullanıcının kimlik bilgilerini belirten geçerli bir OAuth erişim jetonuyla bile, API çağrıları ek şartlara tabi olması gerekir:
- Tüm yöntemler için kullanıcının derste öğretmen veya öğrenci olması gerekir
istekteki
courseId
ile belirtilir. - Ek oluşturma, güncelleme, silme ve notların geri verilmesi için kullanıcının isteği gerekir öğretmen olmalısınız.
- Belirli bir Google Classroom yayınına yönelik aramalar,
kontrol eder.
- Bir eklentinin yayında en az bir eki varsa
şunun için istekte bulun:
- iframe başlatma doğrulaması
- Ek okuma, güncelleme ve silme işlemleri
- Bu yayındaki güncellemelere not verin
- Attach Discovery iframe'i ilk kez açıldığında eklenti
henüz yayında ek yok.
addOnToken
sorgu parametresi aşağıdaki talepleri göndermek için kullanılabilecek şekilde sağlanır:- Gönderinin altında ek oluşturma (
addOnToken
gereklidir) - Doğrulamayı başlat (
addOnToken
sağlanmışsa doğrulanır ve eklentisinde mevcut bir ek yoksa yayın)
- Gönderinin altında ek oluşturma (
- Bir eklentinin yayında en az bir eki varsa
şunun için istekte bulun:
OAuth doğrulaması
Classroom eklentileri, Google kullanıcılarının uygulamanıza erişmek için Google API'lerini kullanır. verileri.
Daha fazla bilgi için OAuth API doğrulaması hakkında SSS sayfasına göz atın. doğrulama sürecidir.
Google Workspace Marketplace girişi
Google Workspace Marketplace SDK'sının genel yapılandırma bilgileri için şu adresi ziyaret edin: Google Workspace Marketplace SDK'sını etkinleştirin, yapılandırın ve Google Workspace Marketplace mağaza girişi oluşturun.
Girişle ilgili dikkat edilmesi gereken noktalar
Herkese açık Google Cloud projenizin Marketplace SDK Store'u Listings, uygulamanızın adını belirtir ve açıklamalarına dikkat edin. Bu ayrıntıları birden fazla dillerini Uygulama Ayrıntıları bölümünde bulabilirsiniz.
Girişlerinizde şu kurallara uyun:
Uygulama Ayrıntıları altında:
Uygulama Adı'nda noktalama işaretleri kullanmaktan kaçının. Örneğin, "Eklentim Şirketim tarafından" yerine "Şirketim: Eklentim" yerine veya "Eklentim, Şirket".
Kısa Açıklama ve Ayrıntılı Açıklama şunları içermemelidir görürsünüz.
+ Fiyatlandırma alanı için bir değer seçtiğinizden emin olun. Bu alan, Ücretsiz, Ücretsiz denemeyle ödendi, Şununla ödendi: ücretsiz özellikler ve Ücretli fiyatlandırma. Maliyeti belirtmeniz gerekmez tutarını görebilirsiniz.
Kategori alanı için bir değer seçtiğinizden emin olun. Akademik Kaynaklar veya Öğretmen ve Yönetici Araçları, Classroom eklentisi.
Marketplace'in Uygulamasında listelenen öğeleri görün ayrıntılar açıklamasına göz atın.
Grafik Öğeleri altında:
Sağlanan grafik öğeleri belirsiz değil ve belirtilen boyutları karşılamıyor Google Workspace Marketplace standartlarında
Sağlanan ekran görüntüleri eklentinizin doğru temsilleridir. deneyim.
Destek Bağlantıları bölümünde:
- Uygulamanızın Şartlar ve Koşullar'a Hizmet.
Google API Markalama kurallarına uyduğunuzdan emin olun. izin verilen adları ve açıklamaları kapsar.
Girişinizde herhangi bir Google ürününe atıfta bulunuyorsanız, bu ürünün adını biçimi Ticari Markalar Listesi'nde belirtilmiştir. Lütfen belirtilmişse ticari marka (TM) simgesi; "Google DokümanlarTM" değil Dokümanlar".
Google'ın lisanslama ve faturalandırma hizmetleriyle entegrasyon
Google Workspace Marketplace uygulamalarınızı izin vermek istiyorsanız Google'ın lisanslama ve faturalandırma hizmetleriyle entegrasyon için adresini ziyaret edin. Marketplace API'si hakkında daha fazla bilgi edinin.
Yükleme ayarları
Eklentiler, yöneticiye ek olarak bağımsız yüklemelere de izin verebilir teşekkür ederiz. Bu sayfada, iki yükleme arasındaki bazı farklar vurgulanmaktadır. bulunur. iki yükleme türünü birden tanıtmak amaçlanmamıştır. Şunları seçebilirsiniz: Google Workspace Marketplace SDK'sında bireysel yüklemeye izin verilip verilmeyeceği Uygulama Yapılandırması sayfasını ziyaret edin.
Yönetici haklarıyla yükleme
Yönetici yüklemeleri; bir yöneticinin veya belirli erişim gruplarına ya da kuruluş birimlerine otomatik olarak dahil edilir. Yalnızca alan yöneticisi yönetici yüklemesi gerçekleştirebilir. İlgili içeriği oluşturmak için kullanılan yönetici, isteğe bağlı olarak tüm kullanıcılar adına tüm erişim kapsamlarına izin verebilir Alanda Kullanıcılardan herhangi bir erişim kapsamına izin vermeleri bu işlemi yapmayı tercih ettiğinde.
Aşağıda, yönetici kurulumuyla ilgili dikkate alınması gereken bazı noktalar yer almaktadır.
- Daha sıkı kontroller. Yöneticiler, ekleyebilirsiniz.
- Lisanslama ile uyumluluk. Uygulamanız için lisans gerekiyorsa kanallarına ait yüklemelerin bir yönetici aracılığıyla gerçekleştirilmesi, lisansların dağıtım ve kullanımına dair bilgilerin, ilgili kurumunuzla ilgili bilgi edineceksiniz.
- Son kullanıcıların yükünü azaltın. Bir yönetici yüklemesi, uygulama yükleme ve öğrencilerin yükünü hafifletir. Bu sayede daha sorunsuz bir kullanıcı deneyimi sağlayabilirsiniz. daha az tıklama ve daha az kafa karışıklığı yapma olanağı sağlar.
Nasıl yapacağınız hakkında daha fazla bilgi edinmek için Marketplace uygulamalarını alanınıza yükleme başlıklı makaleyi inceleyin. yönetici yüklemeleri gerçekleştirme ve Kuruluş yapısının işleyiş şekli kuruluş birimleri ve erişim grupları hakkında daha fazla bilgi edinin.
Bireysel kurulum
Tek tek yüklemeler, kullanıcının kendi hesabına bir eklenti ekler. Kullanıcı yükleme sırasında eklentinin erişim kapsamlarına izin vermeniz istenir.
Aşağıda, tek tek yüklemeyle ilgili olarak dikkate alınması gereken bazı noktalar yer almaktadır.
- Benimseme sürecini kolaylaştırın. Eklentinizi şuradan daha fazla kullanıcı görebilir ve yükleyebilir: Google Workspace Marketplace. Tek tek yüklemeye izin verdiğinizde veya destekçisi olmaya teşvik edebilirsiniz.
- Yönetici tarafından test. Bir yönetici, onaylamadan ya da yüklemeden önce test etmek veya değerlendirmek için fark ettim.
Yöneticiler, kullanıcılar adına eklenti yüklemenin yanı sıra, kullanıcıların bağımsız olarak izin verilen eklentiler yüklemesine izin vermek için bir izin verilenler listesi bulundurmak teşekkür ederiz. İzin verilenler listesinde bir eklenti olmasa da kullanıcılar eklentisinin Google Workspace Marketplace'te listelenmesi ancak eklenti bunun yerine eklentinin şu ana kadar yüklenmediğini alan yöneticisi tarafından yüklenmesine izin verildiği anlamına gelir. Google Workspace'i yönetme başlıklı makaleyi inceleyin. Bu davranış hakkında daha fazla bilgi edinmek için izin verilenler listenizdeki Marketplace uygulamalarını inceleyin.
Aşağıdakiler için Google Workspace Marketplace yükleme ayarları dokümanlarına bakın: daha fazla bilgi edinin.
Uygulama Entegrasyonu
Ek Kurulumu URI'si alanında bir başlatma iframe'i URL'si sağlamanız gerekir. Bu
URL, Ek Discovery iframe'i için iframe src
değeri olarak kullanılır. İlgili içeriği oluşturmak için kullanılan
Attach Discovery iframe'i, öğretmenler tarafından hedeflenecek içerik veya etkinlikleri bulmak için kullanılır
ekleyebilirler.
Ayrıca, eklere izin verilen tüm URI ön eklerini belirtmeniz gerekir kullanabilirsiniz. Bu özellik, eklerin yetkisiz olabilir.
Bu alanlarla ilgili daha ayrıntılı bilgi için iframe'ler kılavuzu sayfasına bakın.
Test hesapları
Demo alanınızda doğru davranışı onaylamak için test hesapları oluşturun. ekleyebilirsiniz. Cihazlar arasında geçiş yapmayı test etmek için iki öğrenci hesabı gereklidir öğrenci çalışmaları ve öğrenciler için
Önerilen test hesapları:
- Tammy Öğretmen, tammy.ogretmen@<demo alanınız>
- Selim Öğrenci, sam.student@<demo alanınız>
- Sally Öğrenci, sally.student@<demo alanınız>
Yeni bir test hesabı oluşturmak için şu prosedürü izleyin:
- Yönetici konsolunuza giriş yapın.
- Kullanıcılar'a gidin.
- Yeni kullanıcı ekle'yi tıklayın (bkz. Şekil 1).
- Kullanıcının bilgilerini girin ve uygun rolleri atayın.
Şekil 1. Yeni kullanıcı ekle bağlantısının
Yönetici konsolu'nda oturum açın.
Yeni bir test grubu oluşturmak için şu prosedürü izleyin:
- Yönetici konsolunuza giriş yapın.
- Gruplar'a gidin.
- Grup oluştur'u tıklayın (bkz. Şekil 2).
- Grubun üyelerini ve sahiplerini girin.
Şekil 2. Grup oluştur bağlantısının
Yönetici konsolu'nda oturum açın.