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 日曆就會停用外掛程式。
chat

object ()

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

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

object (Drive)

如果 Google Workspace 外掛程式擴充 Google 雲端硬碟功能，則為必填屬性。 在 Google 雲端硬碟主機應用程式中，Google Workspace 外掛程式外觀和行為的設定。如果省略這個欄位，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 試算表中停用。
slides

object (Slides)

如果 Google Workspace 外掛程式擴充功能會擴充 Google 簡報，則為必填屬性。 在 Google 簡報主機應用程式中，Google Workspace 外掛程式外觀和行為的設定。如果省略這個欄位，系統會在 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

用於控管 外掛程式工具列和按鈕的顏色和外觀。

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

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