Apps Script ダッシュボード

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

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

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

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

  • スター付きプロジェクトモニタリングしているプロジェクト。
  • マイ プロジェクト。自分がオーナーとなっているプロジェクト。
  • すべてのプロジェクト。自分がオーナーであるか、閲覧権限もしくは編集権限を持っているプロジェクト。
  • 共有アイテム。自分が所有していないものの、共有されているプロジェクト。
  • ゴミ箱:Google ドライブから削除したプロジェクト。

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

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

各プロジェクトには、そのプロジェクトに関するデベロッパーの詳細を表示するビューがあります。プロジェクトの詳細を表示するには、プロジェクト リストの行をクリックします。

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

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

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

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

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

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

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

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

実行の管理

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

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

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

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

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

  • アドオン:アドオンから実行されました。
  • Execution API:実行は Apps Script API の呼び出しによって行われました。
  • 時間主導。時間イベントが原因で実行されました。
  • トリガー。実行はトリガーソースから行われました。
  • ウェブアプリ。デプロイ済みのウェブアプリから実行されました。
  • 編集者。実行は Apps Script エディタから行われました。

実行を終了する

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

設定

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

[設定] パネルで、Apps Script API の切り替えを行うことができます。これにより、API にスクリプト プロジェクトへのアクセス権を付与できます。

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

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