AddOns 資訊清單資源

用於定義 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)
  },
  "meet": {
    object (Meet)
  }
}
欄位
common

object (Common)

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

calendar

object (Calendar)

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

chat

object ()

如果 Google Workspace 外掛程式會擴充 Chat,則為必要項目。Google Chat 應用程式的設定。如果省略,外掛程式會在 Google Chat 中停用。

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

drive

object (Drive)

如果 Google Workspace 外掛程式會擴充雲端硬碟功能,則為必要項目。雲端硬碟主機應用程式中的外觀和行為設定。如果省略,外掛程式會在雲端硬碟中停用。

gmail

object (Gmail)

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

docs

object (Docs)

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

sheets

object (Sheets)

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

slides

object (Slides)

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

meet

object (Meet)

如果 Google Workspace 外掛程式會擴充 Meet 功能,則必須提供這項資訊。在 Meet 主辦人應用程式中設定外觀和行為。如果省略此引數,系統會在 Meet 中停用外掛程式。

通用

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

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 函式名稱。

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