プロジェクト管理

このセクションでは、Google Apps Script プロジェクトの作成、読み取り、変更、モニタリングに使用できる Google 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 バージョンとして保存されます。スクリプトがトリガーとして実行される場合、スクリプト エディタ、 Google Workspace アドオンのプレビュー モード、ウェブアプリ、 開発モードの Apps Script API として使用されます。

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

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

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

projects.getMetrics

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

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