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 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。作成トリガー関数に渡されるイベント オブジェクトにメッセージの受信者のリストが入力されます。この設定では、アドオンに gmail.addons.current.message.metadata スコープが含まれている必要があります。
selectActions[]

object (SelectAction)

Compose UI を作成する作成アクションのリスト。ただし、このリストは、アドオンごとに 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 関数の名前。この Compose トリガー関数は、アドオンの作成 UI を作成します。

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

text

string

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