【初心者向けGAS】Google Apps Scriptで別の関数を呼び出すfunctionの書き方

photo credit: vwcampin History of the Telephone – Montreal Archaeology and History Complex via photopin (license)

みなさん、こんにちは！
タカハシ(@ntakahashi0505)です。

Google Apps ScriptでBotを作りながらその基本を学ぶシリーズをお届けしています。

前回の記事はコチラ。

【初心者向けGAS】Chatworkのマイチャットにメッセージを送る最も簡単な例

初心者向けGoogle Apps Scriptのシリーズとして、ChatworkのBotを作成する方法をお伝えしています。今回は、超簡単な例としてマイチャットにメッセージを送る方法と、APIトークンの取得の方法です。

GASでChatwork APIを操作してマイチャットにメッセージを送る方法についてお伝えしました。

もう、あとちょっとですね！

前回はテストで「テストメッセージ」と送っただけなので、今回はちゃんとBotとして名言を送るように仕込んでいきます。

その際に、関数から別の関数を呼び出すという方法を使ってみましょう。

では、Google Apps Scriptで別の関数を呼び出すfunctionの書き方です。

では、行ってみましょう！

これまでのおさらい
1. Chatworkのマイチャットにメッセージを送る部分
2. スプレッドシートの上から順に名言をログ出力する
関数の呼び出し
まとめ
連載目次：超初心者向けGASでBotを作りながら基礎を学ぶ

これまでのおさらい

Chatworkのマイチャットにメッセージを送る部分

まず、前回お伝えしたのが、Chatwork APIを使ってメッセージを送るという部分で、スクリプトは以下の通りでした。

function testMessage(){
  const cw = ChatWorkClient.factory({token: 'ここにAPIトークンを入力してください'});
  const body = 'テストメッセージ';
  cw.sendMessageToMyChat(body);
}

ここで、送信するメッセージbodyを名言にしていけばよいわけですね。

あ、ちなみにライブラリ「ChatWorkClient for Google Apps Script」を使っていますので、まだ追加されていない方は、以下の記事を参考に追加してくださいね。

【初心者向けGAS】面倒なことはライブラリに任せよう！その概要と追加の方法

初心者向けGoogle Apps ScriptのシリーズとしてチャットワークのBotの作り方についてお伝えしています。今回はライブラリとは何か、またその追加の仕方についてお伝えしていきます。

スプレッドシートの上から順に名言をログ出力する

もう一つスクリプトを紹介します。

コチラの記事までで完成させたものですが、スプレッドシートの上から順に名言をログ出力するというものです。

function myFunction() {
  const sheet = SpreadsheetApp.getActiveSheet(); 
  const lastRow = sheet.getLastRow();
  
  for(let i = 2; i <= lastRow; i++) {
    if(!sheet.getRange(i, 4).getValue()){ 
      console.log(sheet.getRange(i, 1).getValue());
      sheet.getRange(i, 4).setValue(true);
      
      if(i >= lastRow) {
        sheet.getRange(2, 4, lastRow - 1).clearContent();
      }
      break;
    }
  }
}

こちらのスクリプトの7行目がconsole.logによるログ出力になっていますので、この部分を前述のメッセージ送信する処理に差し替えていけばよいわけですね。

関数の呼び出し

myFunctionの7行目に、testMessageの処理をボコーンとコピペして差し込んでもいいのですが、ちょっとここは工夫して楽な方法をとりましょう。

testMessageを改良したメッセージを送信する別の関数sendMessageを呼び出すのです。

別の関数を呼び出す

関数から別の関数を呼び出すときには、このように記述します。

関数名(引数1, 引数2, …)

まず、関数名に開く＆閉じる括弧をつける、と。

その際に、何らかの値を任意の数だけ持たせて呼び出すことができ、それを引数と言います。

今回の場合、Chatworkに送信するメッセージを文字列bodyとして渡して、関数sendMessageにわたすのであれば前述のスクリプトの7行目を以下に変更すれば良いですね。

const body = sheet.getRange(i, 1).getValue();
sendMessage(body);

全体として

function myFunction() {
  const sheet = SpreadsheetApp.getActiveSheet(); 
  const lastRow = sheet.getLastRow();
  
  for(let i = 2; i <= lastRow; i++) {
    if(!sheet.getRange(i, 4).getValue()){ 
      const body = sheet.getRange(i, 1).getValue();
      sendMessage(body);
      sheet.getRange(i, 4).setValue(true);
      
      if(i >= lastRow) {
        sheet.getRange(2, 4, lastRow - 1).clearContent();
      }
      break;
    }
  }
}

とすればOKです。

呼び出される関数の定義

呼び出される側の関数数sendMessageですが、この定義をする必要があります。

記述の方法はですが、引数を受け取る必要がありますので、その分も踏まえると、functionの定義文は以下のような構文になります。

function 関数名(仮引数1, 仮引数2, …) {
　//何らかの処理
　return 戻り値;
}

呼び出す側の関数で引数が与えられれば、仮引数に格納されます。仮引数は、渡す引数と同じ数だけ用意してくださいね。

この仮引数は、その関数内で変数のように使用することができます。

また、return文は省略可能ですが、呼び出した関数に戻るときに、値を渡すことができます。それを戻り値と言います。

今回の例では、testMessageをベースに、関数名をsendMessageと変更して

function sendMessage(body){
  const cw = ChatWorkClient.factory({token: 'ここにAPIトークンを入力してください'});
  cw.sendMessageToMyChat(body);
}

とすれば良いです。

マイチャットに名言を送る

では、実行してみましょう。

myFunctionを３回連続で実行してみました。

このようにマイチャットに名言が送られてきて、スプレッドシートには送信した名言にTRUEが付与されますね。

これで…Bot完成ですね！

まとめ

以上、スプレッドシートの名言をChatworkのマイチャットに送信するスクリプトを作成しました。

またその際の、別の関数を呼び出すfunctionの書き方、また引数の受け渡し方について解説しました。

機能を分けておくとわかりやすいですし、再利用しやすいので、ぜひ別のfunctionを作って部品化するテクニックも使ってくださいね。

次回は、時限式トリガーを使って、特定の時間に自動で実行させていきたいと思います。

【初心者向けGAS】時限式のイベントトリガーを設置して決まった時刻にBotを送信する方法

初心者向けGoogle Apps Scriptのシリーズとして、名言Botの作成の方法をお伝えしています。今回は、時限式のイベントトリガーを設置して決まった時刻にChatworkにBot送信する方法です。

どうぞお楽しみに！

連載目次：超初心者向けGASでBotを作りながら基礎を学ぶ

Google Apps Script（GAS）をはじめるためのメリットは山程ありますが、何を作ったらいいの？と悩んでしまうこともありますよね。そんな時に、おすすめしたいのが「Bot」の作成です。このシリーズでは、超初心者向けにGASでBotを作る方法を題材としながら、GASプログラミングの一通りの流れと書き方について学んでいきます。