Gmail マニフェスト リソース

Gmail 内の Google Workspace アドオンのコンテンツと動作を定義するために使用されるリソース構成。Gmail を拡張する場合、Google Workspace アドオンのマニフェストには、すべてのコンポーネントが「必須」としてマークされている必要があります。

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 のセットを定義します。

詳しくは、 メール作成用 UI を作成アクションで拡張するをご覧ください。
contextualTriggers[]

object (ContextualTrigger)

必須。Gmail でメッセージが開かれたときにトリガーされるトリガーのリスト。トリガーが起動すると、通常は新しいカードを作成して UI を更新するために、特定の Apps Script 関数が実行されます。
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 アクションのリスト。ただし、このリストはアドオンごとに 1 つのアクションに制限されます。作成アクションには、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 関数の名前。このコンポーズ トリガー関数は、アドオンのコンポーズ UI をビルドします。

詳細については、 Compose トリガー関数をご覧ください。
text

string

作成アクションに必要です。この作成アクションの短いテキスト説明。