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