Google Apps ScriptでGET・POST 🌴 officeの杜

Google Apps Scriptには、ウェブアプリケーションを公開したりするために「doGet」「doPost」という特別な関数があります。パラメータを加えて渡して上げることで、スプレッドシートのデータなどをJSONで受け取ったり、ウェブページを生成して、ウェブアプリケーションを表示したりなど、非常に重要な機能の１つです。この仕組を使うことで、自作のREST APIを作ることも可能です。

今回は、この「doPost」「doGet」を利用して、実行をするとスプレッドシートに書き込まれるといったものを作ってみたいと思います。

1 今回使用するスプレッドシートや資料
2 概要
3 doGet
4 doPost
5 関連リンク

今回使用するスプレッドシートや資料

概要

doGetは、URLに繋げてパラメータを与えて送ります。HTTP通信のGETなわけですが、こちらのほうが利用する範囲が広いんじゃないかなぁと。思いつくだけで言えば、

パラメータ付きで送ってスプレッドシートの値をJSONで取得する（しかも、フィルタした後の値とか）
予め組んで置いたURLをメールに記載して、クリックすると発動する何か（例えば、承認されるとか、ファイルが作られるとか）
与えるパラメータに応じて表示するHTMLを切り替える
パラメータを可変でユーザが選んだり、与えたパラメータによってデータを書き換える。
Google Apps Scriptではウェブアプリケーション公開用のメソッドでもある。

doPostは、URLに繋げるのではなくHTTP通信にパラメータを渡すPOST通信です。GETと違いパラメータはURLには出てこないので、認証などを要するようなケースで利用されます。また、バイナリデータを送ったり（アップロード）などでもPOSTを使いますね。

両者の違い、用途としてデータを取得する場合にはGET、送る場合にはPOSTといった感じで使い分けをすると良いでしょう。

※doGetおよびdoPostは、同居は可能ですが1プロジェクトで1個しか用意できないので、複数用意したい場合には仕組みで分けるか？複数プロジェクトを作って運用する必要があります。

doGet

仕組み

仕組みは至って簡単なものです。以下のような感じです。

doGetはパラメータを受け取れるようにdoGet(e)という形で記述を行う。
送る側は、公開されてるウェブアプリケーションのURLにパラメータをくっつけて、叩くだけ。
付け加えるパラメータは、?param1=kinoko&param2=takenoko　みたいな感じ。この場合２つのパラメータを取得できる
パラメータを受け取る側は、e.parameter.param1でkinokoという値が取得できるという塩梅です。
受け取ったパラメータを後は煮るなり焼くなり好きにする。
最後にreturnで、例えばHTML表示をしたり、JSONデータを返して上げれば、プログラムがそのままURLからデータを取得出来るようにもなる。（WebAPI的なものが作れるわけです）。

実行結果

コードを作ってGETパラメータ文字列を組み立ててURLを叩きます。例えば今回使用するスプレッドシートに於いて、【情報通信業】の【2009】の年のデータを引き出したい時には以下のようなURLを組み立てます。

https://script.google.com/macros/s/AKfycbzYnY1ZI3FtspAdnCc9BqC5MpTldd81m1A6KI0bPQilJ4TEU0E/exec?param1=情報通信業&param2=2009

すると、{“value”:194} といったようなJSONで返ってきます。param1が業態の指定・param2が年度の指定になります。業態の指定がおかしかったり、指定した年度の情報がない場合には、valueの値はerrorとして返すようにしています。上記のURLをクリックすると実際に値が返って来ます。

※ただし出力時に、URLはリダイレクトしますので、何かプログラムでデータを取得する場合にはそれを考慮する必要があります。

ソースコード

