Apps Script ダッシュボード

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

  • ドキュメントに関連付けられたバインド スクリプトを含む、既存の 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 アクセス ガイドをご覧ください。