Gmail 資訊清單資源

用來定義下列項目的資源設定 Google Workspace 外掛程式 Gmail 中的內容和行為。 Google Workspace 外掛程式資訊清單必須具備 如果元件延伸到 Gmail，則所有標示為必要的元件。

Gmail

應用程式的 Google Workspace 外掛程式資訊清單設定 Gmail 擴充功能。詳情請見 使用 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 組合 撰寫電子郵件給使用者

詳情請參閱 使用撰寫動作擴充撰寫 UI，取得詳細資料。

contextualTriggers[]

object (ContextualTrigger)

必要。會在開啟訊息時觸發的觸發條件清單 。觸發條件會在觸發時執行 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

對每個內容比對觸發條件來說都是必要項目。應用程式的名稱 觸發條件啟動時執行的指令碼函式。

詳情請參閱 內容比對觸發條件函式，進一步瞭解如何定義該功能 函式。

unconditional

object

對每個內容比對觸發條件來說都是必要項目。用來指定 當 Gmail 郵件與 已開啟。這是目前唯一的選項，因此這個類型一律為 空白物件。

SelectAction

Compose 動作設定，用來定義當 使用者選取撰寫動作。

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

string

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

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

text

string

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