GoogleAppsScriptのローカル開発環境の構築

GoogleAppsScriptのローカル開発環境の構築についてまとめます。

目的は、「Gitでソースを管理するため」です。

【注意事項】
・本記事における操作環境はMacOSのためCLI操作はすべてターミナルで行います。
・本記事における操作説明は、ローカル環境構築ですが、Git環境の構築は含まれません。（本記事をアップデートするか別記事での解説を予定しています。）

手順は以下の通りです。

1. node.jsをインストールする

ローカルでGoogleAppsScriptを用いて開発する場合は、node.jsが必要です。

以下のサイトからインストールできます。

Node.js

2. claspをインストールする

GoogleAppsScriptプロジェクトをローカル環境で行うためにclaspをインストールします。

google/clasp

上記URLにも記載されている通り、claspをインストールするためのコマンドは以下の通りです。

sudo npm i @google/clasp -g

3. GoogleAppsScriptAPIを有効化する

外部からGoogleAppsScriptにアクセスできるように、GoogleAppsScriptAPIを有効化します。

やり方は、以下のURLにアクセスして表示されるスイッチコントロールを有効にします。

Apps Script – Google Apps Script

4. claspがGoogleアカウントへアクセスすることを許可する

claspはターミナルで操作します。

任意のプロジェクトディレクトリを作成したら、cdコマンドで作成したディレクトリへ移動します。

移動したら、claspがGoogleアカウントのツール郡を操作できるように以下のコマンドを入力します。するとブラウザが起動するので画面に従います。

clasp login

CLI画面で、「Authorization successful.」と表示されれば完了です。

5. ローカルディレクトリにスクリプトエディタ のソースをクローンする

ターミナルで操作を行う前に、スクリプトエディタの「スクリプトID」を調べておきます。(スクリプトエディタはスタンドアロンでもコンテナバインドでも構いません。)

調べたスクリプトIDを用いて、以下のコマンドを実行する。

clasp clone <スクリプトID>

以上で、ローカル環境の構築は完了です。ローカルのエディタでプログラムを編集してみてください。

(おまけ)claspの使い方①： ローカルで編集したソースをスクリプトエディタへpushする

ローカルで編集したソースコードを実行するには、スクリプトエディタ へpushする必要があります。

以下のコマンドを実行します。

clasp push

スクリプトエディタ を開く(すでに開いていた場合は開き直す)と、ローカルで編集したソースが反映されていることを確認できます。

(おまけ)claspの使い方②： スクリプトエディタ で編集したソースをローカルにpullする

スクリプトエディタ で編集したソースコートをローカル環境に対して反映させるにはpullする必要があります。

以下のコマンドを実行します。

clasp pull

他のコマンドを調べたい場合は、単に「clasp」と入力すればコマンド一覧が確認できます。

以上です。参考になれば幸いです。