【GAS】4つのcreateAllDayEventメソッドを完全マスター

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

終日予定を作成するメソッド — createAllDayEvent

Googleが提供しているリファレンスはとても詳しく書いてあるのですが、英語のみの提供のためハードルが高く感じる人も少なくないと思います。そのハードルを少しでも低くし、より多くの人にGoogle Apps Scriptを使えるようになってもらいたいという思いから日本語のリファレンスページを用意しています。

このページでは、終日予定を作成するcreateAllDayEvent()の使い方を紹介します。

  1. createAllDayEvent(title, date)
  2. createAllDayEvent(title, startDate, endDate)
  3. createAllDayEvent(title, startDate, endDate, options)
  4. createAllDayEvent(title, date, options)

このメソッドを利用するとGoogleカレンダーに終日予定を作成することができます。

『 引数に入れる値 』

  • title(予定のタイトル) — ダブルクォーテーションで囲んだ文字列
  • date(予定日) — 日付オブジェクト
  • startDate(予定開始日) — 日付オブジェクト
  • endDate(予定終了日) — 日付オブジェクト
  • options(詳細オプション) — JSONオブジェクト
    • description — 予定の説明 (文字列)
    • location — 予定の場所 (文字列)
    • guests — ゲストのアドレス(文字列:ゲストを複数招待する場合には、カンマで区切る)
    • sendInvites — true / false

createAllDayEvent(title, date)

まずは終日予定を作成するメソッドのなかで一番基本的なパターンを紹介します。
予定タイトルと予定日のみ指定するシンプルなコードで終日予定が作成できます。

サンプルコード1
//デフォルトカレンダーにtitleに代入した予定タイトルでdateに指定した日付に終日予定を作成するコード
function sampleCode1() {
  var calendar = CalendarApp.getDefaultCalendar();
  var title = "予定のタイトル";
  var date = new Date();
  calendar.createAllDayEvent(title, date);
}

『 変数の説明 』

calendar = アカウントのデフォルトカレンダーを取得
title = 予定タイトルに設定される文字列をダブルクォーテーションで代入
date = 日付オブジェクトで予定日を指定
※サンプルコードでは、new Date()としてプログラム実行日を取得しています。
もし日付を指定したい場合には、new Date(“2018/06/08”)というような形で指定できます。

createAllDayEvent(title, startDate, endDate)

次に、数日にまたがる終日予定を作成する方法を紹介します。

サンプルコード2
//デフォルトカレンダーにtitleに代入した予定タイトルでstartDateからendDateに指定した日付までの複数日にまたがる終日予定を作成するコード
function sampleCode2() {
  var calendar = CalendarApp.getDefaultCalendar();
  var title = "予定のタイトル";
  var startDate = new Date("2018/06/08");
  var endDate = new Date("2018/06/10");
  calendar.createAllDayEvent(title, startDate, endDate);
}

『 変数の説明 』

calendar = アカウントのデフォルトカレンダーを取得
title = 予定タイトルに設定される文字列をダブルクォーテーションで代入
startDate = 日付オブジェクトで予定開始日を指定
endDate = 日付オブジェクトを予定終了日を指定

createAllDayEvent(title, startDate, endDate, options)

詳細をプログラムで設定して数日にまたがる終日予定を作成する方法を紹介します。

サンプルコード3
//オプション設定で細かい内容まで設定した複数日にまたがる終日予定作成コード
function sampleCode3() {
  var calendar = CalendarApp.getDefaultCalendar();
  var title = "予定のタイトル";
  var startDate = new Date("2018/06/08");
  var endDate = new Date("2018/06/10");
  var options = {
    description: "友達と待ち合わせ",
    location: "新宿駅東口",
    guests: "guestAddress1,guestAddress2,guestAddress3", //実際の使用時はゲストアドレスを変更してください。
    sendInvites: true
  }
  calendar.createAllDayEvent(title, startDate, endDate, options);
}

『 変数の説明 』

calendar = アカウントのデフォルトカレンダーを取得
title = 予定タイトルに設定される文字列をダブルクォーテーションで代入
startDate = 日付オブジェクトを予定開始日を指定
endDate = 日付オブジェクトを予定終了日を指定
options = 細かい内容を指定して予定を作成できます。
オプションは必要なものをオブジェクト形式に格納して引数として渡します。
必要のない内容は行を削除して使用することができます。

createAllDayEvent(title, date, options)

詳細をプログラムで設定して終日予定を作成する方法を紹介します。

サンプルコード4
//オプション設定で細かい内容まで設定した単日終日予定作成コード
function sampleCode4() {
  var calendar = CalendarApp.getDefaultCalendar();
  var title = "予定のタイトル";
  var date = new Date();
  var options = {
    description: "友達と待ち合わせ",
    location: "新宿駅東口",
    guests: "guestAddress1,guestAddress2,guestAddress3", //実際の使用時はゲストアドレスを変更してください。
    sendInvites: true
  }
  calendar.createAllDayEvent(title, date, options);
}

『 変数の説明 』

calendar = アカウントのデフォルトカレンダーを取得
title = 予定タイトルに設定される文字列をダブルクォーテーションで代入
startDate = 日付オブジェクトを予定開始日を指定
endDate = 日付オブジェクトを予定終了日を指定
options = 細かい内容を指定して予定を作成できます。
オプションは必要なものをオブジェクト形式に格納して引数として渡します。
必要のない内容は行を削除して使用することができます。

まとめ

createAllDayEvent()の解説はいかがでしたでしょうか?

英語でハードルが高いと思っていたことも日本語で読むとそれほど難しくありませんよね。

すべてのサンプルコードはコピーしてスクリプトエディタに貼り付けることでそのまま利用が可能です。

SNSでもご購読できます。

コメントを残す

*