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 Workspace 外掛程式在文件代管應用程式中的外觀和行為設定。如果省略這個欄位,Google 文件中的外掛程式就會停用。

sheets

object (Sheets)

如果 Google Workspace 外掛程式擴充試算表,則為必要項目。 Google Workspace 外掛程式在試算表代管應用程式中的外觀和行為設定。如果省略這個欄位,Google 試算表就會停用外掛程式。

slides

object (Slides)

如果 Google Workspace 外掛程式擴充 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

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

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