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 動作擴充 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 的 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

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