Apps Script プロジェクトの開発と管理を Apps Script エディタではなくターミナルから行うには、clasp
というオープンソース ツールを使用します。
clasp
Codelab では、すべての clasp
機能の概要について説明しています。
機能
ローカルで開発する
clasp
を使用すると、Apps Script プロジェクトをローカルで開発できます。自分のパソコンでコードを記述して、完成したら Apps Script にアップロードできます。既存の Apps Script プロジェクトをダウンロードして、オフライン時に編集することもできます。コードはローカルなので、Apps Script プロジェクトをビルドするときに、git
などのお好みの開発ツールを使用できます。
デプロイのバージョンを管理する
プロジェクトの複数のデプロイメントを作成、更新、表示します。
コードを構造化する
clasp
を使用すると、コードをディレクトリに整理できます。ディレクトリは、script.google.com にアップロードする際に保持されます。
# On script.google.com: ├── tests/slides.gs └── tests/sheets.gs # Locally: ├── tests/ │ ├─ slides.gs │ └─ sheets.gs
要件
clasp
は Node.js で記述され、npm
ツールで配布されます。clasp
を使用する前に、Node.js バージョン 4.7.4 以降をインストールしておく必要があります。Node.js のインストールには管理者権限が必要です。
インストール
Node.js をインストールしたら、次の npm
コマンドを使用して clasp
をインストールできます。
npm install @google/clasp -g
インストール後、パソコンの任意のディレクトリから clasp
コマンドを使用できます。
clasp
の使用
clasp
を使用すると、コマンドラインからさまざまなタスクを処理できます。このセクションでは、clasp
を使用して開発するときに使用できる一般的なオペレーションについて説明します。
ログイン
このコマンドはログインして、Google アカウントの Apps Script プロジェクトの管理を承認します。実行後、Apps Script プロジェクトが保存されている Google アカウントにログインするよう求められます。
clasp login
ログアウト
このコマンドは、コマンドライン ツールからログアウトします。引き続き clasp
を使用するには、clasp login
を使用して再ログインし、Google での再認証を行う必要があります。
clasp logout
新しい Apps Script プロジェクトを作成する
このコマンドは、オプションのスクリプト タイトルを指定して現在のディレクトリに新しいスクリプトを作成します。
clasp create [scriptTitle]
このコマンドは、現在のディレクトリに 2 つのファイルも作成します。
- スクリプト ID を格納する
.clasp.json
ファイル。 - プロジェクト メタデータを含む
appsscript.json
プロジェクト マニフェスト ファイル。
既存のプロジェクトのクローンを作成する
このコマンドは、現在のディレクトリに既存のプロジェクトのクローンを作成します。スクリプトを作成するか、Google アカウントと共有する必要があります。スクリプト ID を指定して、クローンを作成するスクリプト プロジェクトを指定します。
プロジェクトのスクリプト ID を確認する手順は次のとおりです。
- Apps Script プロジェクトを開きます。
- 左側にある [プロジェクトの設定] をクリックします。
[ID] で、スクリプト ID をコピーします。
clasp clone <scriptId>
スクリプト プロジェクトをダウンロードする
このコマンドにより、Apps Script プロジェクトが Google ドライブからパソコンのファイル システムにダウンロードされます。
clasp pull
スクリプト プロジェクトをアップロードする
このコマンドは、スクリプト プロジェクトのすべてのファイルをパソコンから Google ドライブにアップロードします。
clasp push
プロジェクト バージョンを一覧表示する
このコマンドは、スクリプト プロジェクトの各バージョンの番号と説明を一覧表示します。
clasp versions
公開済みのプロジェクトをデプロイする
スクリプト プロジェクトは、ウェブアプリ、アドオン、実行可能ファイルとしてデプロイできます。デプロイメントは、スクリプト エディタ、プロジェクトのマニフェスト、または clasp
を使用して作成できます。
clasp
を使用してプロジェクトをデプロイするには、まず Apps Script プロジェクトのイミュータブル バージョンを作成します。バージョンは、スクリプト プロジェクトの「スナップショット」であり、読み取り専用の分岐リリースに似ています。
clasp version [description]
このコマンドにより、新しく作成されたバージョン番号が表示されます。この数を使用して、プロジェクトのインスタンスをデプロイまたはデプロイ解除できます。
clasp deploy [version] [description]
clasp undeploy <deploymentId>
このコマンドは、既存のデプロイメントを新しいバージョンと説明で更新します。
clasp redeploy <deploymentId> <version> <description>
デプロイを一覧表示する
このコマンドは、スクリプト プロジェクトのデプロイ ID、バージョン、それらの説明を一覧表示します。
clasp deployments
Apps Script エディタでプロジェクトを開く
このコマンドにより、Apps Script エディタでスクリプト プロジェクトが開きます。エディタが、デフォルトのウェブブラウザの新しいタブとして起動します。
clasp open
clasp
オープンソース プロジェクトへの貢献
GitHub で clasp
に貢献します。