Class CalendarEvent

CalendarEvent

単一のカレンダーの予定を表します。

Methods

メソッド戻り値の型概要
addEmailReminder(minutesBefore)CalendarEvent新しいリマインダー メールを予定に追加します。
addGuest(email)CalendarEvent予定にゲストを追加します。
addPopupReminder(minutesBefore)CalendarEventイベントに新しいポップアップ通知を追加します。
addSmsReminder(minutesBefore)CalendarEvent予定に新しい SMS リマインダーを追加します。
anyoneCanAddSelf()Booleanユーザーがカレンダーの予定にゲストとして追加できるかどうかを指定します。
deleteEvent()voidカレンダーの予定を削除します。
deleteTag(key)CalendarEventイベントから Key-Value タグを削除します。
getAllDayEndDate()Dateこの終日の予定が終了する日付を取得します。
getAllDayStartDate()Dateこの終日の予定が始まる日付を取得します。
getAllTagKeys()String[]イベントに設定されているタグのすべてのキーを取得します。
getColor()Stringカレンダーの予定の色を返します。
getCreators()String[]イベントの作成者を取得します。
getDateCreated()Dateイベントが作成された日付を取得します。
getDescription()Stringイベントの説明を取得します。
getEmailReminders()Integer[]予定のすべてのリマインダー メールについて分の値を取得します。
getEndTime()Dateこのカレンダーの予定が終了する日時を取得します。
getEventSeries()CalendarEventSeriesこの予定が属する一連の定期的な予定を取得します。
getGuestByEmail(email)EventGuestメールアドレスでゲストを取得します。
getGuestList()EventGuest[]予定のゲスト(予定のオーナーを含まない)を取得します。
getGuestList(includeOwner)EventGuest[]予定のゲストを取得します。場合によっては、予定のオーナーも取得します。
getId()Stringイベントの一意の iCalUID を取得します。
getLastUpdated()Dateイベントが最後に更新された日付を取得します。
getLocation()Stringイベントの場所を取得します。
getMyStatus()GuestStatus有効なユーザーのイベントのステータス(参加や招待など)を取得します。
getOriginalCalendarId()Stringこの予定を最初に作成したカレンダーの ID を取得します。
getPopupReminders()Integer[]予定のすべてのポップアップ通知の分の値を取得します。
getSmsReminders()Integer[]予定のすべての SMS リマインダーの分の値を取得します。
getStartTime()Dateこのカレンダーの予定を開始する日時を取得します。
getTag(key)Stringイベントのタグ値を取得します。
getTitle()Stringイベントのタイトルを取得します。
getVisibility()Visibilityイベントの公開設定を取得します。
guestsCanInviteOthers()Booleanゲストが他のゲストを招待できるようにするかどうかを指定します。
guestsCanModify()Booleanゲストが予定を変更できるかどうかを指定します。
guestsCanSeeGuests()Booleanゲストに他のゲストを表示するかどうかを指定します。
isAllDayEvent()Boolean終日の予定かどうかを指定します。
isOwnedByMe()Boolean自分が予定のオーナーかどうかを判断します。
isRecurringEvent()Booleanイベントが一連のイベントに含まれるかどうかを示します。
removeAllReminders()CalendarEvent予定からすべてのリマインダーを削除します。
removeGuest(email)CalendarEvent予定からゲストを削除します。
resetRemindersToDefault()CalendarEventカレンダーのデフォルト設定を使用してリマインダーをリセットします。
setAllDayDate(date)CalendarEventイベントの日付を設定します。
setAllDayDates(startDate, endDate)CalendarEventイベントの日付を設定します。
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventゲスト以外のユーザーが自身をイベントに追加できるかどうかを設定します。
setColor(color)CalendarEventカレンダーの予定の色を設定します。
setDescription(description)CalendarEventイベントの説明を設定します。
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventゲストが他のゲストを招待できるかどうかを設定します。
setGuestsCanModify(guestsCanModify)CalendarEventゲストが予定を変更できるかどうかを設定します。
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventゲストに他のゲストを表示するかどうかを設定します。
setLocation(location)CalendarEventイベントの場所を設定します。
setMyStatus(status)CalendarEvent有効なユーザーのイベントのステータス(参加、招待など)を設定します。
setTag(key, value)CalendarEventカスタム メタデータを格納するための Key-Value タグをイベントに設定します。
setTime(startTime, endTime)CalendarEventイベントの開始日時と終了日時を設定します。
setTitle(title)CalendarEventイベントのタイトルを設定します。
setVisibility(visibility)CalendarEventイベントの公開設定を設定します。

