メインコンテンツへスキップ
見出し画像

Windows11でGAS開発を効率化するVS Code×clasp 【1. 環境構築編】

    はじめに

    Google Apps Script(以下、GAS)を開発していると、Visual Studio Code(以下、VS Code)やCursor を使って、AIにコーディングをアシストしてもらいたい、と思うことはありませんか?

    この記事では、Windows11環境でClaspを使用してVS CodeやCursor 上でGASを開発するため、Claspの環境構築方法をまとめます。

    claspとは

    clasp(Command Line Apps Script Projects)は、GASをローカル環境で開発するためのコマンドラインツールです。
    claspを使うことで、VS Code上でGASのコーディングを行い、Git等のバージョン管理システムと連携させることができます。

    環境構築方法

    Windows環境でのclasp導入の前提条件

    Windows環境でclaspを利用するためには、Node.jsとそのパッケージ管理ツールであるnpmのインストールが必要です。

    1.NVM for Windowsのインストール

    nvm(Node Version Manager)は、複数のNode.jsバージョンを管理するためのツールです。これにより、プロジェクトごとに異なるNode.jsバージョンを切り替えることが可能になります。

    インストール手順:

    1.https://github.com/coreybutler/nvm-windows/releases から、 最新の「nvm-setup.exe」をダウンロードします。

    画像
    1.1 nvm-setup.exeのダウンロード

    2.1.でダウンロードした「nvm-setup.exe」ファイルをダブルクリックして実行します。

    3.「I accept the agreement」のチェックボックスをクリックし、「Next」をクリックします。

    画像
    1.3 License Agreement
    画像
    1.3 License Agreement Nextボタンクリック

    4.インストールフォルダを選択します。特に指定なければ現在のフォルダのまま、「Next」をクリックします。

    画像
    1.4 Select Destination Location

    5.Node.jsのシンボリックリンクを作成するフォルダを選択します。特に指定なければ現在の設定のまま、「Next」をクリックします。

    画像
    1.5 Set Node.js Symlink

    6.「Install」をクリックして、インストールを開始します。

    画像
    1.6 Ready to Install
    画像
    インストール中

    7.インストールが完了したら「Finish」をクリックします。

    画像
    1.7 インストール完了

    8.コマンドプロンプトを「管理者として実行」で起動します。

    画像
    1.8 コマンドプロンプト起動
    画像
    1.8 コマンドプロンプト画面

    9.インストールが正常に完了したか確認します。

    nvm -v
    画像
    1.9 nvmのバージョン表示

    2.nvm経由でNode.jsをインストール

    Node.jsは、JavaScriptをブラウザ外でも実行できる環境で、サーバーサイドやデスクトップアプリケーションの開発に利用されます。

    インストール手順:

    1.コマンドプロンプトを「管理者として実行」で起動します。

    画像
    2.1 コマンドプロンプト起動
    画像
    2.1 コマンドプロンプト画面

    2.インストール可能な Node.js のバージョン一覧を表示します。

    画像
    2.2 Node.jsバージョン一覧表示

    3.表示された一覧からLTS(Long Term Support)の最新バージョンをインストールします。(今回は、20.18.0でした)

    nvm install 20.18.0
    画像
    2.3 インストール

    4.3.でインストールしたバージョンを使用するように設定します。

    nvm use 20.18.0
    画像
    2.4 バージョン切り替え

    5.npmコマンドが利用可能か確認します。

    npm -version
    画像
    2.5 バージョン確認

    3.Google Apps Script APIの有効化

    ローカル環境(PC)からGASプロジェクトを操作するには、Google Apps Script APIを有効にする必要があります。

    1.Apps Scriptの設定画面に移動します。

    画像
    3.1 Apps Scriptの設定画面

    2.「Google Apps Script API」をクリックし、スライダーを「オン」に切り替えます。

    画像
    3.2 Google Apps Script APIをクリック
    画像
    3.2 オンに切り替え

    3.設定が完了したら、左上の戻るボタン「←」をクリックします。

    画像
    3.3 戻るボタンクリック

    「Google Apps Script API」の設定がオンに切り替わりました。

    画像
    「Google Apps Script API」の設定完了

    4.claspのインストール

    コマンドプロンプトを「管理者として実行」で起動します。

    画像
    4.1 コマンドプロンプト起動
    画像
    4.1 コマンドプロンプト画面

    2.npmを使用してclaspをグローバルにインストールします。

    npm install -g @google/clasp
    画像
    4.2 claspインストール

    3.インストールが正常に完了したかを確認します。

    clasp --version
    画像
    4.3 バージョン確認

    5.claspでのログイン認証

    claspを使ってGoogle Apps Scriptにアクセスするには、Googleアカウントとの連携が必要です。

    1.コマンドプロンプトで、以下のコマンドを実行します。

    clasp login
    画像
    5.1 claspログイン

    2.ブラウザが自動的に開き、Googleアカウントへのログイン画面が表示されます。

    画像
    4.2 アカウント選択画面

    3.Googleアカウントを選択し、必要な権限を許可し、「続行」をクリックします。
    (セキュリティ警告が表示されることがありますが、自身のプロジェクトのためであれば問題ありません)。

    画像
    4.3 権限選択

    4.認証が成功すると、下記画面が表示されます。

    画像
    4.4 認証成功

    まとめ

    以上で、Windows11環境でclaspを使ったGAS開発環境の構築が完了しました。
    次回は、この環境を使用して、GASプロジェクトの作成、プロジェクトにファイルをアップロード、プロジェクトからファイルをダウンロードする方法についてまとめていきます。

    連載目次

    1.Windows11でGAS開発を効率化するVS Code×clasp 【1. 環境構築編】

    2.Windows11でGAS開発を効率化するVS Code×clasp 【2. GASプロジェクトの管理編 - クローン・アップロード・ダウンロード】

    3.Windows11でGAS開発を効率化するVS Code×clasp 【3. clasp loginせずに複数アカウントを切り替える】


     
     
    ノンプロ研にて、Python、GAS(Google Apps Script)、技術ライティング勉強中です。 東北地方の片隅で、オンラインアシスタントとして、リモートワークしています。

    あなたへのおすすめ