【GAS】カレンダー予定の詳細を取得するgetDescriptionメソッドを完全マスター

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る
icon_for_CalendarApp_getDescription

予定の詳細を取得する— getDescription()

今回のメソッドは、予定の詳細情報を取得するgetDescription()メソッドをご紹介します。このメソッドでは、予定の説明を入力した部分のすべての文章を取得することができます。

予定の詳細とはそもそもどの部分なのでしょうか?わからない方もいると思いますので、スクリーンショットを用意しました。

予定の詳細情報

詳細情報部分は、上記スクリーンショットで赤枠で囲った部分になります。
この中には、任意の文章を書き込むことができ、そのすべての情報をgetDescription()メソッドでは取得することができます。

使い方としては、普通に入力した内容を取得しても良いですし、プログラムで一時的に保持したい内容を詳細情報に記載しておいてプログラム処理の情報として取得してもよいかと思います。ただし、この部分はカレンダーの編集権限があるアカウントでは編集が可能な部分ですので、プログラム用の情報を格納するのであれば個人的にはタグを利用することをおすすめします。タグの設定についてはこちらのページでサンプルコード付きで説明しています。

      1. getDescription()

『 引数に入れる値 』

今回のメソッドに関しては引数は必要ありません。

getDescription()

サンプルコード1
//予定の詳細情報を取得するコード
function sampleCodeForCalendarAppGetDescription() {
  var calendar = CalendarApp.getDefaultCalendar();
  var date = new Date(); 
  var events = calendar.getEventsForDay(date);
  for (var i in events) {
    var event = events[i];
    Logger.log(event.getDescription());
  }
}

『 変数の説明 』

calendar = デフォルトカレンダーを取得
date = プログラム実行日を代入
events = プログラム実行日の予定を取得
event = 個々予定を取得

スクリプトができたら▶ボタンでプログラムを実行してみましょう。今回のコードではプログラム実行日の予定の詳細情報を取得してログに表示するコードを書いてみました。私の環境では、対象の予定の詳細情報には予めテストと記載しておいたので、ログ結果にテストと記載されています。

上記サンプルコードをコピペしてもらい、プログラムの実行が終了したらCtrl + Enterを打鍵してログを確認してみましょう。ご自身の予定の詳細がログに出力されていればプログラムは問題なく動作しています。

getDescriptionの出力ログ

実行後のログ画面スクリーンショット

使い方は非常にシンプルですので、この記事でマスターしてしまいましょう。

まとめ

今回は予定の詳細情報を取得するgetDescription()メソッドのご紹介をしました。予定の詳細を取得する方法がこれでわかったと思いますので、覚えたメソッドを活用してコードを書いてみましょう。

SNSでもご購読できます。

コメントを残す

*