walk diagonally

基本的にはプログラミングの話のつもり。フロントエンドよりです。

GASでspreadsheetに追記できるwebアプリを作ってみた。

Webアプリからspreadsheetにデータを送りたかったんですが、大変でした。

TL;DR

簡単にwebappを作るなら

  1. SpreadSheetからgoogle apps scriptを生成する
  2. VueCLI3でプロジェクト作成し、vue.config.jsをいじる
  3. claspインストールし、2で作成したプロジェクトの成果物をpushできるようにする
  4. POSTで書き込みをしようとするのではなく、 google.script.run.○○ で実行する

解説

1. SpreadSheetからgoogle apps scriptを生成する

SpreadSheetからgasを作成します。 この際gasとsheetを分けても問題ないが、呼び出しが少し面倒になるため、個人的にはsheetから生成したほうがいいと思っています。

2. VueCLI3でプロジェクト作成し、vue.config.jsをいじる

vue create gasapp
cd gasapp
npm i -D html-webpack-inline-source-plugin webpack-cdn-plugin

プロジェクトを作成し、以下のvue.config.jsで使うためのモジュールをinstall。 cli.vuejs.org

// vue.config.js
module.exports = {
  chainWebpack: config => {
    // disable prefetch and preload
    config.plugins.delete("prefetch");
    config.plugins.delete("preload");

    // Make js and css files inline into index.html
    config
      .plugin("html-inline-source")
      .use(require("html-webpack-inline-source-plugin"));
    config.plugin("html").tap(args => {
      args[0].inlineSource = "(/css/.+\\.css|/js/.+\\.js)";
      return args;
    });

    // make inline images
    config.module
      .rule("images")
      .use("url-loader")
      .options({});

    // make inline media
    config.module
      .rule("media")
      .use("url-loader")
      .options({});

    // make inline fonts
    config.module
      .rule("fonts")
      .use("url-loader")
      .options({});

    // make inline svg
    config.module
      .rule("svg")
      .uses.delete("file-loader")
      .end()
      .use("url-loader")
      .loader("url-loader")
      .options({});

    // Get npm modules from CDN
    config.plugin("webpack-cdn").use(require("webpack-cdn-plugin"), [
      {
        modules: [
          {
            name: "vue",
            var: "Vue",
            path: "dist/vue.runtime.min.js"
          },
          {
            name: "vue-router",
            var: "VueRouter",
            path: "dist/vue-router.min.js"
          }
        ]
      }
    ]);

    if (process.env.NODE_ENV === "production") {
      // html minify settings for GAS
      config.plugin("html").tap(args => {
        args[0].minify.removeAttributeQuotes = false;
        args[0].minify.removeScriptTypeAttributes = false;
        return args;
      });
    }
  }
};

こちらに記載されていたもののパクりです。 とても感謝してます。

qiita.com

これにより、vueで書いてもgas上で動かせるようになりました。

claspインストールし、2で作成したプロジェクトの成果物をpushできるようにする

qiita.com

こちらを参考にclaspを使えるようにした。

qiita.com

また、こちらを参考に appsscript.json 等々を配置

package.jsonscript"push": "vue-cli-service build && clasp push -f" を追記してdist以下の生成とそれらのpushをひとまとめにするとラクでした。

4.POSTで書き込みをしようとするのではなく、 google.script.run.○○ で実行する

一番大変なところでした。 詳細は下に記載するとして、まず結論としてページのview部分のファイルはこのようになりました。 *CSSフレームワークにbulmaを使用してます

// index.vue
<template>
  <div class="container">
    <h1>Input Your Data</h1>
    <div class="field">
      <div class="control">
        <input class="input is-info" type="text" placeholder="Text" v-model="text">
      </div>
    </div>
    <div class="field">
      <div class="control">
        <a class="button is-link" @click="onClick">Submit</a>
      </div>
    </div>
  </div>
</template>

<script>
export default {
  name: "Index",
  data() {
    return {
      text: ""
    };
  },
  methods: {
    onClick: function(e) {
      google.script.run.addData(
        JSON.stringify({
          text: this.text,
        })
      );
   }
};
</script>

Code.js(google apps script)

function doGet() {
  return HtmlService.createHtmlOutputFromFile("index").addMetaTag(
    "viewport",
    "width=device-width, initial-scale=1"
  );
}

function addData(rawParams) {
  Logger.log("addData");
  var params = JSON.parse(rawParams);
  var ss = SpreadsheetApp.getActive();
  var sheet = ss.getActiveSheet();
  var values = [params.text];
  sheet.appendRow(values);
}

どうにかしてPOSTでできないかと考えていましたが、普通に google.script.run.hogehoge とやったら動きました。

詰まったところ : POST編

詰まった要因として一番大きかったところはPOSTでリクエストを飛ばしてどうにかできないかと考えていたところでした。

一番最初に考えたこと

axiosを入れて普通にpostしようとした

axios.post("https://script.google.com/macros/s/AKfxxxxx/exec", params)

->405エラー OPTIONSのmethodで飛ばされてしまっているらしい。

stackoverflow.com

次に考えたこと

それだと通らないようだったので application/x-www-form-urlencoded で投げるように修正してみました。

const params = new URLSearchParams();
params.append("test", this.test);
axios.post("https://script.google.com/macros/s/AKfxxxxx/exec", params)

Access to XMLHttpRequest at 'https://script.google.com/macros/s/AKfxxxxx/exec' from origin 'https://n-hv3nxxxxx-script.googleusercontent.com' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

???
どうやらoriginが違う・・・
ブラウザでアクセスしているURLも https://script.google.com/macros/s/AKfxxxxx/exec にもかかわらず、originが違う認識になっている。
デベロッパーツール開いて window.location.href 等でURLを見てみても https://script.google.com/macros/s/AKfxxxxx/exec になっているのでなかなか不思議な現象。
きっとセキュリティ的な問題でこういう仕様になっているのだろうと諦めた。

結果としておかげさまで google.script.run にたどりつけたのでよかったといえばよかった。
そして公式のドキュメントにも実はちゃんと書いていた。

developers.google.com

詰まったところ : Lambda編

ブラウザから叩こうとするからCORSで阻まれるので、何らかの形でサーバー側から実行できたらいいじゃんと考え、なんとなくlambdaでできないかと試してみた。

qiita.com

紆余曲折はあったものの、上記を参考にして一旦動くようにはなったが、定期的にtokenのリフレッシュをしなければいけない、というところで少し面倒+そこまでして動かしたいものではないなということで断念。

その後いろいろ試してみたら

// Lambda
const request = require("request");

const headers = {
  "Content-type": "application/json"
};

const dataString = '{"value":"aaa"}';

var options = {
  url:process.env['url'],
  method: "POST",
  headers: headers,
  body: dataString
};

function callback(error, response, body) {
  if (!error && response.statusCode == 200) {
    console.log(body);
    const response = {
    statusCode: 200,
    body: JSON.stringify("Hello from Lambda!")
  };
  return response;
  }else{
    console.error(error)
  }
}

exports.handler = event => {
  console.log("POST gas to sheet");
  request(options, callback);
  console.log("Finished");
  // TODO implement
  
};

だいぶてきとーに書いてますが、普通に request で飛ばしたらいけました。
tokenとか全然関係ないのか・・・

余談

実装してみたサンプルコード

github.com