Apps Script Google Workspace アドオンのテストとデバッグ

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

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

前提条件

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

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

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

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

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

Apps Script プロジェクトを自分のアカウントと共有することで、他のユーザーがアドオンをテストできるようになります(編集権限が必要です)。ユーザーに上記の手順を行うように促します。

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

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

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

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

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

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

Google Workspace アドオンをテストする際は、アドオン開発に関するベスト プラクティスに従ってください。また、次のことを確認してください。

  1. アドオンが拡張するすべてのホストアプリで、カード ナビゲーション フローを完全にテストします。ユーザーがコンテキストからコンテキスト間や、コンテキスト非依存カードとコンテキスト カード間を移動する際に、アドオンの動作が正しく行われることを確認します。

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

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

  4. すべてのエラー条件が適切に処理されていることを確認します。必要に応じてエラーカードを使用します。

  5. アドオンのパフォーマンスに注意してください。コードを変更してアドオンの処理速度が低下し始めた場合は、その機能を削除するか、作り直さなければならない場合があります。