Hangout Chatに自動でメッセージを送るbotを作る。

Question

前提・実現したいこと

カレンダーに登録した予定の時刻の3分前にHangout Chatに自動で通知を送るbotを作る。

発生している問題・エラーメッセージ

中学生です。
今学校が休校中でオンライン授業をしています。ただ、時間割がいつもと違うため、不便に感じています。そこで、Google calendarにあらかじめ予定を登録しておくと、予定した時間の3分前にHangout Chatにて自動で通知を送るbotを作ろうとしています。いかにソースコードを添付しましたが、このコードではエラーメッセージが出ないのにもかかわらず、メッセージが送られませんでした。僕はプログラミングを始めて1か月もたっていないので、どうしていいのかわからず立ち往生しています。どなたか改善策を教えていただけませんか？
ただ、Google calendar ID と、webhookUrlは入力してある状態でした。

ソースコード
function getEvents(){
 var kaichiCal　=CalendarApp.getCalendarById(''); //取得するGoogleカレンダーのIDを指定する。
 
 // 取得したWebhookのURLを記載する。Chatで確認できるはずなので、それを入力します。
  if(!kaichiCal) {
  Logger.log("Unable to access calendar with id=" + kaichiCal);
  return;
  }
  var events = kaichiCal.getEventsForDay(new Date()); // カレンダーから予定を取得する
  var hello = 'こんにちは。\n 直近の予定をお知らせします。\n ------------------------------- ';
  

  // 各予定1つ1つに実行する処理
  for(var i=0; i < events.length; i++){
 
 
  
              
      // 予定の件名、開始時間を取得
         startTime = events[i].getStartTime();
         eventName = events[i].getTitle();
    
      //予定の開始時間から3分引いた時刻を取得
      var threeMinutesBefore = (startTime.getTime() - 3*60*1000);
 
      //現在時刻を取得
      var now = new Date();    
          now = now.getTime();
      if (threeMinutesBefore < now && now < startTime){
 
        // 時間をJSTに変換 (GASの標準はUTC)
   var startTimeJST = Utilities.formatDate(startTime, "JST", "HH:mm")
  　 //送信用のメッセ―ジ
   var message = hello + startTimeJST + " " + eventName + " ";
  //chatに送る
  postchat(message);
}
}
}

  // chatに投稿する
 
 function postchat(message,webhookUrl){
   var webhookUrl = '';//webhookUrlを入力
   var botMessage = { 'text' : message}
   var options = {
    'method': 'POST',
    'headers' : {
      'Content-Type': 'application/json; charset=UTF-8'
       },
    'payload':JSON.stringify(botMessage)  
     };
   var result = UrlFetchApp.fetch( webhookUrl,
                                  {payload: JSON.stringify(options),
                                   muteHttpExceptions:true,
                                   });
  Logger.log(result);
}

Answer 1

まず賛辞を。こんな改善をやろう！と思い立てるなんて、めちゃめちゃ偉いです！
更に、teratailという質問サイトを見つけてこれる検索能力も素晴らしいです。
これからも、色々調べて、どんどん知識を吸収していってください。

さて、問題点についてですが、２つの改善点があるようです。

まず、１つ目です。
for文の書き方が間違っているようです。

