エディタのアドオンをテストする

アドオンを公開前に十分にテストして、意図したとおりに動作することを確認する必要があります。Apps Script では、特定の Google ドキュメントのスプレッドシート、フォーム、スライド ファイルで、開発中のエディタのアドオンをテストできます。以下の目的で使用できます。

  • スタンドアロン スクリプトで作成したアドオンを、シート、ドキュメント、プレゼンテーション、フォームに適用すると、意図したとおりに機能することを確認します。
  • アドオンの初期インストール フローが意図したとおりに機能することを確認します。特に、さまざまな初期認証ライフサイクル状態インストール済み、有効、またはその両方)に有効です。
  • 特定のドキュメントとそのコンテンツに対する操作時に、アドオンが想定どおりに機能することを確認します。
  • アドオンの現在のバージョンと以前のバージョンをテストして比較します。

テストデプロイを作成する

テストデプロイは、アドオンとテスト ドキュメントを組み合わせたものです。 スクリプト バージョンを開発し、アドオンとしてテストする場合は、次の手順を行います。

  1. アドオンのテストに使用するスプレッドシート、ドキュメント、プレゼンテーション、フォームをまだ作成していない場合は、作成します。
  2. アドオンを含むスクリプト プロジェクトを開きます。
  3. [デプロイ] > [デプロイをテスト] をクリックします。
  4. [Select type] の横にあるデプロイタイプを有効にするアイコン をクリックし、[Editor Add-on] を選択します。
  5. [新しいテストを作成] または [テストを追加] をクリックします。
  6. コードのバージョンを選択するか、[Latest Code] を選択します。
  7. [構成] セクションで、テストの初期承認状態を選択します。
  8. [テスト ドキュメント] で [ドキュメントが選択されていません] をクリックします。アドオンのテストに使用するスプレッドシート、ドキュメント、スライド、フォーム ファイルを選択し、[挿入] をクリックします。
  9. [テストを保存] をクリックします。

保存したテストデプロイはすべて [テストのデプロイ] ダイアログに表示されます。これにより、後で同じテストのデプロイに再アクセスできます。

テストデプロイの実行

保存したテストデプロイが 1 つ以上ある場合は、次の手順で実行できます。

  1. アドオンを含むスクリプト プロジェクトを開きます。
  2. [デプロイ] > [デプロイをテスト] をクリックします。
  3. [Saved Tests] で、実行する保存済みテストのデプロイの横にあるラジオボタンを選択し、[Execute] をクリックします。

テスト ドキュメントが新しいタブで開きます。アドオンがテストデプロイで指定された承認状態にある。アドオンがメニューや UI 要素を操作することで、意図したとおりに機能するかを検証できます。

テストの詳細

エディタのアドオンをテストする場合は、次の点に注意してください。

  • インストール可能なトリガーは、テストではサポートされません。インストール可能なトリガーに依存する機能はテストできません。
  • 最新のコードでテストするように設定されたテストデプロイを実行しているときに、テスト ドキュメントを更新すると、アドオン スクリプトに保存された変更を確認できます。
  • テスト ドキュメントの URL は元のテスト ドキュメントの編集者と共有できます。これにより、テストと開発を行いながら、他のユーザーと簡単に共同作業できます。
  • アドオンがプロパティ サービスを使用する場合、プロパティは保持され、テストデプロイの次回実行時に使用可能になります。
  • また、アドオンとテスト ドキュメントと同じ組み合わせを使用するテストのデプロイでも、同じプロパティ情報にアクセスできます。たとえば、2 つのテストデプロイを作成した場合、最初の実行中に保存されたプロパティは 2 番目の実行中に使用可能になります(その逆も同様)。ただし、デプロイで同じスクリプトとテスト ドキュメントが使用されている場合に限ります。
  • テスト デプロイを実行すると、これまでにスクリプトを実行したことがない場合に、承認を求められることがあります。テスト中にスクリプトを承認すると、テスト外のスクリプトも承認されることに注意してください。