//書き込みスプレッドシートID
var gasheet = "書き込み先のスプレッドシートのIDをここに記入";
function doGet(e) {  
//受け取るパラメータを用意する
var filterparam = e.parameter.param1;
var nendoparam = e.parameter.param2;
var rowData = {};  //JSONオブジェクト格納用の入れ物
if (e.parameter == undefined) {
//パラメータ不良の場合はundefinedで返す
var getvalue = "undefined"
rowData.value = getvalue;
var result = JSON.stringify(rowData);
return ContentService.createTextOutput(result);
} else {
var id = gasheet; //スプレッドシートのID
var sheet = SpreadsheetApp.openById(id).getSheetByName("シート1");
var range = sheet.getRange("A1:Q").getValues();
var record = range.length;
var colman = range[0].length;
//年度の特定
var nencnt = 0;;
for(var i = 1;i<record;i++){
if(nendoparam == range[i][0]){
nencnt = i;
break;
}
}
//年度で見つからなかった場合の処理
if(nencnt == 0){
var getvalue = "error"
rowData.value = getvalue;
var result = JSON.stringify(rowData);
return ContentService.createTextOutput(result);
}
//業態の特定
var gyocnt = 0;
for(var j = 1;j<colman;j++){
if(filterparam == range[0][j]){
gyocnt = j;
break;
}
}
//業態が見つからなかった
if(gyocnt == 0){
var getvalue = "error"
rowData.value = getvalue;
var result = JSON.stringify(rowData);
return ContentService.createTextOutput(result);
}
//みつかった値をJSONで返す
var getvalue = range[nencnt][gyocnt];
rowData.value = getvalue;
var result = JSON.stringify(rowData);
//ログ出力と値の出力
Logger.log(result);
return ContentService.createTextOutput(result);    
}
}

//書き込みスプレッドシートID

var gasheet = "書き込み先のスプレッドシートのIDをここに記入";

