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

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

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

テスト Deployment を作成する

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

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

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

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

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

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

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

テストの詳細

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

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