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 以外の OAuth の構成例に示すように、例外をスローする必要があります。

composeTrigger

object (ComposeTrigger)

作成アクションの場合は必須。メール作成時に使用できる UI を定義します。

詳しくは、 作成アクションで作成 UI を拡張するをご覧ください。

contextualTriggers[]

object (ContextualTrigger)

必須。Gmail でメッセージが開いたときに起動するトリガーのリスト。トリガーは、特定の Apps Script 関数を実行して UI を更新します。
homepageTrigger

object (HomepageTrigger)

Gmail のアドオンの ホームページのトリガー関数。これにより、 addOns.common.homepageTrigger がオーバーライドされます。

ComposeTrigger

作成アクションの構成。詳しくは、 作成 UI を拡張する をご覧ください。

JSON 表現 
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
フィールド
draftAccess

string

作成トリガー関数のデータアクセス レベルを定義します。 有効なオプションは以下のとおりです。

  • NONE （デフォルト）: イベント オブジェクトはほとんど空です。
  • METADATA: イベント オブジェクトに受信者リストが含まれます。これには gmail.addons.current.message.metadata スコープが必要です。
selectActions[]

object (SelectAction)

作成アクションのリスト。リストは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 を構築します。
text

string

作成アクションの場合は必須。アクションの簡単な説明。