// 各予定1つ1つに実行する処理
for(var i=1; i < events.length; i++){

eventsの要素は、0番から始まっています。

一番最初の要素の、要素番号は0番
二番目の要素の、要素番号は1番
三番目の要素の、要素番号は2番

提示して頂いたソースコードのような書き方をすると、二番目の要素からしか検索を行ってくれません。
またその日の予定が１つしかないときには、for文に入らずに処理が終わってしまいます

なので、次のようにして0番から調べ始めると良いです。

// 各予定1つ1つに実行する処理
for(var i=0; i < events.length; i++){

次に、２つ目です。
postchatの引数が足りていないようです。

//chatに送る
postchat(message);

postchat関数は、引数が２つ必要なので、次のように記載する必要がありそうです。

//chatに送る
postchat(message, webhookUrl);

関数に引数を１つだけ渡した場合、
webhookUrlはundefined（未定義）になるので、エラーが起きます。
従ってエラーが起きていないという事は、
現時点では１つ目の部分でつまづいているものと思われます。

以下に全文を乗せます。

ソースコード
function getEvents(){
	var kaichiCal　=CalendarApp.getCalendarById(''); //取得するGoogleカレンダーのIDを指定する。
	var webhookUrl = ''; 
	// 取得したWebhookのURLを記載する。Chatで確認できるはずなので、それを入力します。
	if(!kaichiCal) {
		Logger.log("Unable to access calendar with id=" + kaichiCal);
		return;
	}
	var events = kaichiCal.getEventsForDay(new Date()); // カレンダーから予定を取得する
	var hello = 'こんにちは。\n 直近の予定をお知らせします。\n ------------------------------- ';


	// 各予定1つ1つに実行する処理
	for(var i=0; i < events.length; i++){ // <--- １つ目の改善.
		// 予定の件名、開始時間を取得
		var startTime = events[i].getStartTime();
		var eventName = events[i].getTitle();

		//予定の開始時間から3分引いた時刻を取得
		var threeMinutesBefore = (startTime.getTime() - 3*60*1000);

		//現在時刻を取得
		var now = new Date();    

		if (threeMinutesBefore < now && now < startTime){

			// 時間をJSTに変換 (GASの標準はUTC)
			var startTimeJST = Utilities.formatDate(startTime, "JST", "HH:mm")
			//送信用のメッセ―ジ
			var message = hello + startTimeJST + " " + eventName + " ";
			//chatに送る
			postchat(message, webhookUrl); // <--- ２つ目の改善.
		}
	}
}

// chatに投稿する
function postchat(message,webhookUrl){
	var botMessage = { 'text' : message}
	var options = {
		'method': 'POST',
		'headers' : {
			'Content-Type': 'application/json; charset=UTF-8'
		},
		'payload':JSON.stringify(botMessage)  
	};
	var result = UrlFetchApp.fetch(webhookUrl, options);
	Logger.log(result);
}

上手くいかなかったり、疑問点があるようでしたら、教えてください。

また、今後の勉強のために使えるキーワードとして次のものが有ります。
興味があったら、調べてみてください。

1. 「Google App Script ブレークポイント デバッグ実行」

　　今実行しているプログラムの変数の中身を調べることが出来ます。

1. 「インデント」

　　if文やfor文やfunctionを囲むカッコ{}　（波括弧、中括弧とも言います。）
の中は、インデントを付けて字下げを行ってください。
どこまでがカッコの中なのか分かりやすくするためです。

Comments

[ouoyoueee]

ご返信ありがとうございます！

for文とpostchatの関数を変えて、両方とも実行してもエラーが出てこなくなりました。
それから、function postchatの最後のUrlFetchApp.fetchの部分も、エラー400がでたので、muteHttpExceptions:true,を付け足しました。元の質問のソースコードも更新します。
しかし、https://script.google.com/homeこのサイトで調べてみると、自分の関数がまだ一度も実行された形跡がありません...どこが悪いのでしょうか。それとも、一日の上限回数に達してしまったのでしょうか…

[hara64]

エラー400ということで、一歩前進ですね！

エラー400 について、軽くでも調べてみてください。
あなたのアプリケーションから、サーバーにアクセスするときに、
アクセスしちゃだめだよ、と言われている状態ですので、
エラーを無視しても動きません。
muteHttpExceptions:true　は、付けないでください。

エラーが起きて、何が何やら分からないとき、問題を分解していくと良いです。
postchatをするときにうまく動いていないようですから
これで動かしてみてください。
これで動かして、Hangout Chat にて　test　という文字列を受け取れたら良いわけですね。

function getEvents(){
var webhookUrl = '';
// 取得したWebhookのURLを記載する。Chatで確認できるはずなので、それを入力します。
postchat("test",webhookUrl);
}

まず最初に確認する点は、webhookUrlの文字を打ち間違えてないかという点です。
これが一番ありがちですので、確認をお願いします。

次に確認する点は、リクエスト送信先のアクセス許可という点です。
通知を送りたいHangout Chatというのは、学校の皆さんが使用されているのでしょうか。
もしくは、あなた個人で使用しているのでしょうか？

使用されているHangout Chatが、外部からの接続を許可していなければ、この手のスクリプトは動きません。
怪しいリクエストだ！ということで通信を弾いてしまうんですね。
一度、先生もしくは管理者の方にお願いをして、こういったものを動かしてみたい、と相談をしてみてください。

Answer 2

(普段私はコードそのものを書く回答をしていますが、今回はそういう回答を求めてないと思っています。もしただただ答えが欲しいのであれば質問にその旨追記してください)

どうしていいのかわからず立ち往生しています。どなたか改善策を教えていただけませんか？

こういうとき、”デバッグ”をします。

Google Apps Script にはデバッガが付属しています。通常▼を反時計周りに 90 度回転させた関数の実行ボタンで実行しているか、トリガーで実行していると想定しますが、そうではなく、クモっぽいアイコンで実行します。その際に、あらかじめ行番号の左あたりをクリックすると赤い●をつけておくことができ、そのつけた行で実行を停止し、変数の状態を確認することができます。
また、そこから1行ずつすすめて、変数がどう変わっていくかを追いかけることができます。
このようにして、どこでどのようなエラーが起きているか突き止めることができます。

もう1点。 muteHTTPexception を付けたのはエラーメッセージを表示するには、というメッセージに従ったからだと思います。であれば、ログをみましょう。ご自身で Logger.log もしておられるので、それもログでみましょう。
メニューの”表示”を開いたときの、うえから3つを全て確認してください。
デバッガがないときは、このようにログをだしてデバッグをすることが有効な場合があります。また、質問の際にも、ログに何と出ているかを記載するのは有効な回答を得る助けになります。
特に外部システムからのメッセージが詳細に判明すれば検索するキーワードとして有用です。

Answer 3

時間を比較するなら now は now.getTime()にする必要があるのではないでしょうか。

var threeMinutesBefore = startTime.getTime() - 3 * 60 * 1000;
//現在時刻を取得
var now = new Date();
if (threeMinutesBefore < now && now < startTime) {
}