Google Workspace eklentileri oluşturma

Bu sayfada, Google Workspace eklentilerinin nasıl tasarlanacağı, oluşturulacağı ve yayınlanacağı hakkında genel bilgiler verilmektedir. Bu genel bakışta aşağıdaki adımlar açıklanmaktadır:

  1. Eklentinizin kullanıcıların kullanımına sunulmasını istediğiniz Google Workspace uygulamalarını belirleyin.
  2. Eklentinizin projelerini oluşturun, bir sahip ve ortak çalışan seçin.
  3. Eklentinizin görünümünü ve davranışını tasarlayıp yapılandırın.
  4. Eklentiyi derleyin.
  5. Eklentinizin OAuth kapsamlarını doğrulayın.
  6. Eklentiyi bir veya daha fazla Google Workspace uygulamasında test edin.
  7. Eklentiyi yayınlayın.

Google Workspace ana makine uygulamalarını seçme

Google Workspace eklentilerini aşağıdaki Google Workspace ana makine uygulamalarında görünecek şekilde yapılandırabilirsiniz:

  • Gmail
  • Google Takvim
  • Google Chat (Geliştirici Önizlemesi)
  • Google Dokümanlar
  • Google Drive
  • Google E-Tablolar
  • Google Slaytlar

Google Workspace uygulamaları için nasıl geliştirme yapacağınız hakkında bilgi edinmek istiyorsanız Google Workspace kullanıcı arayüzünü genişletme başlıklı makaleyi inceleyin.

Eklentinizin projelerini oluşturun, sahip ve ortak çalışan seçin

Eklentinizi Apps Komut Dosyası'nda oluşturursanız hem Apps Komut Dosyası projesi hem de Google Cloud projesi oluşturursunuz. Eklentinizi Apps Komut Dosyası dışında bir dilde oluşturursanız yalnızca bir Google Cloud projesi oluşturmanız gerekir.

Eklenti geliştirmeye başlamadan önce, projelerin sahibi olacak tek bir kullanıcı hesabı seçin ve diğer hangi hesapların ortak çalışan olacağını belirleyin. Proje sahibi, proje dosyalarını ve ilişkili ayarları oluşturup yönetirken ortak çalışanlar kodlama ve test konusunda yardımcı olabilir.

Apps Komut Dosyası projeleri

Eklentinizin Apps Komut Dosyası proje dosyalarını, tek bir hesabın tek başına sahip olmayacağı şekilde ortak bir Drive'da oluşturabilirsiniz. Eklenti komut dosyası dosyanızı ortak bir Drive'a yerleştirdiğinizde, birden fazla ortak çalışanın komut dosyası projesine erişimi olur.

Bir eklentiyi yayınladığınızda tek bir kullanıcı hesabı yayıncı olarak çalışır. Yayınlama hesabının komut dosyası projesine düzenleme erişimi olmalıdır ancak hesabın sahibi olması gerekmez.

Apps Komut Dosyası projesi oluşturmak için Komut dosyası projeleri başlıklı makaleyi inceleyin.

Google Cloud projeleri

Eklentinin Cloud projesine ortak çalışanlar eklemenizi öneririz. Bu sayede, ekibinizdeki bir kullanıcı eklentinin Cloud ayarlarına her zaman erişebilir.

Google Cloud projesi oluşturmak için Google Cloud projesi oluşturma başlıklı makaleyi inceleyin.

Eklentinizin görünümünü ve davranışını tasarlama ve yapılandırma

Eklentinizi oluşturmaya başlamadan önce nasıl görünmesini ve nasıl davranmasını istediğinize karar verin. Eklentinin hangi kullanım alanlarına çözüm sunmaya çalışması gerektiğini düşünün. Öncelikle çalışmaya başlamak için basit bir tasarımla başlayın, ardından daha fazla ayrıntı ekleyin.

Eklenti kullanıcı deneyiminizin nasıl tasarlanacağıyla ilgili yönergeler için Google Workspace eklentisi stil kılavuzuna bakın.

Eklenti manifestini yapılandırma

Eklentinizi tasarladıktan sonra tasarımı eklenti manifest dosyasına uygulamaya başlayabilirsiniz. Eklentinin görünümünün ve davranışının çoğunu (eklentinin genişlettiği Google Workspace ana makine uygulamaları dahil) yapılandırdığınız yer manifest dosyasıdır.

Ayrıntılar için Google Workspace eklentisi manifest'leri başlıklı makaleyi inceleyin.

Eklentinize kod ve özellikler eklerken, gerekli eklenti görünümünü ve davranışını oluşturmak için manifest dosyasını gerektiği gibi düzenleyin.

Google Chat uygulamasının görünümünü ve davranışını yapılandırma

Google Chat'i genişleten bir eklenti tasarladıysanız Chat uygulamasının görünümünü ve davranışını yapılandırmak için Google Chat API'yi kullanmanız gerekir. Adımlar için Google Chat uygulamasını yapılandırma başlıklı makaleyi inceleyin.

Eklentiyi oluşturma

