Apps Script ダッシュボードでは、Apps Script プロジェクトを管理、モニタリングできます。このダッシュボードを使用すると、次のことができます。
- Google Workspace ドキュメントに添付されたバインド スクリプトなど、既存の Apps Script プロジェクトを表示して検索します。
- 新しいプロジェクトを作成する。
- プロジェクトの詳細(使用している OAuth スコープなど)を表示します。
- スクリプト プロジェクトの健全性と使用状況をモニタリングします。
- アカウントの認証情報を使用して実行されるプロジェクトと他のユーザーのプロジェクトの実行ログを表示します。
- [Apps Script API] をオンまたはオフに切り替えて、アプリが API を使用してスクリプト プロジェクトを操作できるようにするかどうかを設定します。
プロジェクトの表示と検索
Apps Script ダッシュボードには、表示または編集できるすべてのスクリプト プロジェクトが一覧表示されます。ダッシュボードの左側のナビゲーションでは、これらのプロジェクトが次のカテゴリに分類されます。
- スター付きのプロジェクト。モニタリングしているプロジェクト。
- [マイ プロジェクト] をクリックします。オーナーであるプロジェクト。
- [すべてのプロジェクト] をクリックします。自分がオーナーであるプロジェクト、または閲覧権限または編集権限があるプロジェクト。
- [共有アイテム] をタップします。所有していないが、共有されているプロジェクト。
- ゴミ箱。Google ドライブから削除したプロジェクト。
プロジェクト リストには、プロジェクト名、オーナー、最終更新日が表示されます。プロジェクト名の横にあるアイコンは、プロジェクトがスタンドアロン プロジェクトかバインド プロジェクトかを示します。
プロジェクトの詳細を表示する
各プロジェクトには、プロジェクトに関するデベロッパーの詳細を表示するビューが含まれています。プロジェクトの詳細を表示するには、プロジェクト リストの行をクリックします。
プロジェクトの詳細ビューには、プロジェクトに関するエラー率、実行回数、ユーザー数のデータとグラフが表示されます。また、プロジェクトを使用するエンドユーザーにリクエストされた OAuth スコープも表示されます。データ指標は次のように定義されます。
- エラー率。キャッチされない例外が原因で実行に失敗した実行の割合。定義された期間内の合計実行数に対する失敗した実行数の割合として計算されます。
- 実行。プロジェクトが「実行」された回数。プロジェクトの実行方法の詳細については、実行タイプをご覧ください。
- ユーザー。指定した期間にプロジェクトを 1 回以上実行したユニーク ユーザー(アカウント)の数。匿名ユーザーは追跡されないため、ユーザー数やグラフに反映されません。
プロジェクトの各デプロイは、データとグラフの上の [プロジェクトの詳細] ページにタブとして表示されます。タブを選択すると、そのデプロイに関連付けられたデータが表示されます。[すべて] を選択すると、プロジェクトのすべてのデプロイと、デベロッパーが Apps Script コードエディタ内からプロジェクトを実行した結果の実行からの集計データが表示されます。
プロジェクトをモニタリングする
日常的に使用または管理している Apps Script プロジェクトよりも、はるかに多くのプロジェクトにアクセスできる場合があります。プロジェクトをブックマークして簡単にアクセスできるようにするには、プロジェクトにスターを付けます。プロジェクトにスターを付けると、それらのプロジェクトの集計使用量とエラー率の統計情報とグラフをモニタリングすることもできます。
プロジェクトにスターを付けるには、プロジェクトの行の右側にあるその他アイコン プロジェクトの詳細を表示しているときに、その他アイコン をクリックしてプロジェクトにスターを付けることもできます。
> [スターを付ける] をクリックします。左側のナビゲーションで [スター付きプロジェクト] を選択すると、ブックマークしたプロジェクトが表示されます。ページ上部の [エラー率]、[実行数]、[ユーザー数] のスコアカードをクリックすると、過去 7 日間のすべてのスター付きプロジェクトに関連するグラフが表示されます。
プロジェクトの行で [その他]
をクリックし、[スターを削除] を選択すると、プロジェクトからスターを削除できます。実行を管理する
Apps Script ダッシュボードを使用すると、Apps Script プロジェクト関数の個々の実行を表示して管理できます。最近の実行の完全なログは、左側のナビゲーションで [My Executions] 項目を選択すると確認できます。
[マイ実行] パネルには、デフォルトで、オーナー、編集者、閲覧者のいずれかのロールが付与されているプロジェクトの、過去と現在実行中のすべての実行のログが表示されます。このリストには、ユーザーに代わって実行される(たとえば、インストールして実行したアドオンなど)アクセス権のないプロジェクトの関数実行も含まれることがあります。実行リストには、実行の開始時に呼び出される初期関数のみが表示されます。このビューには、実行中に呼び出されたすべての関数が表示されるわけではありません。
ビューの上部にあるフィルタを使用して、ログに記録する実行のタイプを制御できます。ログの各行は 1 回の実行を表します。[開始時間]、[期間]、[ステータス] 列には、その実行に関する対応する情報が表示されます。
[関数] 列には、実行を開始した関数の名前が表示されます。実行に対応するスクリプト プロジェクトにアクセスできないが、ユーザーの代わりに実行された場合、この列には名前が表示されません。
[タイプ] 列には、実行を開始したものが表示されます。次の値があります。
- アドオン。実行はアドオンから開始されました。
- Execution API。実行は Apps Script API の呼び出しから開始されました。
- 時間駆動。実行は時間イベントによって発生しました。
- トリガー。実行はトリガーソースから開始されました。
- ウェブアプリ。実行はデプロイされたウェブアプリから開始されました。
- 編集者。実行の発生元が Apps Script エディタである。
実行を終了する
現在進行中の長時間実行は、ステータスが「実行中」と表示されます。これらの実行を停止するには、プロジェクト行の右側にあるその他アイコン
> [終了] をクリックします。設定
ダッシュボードの設定を調整するには、左側のナビゲーションで [設定] を選択します。
[設定] パネルに、Apps Script API の切り替えがあります。これにより、API にスクリプト プロジェクトへのアクセス権を付与できます。
この切り替えにアクセスするには、[設定] パネルで [Google Apps Script API] ラベルをクリックします。警告テキストと切り替えスイッチが表示された新しいパネルが開きます。セキュリティ対策として、スクリプト プロジェクトへのアクセスはデフォルトでオフになっています。アクセスを許可すると、承認したサードパーティ製アプリケーションは API を使用してスクリプトとデプロイを変更できるようになります。このアクセス権は、[設定] パネルでいつでも取り消すことができます。
詳しくは、Apps Script API アクセスガイドをご覧ください。