はじめに

Google Apps Script API を使用すると、Google Apps Script でのスクリプトの作成、管理、実行を自動化できます。Google Apps Script プロジェクトの作成、変更、デプロイをプログラムで行ったり、Apps Script 関数をリモートで実行したりできます。これらの操作は、通常は Apps Script エディタまたはその UI を使用する必要があります。

この API は、次の目的でよく使用されます。

  • Apps Script プロジェクトとデプロイを作成、管理します。
  • スクリプト プロジェクトで関数を追加または更新します。
  • 他のアプリケーションから Apps Script 関数を実行する。
  • スクリプトの実行ログとステータスをモニタリングします。

また、Apps Script API は Apps Script Execution API を置き換え、拡張します。Apps Script API を使用すると、Execution API と同様に、Apps Script 関数をリモートで実行できます。

アプリでこの API を使用するには、使用を有効にする必要があります。

他のアプリがスクリプトを管理できるようにするには、アクセス権を付与する必要があります。

API の概要

Apps Script API は複数のリソースに分割されており、それぞれに特定の目的と実行できるリクエストのセットがあります。これらのリソースは次のとおりです。

  • projects - スクリプト プロジェクトの表現。API には、プロジェクトの作成、読み取り、モニタリング、変更を行うメソッドが用意されています。このリソースを使用して、プロジェクトのスクリプト ファイルとメタデータを管理します。
  • projects.deployments - スクリプト デプロイの表現。この API には、スクリプト プロジェクトのデプロイを作成、一覧表示、更新、削除するためのメソッドが用意されています。デプロイを使用して、スクリプトをウェブアプリ、アドオン、実行可能ファイルとして利用できるようにします。
  • projects.versions — スクリプト プロジェクトのバージョンを表します。この API には、プロジェクト バージョンを作成して読み取るメソッドが用意されています。バージョンを使用して、スクリプト プロジェクトのさまざまなイテレーションを追跡します。
  • processes - スクリプト関数の実行を表します。この API は、既存のプロセスを一覧表示し、タイプや現在のステータスなどの情報を収集するメソッドを提供します。このリソースを使用して、scripts.run メソッドを使用して開始されたスクリプト実行をモニタリングします。
  • scripts - Apps Script 関数をリモートで実行するメソッドを提供するエンドポイント。このリソースを使用して、アプリケーションからスクリプト プロジェクトの関数を実行します。