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

詳しくは、 メール作成用 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: 作成トリガー関数に渡されるイベント オブジェクトに、メッセージの受信者のリストを入力します。この設定を使用するには、アドオンに 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 関数の名前。このコンポーズ トリガー関数は、アドオンの Compose UI をビルドします。

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

string

作成アクションに必須です。このコンポーズ アクションの簡単な説明。