Düzenleyici manifest kaynağı

Düzenleyicilerdeki Google Workspace eklentisi içeriğini ve davranışını tanımlamak için kullanılan kaynak yapılandırması. Google Workspace eklenti manifestoları, Düzenleyici'yi genişletiyorsa Zorunlu olarak işaretlenen tüm bileşenleri içermelidir.

Editörler

Düzenleyici uzantıları için Google Workspace eklenti manifesti yapılandırması. Daha fazla bilgi için Google Workspace eklentileriyle Dokümanlar Düzenleyicileri'nin işlevlerini genişletme başlıklı makaleyi inceleyin.

JSON gösterimi
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
Alanlar
homepageTrigger

object (HomepageTrigger)

Bu tetikleyici işlev, ana makine uygulamasında eklenti ana sayfasını oluşturur. Bu, addOns.common.homepageTrigger değerini geçersiz kılar.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Eklentiniz, kullanıcının drive.file kapsamını yetkilendirmesiyle tetiklenen ve mevcut Dokümanlar dokümanına özgü davranışlar içeriyorsa gereklidir.

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Bağlantı önizlemeleri için gereklidir. Google Dokümanlar, E-Tablolar veya Slaytlar dosyasındaki bağlantıları önizlemek için tetikleyicilerin listesi. Ayrıntılar için Akıllı çiplerle bağlantıları önizleme başlıklı makaleyi inceleyin.

createActionTriggers[]

object (createActionTriggers)

Üçüncü taraf kaynağı oluşturmak için gereklidir. @ menüsünden üçüncü taraf hizmetinde kaynak oluşturmak için tetikleyicilerin listesi. Ayrıntılı bilgi için Akıllı çiplerle üçüncü taraf kaynakları oluşturma başlıklı makaleyi inceleyin.

OnFileScopeGrantedTrigger

CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); kullanılarak dosya kapsamı iletişim kutusu istendiğinde ve kullanıcı drive.file kapsam yetkilendirmesi verdiğinde tetiklenen bağlamsal tetikleyici yapılandırması.

JSON gösterimi
{
  "runFunction": string
}
Alanlar
runFunction

string

drive.file kapsamı verilirse çalıştırılacak işlevin adı. Belirtilmişse eklenti kullanıcı arayüzünde gösterilecek Card nesnelerinden oluşan bir dizi oluşturup döndürmek için bu işlevi uygulamanız gerekir.

LinkPreviewTriggers

Kullanıcı, üçüncü taraf veya Google dışı bir hizmetten bir bağlantı yazıp Dokümanlar, E-Tablolar ya da Slaytlar dosyasına yapıştırdığında tetiklenen bir tetikleyicinin yapılandırması.

Bu tetikleyiciyi bir Google Workspace eklentisi için ayarlamak üzere Akıllı çipleri kullanarak bağlantıları önizleme başlıklı makaleyi inceleyin.

JSON gösterimi
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
Alanlar
labelText

string

Zorunludur. Kullanıcılardan bağlantıyı önizlemelerini isteyen örnek bir akıllı çipin metni (ör. Example: Support case). Bu metin statiktir ve kullanıcılar eklentiyi çalıştırmadan önce gösterilir.
localizedLabelText

map (key: string, value: string)

İsteğe bağlı. labelText haritası, diğer dillere yerelleştirme için. Dili ISO 639, ülkeyi/bölgeyi ise ISO 3166 biçiminde ve aralarına kısa çizgi - koyarak belirtin. Örneğin, en-US.

Kullanıcının yerel ayarı haritanın anahtarlarında varsa kullanıcı labelText öğesinin yerelleştirilmiş sürümünü görür.

patterns[]

object (UriPattern)

Zorunludur. Eklentinin bağlantıları önizlemesini tetikleyen URL kalıpları dizisi.
runFunction

string

Zorunludur. Kullanıcı https://www.googleapis.com/auth/workspace.linkpreview kapsamına yetki verdiğinde çalıştırılacak işlevin adı. Belirtilmişse EDITOR_NAME.matchedUrl.url içeren bir etkinlik nesnesini bağımsız değişken olarak kabul etmek ve eklenti kullanıcı arayüzünde bağlantı önizlemesi gösteren tek bir Card nesnesi döndürmek için bu işlevi uygulamanız gerekir.
logoUrl

string

İsteğe bağlı. Akıllı çipte ve önizleme kartında gösterilen simge. Boş bırakılırsa eklenti, araç çubuğu simgesini logoUrl kullanır.

UriPattern

Bağlantı önizlemesini tetikleyen her URL kalıbının yapılandırması.

JSON gösterimi
{
  "hostPattern": string,
  "pathPrefix" : string
}
Alanlar
hostPattern

string

Her URL kalıbının önizlemesi için gereklidir. URL kalıbının alan adı. Eklenti, URL'de bu alan adını içeren bağlantıları önizler. subdomain.example.com gibi belirli bir alt alan adının bağlantılarını önizlemek için alt alan adını ekleyin. Tüm alan adının bağlantılarını önizlemek için alt alan adı olarak yıldız işaretiyle (*) bir joker karakter belirtin.

Örneğin, *.example.com, subdomain.example.com ve another.subdomain.example.com ile eşleşir.

pathPrefix

string

İsteğe bağlı. hostPattern alanının alan adını ekleyen yol.

Örneğin, URL ana makine kalıbı support.example.com ise support.example.com/cases/ adresinde barındırılan durumların URL'lerini eşleştirmek için cases kalıbını kullanın.

Ana makine kalıbı alanındaki tüm URL'lerle eşleşmek için pathPrefix değerini boş bırakın.

CreateActionTriggers

Kullanıcı, Google Dokümanlar'daki @ menüsünden üçüncü taraf entegrasyonu menü öğesini seçtiğinde tetiklenen bir tetikleyicinin yapılandırması.

Bu tetikleyiciyi Google Workspace eklentisi için ayarlamak istiyorsanız Akıllı çiplerle üçüncü taraf kaynakları oluşturma başlıklı makaleyi inceleyin.

JSON gösterimi
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
Alanlar
id

string

Zorunludur. Bu uzantı noktasını ayırt etmek için kullanılan benzersiz kimlik. Kimlik en fazla 64 karakterden oluşabilir ve [a-zA-Z0-9-]+. biçiminde olmalıdır.
labelText

string

Zorunludur. @ menüsünde görünen metin (ör. Create support case).
localizedLabelText

map (key: string, value: string)

İsteğe bağlı. labelText haritası, diğer dillere yerelleştirme için. Dili ISO 639, ülkeyi/bölgeyi ise ISO 3166 biçiminde ve aralarına kısa çizgi - koyarak belirtin. Örneğin, en-US.

Kullanıcının yerel ayarı haritanın anahtarlarında varsa kullanıcı labelText öğesinin yerelleştirilmiş sürümünü görür.

runFunction

string

Zorunludur. Kullanıcı @ menüsünden bir uzantı noktası seçtiğinde çalıştırılacak işlevin adı. İşlev, üçüncü taraf kaynağını oluşturmak için girişlerin bulunduğu bir form kartı döndürmelidir.
logoUrl

string

İsteğe bağlı. @ menüsünde gösterilen simge. Boş bırakılırsa eklenti, araç çubuğu simgesini logoUrl kullanır.