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 uygulamalardan yararlanmanız önerilir.
Başlamadan önce eklenti sahipliğini belirleyin
eklentiler, belirli bir hesaba ait olması veya ortak Drive'a yerleştirilmesi gereken Apps Komut Dosyası projeleri tarafından tanımlanır. Eklenti kodlamadan önce projenin sahibinin ve yayıncısının hangi hesap olması gerektiğini belirleyin. Ayrıca hangi hesapların ortak çalışan olarak görev yapacağını belirleyin ve bu hesapların komut dosyası projesine ve ilişkili Cloud Platform projesine erişebildiğinden emin olun.
Google Workspace'i kopyalamayın, genişletin
Eklentiler, genişlettikleri Google Workspace uygulamalarına yeni özellikler sunmak veya karmaşık görevleri otomatikleştirmek için tasarlanmıştır. Uygulamadaki işlevleri yalnızca kopyalayan veya iş akışında önemli iyileştirmeler yapmayan eklentilerin yayınlanmak üzere eklenti incelemesinden geçme olasılığı düşüktür.
Kapsamları dar tutun
Kapsamlarınızı açıkça tanımlarken her zaman mümkün olan en az izin veren kapsam grubunu seçin. Örneğin, yalnızca okuma erişimine ihtiyacı varsa eklentinizin https://www.googleapis.com/auth/calendar kapsamıyla kullanıcının Takvim'ine tam erişim isteğinde bulunmasına izin 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 tüm Apps Komut Dosyası kodunun tek bir komut dosyası projesinde yer alması durumunda olduğundan daha yavaş çalışmasına neden olabilir. Apps Script kitaplıkları eklentilerde çalışsa da bunları kullanırsanız performansta düşüşler görebilirsiniz. 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. jQuery gibi istemci tarafı JavaScript kitaplıklarını bu gecikmeye takılmadan özgürce kullanabilirsiniz.
Google Workspace eklentileri ile ilgili en iyi uygulamalar
Aşağıdaki en iyi uygulamalar yalnızca Google Workspace eklentileri ve Kart hizmeti'nin kullanımı için geçerlidir.
Yalnızca birkaç kart kullanın
Eklenti çok fazla kart kullanıyorsa gezinme yapılandırması karmaşık hale gelir ve yönetilmesi zorlaşır.
Gerekenden 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 koymayı düşünebilirsiniz.
Bu oluşturma işlevi, 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. Kart hizmetindeki oluşturucu sınıflarını kullandıktan sonra build() işlevini çağırmayı unutmayın.
Kartları basit tutun
Belirli bir kartta çok fazla widget varsa ekranın büyük bir kısmını kaplayarak daha az kullanışlı hale gelebilir. Büyük kart bölümleri, daraltılabilir kullanıcı arayüzü öğeleri olarak oluşturulur. Bu, bilgileri kullanıcıdan gizler. Eklentinizi basitleştirmeyi ve kullanıcının tam olarak ihtiyaç duyduğu şeyi, fazlasını değil, sunmayı hedefleyin.
Hata kartlarını kullanma
Hata koşulları için kartlar oluşturun. Eklentiniz hata oluşturuyorsa hata bilgilerini ve mümkünse hatayı düzeltme talimatlarını içeren bir kart gösterilir. Ö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ğrulamasını isteyin.
Testler ve test mesajları yazma
Oluşturduğunuz tüm eklentileri ayrıntılı olarak test etmeniz gerekir. Test verileri kullanarak kart ve widget 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());
Oluşturduğunuz test işlevlerini doğrudan Apps Script düzenleyicisinden Çalıştır menüsünü kullanarak çalıştırın. Çalışan bir eklentiniz olduğunda, test edebilmek için yayınlanmamış sürümü yüklemeyi unutmayın.
Eklentinin genişlettiği her ana makine uygulamasına uygun test verilerini kullanın. Örneğin, eklenti Gmail'i genişletiyorsa farklı ileti içerikleri kullanıldığında eklentinin beklendiği gibi çalıştığından emin olmak için birkaç test e-postasına ve bunların ileti kimliklerine ihtiyacınız olabilir. Gmail API Users.messages.list yöntemini kullanarak veya Apps Komut Dosyası'nın Gmail hizmetini kullanarak iletileri listeleyerek belirli bir ileti için ileti kimliğini alabilirsiniz.
Takvimde konferans görüşmesi yapmayla ilgili en iyi uygulamalar
Eklentiniz Google Takvim'e üçüncü taraf takvim konferansı seçeneklerini entegre ediyorsa aşağıdaki en iyi uygulamaları uygulayın:
onCreateFunction ışığını açık tutun
Manifestinizde tanımladığınız her onCreateFunction, bir kullanıcı bu tür bir konferans çözümü oluşturmaya çalıştığında eşzamanlı olarak çağrılır. Bu işlevlerin yalnızca konferansı oluşturmak için gereken minimum işlemi yaptığından emin olun. Bu işlevlerde çok fazla işlem yapmak, eklentinizin yavaş bir kullanıcı deneyimi sunmasına neden olabilir.
Konferans verileri için uygun ConferenceData alanlarını kullanın
ConferenceData objeleri oluşturduğunuzda 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ı ConferenceDatanotlar alanına yerleştirmeyin.
Google Takvim etkinliğine konferans görüşmesi ayrıntılarını ekleme
Eklentinizin, oluşturulan üçüncü taraf konferansları hakkındaki bilgileri Google Takvim etkinlik açıklamasına eklemesi gerekmez. Google Takvim, gerektiğinde bunu otomatik olarak yapar.