ADVERTISEMENT

【Googleスプレッドシート】Apps Script Add-onの作成!配布用アドオンの公開手順

【Googleスプレッドシート】Apps Script Add-onの作成!配布用アドオンの公開手順
🛡️ 超解決

Googleスプレッドシートでアドオンを作成し、Google Workspace Marketplaceで公開したいと考えたことはありませんか。アドオンにすれば、自作のスクリプトを他のユーザーと簡単に共有できます。しかし、公開手順は意外と複雑で、どこから手をつければ良いか迷う方も多いようです。この記事では、Apps Scriptでアドオンを作成し、配布用に公開するまでの手順を詳しく解説します。

【要点】アドオン公開の全体像と3つのステップ

  • スクリプトエディタでのアドオンマニフェスト設定: アドオンの種類や権限を宣言するappsscript.jsonファイルを正しく記述します。
  • テスト版アドオンのインストールと動作検証: 自分自身でテスト用URLからアドオンをインストールし、問題なく動作するか確認します。
  • Google Workspace Marketplace SDKでの公開設定: ストアリスティングの作成、審査提出、公開処理を行います。

ADVERTISEMENT

アドオン作成の基礎知識

アドオンとは、Googleスプレッドシートなどに機能を追加する拡張機能のことです。通常のスクリプトはスクリプトファイルに直接バインドされますが、アドオンは独立したプロジェクトとして作成し、複数のファイルやユーザーで利用できます。アドオンには「エディタアドオン」と「Workspaceアドオン」の2種類があり、今回はスプレッドシートのエディタアドオンを対象とします。作成にはGoogle Apps Scriptを使い、最終的にGoogle Workspace Marketplaceで公開します。

アドオンを公開するには、以下の前提条件を満たす必要があります。Googleアカウント(個人用またはGoogle Workspaceアカウント)と、スクリプトの基本知識が必要です。また、公開前にプライバシーポリシーとOAuth同意画面の設定が必須です。これらの準備を整えた上で、手順を進めてください。

アドオンを作成する手順

ここでは、スプレッドシートにメニューを追加する簡単なアドオンを例に、作成から公開までの手順を説明します。

ステップ1: スクリプトプロジェクトを作成する

  1. スプレッドシートを開く
    Googleスプレッドシートを新規作成するか、既存のシートを開いてください。
  2. 拡張機能メニューからスクリプトエディタを起動する
    「拡張機能」→「Apps Script」をクリックします。新しいタブでスクリプトエディタが開きます。
  3. プロジェクト名を変更する
    左上の「無題のプロジェクト」をクリックし、わかりやすい名前(例:「サンプルアドオン」)に変更します。

ステップ2: アドオンコードを記述する

  1. デフォルトのコードを置き換える
    エディタに表示されているfunction myFunction()を削除し、以下のコードを貼り付けてください。
  2. サンプルコード
    次のコードは、スプレッドシートに「カスタムメニュー」を追加し、そのメニューからアクションを実行するアドオンの例です。
    function onOpen() {
      var ui = SpreadsheetApp.getUi();
      ui.createMenu('カスタムメニュー')
          .addItem('挨拶を表示', 'showGreeting')
          .addToUi();
    }
    function showGreeting() {
      SpreadsheetApp.getUi().alert('こんにちは、アドオンから呼び出されました。');
    }
  3. 保存する
    Ctrl+S(Macの場合はCmd+S)でコードを保存します。

ステップ3: アドオンマニフェストを設定する

  1. マニフェストファイルを開く
    スクリプトエディタの左側メニューで「プロジェクトの設定」アイコン(歯車)をクリックし、「「appsscript.json」マニフェスト ファイルをエディタで表示」にチェックを入れます。これでコードエディタにappsscript.jsonが表示されます。
  2. マニフェストを編集する
    デフォルトの内容を、アドオン用に書き換えます。以下は最小限の設定例です。
    {
      "timeZone": "Asia/Tokyo",
      "dependencies": {
      },
      "exceptionLogging": "STACKDRIVER",
      "runtimeVersion": "V8",
      "addOns": {
        "common": {
          "name": "サンプルアドオン",
          "logoUrl": "https://example.com/logo.png",
          "homepageTrigger": {
            "runFunction": "onHomepage"
          }
        },
        "sheets": {}
      }
    }
  3. 注意点
    「addOns.common」セクションにはアドオンの名前(最大30文字)とロゴURL(推奨128x128px)を設定します。「homepageTrigger」はアドオンのホームページを開いたときに実行する関数を指定しますが、スプレッドシートのアドオンでは必須ではありません。代わりに「sheets」セクションを空でも良いので含めてください。ロゴURLは実際にアクセス可能な画像URLを用意します。

ステップ4: テスト用アドオンとしてインストールする

  1. 公開前のテストとしてインストールする
    スクリプトエディタで「デプロイ」→「新しいデプロイ」をクリックします。
  2. デプロイの種類を選択する
    「種類の選択」で「アドオン」を選び、「デプロイ」ボタンをクリックします。初回は権限の確認が表示されるので、許可してください。
  3. テスト用URLを取得する
    デプロイが成功すると、インストール用のURLが表示されます。このURLをコピーし、ブラウザのアドレスバーに貼り付けてアクセスすると、アドオンをインストールできます。テスト用アドオンは自分だけがインストール可能です。
  4. 動作を確認する
    スプレッドシートを再度開き、「カスタムメニュー」が表示されるか確認します。「挨拶を表示」をクリックしてアラートが表示されれば成功です。

アドオン公開のための注意点

公開にはいくつかの重要な準備と注意点があります。ここでは、特に間違いやすいポイントを説明します。

OAuth同意画面とプライバシーポリシーの設定が必須

アドオンがユーザーデータにアクセスする場合、OAuth同意画面を設定する必要があります。Google Cloud Consoleでプロジェクトを作成し、同意画面に必要な情報(アプリ名、サポートメール、プライバシーポリシーURLなど)を入力します。プライバシーポリシーは、アドオンがどのデータをどう扱うかを説明する文書で、自前のWebサイトやGoogleドキュメントで公開します。この設定がないと、Marketplaceで公開審査に合格できません。

Marketplace SDKの設定とストアリスティングの作成

Google Workspace Marketplace SDKを有効にし、ストアリスティングを作成します。具体的な手順は以下の通りです。まず、Google Cloud Consoleで該当プロジェクトを開き、「APIとサービス」→「ライブラリ」から「Google Workspace Marketplace SDK」を検索して有効にします。次に、「APIとサービス」→「認証情報」でOAuth2.0クライアントIDを作成(アプリケーションの種類は「ウェブアプリケーション」)します。その後、Marketplace SDKの設定画面でストアリスティングの詳細(説明、アイコン、スクリーンショット、カテゴリなど)を入力します。ストアリスティングの情報は審査の対象になるため、正確かつ魅力のある内容にしましょう。

審査に合格するための品質基準

Googleはアドオンの審査を厳格に行います。最低限の基準として、アドオンが正しく機能すること、ユーザーを混乱させないUIであること、スパム的でないこと、プライバシーポリシーが存在することなどが求められます。また、アドオンが収集するデータの範囲を最小限にし、適切なスコープ(権限範囲)を設定してください。審査には数日から1週間程度かかることがあります。不合格の場合は、理由がフィードバックされるので修正して再提出します。

ADVERTISEMENT

Apps Scriptアドオンと通常スクリプトの違い

アドオンと通常のスクリプト(コンテナバインドスクリプト)の違いを理解しておくと、用途に合わせた選択ができます。以下の表で主な違いをまとめます。

項目 通常のスクリプト アドオン
共有方法 スクリプトファイルを直接共有、またはURLで共有 Google Workspace Marketplaceからインストール
利用範囲 そのスプレッドシート内のみ インストールしたユーザーのすべてのスプレッドシートで利用可能
インストールの手間 スクリプトを開くだけで使用開始 ユーザーがMarketplaceからインストールが必要
配布の容易さ 少数のユーザーへの共有には便利 多数のユーザーへの配布に最適
審査の有無 審査不要 Googleによる審査あり

まとめ

この記事では、Apps Scriptを使ってスプレッドシート用のアドオンを作成し、Google Workspace Marketplaceで公開する手順を解説しました。まずアドオンマニフェストを正しく設定し、テスト版をインストールして動作確認を行います。その後、OAuth同意画面とプライバシーポリシーを準備し、Marketplace SDKでストアリスティングを作成して審査を受けます。アドオンにすると、自作スクリプトを世界中のユーザーに配布できるようになります。次のステップとして、実際に簡単なアドオンを作成し、公開まで試してみてください。また、アドオンの機能を充実させるために、スプレッドシートAPIやGoogle Workspace APIsの活用も検討するとよいでしょう。


ADVERTISEMENT

この記事の監修者
✍️

超解決 第一編集部

疑問解決ポータル「超解決」の編集チーム。正確な検証と、現場視点での伝わりやすい解説を心がけています。