アドオンは、公開前に徹底的にテストして、意図したとおりに動作することを確認する必要があります。Apps Script では、Google ドキュメントの特定のスプレッドシート、フォーム、スライドのファイルで、開発中のエディタのアドオンをテストできます。これは次の目的で使用できます。
- スタンドアロン スクリプトで記述されたアドオンが、シート、ドキュメント、プレゼンテーション、フォームに適用されたときに、意図したとおりに機能することを確認します。
- 特に、初期の認証ライフサイクルの状態（インストール済み、有効、またはその両方）で、アドオンのインストール フローが意図したとおりに機能することを確認します。
- 特定のドキュメントとそのコンテンツを操作する際に、アドオンが意図したとおりに機能することを確認します。
- アドオンの現在のバージョンと以前のバージョンをテストして比較できます。
テストデプロイを作成する
テストデプロイは、アドオンとテスト ドキュメントを組み合わせたものです。作成したスクリプト バージョンをアドオンとしてテストするには、次の手順を行います。
- アドオンのテストに使用するスプレッドシート、ドキュメント、プレゼンテーション、フォームをまだ作成していない場合は、作成します。
- アドオンを含むスクリプト プロジェクトを開きます。
- [デプロイ] > [デプロイをテスト] をクリックします。
- [タイプを選択] の横にある「デプロイタイプを有効にする」アイコン をクリックし、[エディタ アドオン] を選択します。
- [新しいテストを作成] または [テストを追加] をクリックします。
- コード バージョンを選択するか、[最新のコード] を選択します。
- [Config] セクションで、テストの初期承認状態を選択します。
- [テスト ドキュメント] で [ドキュメントが選択されていません] をクリックします。アドオンのテストに使用するスプレッドシート、ドキュメント、スライド、フォームのファイルを選択し、[挿入] をクリックします。
- [テストを保存] をクリックします。
保存したすべてのテストデプロイが [テストデプロイ] ダイアログに表示されます。これにより、後で同じテストデプロイに再度アクセスできます。
テストデプロイを実行する
保存済みのテストデプロイが 1 つ以上ある場合は、次の手順でそのうちの 1 つを実行できます。
- アドオンを含むスクリプト プロジェクトを開きます。
- [デプロイ] > [デプロイをテスト] をクリックします。
- [Saved Tests] で、実行する保存済みテストのデプロイの横にあるラジオボタンを選択し、[Execute] をクリックします。
テスト ドキュメントが新しいタブで開きます。アドオンがテストデプロイで指定された認可状態にある。メニューや UI 要素を操作して、アドオンが意図したとおりに機能することを確認できます。
テストの詳細
この方法でエディタのアドオンをテストする際は、次の点に留意してください。
- テスト時には、インストール可能なトリガーはサポートされていません。インストール可能なトリガーに依存する機能はテストできません。
- 最新のコードでテストするように設定されたテストデプロイの実行中に、テスト ドキュメントを更新すると、アドオン スクリプトに保存された変更を確認できます。
- テスト ドキュメントには、元のテスト ドキュメントの編集者と共有できる URL があります。これにより、テストと開発中に他のユーザーと簡単に共同作業を行うことができます。
- アドオンでプロパティ サービスを使用している場合、プロパティは維持され、次回のテストデプロイの実行時から利用可能になります。
- また、アドオンとテスト ドキュメントの同じ組み合わせを使用するテスト環境では、同じプロパティ情報にアクセスできます。たとえば、2 つのテストデプロイを作成する場合、1 つ目のデプロイの実行中に保存されたプロパティは 2 つ目のデプロイでも使用でき、その逆も同様です。ただし、デプロイで同じスクリプトとテスト ドキュメントを使用している場合に限ります。
- テストデプロイを実行するときに、以前にスクリプトを実行したことがない場合は、承認を求められることがあります。テスト中にスクリプトを承認すると、テスト外でもスクリプトが承認されることに注意してください。