function doGet(e) {

//受け取るパラメータを用意する

var filterparam = e.parameter.param1;

var nendoparam = e.parameter.param2;

var rowData = {}; //JSONオブジェクト格納用の入れ物

if (e.parameter == undefined) {

//パラメータ不良の場合はundefinedで返す

var getvalue = "undefined"

rowData.value = getvalue;

var result = JSON.stringify(rowData);

return ContentService.createTextOutput(result);

} else {

var id = gasheet; //スプレッドシートのID

var sheet = SpreadsheetApp.openById(id).getSheetByName("シート1");

var range = sheet.getRange("A1:Q").getValues();

var record = range.length;

var colman = range[0].length;

//年度の特定

var nencnt = 0;;

for(var i = 1;i<record;i++){

if(nendoparam == range[i][0]){

nencnt = i;

break;

}

//年度で見つからなかった場合の処理

if(nencnt == 0){

var getvalue = "error"

rowData.value = getvalue;

var result = JSON.stringify(rowData);

return ContentService.createTextOutput(result);

}

//業態の特定

var gyocnt = 0;

for(var j = 1;j<colman;j++){

if(filterparam == range[0][j]){

gyocnt = j;

break;

}

//業態が見つからなかった

if(gyocnt == 0){

var getvalue = "error"

rowData.value = getvalue;

var result = JSON.stringify(rowData);

return ContentService.createTextOutput(result);

}

//みつかった値をJSONで返す

var getvalue = range[nencnt][gyocnt];

rowData.value = getvalue;

var result = JSON.stringify(rowData);

//ログ出力と値の出力

Logger.log(result);

return ContentService.createTextOutput(result);

}

ポイント

今回の事例は非常に単純な指定したパラメータで値を返すだけですが、複数データを返すような場合には、JSONオブジェクト作成の部分で階層的なコードを書く必要性があるでしょう。
複雑なデータの出力については、SheetAsJsonのコードを再利用するとやりやすいかもしれません。
param1やparam2といった部分はソースコード内で決めることができるので、自由にネーミングを付けて下さい。
最終的にContentService.createTextOutputにてJSON文字列を返してあげます。これをやらないと、他のプログラムからJSON出力を取得できません。

doPost

実行結果

<br />

※入力して送信するとスプレッドシートに書き込まれます。

ソースコード

GAS側コード

//書き込み先スプレッドシートID
var gasheet = "ここに参照先スプレッドシートのIDを入れる";
//POSTで受け取ってスプレッドシートへ書き込み
function doPost(e) {
var test = e.parameter.name;
var ss = SpreadsheetApp.openById(gasheet);
var sheet = ss.getSheetByName("POST");
var array = [e.parameter.name,e.parameter.sex,e.parameter.food,e.parameter.mycar];
sheet.appendRow(array);
//結果をリターン
return makeContent(makeResponse(e,"POST"));
}
//スプレッドシートのIDチェック用
function checkId(id) {
var ss = SpreadsheetApp.openById(gasheet);
var sheet = ss.getSheetByName('POST');
var range  = sheet.getRange(1, 1, sheet.getLastRow(), 1);
var values = range.getValues();
var result = false;
values.forEach(function (row) {
row.forEach(function (val) {
if (result) {
return;
}
if (val === id) {
result = true;
return;
}
});
});
return result;
}
//投稿内容をJSONで組み立てて返す
function makeResponse (e, type) {
var valid = checkId(e.parameter.presentCode);
e.parameter.valid = valid;
var s  = JSON.stringify({type: type, params: e});
if (!e.parameter.callback) {
return {mime:ContentService.MimeType.JSON,  content: s};
}
else {
return {mime: ContentService.MimeType.JAVASCRIPT, content: e.parameter.callback + "(" + s + ");" };
}
}
//投稿コンテンツ内容をJSONで返す
function makeContent(content) {
return ContentService.createTextOutput(content.content).setMimeType(content.mime);
}

//書き込み先スプレッドシートID

var gasheet = "ここに参照先スプレッドシートのIDを入れる";

//POSTで受け取ってスプレッドシートへ書き込み

function doPost(e) {

var test = e.parameter.name;

var ss = SpreadsheetApp.openById(gasheet);

var sheet = ss.getSheetByName("POST");

var array = [e.parameter.name,e.parameter.sex,e.parameter.food,e.parameter.mycar];

sheet.appendRow(array);

//結果をリターン

return makeContent(makeResponse(e,"POST"));

}

//スプレッドシートのIDチェック用

function checkId(id) {

var ss = SpreadsheetApp.openById(gasheet);

var sheet = ss.getSheetByName('POST');

var range = sheet.getRange(1, 1, sheet.getLastRow(), 1);

var values = range.getValues();

var result = false;

values.forEach(function (row) {

row.forEach(function (val) {

if (result) {

return;

}

if (val === id) {

result = true;

return;

}

});

return result;

}

//投稿内容をJSONで組み立てて返す

function makeResponse (e, type) {

var valid = checkId(e.parameter.presentCode);

e.parameter.valid = valid;

var s = JSON.stringify({type: type, params: e});

if (!e.parameter.callback) {

return {mime:ContentService.MimeType.JSON, content: s};

}

else {

return {mime: ContentService.MimeType.JAVASCRIPT, content: e.parameter.callback + "(" + s + ");" };

}

//投稿コンテンツ内容をJSONで返す

function makeContent(content) {

return ContentService.createTextOutput(content.content).setMimeType(content.mime);

}

意外とシンプルです。getActiveSpreadsheetが使用できないので、openByIdで開くようにしています。また、formから送られてくるデータはformの各コントロールに付与してるname属性を利用しています。なので、e.parameterの後にname属性を付けると、その値が取得できるので、これを順番に配列に格納し、appendRowで最終行に登録しています。

HTML側コード（POST送信用）

<html>
<head>
<title>Google Spreadsheet書き込みテスト</title>
<link rel="stylesheet" href="https://ssl.gstatic.com/docs/script/css/add-ons1.css">
<script type="text/javascript">
function disp(){
// 「OK」時の処理開始 ＋ 確認ダイアログの表示
if(window.confirm('本当にいいんですね？')){
//FORMデータを送信する
document.getElementById("formman").submit();
document.getElementById("kinoko").innerHTML = "<b>ありがとう</b>";  
}else{
window.alert('キャンセルされました'); // 警告ダイアログを表示
}
}
</script>
</head>
<body>
<div id="kinoko">
<form id="formman" action="ここにPOST側ウェブアプリケーションURLを入れる" method="post" target="_blank">
ニックネーム：<input type="text" name="name" id="input1"/><p>
性別：  
<input type="radio" name="sex" id="input2" value="男" />男  
<input type="radio" name="sex" id="input3" value="女" />女<p>
好きな食べ物：  
<select name="food" id="input4">  
<option value="すき焼き">すき焼き</option>  
<option value="寿司">寿司</option>  
<option value="天ぷら">天ぷら</option>  
<option value="あげパン">あげパン</option>  
<option value="カレーライス">カレーライス</option>  
</select><p>
愛車：
<select name="mycar" id="input5">
<option value="GT-R">スカイラインGT-R</option>
<option value="トレノ">スプリンタートレノ</option>
<option value="シビック">シビックEK9</option>
<option value="インプレッサ">インプレッサ</option>
<option value="ランエボ">ランサーエボリューション</option>
</select><p>
<center>
<p><input type="button" value="確認ダイアログ" onClick="disp()" class="action"></p>
</center>
</form>
</div>
</body>
</html>

<html>

<head>

<title>Google Spreadsheet書き込みテスト</title>

function disp(){

// 「OK」時の処理開始＋確認ダイアログの表示

if(window.confirm('本当にいいんですね？')){

//FORMデータを送信する

document.getElementById("formman").submit();

document.getElementById("kinoko").innerHTML = "<b>ありがとう</b>";

}else{

window.alert('キャンセルされました'); // 警告ダイアログを表示

}

</script>

</head>

<body>

ニックネーム：<input type="text" name="name" id="input1"/><p>

性別：

<input type="radio" name="sex" id="input2" value="男" />男

好きな食べ物：

<option value="カレーライス">カレーライス</option>

</select><p>

愛車：

<option value="GT-R">スカイラインGT-R</option>

<option value="トレノ">スプリンタートレノ</option>

<option value="シビック">シビックEK9</option>

<option value="インプレッサ">インプレッサ</option>

<option value="ランエボ">ランサーエボリューション</option>

</select><p>

</center>

</form>

</div>

</body>

</html>

Formの各要素のname属性がdoPost側に渡るe.parameterの値を取り出すときの要素になるので、重複しないようにname属性は付けなければなりません。また、送信ボタンで実行する関数の中で、document.getElementById(“formman”).submit();とあるけれど、これがフォームデータを送るコマンド。その送信先が、formタグのactionに記入されてるURL。これはスプレッドシートの公開URLです。

※全て用意が完了したらウェブページとして一度公開し、URLを取得。一度公開を無効化して、URLをHTML側のFORMの送信先に入れて、再度公開すると使えるようになります。

ポイント

今回書き込むシートのシート名はPOSTである。
ウェブアプリケーションとして公開した時の公開URLは別途必要になる。
ウェブアプリケーションとして公開する場合、実行権限は今回は自分自身のみにして、他の人が実行しても自分が実行した事になるようにしている。
完全フリーで公開する場合には、実行権限は自分自身であっても、投稿許可は匿名も可にしておく必要性がある。

MENU

Google Apps ScriptでGET・POST

今回使用するスプレッドシートや資料

概要

doGet

仕組み

実行結果

ソースコード

ポイント

doPost

実行結果

ソースコード

GAS側コード

HTML側コード（POST送信用）

ポイント

関連リンク

関連記事

コメント

最近の投稿

人気の投稿とページ

おすすめ