編輯器資訊清單資源

用於定義 Google Workspace 外掛程式內容和編輯器行為的資源設定。如果 Google Workspace 外掛程式資訊清單會擴充編輯器，則必須將所有元件標示為「必要」。

編輯器

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

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

object (HomepageTrigger)

這個觸發事件函式會在主機應用程式中建立外掛程式 homepage。這會覆寫 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 服務的連結時，觸發事件就會觸發。

如要為 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.com 和 another.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。