スキップしてメイン コンテンツに移動

GASアドオン公開の極意

GASアドオン公開の極意

GAS応用でアドオン開発を始める

Google Apps Script(GAS)は、Google Workspace の各サービスを拡張するための強力なツールです。GAS を使ったアドオン開発は、スプレッドシートやドキュメント、Gmail などの UI をカスタマイズし、業務効率を大幅に向上させることができます。まずは、Apps Script エディタを開き、プロジェクトを作成します。プロジェクト名は「カスタムアドオン」としましょう。

アドオンの基本構成は、appsscript.json というマニフェストファイルと、実際のスクリプトファイルです。マニフェストには、アドオンの名前、バージョン、必要な OAuth スコープ、UI の設定などを記述します。以下は最小限のマニフェスト例です。

{
  "timeZone": "Asia/Tokyo",
  "dependencies": {},
  "exceptionLogging": "STACKDRIVER",
  "addOns": {
    "common": {
      "name": "サンプルアドオン",
      "logoUrl": "https://example.com/logo.png",
      "useLocaleFromApp": true
    },
    "sheets": {
      "homepageTrigger": {
        "runFunction": "onOpen"
      }
    }
  }
}

次に、onOpen 関数を実装し、スプレッドシートのメニューにカスタム項目を追加します。これにより、ユーザーはアドオンの機能を簡単に呼び出せるようになります。

function onOpen() {
  var ui = SpreadsheetApp.getUi();
  ui.createMenu('カスタムメニュー')
    .addItem('サイドバーを開く', 'showSidebar')
    .addToUi();
}

上記コードは、スプレッドシートが開かれたときに「カスタムメニュー」を追加し、その中に「サイドバーを開く」項目を設置します。ユーザーがこの項目をクリックすると、showSidebar 関数が実行されます。

メニュー拡張とサイドバーで機能追加

メニュー拡張は、ユーザーが直感的に操作できる UI を提供するための第一歩です。さらに、サイドバーを利用することで、複雑な入力フォームや情報表示を実装できます。サイドバーは HTML と Apps Script の連携で構築され、Google Workspace の UI とシームレスに統合されます。

サイドバーを表示する関数は以下のように実装します。

function showSidebar() {
  var html = HtmlService.createHtmlOutputFromFile('Sidebar')
      .setTitle('サイドバー');
  SpreadsheetApp.getUi().showSidebar(html);
}

ここで参照している Sidebar.html は、サイドバーに表示する HTML ファイルです。簡単な例として、以下のような構成にします。

<!DOCTYPE html>
<html>
<head>
  <base target="_top">
</head>
<body>
  <h3>サイドバーのタイトル</h3>
  <p>ここに入力フォームや情報を配置します。</p>
</body>
</html>

サイドバー内から Apps Script の関数を呼び出すには、google.script.run を使用します。例えば、ユーザーが入力したデータをスプレッドシートに書き込む関数を呼び出す場合、以下のようにします。

<input type="text" id="inputData">
<button onclick="saveData()">保存</button>
<script>
function saveData() {
  var data = document.getElementById('inputData').value;
  google.script.run.withSuccessHandler(function() {
    alert('保存しました');
  }).saveToSheet(data);
}
</script>

Apps Script 側で saveToSheet を実装すれば、サイドバーからの入力をスプレッドシートに反映できます。

Google Workspace Marketplaceで公開・審査・配布

アドオンを完成させたら、次は Google Workspace Marketplace で公開し、ユーザーに配布します。公開プロセスは以下のステップで構成されます。

  1. Google Cloud Console でプロジェクトを作成し、Apps Script をリンクします。
  2. マニフェストに addOns セクションを正しく設定し、必要な OAuth スコープを宣言します。
  3. Marketplace の「公開」タブで、アドオンの説明、アイコン、サポート情報を入力します。
  4. 「審査」ボタンを押して、Google の審査プロセスを開始します。審査は通常数日から数週間かかります。
  5. 審査が通過すると、アドオンは Marketplace に掲載され、ユーザーは「インストール」ボタンから簡単に導入できます。

審査時に重視されるポイントは、プライバシーとセキュリティです。ユーザーのデータにアクセスする場合は、最小限のスコープを使用し、データの取り扱いを明確に説明する必要があります。また、アドオンの UI が Google のデザインガイドラインに準拠しているかも確認されます。

公開後は、Marketplace のダッシュボードからインストール数やユーザーのフィードバックを確認できます。フィードバックをもとに機能追加やバグ修正を行い、アドオンを継続的に改善していくことが重要です。

この記事はAIによって作成されました。

コメント