【コピペで使える】GASでカレンダー予定からタグを削除してみる

予定に設定したメタデータを削除する— deleteTag()

今回のメソッドは、予定に設定した任意のデータ（タグ）を削除することができるdeleteTag()メソッドを紹介します。

setTag()メソッドによってタグを設定した予定はプログラムからしかタグを削除することができません。設定したタグを削除するためのメソッドが今回紹介するdeleteTag()メソッドになります。予定に設定されたタグはプログラムからしかアクセスできませんので、削除しなくても一般的な利用者に対しては問題ありませんが、プログラム的にタグに設定した情報にアクセスするような仕様のプログラムを組んでいる場合には、プログラムが予期せぬ動作をする可能性も出てきますので、不必要なタグは削除するようにしましょう。

1. 1. 1. deleteTag(key)

『 引数に入れる値 』

• • key（文字列） — タグ名を指定

deleteTag(key)

//予定に設定したタグを削除するコード
function sampleCode1() {
  var calendar = CalendarApp.getDefaultCalendar();
  var date = new Date(); 
  var events = calendar.getEventsForDay(date);
  var key = "タグ名";
  var value = "タグの値";
  for (var i in events) {
    var event = events[i];
    event.setTag(key, value);
    console.log(event.getTag(key));
    event.deleteTag(key);
    console.log(event.getTag(key));
  }
}

『 変数の説明 』

calendar = デフォルトカレンダーを取得
date = プログラム実行日を代入
events = プログラム実行日の予定を取得
key = タグ名を代入
value = タグの値を代入

スクリプトができたら▶ボタンでプログラムを実行してみましょう。今回のコードではプログラム実行日の予定にタグを設定して、設定したタグの値をログで出力し、そのタグを削除したあとに再度同じ名前のタグ情報をログに出力するようにコードを組んでいます。一度目のログ出力では、valueで指定した『タグの値』という文字列がログに出力されますが、次のログ出力ではタグが削除されていますので、『null』が出力されているのが確認できるかと思います。実行が終了したらCtrl + Enterを打鍵してログを確認してみましょう。

ちなみに、keyに指定したタグ名が予定のタグとして設定されていない場合は特に何も処理がされません。エラーも出ませんので、そのまま次の処理が実行されます。

まとめ

今回は予定に設定したタグを削除するdeleteTag()メソッドのご紹介をしました。不必要なタグデータは今回紹介したメソッドを使って削除しましょう。