プロジェクトの管理

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

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

projects.create

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

オプション: プロジェクトのタイトルを指定できます。また、スクリプトの親として機能する Google ドキュメント、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 を使用して、特定の指標間隔を定義することもできます。