Class CalendarEvent

CalendarEvent

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

メソッド

メソッド戻り値の型概要
addEmailReminder(minutesBefore)CalendarEventイベントに新しいメール リマインダーを追加します。
addGuest(email)CalendarEvent予定にゲストを追加します。
addPopupReminder(minutesBefore)CalendarEventイベントに新しいポップアップ通知を追加します。
addSmsReminder(minutesBefore)CalendarEvent予定に新しい SMS リマインダーを追加します。
anyoneCanAddSelf()Booleanユーザーがカレンダーの予定にゲストとして自分自身を追加できるかどうかを指定します。
deleteEvent()voidカレンダーの予定を削除します。
deleteTag(key)CalendarEventイベントからキーと値のタグを削除します。
getAllDayEndDate()Dateこの終日カレンダーの予定の終了日を取得します。
getAllDayStartDate()Dateこの終日カレンダーの予定が開始する日付を取得します。
getAllTagKeys()String[]イベントに設定されているタグのすべてのキーを取得します。
getColor()Stringカレンダーの予定の色を返します。
getCreators()String[]イベントの作成者を取得します。
getDateCreated()Dateイベントが作成された日付を取得します。
getDescription()Stringイベントの説明を取得します。
getEmailReminders()Integer[]イベントのすべてのメール リマインダーの分単位の値を取得します。
getEndTime()Dateこのカレンダーの予定が終了する日時を取得します。
getEventSeries()CalendarEventSeriesこのイベントが属する定期的な予定のシリーズを取得します。
getEventType()EventTypeこのイベントの EventType を取得します。
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イベントのタイトルを取得します。
getTransparency()EventTransparencyイベントの透明度を取得します。
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イベントのタイトルを設定します。
setTransparency(transparency)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 - 予定に 6 つ以上のリマインダーがある場合、または時間が有効範囲外の場合

承認

このメソッドを使用するスクリプトには、次の 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
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to add
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar containing
  // event
  const eventId = '123abc';  // ID of event instance

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  const 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
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to add
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar with the
  // events
  const startDate =
      new Date('YYYY-MM-DD');  // The first date to add the guest to the events
  const endDate =
      new Date('YYYY-MM-DD');  // The last date to add the guest to the events

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  const 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 (let i = 0; i < calEvents.length; i++) {
    const 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 - 予定に 6 つ以上のリマインダーがある場合、または時間が有効範囲外の場合

承認

このメソッドを使用するスクリプトには、次の 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)

イベントからキーと値のタグを削除します。

パラメータ

名前タイプ説明
keyStringタグキー

戻る

CalendarEvent - チェーン用の CalendarEvent

承認

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

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

getAllDayEndDate()

この終日カレンダーの予定の終了日を取得します。（終日の予定でない場合、このメソッドは例外をスローします）。返される Date は、イベントが終了した翌日の午前 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 は、イベントが開始される日の午前 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

getEventType()

このイベントの EventType を取得します。

// Opens the default calendar and logs all out-of-office events for the current day.
const calendar = CalendarApp.getDefaultCalendar();
const events = calendar.getEventsForDay(new Date());
console.log(events.filter(e => e.getEventType() === CalendarApp.EventType.OUT_OF_OFFICE));

戻る

EventType - イベントタイプ。

承認

このメソッドを使用するスクリプトには、次の 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 API とカレンダーの高度なサービスで使用される iCalUID とイベント id は同一ではなく、相互に置き換えることはできません。セマンティクスの違いの 1 つは、定期的な予定では、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@example.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

getTransparency()

イベントの透明度を取得します。このメソッドを使用して、予定が TRANSPARENT（その時間帯にカレンダーが [予定なし] と表示される）か OPAQUE （その時間帯にカレンダーが [予定あり] と表示される）かを判断します。

// Gets the first event from the default calendar for today.
const today = new Date();
const event = CalendarApp.getDefaultCalendar().getEventsForDay(today)[0];
// Gets the event's transparency and logs it.
const transparency = event.getTransparency();
Logger.log(transparency);

戻る

EventTransparency - 透明度の値。

承認

このメソッドを使用するスクリプトには、次の 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
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to remove
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar containing
  // event
  const eventId = '123abc';  // ID of event instance

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  const 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
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to remove
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar with the
  // events
  const startDate = new Date(
      'YYYY-MM-DD');  // The first date to remove the guest from the events
  const endDate = new Date(
      'YYYY-MM-DD');  // The last date to remove the attendee from the events

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  const 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 (let i = 0; i < calEvents.length; i++) {
    const 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@example.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

setTransparency(transparency)

イベントの透明度を設定します。このメソッドを使用して、予定を TRANSPARENT（その時間帯にカレンダーが [予定なし] と表示される）にするか、OPAQUE （その時間帯にカレンダーが [予定あり] と表示される）にするかを設定します。

// 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');
// Sets the event's transparency to TRANSPARENT.
event.setTransparency(CalendarApp.EventTransparency.TRANSPARENT);

パラメータ

名前タイプ説明
transparencyEventTransparency透明度の値。

戻る

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