編輯器資訊清單資源

用於定義編輯器中 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 範圍，要執行的函式名稱。函式必須傳回 UI 的 Card 物件陣列。

LinkPreviewTriggers

當使用者在文件、試算表或簡報檔案中輸入或貼上第三方服務的連結時，觸發條件會觸發。

如要為 Google Workspace 外掛程式設定這項觸發條件，請參閱「使用智慧型方塊預覽連結」。

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

string

必要。例如，提示使用者預覽連結的智慧型方塊文字 (如 Example: Support case)。This text is static.
localizedLabelText

map (key: string, value: string)

(選用步驟) labelText地圖，可翻譯成其他語言。語言格式為 ISO 639，國家/地區格式為 ISO 3166，並以半形連字號 - 分隔。
patterns[]

object (UriPattern)

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

string

必要。使用者授權 https://www.googleapis.com/auth/workspace.linkpreview 範圍時要執行的函式名稱。函式必須接受事件物件，其中包含含有預覽網址的 matchedUrl.url 屬性，並傳回 Card 物件。
logoUrl

string

(選用步驟) 智慧型方塊和預覽資訊卡中顯示的圖示。如果省略這個值，外掛程式會使用工具列圖示 logoUrl。

UriPattern

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

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

string

每個網址模式都必須提供。網址模式網域。外掛程式會預覽含有這個網域的連結。如要比對所有子網域，請使用萬用字元星號 (*)。
pathPrefix

string

(選用步驟) 附加網域的路徑。如要比對網域中的所有網址，請將 pathPrefix 留空。

CreateActionTriggers

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

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

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

string

必要。這個擴充點的專屬 ID。最多可使用 64 個字元，格式為 [a-zA-Z0-9-]+.。
labelText

string

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

map (key: string, value: string)

(選用步驟) 要本地化的 labelText 地圖。請採用 ISO 639 格式指定語言，並採用 ISO 3166 格式指定國家/地區，兩者之間以連字號 - 分隔。
runFunction

string

必要。使用者選取擴充功能點時要執行的函式名稱。函式必須傳回表單卡片。
logoUrl

string

(選用步驟) @ 選單中顯示的圖示。如果省略這個值，外掛程式會使用工具列圖示 logoUrl。