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

構成トリガー関数のデータアクセス レベルを定義します。有効なオプションは以下のとおりです。

  • NONE（デフォルト）: イベント オブジェクトはほとんど空です。
  • METADATA: イベント オブジェクトには受信者リストが含まれます。これには gmail.addons.current.message.metadata スコープが必要です。
selectActions[]

object (SelectAction)

作成アクションのリスト。リストは、アドオンごとに 1 つのアクションに制限されます。作成アクションには、gmail.logoUrl で指定された Gmail ウィンドウのアイコンがあります。

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 UI をビルドします。
text

string

作成アクションに必要です。アクションの簡単な説明。