詳細なドキュメント

addEmailReminder(minutesBefore)

新しいリマインダー メールを予定に追加します。リマインダーは、イベントの 5 ~ 4 週間前(40,320 分)前に設定する必要があります。

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds an email notification for 15 minutes before the event.
event.addEmailReminder(15);

パラメータ

名前説明
minutesBeforeIntegerイベント開始までの時間(分)

リターン

CalendarEvent - チェーン用のこの CalendarEvent

例外

Error - 予定に 5 件を超えるリマインダーがある場合、または時刻が規定の範囲外の場合

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addGuest(email)

予定にゲストを追加します。

// Example 1: Add a guest to one event
function addAttendeeToEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.addGuest(attendeeEmail);
  }

// Example 2: Add a guest to all events on a calendar within a specified timeframe
function addAttendeeToAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to add the guest to the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to add the guest to the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and add the attendee to each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.addGuest(attendeeEmail);
  }
}

パラメータ

名前説明
emailStringゲストのメールアドレス。

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addPopupReminder(minutesBefore)

イベントに新しいポップアップ通知を追加します。通知はイベントの 5 分以上前、最長で 4 週間(40,320 分)前である必要があります。

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds a pop-up notification for 15 minutes before the event.
event.addPopupReminder(15);

パラメータ

名前説明
minutesBeforeIntegerイベント開始までの時間(分)

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addSmsReminder(minutesBefore)

予定に新しい SMS リマインダーを追加します。リマインダーは、イベントの 5 ~ 4 週間前(40,320 分)前に設定する必要があります。

パラメータ

名前説明
minutesBeforeIntegerイベント開始までの時間(分)

リターン

CalendarEvent - チェーン用のこの CalendarEvent

例外

Error - 予定に 5 件を超えるリマインダーがある場合、または時刻が規定の範囲外の場合

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

anyoneCanAddSelf()

ユーザーがカレンダーの予定にゲストとして自身を追加できるようにするかどうかを指定します。

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Determines whether people can add themselves as guests to the event and logs it.
console.log(event.anyoneCanAddSelf());

リターン

Boolean - ゲスト以外のユーザーが自分自身を予定に追加できる場合は true、そうでない場合は false

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

deleteEvent()

カレンダーの予定を削除します。

// Gets an event by its ID.
// TODO(developer): Replace the string with the ID of the event that you want to delete.
const event = CalendarApp.getEventById('abc123456');

// Deletes the event.
event.deleteEvent();

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

deleteTag(key)

イベントから Key-Value タグを削除します。

パラメータ

名前説明
keyStringタグキー

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getAllDayEndDate()

この終日の予定が終了する日付を取得します。終日イベントでない場合、このメソッドは例外をスローします。返される Date は、イベントが終了した後の 1 日の午前 0 時をスクリプトのタイムゾーンで表します。カレンダーのタイムゾーンを使用するには、getEndTime() を呼び出します。

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Creates an event named 'My all-day event' for May 16, 2023.
const event = calendar.createAllDayEvent('My all-day event', new Date('May 16, 2023'));

// Gets the event's end date and logs it.
const endDate = event.getAllDayEndDate();
console.log(endDate);

リターン

Date - カレンダーのこの終日の予定の終了日

例外

Error - 終日の予定でない場合

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getAllDayStartDate()

この終日の予定が始まる日付を取得します。終日イベントでない場合は、このメソッドは例外をスローします。返される Date は、スクリプトのタイムゾーンでイベントが開始する 1 日の午前 0 時を表します。カレンダーのタイムゾーンを使用するには、getStartTime() を呼び出します。

// Gets the user's default calendar. To get a different calendar, use getCalendarById()
// instead.
const calendar = CalendarApp.getDefaultCalendar();

// Creates an event named 'My all-day event' for May 16, 2023.
const event = calendar.createAllDayEvent('My all-day event', new Date('May 16, 2023'));

// Gets the event's start date and logs it.
const startDate = event.getAllDayStartDate();
console.log(startDate);

リターン

Date - この終日カレンダーの予定の開始日

例外

Error - 終日の予定でない場合

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getAllTagKeys()

イベントに設定されているタグのすべてのキーを取得します。

リターン

String[] - 文字列キーの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getColor()

