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 を定義します。

詳しくは、 作成アクションによる 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: デフォルト設定。これにより、Compose トリガー関数に渡されるイベント オブジェクトはほとんど空になります。
  • METADATA。Compose トリガー関数に渡されたイベント オブジェクトに、メッセージの受信者のリストを設定します。この設定を行うには、アドオンに 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 のメールが開いたときに、すべての Gmail メッセージに対してコンテキスト トリガーを有効にするよう指定するために使用します。現時点ではこれが唯一のオプションであるため、常に空のオブジェクトである必要があります。

SelectAction

作成アクションの構成。ユーザーが作成アクションを選択したときに実行する関数を定義します。

JSON 表現
{
  "runFunction": string,
  "text": string
}
フィールド
runFunction

string

作成アクションに必要です。この作成アクションが選択されたときに実行される Apps Script 関数の名前。この Compose トリガー関数は、アドオン Compose UI をビルドします。

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

text

string

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