Resource manifes editor

Konfigurasi resource yang digunakan untuk menentukan konten dan perilaku add-on Google Workspace 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 mengetahui informasi selengkapnya.

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

object (HomepageTrigger)

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

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Wajib jika add-on Anda menyertakan perilaku khusus untuk dokumen Editor saat ini, yang dipicu saat pengguna memberikan otorisasi pada 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)

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

OnFileScopeGrantedTrigger

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

Representasi JSON
{
  "runFunction": string
}
Kolom
runFunction

string

Nama fungsi yang akan dijalankan jika cakupan drive.file diberikan. Jika ditentukan, Anda harus menerapkan fungsi ini untuk mem-build dan menampilkan array objek 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 file Dokumen, Spreadsheet, atau Slide.

Untuk menyiapkan pemicu ini bagi 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 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. Format bahasa dalam ISO 639 dan negara/wilayah dalam ISO 3166, dipisahkan dengan tanda hubung -. Misalnya, en-US.

Jika lokalitas pengguna ada di 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 saat pengguna memberikan otorisasi pada cakupan https://www.googleapis.com/auth/workspace.linkpreview. Jika ditentukan, Anda harus menerapkan fungsi ini untuk menerima objek peristiwa yang berisi EDITOR_NAME.matchedUrl.url sebagai argumen dan menampilkan satu objek Card yang menampilkan pratinjau link di UI add-on.
logoUrl

string

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

UriPattern

Konfigurasi untuk setiap pola URL yang memicu pratinjau link.

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

string

Wajib diisi untuk setiap pola URL yang akan dilihat pratinjaunya.Domain pola URL. Add-on ini melihat pratinjau link yang berisi domain ini di URL. Untuk melihat pratinjau link untuk subdomain tertentu, seperti subdomain.example.com, sertakan subdomain. Untuk 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, untuk mencocokkan URL untuk kasus yang dihosting di support.example.com/cases/, gunakan cases.

Untuk mencocokkan semua URL di domain pola host, biarkan pathPrefix kosong.

CreateActionTriggers

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

Untuk menyiapkan pemicu ini bagi 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 titik ekstensi ini. ID dapat berisi hingga 64 karakter dan harus dalam format [a-zA-Z0-9-]+..
labelText

string

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

map (key: string, value: string)

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

Jika lokalitas pengguna ada di 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 dihilangkan, add-on akan menggunakan ikon toolbar-nya, logoUrl.