Google Apps Scriptを利用したgmailアドオンの作成方法

こんにちは、技術部の T です。今回は google が提供している Google Apps Script(GAS)について書いていきます。公式ドキュメントは以下になります。

Google Apps Script とは

Apps Script は、Google Workspace の統合、自動化、拡張のためのビジネスソリューションをすばやく簡単に構築するための唯一のローコードプラットフォームです。(https://workspace.google.co.jp/intl/ja/products/apps-script/)

簡単に言えば環境構築不要で gmail やスプレッドシートなどの google の関連したアプリケーションを使用したシステムが作成できるプラットフォームです。

作成方法

以下の URL から「新しいプロジェクト」を押下
https://script.google.com/

今回は gmail のアドオンを作成するためにとある設定を行います。
「プロジェクトの設定」を押下し、「「appsscript.json」マニフェストファイルをエディタで表示する」にチェックを入れる。
設定を行った後「エディタ」を押下する「appsscript.json」が表示される。

appsscript.json の設定

appsscript.json に以下の json を追加します。

				
					  "oauthScopes": [
    "https://mail.google.com/",
    "https://www.googleapis.com/auth/gmail.addons.execute",
    "https://www.googleapis.com/auth/script.external_request"
  ],
  "gmail": {
    "name": "アドオン名",
    "logoUrl": "https://www.gstatic.com/images/icons/material/system/1x/label_googblue_24dp.png",
    "contextualTriggers": [{
      "unconditional": {
      },
      "onTriggerFunction": "buildAddOn"
    }],
    "openLinkUrlPrefixes": [
      "https://mail.google.com/"
    ],
    "primaryColor": "#FF0000",
    "secondaryColor": "#0000ff"
  }

`oauthScopes`はアクセスを許可するプログラムを指定するものです。今回は gmail のアドオン作成のため関連する三つを記載します。

`gmail`はアドオンに関する情報を記載します。
`name`はアドオンの名前を指定します。
`logoUrl`はアドオンのロゴを URL で指定します。今回は Google のサンプルロゴを使用しています。
`contextualTrigger`はアドオンでトリガーとなるファンクションを指定します。
`openLinkUrlPrefixes`はリンクの前につけるプレフィクスを指定します。
`primaryColor`と`secondaryColor`はアドオンのメインカラーとセカンドカラーを指定します。

スクリプトの作成

今回は gmail にアドオンを表示させる所までをおこなうので、簡単に CardService という機能を作成します。
アドオン表示時にメッセージを表示するように

				
					function buildAddOn(e) {
    var message = CardService.newTextParagraph()
    .setText('この文章を表示');

    var text = CardService.newCardSection().addWidget(message);

    var card = CardService.newCardBuilder()
        .setHeader(
        CardService.newCardHeader()
            .setTitle('はじめてのアドオン')
        )
        .addSection(text)
        .build();

return [card];
}

gmail で確認する方法

「デプロイ」を押下し、「デプロイをテスト」を押下する。

「インストール」を押下後に「完了」を押下する。

gmail の画面を表示すると画面右にアドオンが追加されているので押下する。画面が表示されていれば成功です。

最後に

GAS を使用すれば様々な業務の効率化が出来ると思います。スプレッドシートと gmail を併用して機能を造ることも可能です。次回はスプレッドシートを利用し、メールを送信する機能を作ってみようとおもいます。

スーパーソフトウエアの採用情報

あなたが活躍できるフィールドと充実した育成環境があります

詳しく見る

2023-05-30
テクノロジー