Eklenti tasarımıyla ilgili bu kılavuzları izleyerek 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ı izlemenizi öneririz.
Başlamadan önce eklenti sahipliğini belirleyin
Eklentiler, belirli bir hesaba ait olması veya bir ortak Drive'a yerleştirilmiş olması gereken Apps Komut Dosyası projeleri tarafından tanımlanır. Bir eklentiyi kodlamadan önce, projeye hangi hesabın sahip olması gerektiğini ve hangi hesabın yayıncısı olarak görev yapacağını belirleyin. Ayrıca, ortak çalışan olarak kullanılacak hesapları belirleyin ve bu hesapların, komut dosyası projesine ve ilişkili Cloud platform projesine erişimi olduğundan emin olun.
Google Workspace'in kapsamını genişletip çoğaltmayın
Eklentilerin, genişlettikleri Google Workspace uygulamalarına yeni özellikler sağlaması veya karmaşık görevleri otomatikleştirmeleri amaçlanmıştır. Yalnızca uygulamanın içinde bulunan işlevleri çoğaltan veya bir iş akışında aynı önemli iyileştirmeleri yapmayan eklentilerin, yayınlanmak üzere eklenti incelemesinden geçmeleri pek olası değildir.
Kapsamları dar tutun
Kapsamlarınızı açık bir şekilde tanımlarken her zaman mümkün olan en dar kapsamlı kapsam grubunu seçin. Örneğin, eklenti isteğinizin yalnızca okuma erişimine ihtiyacı varsa https://www.googleapis.com/auth/calendar kapsamıyla kullanıcının Takvimine tam erişimi vermeyin. Salt okuma erişimi için https://www.googleapis.com/auth/calendar.readonly kapsamını kullanın.
Kitaplıklara çok fazla güvenmekten kaçının
Apps Komut Dosyası kitaplıklarını kullanmak, eklentinizin, Apps Komut Dosyası kodunun tamamı tek bir komut dosyası projesinde yer aldığında, gerekenden daha yavaş çalışmasına neden olabilir. Apps Komut Dosyası kitaplıkları eklentilerde çalışır ancak bunları kullanırsanız performans düşüşleriyle karşılaşabilirsiniz. Projenize gereksiz kitaplıklar eklemekten kaçının ve eklentinizin bu kitaplıklara bağımlılığını azaltmanın yollarını düşünün.
Yukarıda açıklanan gecikme, yalnızca sunucu tarafı kitaplık olarak kullanılan Apps Komut Dosyası projeleri için geçerlidir. Bu gecikmeyle karşılaşmadan jQuery gibi istemci taraflı JavaScript kitaplıklarını serbest bir şekilde kullanabilirsiniz.
Google Workspace eklentisi için en iyi uygulamalar
Aşağıdaki en iyi uygulamalar yalnızca Google Workspace Eklentileri ve Kart hizmetinin kullanımı için geçerlidir.
Yalnızca birkaç kart kullanma
Eklenti çok fazla kart kullanırsa gezinme yapılandırması karmaşık hale gelir ve yönetimi zorlaşır.
Gereğinden fazla kart oluşturma dürtüsünden kaçının.
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üşünün.
Bu oluşturma işlevi yalnızca nesneyi derlemeli ve döndürmelidir. Böylece, kullanıcı arayüzünün yenilenmesi gerektiğinde bu nesneyi hızlıca yeniden oluşturabilirsiniz. Kart hizmetindeki oluşturucu sınıflarını kullandıktan sonra build() yöntemini aramayı unutmayın.
Kartları basit tutun
Belirli bir kartta çok fazla widget varsa ekranın çok büyük bir kısmı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şturulsa da bu özellik, bilgileri kullanıcıdan gizler. Eklentinizi basitleştirmeyi ve kullanıcının tam olarak ihtiyaç duyduğu şeyi sağlamayı,
Hata kartlarını kullanın
Hata koşulları için kartlar oluşturun. Eklentiniz hata oluşturursa hata bilgilerinin ve mümkünse hatanın nasıl düzeltileceğine ilişkin talimatların bulunduğu bir kart görüntülemelidir. Örneğin, eklentiniz yetkilendirme başarısız olduğu için Google dışı bir hizmete bağlanamadıysa bunu belirten bir kart görüntüleyin ve kullanıcıdan kullanılan hesap bilgilerini doğrulamasını isteyin.
Testler ve test mesajları yazma
Oluşturduğunuz tüm eklentileri ayrıntılı bir şekilde test etmelisiniz. Test verilerini kullanarak kartlar ve widget'lar oluşturan test işlevleri oluşturun ve 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());
Çalıştır menüsünü kullanarak doğrudan Apps Komut Dosyası düzenleyicisinden oluşturduğunuz test işlevlerini ç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şletirse muhtemelen birkaç test e-postasına ve bunların ileti kimliklerine ihtiyacınız olur. Böylece, farklı ileti içeriği verildiğinde eklentinin beklendiği gibi çalıştığından emin olabilirsiniz. Belirli bir mesajın ileti kimliğini, Gmail API Users.messages.list yöntemini kullanarak veya Apps Komut Dosyası'nın Gmail hizmetinden yararlanarak mesajları listeleyerek alabilirsiniz.
Takvim konferansı için en iyi uygulamalar
Eklentiniz, Google Takvim'e üçüncü taraf takvim konferansı seçeneklerini entegre ediyorsa aşağıdaki en iyi uygulamaları izleyin:
onCreateFunction cihazınızı ışığınızı tutun
Bir kullanıcı bu türde bir konferans çözümü oluşturmaya çalıştığında manifest dosyanızda tanımladığınız her onCreateFunction eşzamanlı olarak çağrılır. Bu fonksiyonların konferansı oluşturmak için yalnızca
minimum düzeyde gerekli işleri yaptığından emin olun. Bu işlevlerde çok fazla yapılması, eklentiniz için yavaş bir kullanıcı deneyimine neden olabilir.
Konferans verileri için uygun ConferenceData alanlarını kullanın
ConferenceData nesneleri oluştururken bunlara konferansla ilgili ayrıntılar (erişim kodları, telefon numaraları, pin'ler, URI'ler vb.) ekleyebilirsiniz. Bu bilgi için karşılık gelen EntryPoint alanını kullandığınızdan emin olun. Bu ayrıntıları, ConferenceData notları alanına yerleştirmeyin.
Google Takvim etkinliğine konferans görüşmesi ayrıntıları eklemeyin.
Eklentinizin, oluşturulan üçüncü taraf konferanslarla ilgili bilgileri Google Takvim etkinlik açıklamasına eklemesine gerek yoktur. Google Takvim gerektiğinde bunu otomatik olarak yapar.