Google Editor arayüzleri oluşturma

Google Workspace eklentileriyle, düzenleyiciler, düzenleyiciler ve Google Dokümanlar, E-Tablolar ve Slaytlar dahil. Bu, kullanıcıya görevleri otomatik hale getirebilir ve üçüncü taraf sistemleri, Düzenleyiciler.

Eklenti kullanıcı arayüzüne erişme

Düzenleyiciler'de bir Google Workspace eklentisini açabilirsiniz. simgesi Google Workspace'te görünüyorsa Dokümanlar, E-Tablolar ve Slaytlar kullanıcısının sağ tarafındaki yan panele erişim kullanır.

Google Workspace Eklentileri aşağıdaki arayüzleri sunabilir:

  • Ana sayfa arayüzleri: Eklentinin manifest dosyası tetikleyiciyi içerir Kullanıcının eklentiyi açtığı Düzenleyici için EDITOR_NAME.homepageTrigger, eklenti, tablodaki bir ana sayfa kartı olmasını sağlayabilirsiniz. Eklentinin manifest dosyasında Kullanıcının açtığı Düzenleyici için EDITOR_NAME.homepageTrigger bunun yerine genel bir ana sayfa kartı gösterilir.

  • REST API arayüzleri: Eklenti REST kullanıyorsa bir dokümana dosya başına erişim isteyen tetikleyiciler ekleyebilirsiniz. drive.file kapsamı kullanılıyor. İzin verildikten sonra, EDITOR_NAME.onFileScopeGrantedTrigger yürütme ve dosyaya özgü bir arayüz görüntüler.

  • Bağlantı önizleme arayüzleri: Eklentiniz üçüncü taraf bir hizmetle entegre olursa, önizlemeyi yapan kartlar URL'nizdeki içerikleri kaldırabilirsiniz.

Düzenleyici eklentileri için arayüz oluşturma

Aşağıdaki adımları uygulayarak Düzenleyiciler için Düzenleyici eklentisi arayüzleri oluşturun:

  1. Uygun addOns.common addOns.docs, addOns.sheets ve addOns.slides komut dosyası projesi manifest'teki komut dosyası alanına veri ekleyin.
  2. Gerekli Düzenleyici kapsamlarını şuraya ekleyin: komut dosyası proje manifestinizi hazırlayın.
  3. Düzenleyiciye özel bir ana sayfa sağlıyorsanız EDITOR_NAME.homepageTrigger işlevini kullanmanız gerekir. Değilse common.homepageTrigger ana makine uygulamalarınız için ortak bir ana sayfa oluşturmak üzere tasarlanmıştır.
  4. REST API'ler kullanıyorsanız drive.file kapsamı yetkilendirme akışını uygulayın ve EDITOR_NAME.onFileScopeGrantedTrigger açık dosyaya özgü bir arayüzü görüntüleyecek şekilde tetikleyici işlevi görür. Daha fazla REST API arayüzleri bölümüne bakın.
  5. Bir üçüncü taraf hizmetinin bağlantı önizlemelerini yapılandırıyorsanız https://www.googleapis.com/auth/workspace.linkpreview kapsam yetkilendirme akışı ve linkPreviewTriggers işlevini kullanın. Daha fazla bilgi için bkz. Bağlantı önizleme arayüzleri.
  6. Kullanıcının Düğme tıklamaları gibi kullanıcı arayüzü etkileşimleri.

Düzenleyici ana sayfaları

Eklentinizin komut dosyası projesinde bir ana sayfa tetikleyici işlevi sağlamanız gerekir tek bir Card oluşturan ve döndüren veya eklentinin ana sayfasını oluşturan bir Card nesne dizisi.

Ana sayfa tetikleyici işlevine bir etkinlik nesnesi geçirildi istemcinin platformu gibi bilgileri içeren bir parametre olarak gösterilir. Şunları yapabilirsiniz: ve ana sayfanın yapılışını uyarlamak için etkinlik nesnesi verilerini kullanır.

Düzenleyici'ye özel ortak bir ana sayfa veya özel bir ana sayfa sunabilirsiniz. Eklentinizi açar.

Ortak ana sayfayı görüntüleme

Eklentinizin ortak ana sayfasını Düzenleyicilerde göstermek için addOns.docs gibi düzenleyici alanları addOns.sheets, veya addOns.slides manifest dosyasında bulun.

Aşağıdaki örnekte bir Google Workspace Eklentisinin addons kısmı gösterilmektedir manifest'ini kullanabilirsiniz. Eklenti Dokümanlar, E-Tablolar ve Slaytlar'ı genişletir ve yaygın olarak kullanılan ana sayfa olarak ayarlayabilirsiniz.

 "addOns": {
    "common": {
      "name": "Translate",
      "logoUrl": "https://www.gstatic.com/images/branding/product/1x/translate_24dp.png",
      "layoutProperties": {
        "primaryColor": "#2772ed"
      },
      "homepageTrigger": {
        "runFunction": "onHomepage"
      }
    },
    "docs": {},
    "sheets": {},
    "slides": {}
  }
}

Düzenleyiciye özel bir ana sayfa görüntüleme

Bir düzenleyiciye özel bir ana sayfa sunmak için eklentiye EDITOR_NAME.homepageTrigger ekleyin. manifest'ini kullanabilirsiniz.

