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

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

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

前提条件

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

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

[デプロイ] ダイアログから非公開のアドオンをインストールします。

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

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

他のユーザーがアドオンをテストできるようにするには、プロジェクトをそのユーザーのアカウントと共有します(編集権限が必要です)。その後、ユーザーに同じ手順を行ってもらいます。

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

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

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

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

この手順を行うと、デプロイが削除され、アドオンが表示されなくなります。デプロイはいつでも再インストールできます。

テストのベスト プラクティス

アドオンをテストする際は、ベスト プラクティスに従ってください。また、次の操作も行います。

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

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

  3. アドオンがサードパーティの API に接続する場合は、サービスにアクセスできることを確認します。アドオンが認証とログインを正しく処理することを確認します。

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

  5. アドオンのパフォーマンスをモニタリングします。コードの変更後にアドオンの動作が遅くなる場合は、その機能を再設計する必要があるかもしれません。