My Note

自己理解のためのブログ

clasp で Google App Script ( GAS ) の開発環境を整えた

はじめに

Google App Script(GAS) でコーディングするにあたりローカルの開発環境をセッティングしたので備忘録です。 GASを実行するには、https://script.google.com/home でプロジェクトを作成してブラウザのエディタでコーディンングができます。 しかし、ブラウザ上でコーディンングするより使い慣れたエディタ(Visual Stdio Code)でやりたかったので clasp というgoogle製のCLIツールを 利用して環境を整えました。

設定

インストール

claspのgithuリポジトリ

github.com

node.jsが必要なのでインストールします。ここではインストールされている状態で以下をインストール。

npm init -y
npm install @google/clasp -g
npm install @types/google-apps-script

Googleアカウントに認証する。

clasp login --no-localhost

これを実行するとブラウザに画面が表示されていくので説明に応じて設定します。

設定で "Google Apps Script API" を有効化します。

f:id:yhidetoshi:20220215141154p:plain[

claspのセッティング

clasp でプロジェクトを作成

$ clasp create
Create which script? (Use arrow keys)
❯ standalone
├── .clasp.json
├── node_modules
├── package-lock.json
├── package.json
└── src
    ├── appsscript.json
    ├── crypto.js
  • .clasp.json
    • scriptId: 以下のプロジェクトの設定の値
    • rootDir: jsのソースコードを配置するパスを指定する
{
    "scriptId": "XXXXXXXXXXXXXXX",
    "rootDir": "./src"
}

f:id:yhidetoshi:20220215142003p:plain

  • appsscript.json は rootDirで指定したパスに配置する

claspのコマンド例

$ clasp open # webブラウザのエディタを開く
$ clasp push # コードをwebブラウザのエディタにアップロード
$ clasp pull # webブラウザのエディタのコードから取得する

参考