Resource manifes editor

Konfigurasi sumber daya yang digunakan untuk mendefinisikan Add-on Google Workspace konten dan perilaku dalam editor. Manifes Add-on Google Workspace harus memiliki semua komponen yang ditandai sebagai Wajib jika memperluas Editor.

Editor

Konfigurasi manifes Add-on Google Workspace untuk Ekstensi editor. Lihat Memperluas Editor dengan Add-on Google Workspace untuk informasi selengkapnya.

Representasi JSON
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
Kolom
homepageTrigger

object (HomepageTrigger)

Fungsi pemicu ini membuat add-on halaman beranda di aplikasi host Anda. Ini mengganti addOns.common.homepageTrigger.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Wajib ada jika add-on Anda menyertakan perilaku spesifik untuk Dokumen editor, dipicu saat pengguna mengizinkan cakupan drive.file .

linkPreviewTriggers[]

object (LinkPreviewTriggers)

Wajib untuk pratinjau link. Daftar pemicu untuk melihat pratinjau link di file Google Dokumen, Spreadsheet, atau Slide. Untuk mengetahui detailnya, lihat Melihat pratinjau link dengan smart chip.

createActionTriggers[]

object (createActionTriggers)

Diperlukan untuk pembuatan resource pihak ketiga. Daftar pemicu untuk membuat resource di layanan pihak ketiga dari menu @. Untuk mengetahui detailnya, lihat Membuat referensi pihak ketiga dengan smart chip.

OnFileScopeGrantedTrigger

Konfigurasi untuk pemicu kontekstual yang diaktifkan saat meminta dialog cakupan file menggunakan CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); dan pengguna memberikan drive.file otorisasi ruang lingkup.

Representasi JSON
{
  "runFunction": string
}
Kolom
runFunction

string

Nama fungsi yang akan dijalankan jika cakupan drive.file diberikan. Jika ditentukan, Anda harus mengimplementasikan fungsi ini untuk membangun dan mengembalikan larik Card untuk ditampilkan di UI add-on.

LinkPreviewTriggers

Konfigurasi untuk pemicu yang diaktifkan saat pengguna mengetik atau menempelkan link dari layanan pihak ketiga atau non-Google ke Dokumen, File Spreadsheet, atau Slide.

Untuk menyiapkan pemicu ini untuk Add-on Google Workspace, lihat Melihat pratinjau link dengan smart chip.

Representasi JSON
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
Kolom
labelText

string

Wajib. Teks untuk contoh smart chip yang meminta pengguna untuk melihat pratinjau link, seperti Example: Support case. Teks ini bersifat statis dan ditampilkan sebelum pengguna menjalankan add-on.
localizedLabelText

map (key: string, value: string)

Opsional. Peta labelText untuk dilokalkan ke bahasa lain. Memformat bahasa di ISO 639 dan negara/wilayah di ISO 3166, dipisahkan dengan tanda hubung -. Misalnya, en-US.

Jika lokal pengguna ada dalam kunci peta, pengguna akan melihat versi labelText yang dilokalkan.

patterns[]

object (UriPattern)

Wajib. Array pola URL yang memicu add-on untuk melihat pratinjau link.
runFunction

string

Wajib. Nama fungsi yang akan dijalankan jika pengguna mengizinkan cakupan https://www.googleapis.com/auth/workspace.linkpreview. Jika ditentukan, Anda harus mengimplementasikan fungsi ini untuk menerima objek peristiwa yang berisi EDITOR_NAME.matchedUrl.url sebagai argumen dan menampilkan tunggal Card yang menampilkan pratinjau link di UI add-on.
logoUrl

string

Opsional. Ikon yang ditampilkan di smart chip dan kartu pratinjau. Jika dihapus, add-on menggunakan ikon toolbar, logoUrl.

UriPattern

Konfigurasi untuk setiap pola URL yang memicu pratinjau link.

Representasi JSON
{
  "hostPattern": string,
  "pathPrefix" : string
}
Kolom
hostPattern

string

Wajib untuk setiap pola URL yang akan dipratinjau.Domain pola URL. Add-on mempratinjau link yang berisi domain ini di URL. Guna melihat pratinjau link untuk subdomain tertentu, seperti subdomain.example.com, sertakan subdomain tersebut. Guna melihat pratinjau link untuk seluruh domain, tentukan karakter pengganti dengan tanda bintang (*) sebagai subdomain.

Misalnya, *.example.com cocok dengan subdomain.example.com dan another.subdomain.example.com.

pathPrefix

string

Opsional. Jalur yang menambahkan domain hostPattern.

Misalnya, jika pola host URL adalah support.example.com, gunakan cases untuk mencocokkan URL pada kasus yang dihosting di support.example.com/cases/.

Untuk mencocokkan semua URL di domain pola host, kosongkan pathPrefix.

CreateActionTriggers

Konfigurasi untuk pemicu yang diaktifkan saat pengguna memilih pihak ketiga item menu integrasi dari menu Google Dokumen @.

Untuk menyiapkan pemicu ini untuk Add-on Google Workspace, lihat Membuat resource pihak ketiga dengan smart chip.

Representasi JSON
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
Kolom
id

string

Wajib. ID unik untuk membedakan ekstensi ini poin. ID dapat berisi hingga 64 karakter dan harus dalam format [a-zA-Z0-9-]+..
labelText

string

Wajib. Teks yang muncul di @ seperti Create support case.
localizedLabelText

map (key: string, value: string)

Opsional. Peta labelText untuk dilokalkan ke bahasa lain. Memformat bahasa di ISO 639 dan negara/wilayah di ISO 3166, dipisahkan dengan tanda hubung -. Misalnya, en-US.

Jika lokal pengguna ada dalam kunci peta, pengguna akan melihat versi labelText yang dilokalkan.

runFunction

string

Wajib. Nama fungsi yang akan dijalankan saat pengguna memilih titik ekstensi dari menu @. Fungsi ini akan menampilkan kartu formulir dengan input untuk membuat resource pihak ketiga.
logoUrl

string

Opsional. Ikon yang ditampilkan di menu @. Jika dihapus, add-on menggunakan ikon toolbar, logoUrl.