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