プロジェクトの管理

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

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

projects.create

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

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

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

projects.get

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

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

projects.getContent

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

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

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

projects.updateContent

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

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

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

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

projects.getMetrics

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

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