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 OAuth 設定範例所示。

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

定義 Compose 觸發函式的資料存取層級。 有效選項包括:

  • NONE (預設):事件物件幾乎是空白。
  • METADATA:事件物件包含收件者清單。 這需要 gmail.addons.current.message.metadata scope
selectActions[]

object (SelectAction)

撰寫動作清單。每個外掛程式只能列出一個動作。撰寫動作在 Gmail 視窗中會有圖示,由 gmail.logoUrl 指定。

ContextualTrigger

設定在使用者開啟 Gmail 郵件時觸發的觸發條件。詳情請參閱「擴充訊息使用者介面」。

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

string

每個情境觸發條件都必須提供這項資訊。觸發條件觸發時執行的 Apps Script 函式名稱。
unconditional

object

每個情境觸發條件都必須提供這項資訊。指定觸發條件適用於所有已開啟的 Gmail 郵件。這個物件應一律為空白。

SelectAction

定義選取時要執行的函式的撰寫動作設定。

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

string

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

string

撰寫動作的必要屬性。動作的簡短說明。