AddOns 資訊清單資源

用於定義 Google Workspace 外掛程式內容和行為的資源設定。Google Workspace 外掛程式資訊清單必須包含所有標示為「必要」的元件。

AddOns

Google Workspace 外掛程式資訊清單的頂層設定。

JSON 表示法 
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "chat": {
    object (Chat)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  }
}
欄位
common

object (Common)

必要。定義每個主機應用程式通用的 Google Workspace 外掛程式值。如果省略特定主機的特定值，系統會使用這裡定義的部分值做為預設值。

calendar

object (Calendar)

如果 Google Workspace 外掛程式會擴充 Google 日曆，則必須提供這項資訊。 設定 Google Workspace 外掛程式在 Google 日曆主機應用程式中的外觀和行為。如果省略這個欄位，Google 日曆會停用外掛程式。

chat

object ()

如果 Google Workspace 外掛程式會擴充 Chat，則為必填。 Google Chat 應用程式的設定。如果省略這個欄位，外掛程式會在 Google Chat 中停用。

addOns.chat 物件必須為空白。如要設定外掛程式在 Chat 中的行為和外觀，請參閱「設定 Chat 應用程式」。
drive

object (Drive)

如果 Google Workspace 外掛程式會擴充 Google 雲端硬碟，則必須提供這項資訊。 Google Workspace 外掛程式在 Google 雲端硬碟主機應用程式中的外觀和行為設定。如果省略這個欄位，Google 雲端硬碟就會停用外掛程式。
gmail

object (Gmail)

如果 Google Workspace 外掛程式會擴充 Gmail 功能，則必須提供這項資訊。 在 Gmail 主機應用程式中，設定 Google Workspace 外掛程式的外觀和行為。如果省略這個欄位，Gmail 會停用外掛程式。

docs

object (Docs)

如果 Google Workspace 外掛程式會擴充 Google 文件，則必須提供這項資訊。 Google Workspace 外掛程式在 Google 文件主機應用程式中的外觀和行為設定。如果省略這個欄位，外掛程式會在 Google 文件中停用。

sheets

object (Sheets)

如果 Google Workspace 外掛程式會擴充 Google 試算表，則必須提供這項資訊。 Google Workspace 外掛程式在 Google 試算表主機應用程式中的外觀和行為設定。如果省略這個欄位，系統會在 Google 試算表中停用外掛程式。

slides

object (Slides)

如果 Google Workspace 外掛程式會擴充 Google 簡報的功能，則必須提供這項資訊。 Google Workspace 外掛程式在 Google 簡報主機應用程式中的外觀和行為設定。如果省略這個欄位，系統會在 Google 簡報中停用外掛程式。

通用

適用於每個主機應用程式的常見參數資訊清單設定。如果特定主機省略特定值，系統會使用這裡定義的部分值做為預設值。

JSON 表示法 
{
  "homepageTrigger": {
    object (HomepageTrigger)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "logoUrl": string,
  "name": string,
  "openLinkUrlPrefixes": [
    string
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "useLocaleFromApp": boolean
}
欄位
homepageTrigger

object (HomepageTrigger)

建立外掛程式首頁的預設觸發函式規格。如果未定義主機專用的首頁觸發條件，系統就會使用這項規格。如果也省略此欄位，系統會在需要時建構及使用一般首頁資訊卡。
layoutProperties

object (LayoutProperties)

外掛程式工具列和按鈕所用顏色的設定。
logoUrl

string

必要。工具列中顯示的圖片網址。網址必須公開。
name

string

必要。工具列中顯示的外掛程式名稱。
openLinkUrlPrefixes[]

string

如果外掛程式顯示任何外送連結，無論是在使用 OpenLink 的小工具中，或是在使用 HTML 錨定標記的文字小工具中，都必須提供這項資訊。HTTPS 網址前置字元清單。為保護使用者資料，外掛程式轉譯的任何連結都必須符合這份清單中的其中一個前置字元。

詳情請參閱「 將網址加入允許清單」。
universalActions[]

object (UniversalAction)

外掛程式 UI 中一律可用的通用動作清單。
useLocaleFromApp

boolean

如果 true、外掛程式事件物件傳遞至動作回呼函式或觸發函式，則包含使用者的語言代碼和時區資訊。預設值為 false。

詳情請參閱「 存取使用者地區和時區」。

LayoutProperties

這項設定可控制外掛程式工具列和按鈕的顏色與外觀。 Google Workspace

JSON 表示法 
{
  "primaryColor": string,
  "secondaryColor": string
}
欄位
primaryColor

string

工具列的顏色。預設為灰色 (#424242)。
secondaryColor

string

按鈕的預設顏色。預設為主要顏色 (如有設定)，否則預設為藍色 (#2196F3)。

UniversalAction

通用動作的設定。 選取通用動作後，系統會開啟指定的網址連結，或執行指定的 Apps Script 函式。

JSON 表示法 
{
  "label": string,

  // Union field rule can be only one of the following:
  "openLink": string,
  "runFunction": string,
  // End of list of possible types for union field rule.

}
欄位
label

string

每個通用動作都必須提供這項屬性。這項動作在 UI 選單中顯示的文字。
runFunction

string

如果沒有 openLink，則每個通用動作都必須提供這項屬性。如果提供，使用者選取這項動作時執行的 Apps Script 函式名稱。

詳情請參閱「 通用動作」指南。