編輯器資訊清單資源

用來定義編輯器中 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 物件的陣列，以便顯示在外掛程式使用者介面中。

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 物件，該物件會在外掛程式使用者介面中顯示連結預覽。
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。