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

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

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

前提条件

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

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

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

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

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

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

インストールすると、アドオンは拡張するホスト アプリケーションですぐに使用できるようになります。アドオンが表示される前に、ホスト アプリケーションのタブを更新する必要がある場合があります。アドオンを使用する前に、承認も必要です。プロジェクトがすでに承認されている場合は、ScriptApp.invalidateAuth を使用して既存の承認を無効にし、アドオンできめ細かい OAuth 機能をテストできるようにします。

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

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

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

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

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

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

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

  2. テストデータの例を使用する: アドオンの動作を評価します。

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

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

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