編輯器資訊清單資源

用來在編輯器中定義 Google Workspace 外掛程式內容與行為的資源設定。如果 Google Workspace 外掛程式資訊清單是延伸編輯器,其所有元件都必須標示為「必要」

編輯器

編輯器擴充功能的 Google Workspace 外掛程式資訊清單設定。詳情請參閱「使用 Google Workspace 外掛程式擴充編輯器」。

JSON 表示法
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
欄位
homepageTrigger

object (HomepageTrigger)

這項觸發條件函式會在主機應用程式中建立外掛程式首頁,這項設定會覆寫 addOns.common.homepageTrigger

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

如果外掛程式包含目前編輯器文件的特定行為,則當使用者授權 drive.file 範圍時觸發,則為必要屬性。

linkPreviewTriggers[]

object (LinkPreviewTriggers)

這是連結預覽的必要項目。在 Google 文件、試算表或簡報檔案中預覽連結的觸發條件清單。詳情請參閱「使用智慧型方塊預覽連結」。

createActionTriggers[]

object (createActionTriggers)

建立第三方資源時必填。透過 @ 選單在第三方服務中建立資源的觸發條件清單。詳情請參閱「使用智慧型方塊建立第三方資源」。

OnFileScopeGrantedTrigger

此內容相關觸發條件設定,會在使用 CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); 的要求檔案範圍對話方塊,且使用者授予 drive.file 範圍授權時觸發。

JSON 表示法
{
  "runFunction": string
}
欄位
runFunction

string

授予 drive.file 範圍時要執行的函式名稱。如果有指定,您必須實作此函式以建構並傳回 Card 物件的陣列,以顯示在外掛程式的 UI 中。

LinkPreviewTriggers

當使用者輸入第三方或非 Google 服務的連結,或將連結貼到文件、試算表或簡報檔案中,觸發條件設定就會觸發。

如要為 Google Workspace 外掛程式設定這個觸發條件,請參閱「預覽含有智慧型方塊的連結」一節。

JSON 表示法
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
欄位
labelText

string

必要。智慧型方塊範例的文字,提示使用者預覽連結,例如 Example: Support case。這段文字是靜態的,會在使用者執行外掛程式之前顯示。
localizedLabelText

map (key: string, value: string)

選用設定。用於翻譯成其他語言的 labelText 對應。請使用 ISO 639 格式,並以 ISO 3166 格式的國家/地區設定語言,並以連字號 - 分隔。例如:en-US

如果地圖金鑰中含有使用者的語言代碼,使用者就會看到 labelText 的本地化版本。

patterns[]

object (UriPattern)

必要。觸發預覽連結外掛程式的網址模式陣列。
runFunction

string

必要。使用者授權 https://www.googleapis.com/auth/workspace.linkpreview 範圍時要執行的函式名稱。如有指定,您必須實作此函式,以接受包含 EDITOR_NAME.matchedUrl.url 的事件物件做為引數,並傳回單一 Card 物件,在外掛程式 UI 中顯示連結預覽。
logoUrl

string

選用設定。智慧型方塊和預覽資訊卡中的圖示。如果省略,外掛程式會使用工具列圖示 logoUrl

UriPattern

每個會觸發連結預覽的網址模式設定。

JSON 表示法
{
  "hostPattern": string,
  "pathPrefix" : string
}
欄位
hostPattern

string

每個要預覽的網址格式的必填屬性。網址模式的網域。外掛程式預覽連結的網址會包含該網域。如要預覽特定子網域 (例如 subdomain.example.com) 的連結,請加入子網域。如要預覽整個網域的連結,請指定萬用字元並以星號 (*) 做為子網域。

舉例來說,*.example.com 符合 subdomain.example.comanother.subdomain.example.com

pathPrefix

string

選用設定。附加 hostPattern 網域的路徑。

舉例來說,如果網址主機模式是 support.example.com,如要比對由 support.example.com/cases/ 代管的案件網址,請使用 cases

如要比對主機模式網域中的所有網址,請將 pathPrefix 留空。

CreateActionTriggers

當使用者從 Google 文件的 @ 選單中選取第三方整合選單項目時,觸發條件設定就會觸發。

如要為 Google Workspace 外掛程式設定這項觸發條件,請參閱「使用智慧型方塊建立第三方資源」。

JSON 表示法
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
欄位
id

string

必要。用來區分這個延伸點的專屬 ID。ID 長度上限為 64 個半形字元,且格式應為 [a-zA-Z0-9-]+.
labelText

string

必要。@ 選單中的文字,例如 Create support case
localizedLabelText

map (key: string, value: string)

選用設定。用於翻譯成其他語言的 labelText 對應。請使用 ISO 639 格式,並以 ISO 3166 格式的國家/地區設定語言,並以連字號 - 分隔。例如:en-US

如果地圖金鑰中含有使用者的語言代碼,使用者就會看到 labelText 的本地化版本。

runFunction

string

必要。使用者從 @ 選單中選取延伸點時,要執行的函式名稱。此函式應傳回表單資訊卡,其中包含建立第三方資源的輸入內容。
logoUrl

string

選用設定。@ 選單中顯示的圖示。如果省略,外掛程式會使用工具列圖示 logoUrl