プロジェクトの管理

このセクションでは、Apps Script プロジェクトの作成、読み取り、変更、モニタリングに使用できる Apps Script API メソッドの概要について説明します。[プロジェクト管理] サンプルページには、API 管理リクエストの例が示されています。各メソッドのリファレンス ドキュメントには、実装の詳細が記載されています。

API メソッドの概要
プロジェクトを作成する

projects.create

結果: プロジェクト ファイルのない、デフォルトのプロジェクト マニフェストを含む、基本的な空のプロジェクトを作成します。

オプション: プロジェクトのタイトルを指定できます。スクリプトの親として機能する Google ドキュメント、Google スプレッドシート、Google フォーム、スライド ファイルの Google ドライブ ID を指定して、バインドされたスクリプトを作成することもできます。

プロジェクトのメタデータを読み取る

projects.get

結果: プロジェクト メタデータを表す Project オブジェクトを取得します。このデータには、プロジェクトのタイトル、スクリプト ID、作成ユーザー、作成時間などの詳細が含まれます。

プロジェクトのコンテンツを読み取る

projects.getContent

結果: プロジェクト内のコードファイルと HTML ファイルごとに 1 つの File オブジェクトの配列を返します。リストには、プロジェクト マニフェストも JSON ファイルとして含まれます。ファイル オブジェクトには、ファイルのソース コンテンツ(File.source)と、ファイル内の関数のリスト(File.functionSet)などの他のメタデータが含まれます。

オプション: クエリ パラメータを使用して、取得するコンテンツのバージョンを指定できます。

プロジェクトのコンテンツを更新する

projects.updateContent

結果: スクリプト プロジェクトのファイルの内容を変更します。新しいコンテンツは File オブジェクトの配列として提供します。これらの File オブジェクトの 1 つは JSON 型で、スクリプト プロジェクトの新しいプロジェクト マニフェストを表す必要があります。新しいコンテンツは、プロジェクトの HEAD バージョンとして保存されます。スクリプトがトリガーとして、スクリプト エディタで、アドオンのプレビュー モードで、または開発モードのウェブアプリや Apps Script API として実行される場合に使用されます。

: スクリプト プロジェクトのコンテンツを更新する場合、一般的な方法は、まず projects.getContent リクエストを発行して既存の File の配列を取得し、それらのオブジェクトに必要な変更を加えてから、File projects.updateContent リクエストの入力として使用することです。

警告: 新しいコンテンツは、スクリプト プロジェクト内の既存のファイルをすべて置き換えます。リクエストによって更新されなかったファイルは削除されます。

プロジェクトの指標を読み取る

projects.getMetrics

結果: プロジェクトに関する特定の指標を読み取ります。これらの指標には、ユーザー数、合計実行数、合計実行エラー数などの詳細が含まれます。 MetricType を使用して、リクエストする情報を指定します。

オプション: MetricsFilter を使用して、結果を特定のデプロイまたはスクリプト関数に制限します。 MetricsIntervalConfig を使用して、特定の指標間隔を定義することもできます。