メッセージ UI の拡張

Gmail を拡張する Google Workspace アドオンは、ユーザーがメールを読んでいるときにユーザー インターフェースを提供できます。これにより、Google Workspace アドオンは、メッセージに関連する追加情報の表示、取得、送信など、メッセージ コンテンツに応答するタスクを自動化できます。

アドオン メッセージの UI へのアクセス

アドオンのメッセージ UI を表示する方法は 2 つあります。1 つ目の方法は、アドオンがすでに開いているときにメッセージを開く方法です（Gmail の受信トレイ ウィンドウでアドオンのホームページを表示している場合など）。2 つ目の方法は、メッセージを表示しているときにアドオンを起動する方法です。

どちらの場合でも、アドオンはアドオンのマニフェストで定義されている、対応するコンテキスト トリガー関数を実行します。また、アドオンが開いている間にユーザーが別のメッセージに切り替えた場合も、トリガーが実行されます。コンテキスト トリガー関数は、そのメッセージのメッセージ UI を構築し、Gmail がユーザーに表示します。

メッセージ アドオンの作成

アドオンにメッセージ機能を追加する一般的な手順は次のとおりです。

  1. メッセージ機能に必要なスコープなど、適切なフィールドをアドオン スクリプト プロジェクトのマニフェストに追加します。マニフェストに条件付きトリガー フィールドを追加し、unconditional 値を {} にします。
  2. ユーザーがメッセージでアドオンを選択したときにメッセージ UI を作成するコンテキスト トリガー関数を実装します。
  3. ユーザーの UI 操作に応答するために必要な関連関数を実装します。

コンテキスト トリガー

メッセージの読み取り時にユーザーをサポートするため、Google Workspace アドオンはマニフェストでコンテキスト トリガーを定義できます。トリガー条件を満たす Gmail メールを開いたとき（アドオンが開いている場合）*、トリガーが実行されます。トリガーが実行されると、コンテキスト トリガー関数が実行され、アドオンのユーザー インターフェースが構築され、Gmail に返されて表示されます。この時点で、ユーザーは操作を開始できます。

コンテキスト トリガーは、アドオンのプロジェクト マニフェストで定義します。トリガー定義は、どの条件でどのトリガー関数を呼び出すかを Gmail に指示します。たとえば、次のマニフェスト スニペットは、メッセージが開かれたときにトリガー関数 onGmailMessageOpen() を呼び出す無条件トリガーを設定します。

{
  ...
  "addOns": {

    "common": {
      ...
    },
    "gmail": {
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "onGmailMessageOpen"
        }
      ],
      ...
    },
    ...
  }
  ...
}

コンテキスト トリガー関数

すべてのコンテキスト トリガーには、アドオンのユーザー インターフェースを構築する対応するトリガー関数が必要です。この関数は、マニフェストの onTriggerFunction フィールドで指定します。この関数を実装して、アクション イベント オブジェクト引数を受け取り、単一の Card オブジェクトまたは Card オブジェクトの配列を返します。

特定の Gmail メッセージに対してコンテキスト トリガーがトリガーされると、この関数が呼び出され、アクション イベント オブジェクトが渡されます。多くの場合、トリガー関数は、このイベント オブジェクトから提供されたメール ID を使用して、Apps Script の Gmail サービスを使用してメールのテキストなどの詳細を取得します。たとえば、トリガー関数では、次の関数を使用してメッセージ コンテンツを抽出できます。

  // Activate temporary Gmail scopes, in this case to allow
  // the add-on to read message metadata and content.
  var accessToken = e.gmail.accessToken;
  GmailApp.setCurrentMessageAccessToken(accessToken);

  // Read message metadata and content. This requires the Gmail scope
  // https://www.googleapis.com/auth/gmail.addons.current.message.readonly.
  var messageId = e.gmail.messageId;
  var message = GmailApp.getMessageById(messageId);
  var subject = message.getSubject();
  var sender = message.getFrom();
  var body = message.getPlainBody();
  var messageDate = message.getDate();

  // Setting the access token with a gmail.addons.current.message.readonly
  // scope also allows read access to the other messages in the thread.
  var thread = message.getThread();
  var threadMessages = thread.getMessages();

  // Using this link can avoid the need to copy message or thread content
  var threadLink = thread.getPermalink();

トリガー関数はこのデータに基づいて動作し、インターフェースに必要な情報を抽出します。たとえば、販売数をまとめるアドオンは、メール本文から販売数を収集し、カードに表示できるように整理できます。

トリガー関数は、ビルドされた Card オブジェクトの配列をビルドして返す必要があります。たとえば、次のコードは、メッセージの件名と送信者のみを一覧表示する単一のカードを含むアドオンをビルドします。

  function onGmailMessageOpen(e) {
    // Activate temporary Gmail scopes, in this case to allow
    // message metadata to be read.
    var accessToken = e.gmail.accessToken;
    GmailApp.setCurrentMessageAccessToken(accessToken);

    var messageId = e.gmail.messageId;
    var message = GmailApp.getMessageById(messageId);
    var subject = message.getSubject();
    var sender = message.getFrom();

    // Create a card with a single card section and two widgets.
    // Be sure to execute build() to finalize the card construction.
    var exampleCard = CardService.newCardBuilder()
        .setHeader(CardService.newCardHeader()
            .setTitle('Example card'))
        .addSection(CardService.newCardSection()
            .addWidget(CardService.newKeyValue()
                .setTopLabel('Subject')
                .setContent(subject))
            .addWidget(CardService.newKeyValue()
                .setTopLabel('From')
                .setContent(sender)))
        .build();   // Don't forget to build the Card!
    return [exampleCard];
  }