編輯器資訊清單資源

用於定義編輯器中 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 文件、試算表或簡報檔案時觸發。

如要為 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。