GASと組み合わせて自作ツールにメッセージ受信機能を付ける方法

自作のツールを公開すると後々何らかのメッセージを表示させたり、最悪動かせない様に止めたいなーと思う事が多々あると思います。

今回はその中でも「メッセージを受信する（受信した後に何らかのアクションを起こす）」という機能を、GoogleAppsScript（以下GAS）とスプレッドシートを組み合わせて実装する際の手順を紹介致します。

ちなみに私が以前から公開しており、つい最近更新を行った「くりったー」というツールで「最新バージョンの有無を通知する」という機能を同じ仕組みで実装してるので、そちらで実装した内容を例に紹介していきます。

れいんの技術録

C#でクリックポストの自動登録ツールを作ってみた

https://rabbitfoot.xyz/clickpost-autoregister/

扱えるプログラミング言語を増やさないとなーという事で、C#の勉強がてら適当に作ってみたツールを公開してみる事にします。ツールの内容は「クリックポストの自動作成（登録？）ツール」です。参考にしたのはChromeウェブストアにあったこちらのツール。※こち...

※コードはC#のものです。

- 目次 -

1 仕組みについて
2 スプレッドシート側の書き方
3 GAS側の書き方
4 ウェブアプリケーションとして公開する
5 ツール側の書き方
6 他の利用法

仕組みについて

まず最初に「メッセージ（バージョン番号）を受信する」という性質上、ツールを使用するPCがインターネット接続環境にある事は必須です。オフライン向けのツールには使用できません。

では本題ですが、バージョン番号を受け取って何らかのアクションを実行するまでの処理は大体以下の様な流れになります。

①（ツール）GASに最新バージョンの番号を要求する

②（GAS）スプレッドシートを参照し、バージョン番号を取得する

③（GAS）バージョン番号をツールに返す

④（ツール）受け取ったバージョンを判定し、自身の方が古ければ通知する

図にすると以下の様な感じです。

流れが分かった所で早速それぞれの機能を作っていきます。

スプレッドシート側の書き方

まずスプレッドシート上の書き方ですが、ここは好きなレイアウトで問題ありません。

値の取得はGAS側に書くので、そちらで分かり易い様な形にしておけば大丈夫です。

ちなみに私の場合はこんな感じ。

GAS側の書き方

まずはコードをそのまま載せます。
※「SHT_ID」は伏せ字にしているので、各々で修正して下さい

var FRIMATOOL_VERSION = "B2";
var CLITTER_VERSION = "B3";
var SHT_ID = "*************************************";

function doGet(e) {
  var version = ""
  var sht = SpreadsheetApp.openById(SHT_ID).getSheetByName("main");
  var toolName = e.parameter.toolname;
  
  if(toolName == "clitter"){
    version = sht.getRange(CLITTER_VERSION).getValue();
  }else if(toolName == "frimasupport"){
    version = sht.getRange(FRIMATOOL_VERSION).getValue();
  }
  
  return ContentService.createTextOutput(version);
}

ツールからGET形式でアクセスしてもらう事を想定し、関数はdoGetで用意しておきます。

そして上記のGASは各ツールのバージョン返却用総合窓口として作っているので、アクセス元のツール名を「toolname」に格納して自己申告してもらう様にしています。

※特定のツールに限定して作るのであれば、変数への格納部分やIF文の所は丸ごとカットして問題ありません。

ツール名の送信の仕方はツール側で記述するので、今は『「e.parameter.toolname」でどのツールがアクセスしてきたかが分かる』とだけ考えてもらえれば良いです。

その後、ツール名を判定して返すバージョン値を格納。

returnでバージョン値をツールに返すという流れになります。

ウェブアプリケーションとして公開する

このままでは作成したGASにアクセスする事ができませんので、どこからでもアクセス出来るようにウェブアプリケーションとして公開する必要があります。

手順は「公開」タブから「ウェブアプリケーションとして導入」を選択し、

アクセス権の設定を「匿名ユーザー含む全員」にして公開（Deploy）するだけ。

すると以下の様なURLが発行されるので、これでGAS側の準備は全て完了です。
https://script.google.com/macros/s/********************/exec

ちなみに上で掲載しているGASのコードの場合、以下のURLをブラウザで叩くとスプレッドシートに入力している値が返ってきているのが確認できます。

■「toolname」に「clitter」を指定した場合

https://script.google.com/macros/s/***/exec?toolname=clitter
⇒14

■「toolname」に「frimasupport」を指定した場合

https://script.google.com/macros/***/exec?toolname=frimasupport
⇒300

ツール側の書き方

ツール側のコードは以下の様な形になります。

const int MY_VERSION = 14;
private void Form_Load(object sender, EventArgs e)
{
    var url = "https://script.google.com/macros/s/***/exec?toolname=clitter";
    var request = (HttpWebRequest)WebRequest.Create(url);
    var response = (HttpWebResponse)request.GetResponse();
    string responseContent = string.Empty;
    using (var responseStream = response.GetResponseStream())
    using (var stRead = new StreamReader(responseStream))
    {
        responseContent = stRead.ReadToEnd();
    }
    
    if(MY_VERSION < int.Parse(responseContent))
    {
        this.MenuItem_VersionNotice.Enabled = true;
    }
}

上記コードの例では要求タイミングがフォームロード時になっていますが、別にここでないといけない理由は無いので好きな場所に変更して構いません。

また、今回はWebRequestを使用していますが他の方法でも問題ありません。あくまで一例です。

アクセスする時点でURLに「?toolname=clitter」を記述していますが、ここに自身のツール名を入力しておきます。別のツールに移植する場合は「=」より後ろを変えるだけで済むので手間も掛かりません。

ちなみにGASのコード側で「e.parameter.toolname」と書いて受け取ったツール名を取り出しましたが、この「toolname」という名前はURLでアクセスする際にその名前で指定したからです。

例えばこの部分を

url = “https://script.google.com/macros/s/***/exec?name=clitter”

とすれば、GAS側は

「e.parameter.name」

で値を取得する事ができます。

値を複数渡すことも可能で、その場合は

exec?name=clitter&date=20191106&id=abcde

この様に「&」で要素を繋いだ状態にすればOKです。