Eklenti için karta dayalı bir arayüz uygulamanız gerekir. Apps Script'in kart hizmetini kullanın veya başka bir kod dilinde yazıyorsanız arayüzün kart olarak oluşturulması için düzgün biçimlendirilmiş JSON döndürün.

Eklenti manifestinde belirtilen tüm tetikleyici işlevleri de uygulamanız gerekir. Eklentiniz OAuth'u kullanarak Google dışı bir üçüncü taraf hizmetine bağlanıyorsa bu hizmet için OAuth'u da yapılandırmanız gerekir.

Kart oluşturma

Card nesneleri oluşturup bunları widget'larla doldurarak eklenti kullanıcı arayüzünü tanımlarsınız. Manifest dosyanızda belirtilen tetikleyici işlevler, tek bir Card nesnesi veya eklenti arayüzünün farklı "sayfalarını" temsil eden bir Card nesnesi dizisi döndürmelidir. Eklentiniz, kullanıcı işlemlerine yanıt olarak yeni kartlar da oluşturabilir ve gösterebilir.

Apps Komut Dosyası'nda CardBuilder sınıfını kullanarak kartlar oluşturursunuz. Her kart için bir CardHeader ve bir veya daha fazla CardSections gerekir. Her kart bölümünü, eklenti arayüzünü oluşturan widget'larla doldurmanız gerekir. Etkileşim widget'ları, etkileşim davranışlarını tanımlamak için genellikle işlemlerle bağlantılıdır.

Tüm bölümleri ve widget'ları kartınızın CardBuilder aracılığıyla ekledikten sonra, ilgili Card nesnesini oluşturmak için CardBuilder.build() işlevini çağırmanız gerekir.

Oluşturduğunuz eklenti kartlarında gösterilecek bilgileri almak için CalendarApp gibi diğer yerleşik Apps Script hizmetlerini kullanabilirsiniz. Google dışı hizmetlerden alınan verileri kullanabilirsiniz.

Eklentinizin OAuth gerektiren Google dışı API'lere erişmesi gerekiyorsa bu hizmeti yapılandırmanız ve bağlamanız gerekir. Daha fazla bilgi için Google dışı hizmetlere bağlanma kılavuzuna bakın.

İnşaat siparişi

Kart oluştururken en üstten aşağı doğru oluşturmanız gerekir. Yani şu oluşturma sırasını kullanmanız gerekir:

  1. Widget'ı oluşturun.
  2. Widget'ı kart bölümüne ekleyin.
  3. Kart bölümünde tüm widget'lar eklenene kadar işlemi tekrarlayın.
  4. Kart bölümünü karta ekleyin.

Bir karta veya kart bölümüne widget eklediğinizde aslında o widget'ın kopyasını eklemiş olursunuz. Bu nedenle bu işlem gereklidir. Ekledikten sonra widget nesnesinde yaptığınız değişiklikler nihai karta yansıtılmaz.

Evrensel işlemler

Bağlama bağlı olmayan işlevler sağlamak için evrensel işlemleri kullanabilirsiniz. Evrensel işlemler, hangi kartın görüntülendiğine bakılmaksızın eklenti kullanıcı arayüzünde bulunan menü öğeleridir. Tanımlanmış tüm evrensel işlemler, eklentinin kart menüsünde her zaman görünür.

Daha fazla bilgi için Evrensel işlemler bölümüne bakın.

Eklenti OAuth kapsamlarını doğrulama

Kapsamlar, eklentinin kullanıcı adına hangi işlemleri yapmasına izin verildiğini tanımlar. Eklentilerin, yalnızca çalışması için gerekli olan işlemlere yönelik kapsamlara sahip olması en iyi uygulamadır.

Eklenti projelerinde, eklentinin mümkün olan en az izin verilen kapsam grubunu kullandığından emin olmak için eklenti kapsamlarını açıkça ayarlayın. Eklentinizin kullandığı kapsamları eklenti manifest tanımlarsınız.

Daha fazla bilgi için Kapsamlar bölümüne bakın.

Eklentiyi test etme

Yayınlanmamış eklentileri test etmek için önce yayınlanmamış eklentiyi yüklemeniz gerekir. Yüklenip yetkilendirildikten sonra eklentiyi hesabınızda kullanabilir ve genişlettiği ana uygulamalarda görünümünü ve davranışını test edebilirsiniz. Eklentinin bağlamlar ve kullanıcı işlemleri için beklendiği gibi davrandığını doğrulamanız gerekir.

Eklentinizi test etmeye başlamak için aşağıdaki kılavuzları inceleyin:

Eklentiyi yayınlama

Eklentinizi yayınladığınızda, herkese açık olarak veya yalnızca alanınızdaki kullanıcılara sunulur. Yayınlama sürecine başlamadan önce yayınlamaya genel bakış bölümünü inceleyin. Yayınlama, hazırlık ve zaman gerektiren karmaşık bir süreçtir.

Google Workspace eklentileri Google Workspace Marketplace'te yayınlanır. Herkese açık eklentiler yayınlanmadan önce uygulama incelemesinden geçmelidir.

Daha fazla bilgi için Google Workspace eklentisi yayınlama başlıklı makaleyi inceleyin.