Gmail マニフェスト リソース

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

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

Gmail

Gmail 拡張機能の Google Workspace アドオン マニフェスト構成。詳しくは、アドオンによる Gmail の拡張 Google Workspace をご覧ください。

JSON 表現
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
フィールド
authorizationCheckFunction

string

非推奨。サードパーティの承認要件のチェックを行う Apps Script 関数の名前。この関数は、 Google Workspace アドオンを呼び出す前に呼び出されます。

この関数は、不要な実行レイテンシを避けるために、非推奨になりました。 代わりに、アドオンはこの例に示すように、メインの呼び出しから例外をスローします。

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(デフォルト設定)。これにより、Compose トリガー関数に渡されるイベント オブジェクトはほぼ空になります。
  • METADATA。Compose トリガー関数に渡されるイベント オブジェクトに、メッセージの受信者のリストが表示されます。この設定では、アドオンに gmail.addons.current.message.metadata スコープを含める必要があります。
selectActions[]

object (SelectAction)

Compose UI を作成する Compose アクションのリスト。ただし、このリストは、アドオンごとに 1 つのアクションに制限されます。作成アクションに対応するアイコンが Gmail の作成ウィンドウに表示されます。 アイコンは gmail.logoUrl で指定します。

コンテキスト トリガー

ユーザーが Gmail のメールを開き、メッセージが特定の条件を満たしたときに起動するトリガーの構成。詳細については、メッセージ UI の拡張をご覧ください。

JSON 表現
{
  "onTriggerFunction": string,
  "unconditional": {},
}
フィールド
onTriggerFunction

string

コンテキスト トリガーごとに必須。トリガーの起動時に実行される Apps Script 関数の名前。

この関数を定義する方法について詳しくは、コンテキスト トリガー関数をご覧ください。

unconditional

object

コンテキスト トリガーごとに必須。すべての Gmail メッセージが開かれたときにコンテキスト トリガーを有効にするよう指定する場合に使用します。現時点ではこれが唯一のオプションであるため、これは常に空のオブジェクトである必要があります。

選択操作

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

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

string

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

詳しくは、Compose トリガー関数をご覧ください。

text

string

作成アクションに必須。この作成アクションの短い説明。