AddOns 資訊清單資源

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

AddOns

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

JSON 表示法 
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "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 日曆就會停用外掛程式。

drive

object (Drive)

如果 Google Workspace 外掛程式擴充了 Google 雲端硬碟，則為必要屬性。 Google Workspace 外掛程式外觀與在 Google 雲端硬碟主機應用程式中的行為設定。如果省略這個欄位，Google 雲端硬碟中的外掛程式就會停用。

gmail

object (Gmail)

如果 Google Workspace 外掛程式擴充 Gmail，則為必要屬性。 Google Workspace 外掛程式外觀與在 Gmail 主機應用程式中的行為設定。如果省略這個欄位，Gmail 會停用外掛程式。

docs

object (Docs)

如果 Google Workspace 外掛程式擴充 Google 文件則為必要屬性。 設定 Google Workspace 外掛程式在文件主機應用程式中的外觀和行為。如果省略這個欄位，文件的外掛程式就會停用。

sheets

object (Sheets)

如果透過 Google Workspace 外掛程式擴充試算表，則為必要屬性。設定 Google Workspace 外掛程式在試算表主機應用程式內的外觀和行為設定。如果省略這個欄位，系統就會停用試算表中的外掛程式。

slides

object (Slides)

如果 Google Workspace 外掛程式擴充了簡報功能，則為必要屬性。 設定 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

這項設定可控管 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 函式名稱。

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