Aşağıdaki örnekte bir Google Workspace eklentisi manifestinin addons bölümü gösterilmektedir. Eklenti Dokümanlar, E-Tablolar ve Slaytlar için etkinleştirilmiştir. Bu sayfada genel olarak ana sayfasını, E-Tablolar'da da benzersiz bir ana sayfayı bulabilirsiniz. Geri çağırma onSheetsHomepage işlevi E-Tablolar'a özel ana sayfa kartını oluşturur.

 "addOns": {
    "common": {
      "name": "Translate",
      "logoUrl": "https://www.gstatic.com/images/branding/product/1x/translate_24dp.png",
      "layoutProperties": {
        "primaryColor": "#2772ed"
      },
      "homepageTrigger": {
        "runFunction": "onHomepage"
      }
    },
    "docs": {},
    "slides": {},
    "sheets": {
     "homepageTrigger": {
       "runFunction": "onSheetsHomepage"
     },
  }
}

REST API arayüzleri

Eklentiniz Google Sheets API gibi REST API'leri kullanıyorsa yeni bir arayüz görüntülemek için onFileScopeGrantedTrigger işlevini kullanabilirsiniz Editor ana makine uygulamasında açık olan dosyaya özel.

drive.file onFileScopeGrantedTrigger işlevi. drive.file özelliğini nasıl isteyeceğinizi öğrenmek için kapsam, Geçerli doküman için dosya erişimi isteme başlıklı makaleye bakın.

Bir kullanıcı drive.file kapsamını verdiğinde EDITOR_NAME.onFileScopeGrantedTrigger.runFunction etkinleşir. Tetikleyici etkinleştiğinde, bağlamsal tetikleyici işlevini yürütür EDITOR_NAME.onFileScopeGrantedTrigger.runFunction alanı tarafından belirtilir manifest dosyasıdır.

Düzenleyicilerden biri için REST API arayüzü oluşturmak istiyorsanız aşağıdaki adımları uygulayın. EDITOR_NAME öğesini, seçtiğiniz Editor ana makine uygulamasıyla değiştirin Örneğin sheets.onFileScopeGrantedTrigger.

  1. EDITOR_NAME.onFileScopeGrantedTrigger dahil edilmelidir. manifest'inizin uygun Düzenleyici bölümüne gidin. Örneğin, bu arayüzü Google E-Tablolar'da oluşturmak istiyorsanız, tetikleyiciyi "sheets" bölümü.
  2. EDITOR_NAME.onFileScopeGrantedTrigger bölümünde adı geçen işlevi uygulayın bölümüne bakın. Bu işlev, bağımsız değişken olarak bir etkinlik nesnesini kabul eder ve tek bir Card nesne veya Card nesne dizisidir.
  3. Her kartta olduğu gibi, Widget etkileşimine olanak tanır. Örneğin, arayüzde, ekli bir İşlem ve düğme tıklandığında çalışan, uygulanmış bir geri çağırma işlevi olmalıdır tıklanır.

Aşağıdaki örnekte bir Google Workspace eklentisi manifestinin addons bölümü gösterilmektedir. Eklenti, REST API'leri kullandığından onFileScopeGrantedTrigger API'leri Google E-Tablolar Bir kullanıcı drive.file kapsamını verdiğinde geri çağırma işlevi onFileScopeGrantedSheets, dosyaya özel bir arayüz oluşturur.

"addOns": {
   "common": {
     "name": "Productivity add-on",
     "logoUrl": "https://www.gstatic.com/images/icons/material/system_gm/1x/work_outline_black_18dp.png",
     "layoutProperties": {
       "primaryColor": "#669df6",
       "secondaryColor": "#ee675c"
     }
   },
   "sheets": {
     "homepageTrigger": {
       "runFunction": "onEditorsHomepage"
     },
     "onFileScopeGrantedTrigger": {
       "runFunction": "onFileScopeGrantedSheets"
     }
   }

Bir üçüncü taraf hizmeti için bağlantı önizlemelerini etkinleştirmek istiyorsanız bağlantıyı yapılandırmanız gerekir önizlemeleri düzenleyebilir ve önizleme döndüren bir işlev oluşturabilirsiniz. kartını inceleyebilirsiniz. Kullanıcı yetkilendirmesi gerektiren hizmetlerde işleviniz emin olun.

Bağlantı önizlemelerini etkinleştirme adımları için bkz. Akıllı çiplerle bağlantıları önizleme

Etkinlik nesneleri

Bir etkinlik nesnesi oluşturulur ve EDITOR_NAME.homepageTrigger veya EDITOR_NAME.onFileScopeGrantedTrigger. Tetikleyici işlevi, etkinlik nesnesini tanımlayın. dikkat edin.

Etkinlik nesnelerinin tam yapısı Etkinlik nesneleri bölümünde açıklanmaktadır.

Düzenleyici, eklentinin işlem yapan ana makine uygulaması olduğunda etkinlik nesneleri Dokümanlar, E-Tablolar veya Slaytlar etkinlik nesnesi alanları için geçerlidir.

Eklenti, geçerli kullanıcı için drive.file kapsam yetkilendirmesine sahip değilse veya dokümanı içeriyorsa etkinlik nesnesi yalnızca docs.addonHasFileScopePermission, sheets.addonHasFileScopePermission veya slides.addonHasFileScopePermission alanı için geçerlidir. Eklenti etkinlik nesnesi, tüm Düzenleyici etkinlik nesnesi alanlarını içerir.

Aşağıdaki örnekte sheets.onFileScopeGrantedTrigger işlevi. Burada eklenti Geçerli doküman için drive.file kapsam yetkilendirmesi:

`        {
          "commonEventObject": { ... },
          "sheets": {
            "addonHasFileScopePermission": true,
            "id":"A_24Q3CDA23112312ED52",
            "title":"How to get started with Sheets"
          },
          ...
        }