GASでAPIを作るぞ！JSONを返す方法とその性能試験を実施してみた。 - ポンコツエンジニアのごじゃっぺ開発日記。

この記事は GAS道場 Advent Calendar 2019 の8日目の記事です。 Google Apps Script(GAS)をこれから使おうという方向けのアドベントカレンダーになります。

今回はGASでJSONを返すAPIを作りたいと思います。これこそがGASのとても良いところの1つ、サーバーの用意をせずにも無料でAPIサーバのようなものを作れるのです。

APIを返してみよう

さっそくですが、実際にプログラムを書いてみましょう。

function doGet(e) {
  var data = {Hello:'world'};
  var payload = JSON.stringify(data)
  var output = ContentService.createTextOutput();
  output.setMimeType(ContentService.MimeType.JSON);
  output.setContent(payload);
  
  return output;
}

Helloの要素にworldという文字列を入れて、それをJSONにして返しています。これでOKです。あとは昨日の記事でも紹介したウェブサイトとして公開に書いてあるやり方でウェブサイトとして公開します。このとき注意しないといけないのが、以下の項目です。

項目	内容
次位のユーザーとしてアプリケーションを実行	自分
アプリケーションにアクセスできるユーザー	全員(匿名ユーザを含む)

これで発行されるURLにアクセスしてみましょう。以下のように、しっかりHello Worldっぽいデータが返されました。

f:id:ponkotsu0605:20191207201556p:plain

ブラウザで表示時のJSON整形

ここでちょっと余談なのですが、JSONをそのまま表示するとわかりにくいので、自分は以下のようなchromeの拡張機能を入れて表示しています。

chrome.google.com

これを入れた状態で先程のURLにアクセスすると、以下のように整形されたJSONを確認することができます。 f:id:ponkotsu0605:20191207201818p:plain なので、個人的にはいろんな人にお勧めしております。

アクセスカウンターの応用

では、昨日と同じ流れで、アクセスカウンターをJSONで返してみましょう。

function doGet(e) {
  var data = {count:getData()};
  var payload = JSON.stringify(data)
  var output = ContentService.createTextOutput();
  output.setMimeType(ContentService.MimeType.JSON);
  output.setContent(payload);
  
  return output;
}

function getData() {
  var data = SpreadsheetApp.openById('1sgRxnlKO_i-5rdoex3_Vww27fF0MH2gXgg0BYB4b0eo').getSheetByName('シート1').getRange(1,1).getValue();
  SpreadsheetApp.openById('1sgRxnlKO_i-5rdoex3_Vww27fF0MH2gXgg0BYB4b0eo').getSheetByName('シート1').getRange(1,1).setValue(data + 1)
  return data;
}

スクリプトはほぼ一緒ですが、HTMLではなくJSONで返しています。

これを同じようにウェブサイトとして公開してアクセスしてみましょう。 f:id:ponkotsu0605:20191207202358p:plain アクセスするたびにcountが増えて返してくれるAPIができました。

性能試験

ここで気になるのが、このAPIはどのくらいの性能が出るんでしょう？個人的な感覚ですが、スプレッドシートにアクセスするって重い処理なので心配。

ちなみに、Googleのスピードテストであるインターネット速度テストは、以下のように100Mbps弱です。

f:id:ponkotsu0605:20191207203022p:plain

今回は、curlコマンドを利用して何回かレスポンスタイムを計測してみます。gasは自分のサイトではないので、abコマンドとかjmeterで攻撃したりして負荷試験をしないでくださいね。

そのため、今回使用するのは、以下のようにリクエストを何度か叩いて、それをコンソールに出力するだけです。これの平均値を求めることで性能を見てみようと思います。

$ while true; do curl -kL  http://script.google.com/macros/s/XXXXXXXXXXXXXXXXXXXXXXXXX/exec  -o /dev/null -w "%{time_total}"  2> /dev/null; echo;done

静的なHello Worldの文字列を返すAPI

まずは、Helloなworldの性能です。

以上のようになり、平均値が0.8990289524でした。

動的なアクセスカウンターを返すAPI

次に、アクセスカウンターのようなもので、スプレッドシートの値の取得と書き込みを行っているものです。

以上のようになり、平均値が1.814992714でした。