カレンダーの予定の色を返します。

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets the color of the calendar event and logs it.
const eventColor = event.getColor();
console.log(eventColor);

リターン

String - イベント色の文字列表現で、CalendarApp.EventColor の値のインデックス(1 ~ 11)です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getCreators()

イベントの作成者を取得します。

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets a list of the creators of the event and logs it.
console.log(event.getCreators());

リターン

String[] - イベントの作成者のメールアドレス

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDateCreated()

イベントが作成された日付を取得します。カレンダーへのアクセス権が必要です。

// Opens the calendar by using its ID.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the calendar ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 8:10 AM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 08:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the date that the event
 // was created and logs it.
 const eventCreated = event.getDateCreated();
 console.log(eventCreated);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

Date - 作成日

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDescription()

イベントの説明を取得します。カレンダーの編集権限が必要です。

// Opens the calendar by its ID.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
between 4:00 PM and 5:00 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 16:00:00'), new Date('Feb 04, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the description of the event.
 event.setDescription('Important meeting');

 // Gets the description of the event and logs it.
 const description = event.getDescription();
 console.log(description);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

String - 説明

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEmailReminders()

予定のすべてのリマインダー メールについて分の値を取得します。カレンダーの編集権限が必要です。

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
between 5:00 PM and 6:00 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 15:00:00'), new Date('Feb 04, 2023 18:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, adds email reminders for the user to be
 // sent at 4 and 7 minutes before the event.
 event.addEmailReminder(4);
 event.addEmailReminder(7);

 // Gets the minute values for all email reminders that are set up for the user for this event
 // and logs it.
 const emailReminder = event.getEmailReminders();
 console.log(emailReminder);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

Integer[] - 各値がリマインダーによってトリガーされるイベントまでの分数に対応する配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEndTime()

このカレンダーの予定が終了する日時を取得します。カレンダーへのアクセス権が必要です。 終日以外のイベントの場合は、イベントが終了するように定義された時刻です。終日のみの予定(日時ではなく)が保存される終日の予定は、カレンダーのタイムゾーンで、終了日の翌日の深夜 0 時になります。これにより、あらゆる種類のイベントの終了時刻を有意義に比較できるようになります。ただし、元の日付を変更せずに必ずしも保存されるわけではありません。

終日イベントの場合、getAllDayEndDate() はほとんどの場合、このメソッドに優先して呼び出されます。

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:00 PM and 5:00 PM.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:00:00'), new Date('Feb 01, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the date and time at which the
 // event ends and logs it.
 console.log(event.getEndTime());
} else {
 // If no event exists within the given time frame, logs that info to the console.
 console.log('No events exist for the specified range');
}

リターン

Date - このカレンダーの予定の終了時間

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventSeries()

