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

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

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

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

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

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

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

テストデプロイを実行する

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

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

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

テストの詳細

この方法でエディタ アドオンをテストする際は、いくつかの点に留意してください。

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