Gmail 資訊清單資源

用於定義 Google Workspace 外掛程式內容和 Gmail 行為的資源設定。如果 Google Workspace 外掛程式資訊清單會擴充 Gmail，則必須將所有元件標示為「Required」。

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)

Compose 動作的必要屬性。定義使用者在撰寫電子郵件時可用的 UI 集合。

詳情請參閱「 使用 Compose 動作擴充 Compose UI」。
contextualTriggers[]

object (ContextualTrigger)

必填。在 Gmail 中開啟郵件時觸發的觸發條件清單。觸發條件觸發時，會執行特定的 Apps Script 函式，通常是建立新資訊卡並更新 UI。
homepageTrigger

object (HomepageTrigger)

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

ComposeTrigger

Compose 動作的設定。詳情請參閱「擴充 Compose UI」。

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

string

定義可供 Compose 觸發事件函式使用的資料存取層級。有效的選項如下：

  • NONE，預設設定。這會導致傳遞至 Compose 觸發器函式的事件物件大多為空白。
  • METADATA，會將傳送給撰寫觸發事件函式的事件物件，填入訊息收件者的清單。這項設定要求外掛程式包含 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

Compose 動作設定，定義使用者選取 Compose 動作時要執行的函式。

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

string

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

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

string

Compose 動作的必要屬性。此 Compose 動作的簡短文字說明。