この予定が属する一連の定期的な予定を取得します。カレンダーへのアクセス権が必要です。このイベントが一連のイベントに属していなくても CalendarEventSeries オブジェクトが返されるため、新しい繰り返しの設定を追加できます。

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 18th, 2023 that takes place between
// 1:00 PM and 2:00 PM.
const event =
  calendar.getEvents(new Date('Feb 18, 2023 13:00:00'), new Date('Feb 18, 2023 14:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the event series for the event
 // and sets the color to pale green.
 event.getEventSeries().setColor(CalendarApp.EventColor.PALE_GREEN);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

CalendarEventSeries - このイベントが属するイベント シリーズ。まだシリーズに属していない場合は新しいイベント シリーズ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getGuestByEmail(email)

メールアドレスでゲストを取得します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 5:00 PM and 5:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'))[0];

// Gets a guest by email address.
const guestEmailId = event.getGuestByEmail('alex@example.com');

// If the email address corresponds to an event guest, logs the email address.
if (guestEmailId) {
  console.log(guestEmailId.getEmail());
}

パラメータ

名前説明
emailStringゲストの住所

リターン

EventGuest - ゲスト。メールアドレスがゲストに対応していない場合は null

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getGuestList()

予定のゲストを取得します。参加者には、予定のオーナーは含まれません。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 5:00 PM and 5:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'))[0];

// Adds two guests to the event by using their email addresses.
event.addGuest('alex@example.com');
event.addGuest('cruz@example.com');

// Gets the guests list for the event.
const guestList = event.getGuestList();

// Loops through the list to get all the guests and logs their email addresses.
for (const guest of guestList){
  console.log(guest.getEmail());
}

リターン

EventGuest[] - ゲストの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getGuestList(includeOwner)

予定のゲストを取得します。場合によっては、予定のオーナーも取得します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 5:00 PM and 5:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 17:00:00'), new Date('Feb 25,2023 17:25:00'))[0];

// Gets the guests list for the event, including the owner of the event.
const guestList = event.getGuestList(true);

// Loops through the list to get all the guests and logs it.
for (const guest of guestList) {
  console.log(guest.getEmail());
}

パラメータ

名前説明
includeOwnerBooleanオーナーをゲストとして含めるか、

リターン

EventGuest[] - ゲストの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getId()

イベントの一意の iCalUID を取得します。Calendar v3 APICalendar Advanced サービスで使用される iCalUID とイベント id は同一ではなく、相互に使用することはできません。それらのセマンティクスの違いの一つは、定期的なイベントで、1 つのイベントが発生するたびに ids が異なるのに対し、すべてが同じ iCalUID を共有することです。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 5th, 2023 that takes place
// between 9:00 AM and 9:25 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 05, 2023 09:00:00'), new Date('Jan 05, 2023 09:25:00'))[0];

// Gets the ID of the event and logs it.
console.log(event.getId());

リターン

String - イベントの iCalUID

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getLastUpdated()

イベントの最終更新日を取得します。

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
between 4:00 PM and 5:00 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:00:00'), new Date('Feb 01, 2023 17:00:00'))[0];

// Gets the date the event was last updated and logs it.
const eventUpdatedDate = event.getLastUpdated();
console.log(eventUpdatedDate);

リターン

Date - 最終更新日

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getLocation()

イベントの場所を取得します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the location of the event to Mumbai.
 event.setLocation('Mumbai');

 // Gets the location of the event and logs it.
 const eventLocation = event.getLocation();
 console.log(eventLocation);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

String - イベントの場所

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getMyStatus()

有効なユーザーのイベントのステータス(参加や招待など)を取得します。有効なユーザーがイベントのオーナーである場合は、常に GuestStatus.OWNER を返します。

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the event status of
 // the effective user and logs it.
 const myStatus = event.getMyStatus();
 console.log(myStatus.toString());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

GuestStatus - ステータス

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getOriginalCalendarId()

この予定を最初に作成したカレンダーの ID を取得します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 25th, 2023 that takes place
// between 4:00 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 25,2023 16:00:00'), new Date('Feb 25,2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the ID of the calendar where the
 // event was originally created and logs it.
 const calendarId = event.getOriginalCalendarId();
 console.log(calendarId);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

String - 元のカレンダーの ID

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getPopupReminders()

予定のすべてのポップアップ リマインダーの分の値を取得します。

  // Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
// between 5:05 PM and 5:35 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 17:05:00'), new Date('Feb 04, 2023 17:35:00'))[0];

if (event) {
 // If an event exists within the given time frame, adds two pop-up reminders to the event.
 // The first reminder pops up 5 minutes before the event starts and the second reminder
 // pops up 3 minutes before the event starts.
 event.addPopupReminder(3);
 event.addPopupReminder(5);

 // Gets the minute values for all pop-up reminders for the event and logs it.
 const popUpReminder = event.getPopupReminders();
 console.log(popUpReminder);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

Integer[] - 各値がリマインダーによってトリガーされるイベントまでの分数に対応する配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getSmsReminders()

予定のすべての SMS リマインダーの分の値を取得します。

リターン

Integer[] - 各値がリマインダーによってトリガーされるイベントまでの分数に対応する配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getStartTime()

このカレンダーの予定を開始する日時を取得します。終日以外のイベントの場合は、イベントの開始が定義された時刻です。開始日のみが保存される(日時ではなく)終日の予定の場合、これはカレンダーのタイムゾーンで予定を開始する日の深夜 0 時を表します。これにより、すべての種類のイベントの開始時間を有意義に比較できるようになります。ただし、必ずしも元の日付を変更せずに保持するとは限りません。

終日イベントの場合、getAllDayStartDate() はほとんどの場合、このメソッドよりも優先的に呼び出されます。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

// Gets the date and time at which this calendar event begins and logs it.
const startTime = event.getStartTime();
console.log(startTime);

リターン

Date - このカレンダーの予定の開始時間

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTag(key)

イベントのタグ値を取得します。

パラメータ

名前説明
keyString

リターン

String - タグ値

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTitle()

イベントのタイトルを取得します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

if (event) {
 // If an event exists within the given time frame, logs the title of the event.
 console.log(event.getTitle());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

String - タイトル

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getVisibility()

イベントの公開設定を取得します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, gets the visibility of the event
 // and logs it.
 const eventVisibility = event.getVisibility();
 console.log(eventVisibility.toString());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

Visibility - 可視性の値

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

guestsCanInviteOthers()

ゲストが他のゲストを招待できるようにするかどうかを指定します。

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether guests can invite
 // other guests and logs it.
 console.log(event.guestsCanInviteOthers());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

Boolean - ゲストが他の人を招待できる場合は true、そうでない場合は false

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

guestsCanModify()

ゲストが予定を変更できるかどうかを指定します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event so that guests can't
 // modify it.
 event.setGuestsCanModify(false);

 // Determines whether guests can modify the event and logs it.
 console.log(event.guestsCanModify());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

Boolean - ゲストが予定を変更できる場合は true、変更できない場合は false

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

guestsCanSeeGuests()

ゲストに他のゲストを表示するかどうかを指定します。

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether guests can see other
 // guests and logs it.
 console.log(event.guestsCanSeeGuests());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

Boolean - ゲストが他のゲストを表示できる場合は true、そうでない場合は false

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isAllDayEvent()

終日の予定かどうかを指定します。

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

// Determines whether this event is an all-day event and logs it.
console.log(event.isAllDayEvent());

リターン

Boolean - 終日の予定の場合は true、そうでない場合は false

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isOwnedByMe()

自分が予定のオーナーかどうかを判断します。

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether you're the owner
 // of the event and logs it.
 console.log(event.isOwnedByMe());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

Boolean - 有効なユーザーがイベントのオーナーである場合は true、そうでない場合は false

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isRecurringEvent()

イベントが一連のイベントに含まれるかどうかを示します。

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for Januart 31st, 2023 that takes place
// between 9:00 AM and 10:00 AM.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:00:00'), new Date('Jan 31, 2023 10:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, determines whether the event is part of an
 // event series and logs it.
 console.log(event.isRecurringEvent());
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

Boolean - イベントが一連のイベントに含まれる場合は true、そうでない場合は false

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

removeAllReminders()

予定からすべてのリマインダーを削除します。

// Opens the calendar by its ID. You must have edit access to the calendar
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 1,2023 16:10:00'), new Date('Feb 1,2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, removes all reminders from the event.
 event.removeAllReminders();
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

removeGuest(email)

予定からゲストを削除します。

// Example 1: Remove a guest from one event
function removeGuestFromEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.removeGuest(attendeeEmail);
  }

// Example 2: Remove a guest from all events on a calendar within a specified timeframe
function removeGuestFromAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to remove the guest from the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to remove the attendee from the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and remove the attendee from each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.removeGuest(attendeeEmail);
  }
}

パラメータ

名前説明
emailStringゲストのメールアドレスです。

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

resetRemindersToDefault()

カレンダーのデフォルト設定を使用してリマインダーをリセットします。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 1, 2023 16:10:00'), new Date('Feb 1, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, resets the reminders using the calendar's
 // default settings.
 event.resetRemindersToDefault();
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setAllDayDate(date)

イベントの日付を設定します。このメソッドを適用すると、通常の予定が終日の予定に変更されます。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 17th, 2023 that takes place
// between 4:00 PM and 5:00 PM.
const event =
  calendar.getEvents(new Date('Feb 17, 2023 16:00:00'), new Date('Feb 17, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the date of the event and updates
 // it to an all-day event.
 event.setAllDayDate(new Date('Feb 17, 2023'));
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

パラメータ

名前説明
dateDateイベントの日付(時刻は無視されます)

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setAllDayDates(startDate, endDate)

イベントの日付を設定します。このメソッドを適用すると、通常のイベントが終日イベントに変わります。

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 18th, 2023 that takes place
// between 4:00 PM and 5:00 PM.
const event =
  calendar.getEvents(new Date('Feb 18, 2023 16:00:00'), new Date('Feb 18, 2023 17:00:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event to be an all-day event from
 // Feb 18th, 2023 until Feb 25th, 2023. Applying this method changes a regular event into an
 // all-day event.
 event.setAllDayDates(new Date('Feb 18, 2023'), new Date('Feb 25, 2023'));
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

パラメータ

名前説明
startDateDateイベントの開始日(時刻は無視されます)
endDateDate予定の終了日(時刻は無視されます)

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setAnyoneCanAddSelf(anyoneCanAddSelf)

ゲスト以外のユーザーが自身をイベントに追加できるかどうかを設定します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 15th, 2023 that takes place
// between 3:30 PM and 4:30 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 15, 2023 15:30:00'), new Date('Feb 15, 2023 16:30:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event so that non-guests
 // can't add themselves to the event.
 event.setAnyoneCanAddSelf(false);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

パラメータ

名前説明
anyoneCanAddSelfBoolean誰でも自身を招待できるかどうか

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setColor(color)

カレンダーの予定の色を設定します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the color of the calendar event to
 // green.
 event.setColor(CalendarApp.EventColor.GREEN);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

パラメータ

名前説明
colorString文字列としての整数の色インデックス、または CalendarApp.EventColor の値。

リターン

CalendarEvent - このカレンダーの予定(チェーン用)。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setDescription(description)

イベントの説明を設定します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 4th, 2023 that takes place
// between 5:05 PM and 5:35 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 04, 2023 17:05:00'), new Date('Feb 04, 2023 17:35:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the description of the event to
 // 'Meeting.'
 event.setDescription('Meeting');
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

パラメータ

名前説明
descriptionString新しい説明文

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setGuestsCanInviteOthers(guestsCanInviteOthers)

ゲストが他のゲストを招待できるかどうかを設定します。

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own. You must have edit access to the calendar.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 9:35 AM and 9:40 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 09:35:00'), new Date('Feb 01, 2023 09:40:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event so that guests can invite
 // other guests.
 event.setGuestsCanInviteOthers(true);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

パラメータ

名前説明
guestsCanInviteOthersBooleanゲストが他の人を招待できるかどうか

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setGuestsCanModify(guestsCanModify)

ゲストが予定を変更できるかどうかを設定します。

パラメータ

名前説明
guestsCanModifyBooleanゲストが予定を変更できるかどうか

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setGuestsCanSeeGuests(guestsCanSeeGuests)

ゲストに他のゲストを表示するかどうかを設定します。

パラメータ

名前説明
guestsCanSeeGuestsBooleanゲストが他の参加者を

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setLocation(location)

イベントの場所を設定します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the location of the event to Noida.
 event.setLocation('Noida');
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

パラメータ

名前説明
locationString新しい場所

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setMyStatus(status)

有効なユーザーのイベントのステータス(参加、招待など)を設定します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for February 1st, 2023 that takes place
// between 4:10 PM and 4:25 PM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Feb 01, 2023 16:10:00'), new Date('Feb 01, 2023 16:25:00'))[0];

if (event) {
 // If an event exists within the given time frame, sets the event status for the current user
 to maybe.
 event.setMyStatus(CalendarApp.GuestStatus.MAYBE);
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

パラメータ

名前説明
statusGuestStatus新しいステータス

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

setTag(key, value)

カスタム メタデータを格納するための Key-Value タグをイベントに設定します。

パラメータ

名前説明
keyStringタグキー
valueStringタグの値

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTime(startTime, endTime)

イベントの開始日時と終了日時を設定します。このメソッドを適用すると、終日の予定が通常のイベントに変わります。

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Declares a start time of 11:00 AM on February 20th, 2023 and an end time of 12:00 PM on
// February 20th, 2023.
const startTime = new Date('Feb 20,2023 11:00:00');
const endTime = new Date('Feb 20, 2023  12:00:00');

// Creates an all-day event on February 20th, 2023.
const event = calendar.createAllDayEvent('Meeting', new Date('Feb 20,2023'));

// Updates the all-day event to a regular event by setting a start and end time for the event.
event.setTime(startTime, endTime);

パラメータ

名前説明
startTimeDate新しいイベントの
endTimeDate新しいイベントの

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTitle(title)

イベントのタイトルを設定します。

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('abc123456@group.calendar.google.com');

// Gets the first event from the calendar for January 31st, 2023 that takes place
// between 9:05 AM and 9:15 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

if (event) {
 // If an event exists within the given time frame, changes its title to Event1.
 event.setTitle('Event1');
} else {
 // If no event exists within the given time frame, logs that information to the console.
 console.log('No events exist for the specified range');
}

パラメータ

名前説明
titleString新しいタイトル

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setVisibility(visibility)

イベントの公開設定を設定します。

パラメータ

名前説明
visibilityVisibility

リターン

CalendarEvent - チェーン用のこの CalendarEvent

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds