Apps Script Google Workspace アドオンをテストしてデバッグする

アドオンを公開すると、ユーザーはホスト アプリケーションまたは Google Workspace Marketplace からアドオンをインストールできます。公開する前に、拡張するホスト アプリケーション内で開発したアドオンをテストします。

このページでは、テストや個人的な使用のために、開発中のアドオン(未公開またはデベロッパー アドオン)をインストールする方法について説明します。Apps Script IDE のデバッガとブレークポイントを使用してアドオンをデバッグすることもできます。

前提条件

  • アドオンのスクリプト プロジェクトに対する編集者権限が必要です。
  • 組織内の他のユーザーがアドオンをテストできるようにするには、スクリプト プロジェクトに対する編集者権限を付与します。アクセス権の付与の詳細については、他のデベロッパーとのコラボレーションをご覧ください。

未公開のアドオンをインストールする

未公開のアドオンは、Apps Script の [デプロイ] ダイアログからインストールできます。

テスト用に公開されていない Google Workspace アドオンをインストールする手順は次のとおりです。

  1. Apps Script エディタでスクリプト プロジェクトを開きます。
  2. [デプロイ] > [デプロイをテスト] をクリックします。
  3. [インストール] をクリックします。
  4. 下部にある [完了] をクリックします。

他のユーザーにアドオンをテストしてもらうには、そのユーザーのアカウントと Apps Script プロジェクトを共有します(編集アクセス権が必要です)。上記の手順に沿って操作するようお客様に伝えます。

インストールすると、拡張するホスト アプリケーションですぐにアドオンを使用できるようになります。アドオンが表示されるまでに、ホスト アプリケーション タブを更新する必要がある場合があります。また、使用する前にアドオンを承認する必要があります。

非公開のアドオンをアンインストールする

公開されていないアドオンのデプロイをアンインストールする手順は次のとおりです。

  1. Apps Script エディタでスクリプト プロジェクトを開きます。
  2. [デプロイ] > [デプロイをテスト] をクリックします。
  3. [アンインストール] をクリックします。
  4. 下部にある [完了] をクリックします。

この手順により、デプロイメントは直ちに削除され、アドオンはどのホストアプリにも表示されなくなります。インストール手順を繰り返すことで、デプロイメントをいつでも再インストールできます。

ベスト プラクティスを試す

Google Workspace アドオンをテストする際は、アドオン開発のベスト プラクティスに沿って行ってください。また、次の点にもご注意ください。

  1. アドオンが拡張するすべてのホスト アプリケーションで、カード ナビゲーション フローを徹底的にテストします。ユーザーがコンテキストからコンテキストに移動したり、コンテキストに依存しないカードとコンテキストに依存するカードを切り替えたりするときに、アドオンの動作が正しいことを確認します。

  2. サンプル テストデータを使用して、アドオンの動作を評価します。

  3. アドオンがサードパーティの API やその他のサービスに接続する場合は、サービスにアクセスでき、想定どおりに動作することを確認します。アドオンが認証とログイン情報を正しく処理していることを確認します。

  4. エラー状態が適切に処理されるようにします。必要に応じてエラーカードを使用します。

  5. アドオンのパフォーマンスに注意してください。コードを変更した結果、アドオンの動作が遅くなった場合は、その機能を削除するか、作り直す必要があるかもしれません。