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，此為預設設定。這會導致傳遞至 Compose 觸發條件函式的事件物件大部分為空白。
  • METADATA，用於將傳遞給組合觸發條件函式的事件物件填入訊息收件者清單。這項設定需要外掛程式包含 gmail.addons.current.message.metadata 範圍。
selectActions[]

object (SelectAction)

建立 Compose UI 的組合動作清單；不過，這份清單僅限每個外掛程式執行一項動作。撰寫動作在 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 UI。

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

string

撰寫動作的必要元素。這個撰寫動作的簡短說明。