Gmail 資訊清單資源

用來在 Gmail 中定義 Google Workspace 外掛程式內容和行為的資源設定。如果 Google Workspace 外掛程式資訊清單擴充 Gmail,則必須包含所有標示為「必要」的元件。

Gmail

Gmail 擴充功能的 Google Workspace 外掛程式資訊清單設定。詳情請參閱「使用 Google Workspace 外掛程式擴充 Gmail」一文。

JSON 表示法
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
欄位
authorizationCheckFunction

string

已淘汰。執行第三方授權規定檢查的 Apps Script 函式名稱。每次叫用 Google Workspace 外掛程式之前,系統都會呼叫這個函式。

為避免不必要的執行作業延遲,此函式已淘汰。反之,外掛程式應從主要叫用擲回例外狀況,如這個範例所示。

composeTrigger

object (ComposeTrigger)

撰寫動作的必要項目。定義使用者撰寫電子郵件時可用的 UI 組合。

詳情請參閱「 使用組合動作擴充 Compose UI」。

contextualTriggers[]

object (ContextualTrigger)

必要。在 Gmail 中開啟郵件時觸發的觸發條件清單。觸發條件啟動時,會執行特定 Apps Script 函式,通常用於建立新資訊卡及更新 UI。
homepageTrigger

object (HomepageTrigger)

用於在 Gmail 主機中建立外掛程式首頁的觸發條件函式規格。這會覆寫 addOns.common.homepageTrigger

ComposeTrigger

組合動作的設定。詳情請參閱擴充 Compose UI

JSON 表示法
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
欄位
draftAccess

string

定義撰寫觸發條件函式可用的資料存取層級。以下是有效選項:

  • NONE (預設設定)。這會導致傳遞至撰寫觸發條件函式的事件物件大部分為空白。
  • METADATA,用於填入傳遞至 Compose 觸發條件函式的事件物件,其中包含訊息的收件者清單。如要啟用這項設定,外掛程式須包含 gmail.addons.current.message.metadata 範圍
selectActions[]

object (SelectAction)

用於建立 Compose UI 的 Compose 動作清單;不過,這份清單僅限每個外掛程式使用一個動作。撰寫動作會在 Gmail 撰寫視窗顯示對應的圖示。圖示是由 gmail.logoUrl 指定。

ContextualTrigger

觸發條件設定會在使用者開啟 Gmail 郵件且郵件符合特定條件時觸發。詳情請參閱擴充訊息 UI

JSON 表示法
{
  "onTriggerFunction": string,
  "unconditional": {},
}
欄位
onTriggerFunction

string

對每個內容比對觸發條件來說都是必要項目。Apps Script 函式的名稱,會在觸發條件啟動時執行。

如要進一步瞭解如何定義這個函式,請參閱 內容觸發函式

unconditional

object

對每個內容比對觸發條件來說都是必要項目。用於指定在開啟所有 Gmail 郵件時,內容相關觸發條件會啟用。這是目前唯一的選項,因此這個物件應一律為空白物件。

SelectAction

組合動作設定,用於定義使用者選取組合動作時要執行的函式。

JSON 表示法
{
  "runFunction": string,
  "text": string
}
欄位
runFunction

string

撰寫動作的必要項目。選取這項撰寫動作時要執行的 Apps Script 函式名稱。這個 Compose 觸發條件函式會建構外掛程式 Compose UI。

詳情請參閱「 Compose 觸發條件函式」。

text

string

撰寫動作的必要項目。這項撰寫動作的簡短文字說明。