Apps Script ダッシュボード

Apps Script ダッシュボードでは、Apps Script プロジェクトの管理とモニタリングを行うことができます。ダッシュボードを使用して、次の操作を行うことができます。

  • Google Workspace ドキュメントに関連付けられているバインドされたスクリプトなど、既存の Apps Script プロジェクトの表示と検索を行います。
  • 新しいプロジェクトを作成する。
  • プロジェクトの詳細(使用する OAuth スコープなど)を表示する。
  • スクリプト プロジェクトの正常性と使用状況をモニタリングします。
  • 自分のプロジェクトや、アカウントの認証情報を使用して実行されるその他の実行ログを表示します。
  • Apps Script API をオンまたはオフに切り替えて、アプリが API を使用してスクリプト プロジェクトを操作することを許可または禁止します。

プロジェクトの表示と検索

Apps Script ダッシュボードには、表示または編集可能なすべてのスクリプト プロジェクトが一覧表示されます。ダッシュボードの左側のナビゲーションでは、これらのプロジェクトが次のカテゴリに分類されています。

  • スター付きプロジェクトmonitoringしているプロジェクト。
  • マイ プロジェクト。自身がオーナーとなっているプロジェクト。
  • すべてのプロジェクト。自分が所有しているプロジェクト、または表示または編集の権限があるプロジェクト。
  • 共有アイテム。自分が所有していないが自分と共有されているプロジェクト。
  • ゴミ箱。Google ドライブから削除したプロジェクト。

プロジェクト リストには、プロジェクト名、オーナー、最終更新日が表示されます。プロジェクト名の横にあるアイコンは、プロジェクトがスタンドアロン プロジェクトか、バインドされたプロジェクトかを示します。

プロジェクトの詳細を表示

各プロジェクトには、そのプロジェクトに関するデベロッパーの詳細を確認できるビューが含まれています。プロジェクトの詳細を表示するには、プロジェクト リストの行をクリックします。

[プロジェクトの詳細] ビューには、プロジェクトに関するエラー率実行数ユーザーのデータとグラフに加えて、プロジェクトを使用するエンドユーザーがリクエストした OAuth スコープが表示されます。データ指標は次のように定義されます。

  • エラー率。キャッチされなかった例外が原因で実行に失敗した実行の割合。これは、定義された期間内に失敗した実行数を合計実行数で割った値として計算されます。
  • 実行。プロジェクトが「実行」または実行された回数。プロジェクトの実行方法について詳しくは、実行タイプをご覧ください。
  • ユーザー。指定した期間にプロジェクトを 1 回以上実行したユニーク ユーザー(アカウント)の数。匿名ユーザーは追跡されないため、ユーザー数やグラフには反映されません。

プロジェクトの各デプロイメントは、データとグラフの上にある [プロジェクトの詳細] ページにタブとして表示されます。タブを選択すると、そのデプロイメントの関連データが表示されます。[ALL] を選択すると、プロジェクトのすべてのデプロイメントと、Apps Script コードエディタ内でプロジェクトを実行しているデベロッパーによる実行の集計データが表示されます。

プロジェクトをモニタリングする

定期的に使用または管理するよりもはるかに多くの Apps Script プロジェクトにアクセスできる場合があります。プロジェクトに簡単にアクセスできるようにブックマークするには、スターを付けることができます。プロジェクトにスターを付けると、それらのプロジェクトの使用率とエラー率の統計とグラフの集計もモニタリングできます。

プロジェクトにスターを付けるには、プロジェクト行の右側にあるその他アイコン > [スターを付ける] をクリックします。プロジェクトの詳細の表示中にその他アイコン をクリックして、プロジェクトにスターを付けることもできます。

左側のナビゲーションで [スター付きプロジェクト] を選択すると、ブックマークしたプロジェクトを表示できます。ページの上部にある [エラー率]、[実行数]、または [ユーザー] スコアカードをクリックすると、過去 7 日間のスター付きのすべてのプロジェクトに関連するグラフが表示されます。

プロジェクトからスターを削除するには、プロジェクトの行でその他アイコン をクリックし、[スターをはずす] を選択します。

実行を管理する

Apps Script ダッシュボードを使用して、Apps Script プロジェクト関数の個々の実行を表示および管理できます。左側のナビゲーションで [My Executions] を選択すると、最近の実行の完全なログを確認できます。

[My Executions] パネルには、自分がオーナー、編集者、閲覧者になっているプロジェクトについて、過去と現在実行中のすべての実行のログがデフォルトで表示されます。このリストには、ユーザーに代わって実行された場合、アクセス権がないプロジェクトの関数実行(ユーザーがインストールして実行するアドオンなど)も含まれる場合があります。実行リストには、実行を開始するために呼び出される最初の関数のみが表示されます。実行中に呼び出されたすべての関数が表示されるわけではありません。

ビューの上部にあるフィルタを使用して、ログで報告される実行の種類を制御できます。ログの各行は 1 つの実行を表します。[Start Time]、[Duration]、[Status] の各列に、その実行に関する対応する情報が表示されます。

[関数] 列には、実行を開始した関数の名前が表示されます。実行に対応するスクリプト プロジェクトへのアクセス権がない場合、ユーザーの代わりに実行された場合、この列に名前は表示されません。

[Type] 列には、実行を開始した要因が表示されます。次の値があります。

  • アドオン。アドオンから実行されました。
  • Execution API。Apps Script API の呼び出しによって実行されました。
  • Time Driven。実行はタイムイベントによって発生しました。
  • トリガー。トリガーソースから実行が開始されました。
  • ウェブアプリ。デプロイされたウェブアプリから実行されました。
  • 編集者。Apps Script エディタから実行されました。

実行を終了する

現在進行中の長時間実行は、[ステータス] に「実行中」と表示されます。これらの実行を停止するには、プロジェクト行の右側にあるその他アイコン > [終了] をクリックします。

設定

ダッシュボードの設定を調整するには、左側のナビゲーションで [設定] を選択します。

[Settings] パネルには、Apps Script API の切り替えボタンがあります。これにより、API にスクリプト プロジェクトへのアクセス権を付与できます。

この切り替えにアクセスするには、[設定] パネルの [Google Apps Script API] ラベルをクリックします。新しいパネルが開き、警告テキストと切り替えスイッチが表示されます。セキュリティ対策として、スクリプト プロジェクトへのアクセスはデフォルトではオフになっています。アクセスを許可すると、承認したすべてのサードパーティ アプリケーションが API を使用してスクリプトとデプロイを変更できます。このアクセス権は、[設定] パネルでいつでも取り消すことができます。

詳細については、Apps Script API アクセスガイドをご覧ください。