Package google.apps.script.type.gmail

索引

ComposeTrigger

一種觸發條件,會在使用者撰寫電子郵件時啟動。

欄位
actions[]

MenuItemExtensionPoint

定義撰寫時間外掛程式的動作組合。使用者可以在撰寫時間外掛程式中觸發這些動作。

draftAccess

DraftAccess

定義觸發撰寫時間外掛程式時的資料存取權層級。

DraftAccess

列舉可定義撰寫觸發條件所需的資料存取權層級。

列舉
UNSPECIFIED 草稿存取權未設定時的預設值。
NONE 觸發撰寫外掛程式時,撰寫觸發條件無法存取草稿的任何資料。
METADATA 允許 Compose 觸發在觸發 Compose 外掛程式時存取草稿中繼資料的權限。包括目標對象名單,例如訊息草稿的「收件者」和「副本」清單。

ContextualTrigger

定義在開啟的電子郵件符合特定條件時觸發的觸發條件。觸發條件啟動時會執行特定端點,通常是為了建立新資訊卡並更新 UI。

欄位
onTriggerFunction

string

必要欄位。訊息與觸發條件相符時要呼叫的端點名稱。

聯集欄位 trigger。觸發條件類型會決定 Gmail 用來顯示外掛程式的條件。trigger 只能是下列其中一項:
unconditional

UnconditionalTrigger

只要開啟任何郵件,系統就會執行無條件觸發條件。

GmailAddOnManifest

自訂 Gmail 外掛程式外觀和執行的屬性。

欄位
homepageTrigger

HomepageExtensionPoint

定義要在不符合已聲明內容相關觸發條件的情境中執行的端點。使用者隨時可以查看這項功能產生的任何資訊卡,但只要這個外掛程式宣告更鎖定的觸發條件,就能從內容相關內容中省略。

如有的話,這會覆寫 addOns.common.homepageTrigger 的設定。

contextualTriggers[]

ContextualTrigger

定義一組條件,用於觸發外掛程式。

universalActions[]

UniversalAction

定義外掛程式的一組通用動作。使用者會從外掛程式工具列選單中觸發通用動作。

composeTrigger

ComposeTrigger

定義撰寫時間外掛程式的撰寫時間觸發條件。這種觸發條件會導致外掛程式在使用者撰寫電子郵件時採取行動。所有撰寫時間外掛程式即使無法編輯草稿,也一律須使用 gmail.addons.current.action.compose 範圍。

authorizationCheckFunction

string

端點的名稱,會藉由探測第三方 API,驗證外掛程式是否具備所有必要第三方授權。如果探測失敗,函式應擲回例外狀況,以啟動授權流程。為提供流暢的使用者體驗,系統會在每次叫用外掛程式之前呼叫此函式。

UnconditionalTrigger

這個類型沒有任何欄位。

使用者開啟任何電子郵件時就會觸發的觸發條件。

UniversalAction

無論郵件內容為何,外掛程式工具列選單中一律會顯示該動作。

欄位
text

string

必要欄位。向使用者顯示的動作說明文字,例如「新增聯絡人」。

聯集欄位 action_type。動作類型會決定 Gmail 在使用者叫用動作時的行為。action_type 只能是下列其中一項:
runFunction

string

使用者觸發動作時呼叫的端點。詳情請參閱通用動作指南