Eklenti tasarımıyla ilgili bu kılavuzları uygulayarak kullanıcılarınızın genel deneyimini iyileştirin.
Genel en iyi uygulamalar
Geliştirdiğiniz tüm eklentiler için aşağıdaki en iyi uygulamaları kullanmanız önerilir.
Başlamadan önce eklenti sahipliğini belirleme
Eklentiler, belirli bir hesaba ait olması veya ortak drive'a yerleştirilmesi gereken Apps Komut Dosyası projeleriyle tanımlanır. Bir eklentiyi kodlamadan önce projeye hangi hesabın sahip olması gerektiğini ve hangi hesabın yayıncı olarak hareket edeceğini belirleyin. Ayrıca hangi hesapların ortak çalışan olarak hareket edeceğini belirleyin ve bu hesapların komut dosyası projesine ve ilişkili Google Cloud projesine erişebildiğinden emin olun.
Google Workspace'in kapsamını genişletin, kopyalamayın
Eklentiler, kapsamlarını genişlettikleri Google Workspace uygulamalarına yeni özellikler sağlamak veya karmaşık görevleri otomatikleştirmek için tasarlanmıştır. Yalnızca uygulamada bulunan işlevleri kopyalayan veya iş akışında önemli iyileştirmeler yapmayan eklentilerin yayınlanmak üzere eklenti incelemesini geçmesi olası değildir.
Kapsamları dar tutun
Kapsamlarınızı açıkça tanımlarken her zaman mümkün olan en az izin veren kapsam kümesini seçin. Örneğin, yalnızca okuma erişimine ihtiyacı varsa eklentinizin https://www.googleapis.com/auth/calendar kapsamıyla kullanıcının takvimine tam erişim istemeyin. Salt okuma erişimi için https://www.googleapis.com/auth/calendar.readonly kapsamını kullanın.
Kütüphanelere çok fazla güvenmeyin
Apps Komut Dosyası kitaplıklarını kullanmak, tüm Apps Komut Dosyası kodu tek bir komut dosyası projesinde yer alsaydı eklentinizin daha yavaş çalışmasına neden olabilir. Apps Komut Dosyası kitaplıkları eklentilerde çalışsa da bunları kullanırsanız performans düşüşleri yaşayabilirsiniz. Projenize gereksiz kitaplıklar eklemekten kaçının ve eklentinizin bu kitaplıklara olan bağımlılığını azaltmanın yollarını düşünün.
Yukarıda açıklanan gecikme yalnızca sunucu tarafı kitaplıkları olarak kullanılan Apps Komut Dosyası projeleri için geçerlidir. Bu gecikmeyle karşılaşmadan jQuery gibi istemci tarafı JavaScript kitaplıklarını serbestçe kullanabilirsiniz.
Google Workspace eklentileriyle ilgili en iyi uygulamalar
Aşağıdaki en iyi uygulamalar yalnızca Google Workspace eklentileri ve Card hizmetinin kullanımı için geçerlidir.
Yalnızca birkaç kart kullanma
Eklenti çok fazla kart kullanıyorsa gezinme yapılandırması karmaşık ve yönetilmesi zor hale gelir.
Gereğinden fazla kart oluşturma dürtüsüne karşı koyun.
Widget oluşturma işlevlerini kullanma
Card veya diğer karmaşık kullanıcı arayüzü nesnelerini oluşturan kod yazarken bu kodu kendi işlevine yerleştirmeyi düşünebilirsiniz. Bu oluşturma işlevi yalnızca nesneyi oluşturup döndürmelidir. Bu sayede, kullanıcı arayüzünün yenilenmesi gerektiğinde söz konusu nesneyi hızlıca yeniden oluşturabilirsiniz. Card service'teki oluşturucu sınıflarını kullandıktan sonra build()'ı aramayı unutmayın.
Kartları basit tutun
Belirli bir kartta çok fazla widget varsa ekranın büyük bir bölümünü kaplayabilir ve daha az kullanışlı hale gelebilir. Büyük kart bölümleri daraltılabilir kullanıcı arayüzü öğeleri olarak oluşturulurken bu, bilgileri kullanıcıdan gizler. Eklentinizi kolaylaştırmayı ve kullanıcının tam olarak ihtiyaç duyduğu şeyi sağlamayı hedefleyin.
Hata kartlarını kullanma
Hata koşulları için kartlar oluşturun. Eklentiniz hata veriyorsa hata bilgilerini ve mümkünse nasıl düzeltileceğine dair talimatları içeren bir kart göstermelidir. Örneğin, eklentiniz yetkilendirme başarısız olduğu için Google dışı bir hizmete bağlanamadıysa bunu belirten bir kart gösterin ve kullanıcıdan kullanılan hesap bilgilerini doğrulamayı isteyin.
Testler ve test mesajları yazma
Oluşturduğunuz tüm eklentileri kapsamlı bir şekilde test etmeniz gerekir. Test verilerini kullanarak kartlar ve widget'lar oluşturan test işlevleri oluşturun, ardından nesnelerin beklendiği gibi oluşturulduğunu doğrulayın.
İşlem geri çağırma işlevlerini kullanırken genellikle bir yanıt nesnesi oluşturmanız gerekir. Yanıtların doğru şekilde oluşturulduğunu doğrulamak için aşağıdaki gibi ifadeler kullanabilirsiniz:
Logger.log(response.printJson());
Oluşturduğunuz test işlevlerini Çalıştır menüsünü kullanarak doğrudan Apps Komut Dosyası Düzenleyicisi'nden çalıştırın. Çalışan bir eklentiniz olduğunda, test edebilmek için yayınlanmamış sürümü yüklediğinizden emin olun.
Eklentinin genişlettiği her ana makine uygulaması için uygun test verilerini kullanın. Örneğin, eklenti Gmail'i genişletiyorsa farklı ileti içerikleri verildiğinde eklentinin beklendiği gibi çalıştığından emin olabilmek için birkaç test e-postasına ve bunların ileti kimliklerine ihtiyacınız olabilir. Belirli bir iletinin ileti kimliğini, Gmail API
users.messages.list yöntemini kullanarak iletileri listeleyerek veya Apps Komut Dosyası'nın Gmail hizmetinden yararlanarak alabilirsiniz.
Takvim'de konferansla ilgili en iyi uygulamalar
Eklentiniz üçüncü taraf takvim konferansı seçeneklerini Google Takvim'e entegre ediyorsa aşağıdaki ek en iyi uygulamaları uygulayın:
onCreateFunction ışığınızı açık tutma
Manifest dosyanızda tanımladığınız her bir onCreateFunction, kullanıcı bu türde bir konferans çözümü oluşturmaya çalıştığında senkron olarak çağrılır. Bu işlevlerin, konferansı oluşturmak için yalnızca gereken minimum çalışmayı yaptığından emin olun. Bu işlevlerde çok fazla işlem yapmak, eklentinizin kullanıcı deneyimini yavaşlatabilir.
Konferans verileri için uygun ConferenceData alanlarını kullanın.
ConferenceData
nesneleri oluştururken bunları konferansla ilgili ayrıntılarla (erişim kodları, telefon numaraları, PIN'ler, URI'ler vb.) doldurabilirsiniz. Bu bilgiler için ilgili EntryPoint alanını kullandığınızdan emin olun. Bu ayrıntıları ConferenceData notlar alanına girmeyin.
Konferans ayrıntılarını Takvim etkinliğine eklemeyin.
Eklentinizin, oluşturulan üçüncü taraf konferanslarıyla ilgili bilgileri Takvim etkinliği açıklamasına eklemesi gerekmez. Takvim, gerektiğinde bunu otomatik olarak yapar.