Class CalendarEventSeries

代表一系列活動 (週期性活動)。

方法

方法	傳回類型	簡短說明
`addEmailReminder(minutesBefore)`	`CalendarEventSeries`	為活動新增電子郵件提醒。
`addGuest(email)`	`CalendarEventSeries`	將邀請對象新增到活動中。
`addPopupReminder(minutesBefore)`	`CalendarEventSeries`	為活動新增彈出式通知。
`addSmsReminder(minutesBefore)`	`CalendarEventSeries`	為活動新增簡訊提醒。
`anyoneCanAddSelf()`	`Boolean`	決定使用者是否能將自己新增為日曆活動的邀請對象。
`deleteEventSeries()`	`void`	刪除活動系列。
`deleteTag(key)`	`CalendarEventSeries`	從事件中刪除鍵/值標記。
`getAllTagKeys()`	`String[]`	取得事件中設定的所有標記鍵。
`getColor()`	`String`	傳回日曆活動的顏色。
`getCreators()`	`String[]`	取得活動建立者。
`getDateCreated()`	`Date`	取得事件的建立日期。
`getDescription()`	`String`	取得活動說明。
`getEmailReminders()`	`Integer[]`	取得活動所有電子郵件提醒的分鐘值。
`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[]`	取得活動所有簡訊提醒的分鐘值。
`getTag(key)`	`String`	取得事件的標記值。
`getTitle()`	`String`	取得活動的標題。
`getTransparency()`	`EventTransparency`	取得活動的透明度。
`getVisibility()`	`Visibility`	取得活動的顯示設定。
`guestsCanInviteOthers()`	`Boolean`	決定邀請對象是否可以邀請其他邀請對象。
`guestsCanModify()`	`Boolean`	決定邀請對象是否可以修改活動。
`guestsCanSeeGuests()`	`Boolean`	決定邀請對象是否能看到其他邀請對象。
`isOwnedByMe()`	`Boolean`	判斷您是否為活動擁有者。
`removeAllReminders()`	`CalendarEventSeries`	移除活動中的所有提醒。
`removeGuest(email)`	`CalendarEventSeries`	從活動中移除邀請對象。
`resetRemindersToDefault()`	`CalendarEventSeries`	使用日曆的預設設定重設提醒。
`setAnyoneCanAddSelf(anyoneCanAddSelf)`	`CalendarEventSeries`	設定非邀請對象是否可自行加入活動。
`setColor(color)`	`CalendarEventSeries`	設定日曆活動的顏色。
`setDescription(description)`	`CalendarEventSeries`	設定活動說明。
`setGuestsCanInviteOthers(guestsCanInviteOthers)`	`CalendarEventSeries`	設定邀請對象是否可以邀請其他邀請對象。
`setGuestsCanModify(guestsCanModify)`	`CalendarEventSeries`	設定邀請對象是否可以修改活動。
`setGuestsCanSeeGuests(guestsCanSeeGuests)`	`CalendarEventSeries`	設定邀請對象是否能看到其他邀請對象。
`setLocation(location)`	`CalendarEventSeries`	設定活動地點。
`setMyStatus(status)`	`CalendarEventSeries`	設定有效使用者的活動狀態 (例如出席或受邀)。
`setRecurrence(recurrence, startDate)`	`CalendarEventSeries`	為全天活動系列設定週期性規則。
`setRecurrence(recurrence, startTime, endTime)`	`CalendarEventSeries`	為這個活動系列設定週期性規則。
`setTag(key, value)`	`CalendarEventSeries`	在事件中設定鍵/值標記，用於儲存自訂中繼資料。
`setTitle(title)`	`CalendarEventSeries`	設定活動名稱。
`setTransparency(transparency)`	`CalendarEventSeries`	設定活動的透明度。
`setVisibility(visibility)`	`CalendarEventSeries`	設定活動的顯示狀態。

內容詳盡的說明文件

`addEmailReminder(minutesBefore)`

為活動新增電子郵件提醒。提醒時間必須在活動開始前至少 5 分鐘，最晚 4 週 (40320 分鐘)。

// 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);

參數

名稱	類型	說明
`minutesBefore`	`Integer`	活動開始前幾分鐘

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

擲回

Error：如果活動有超過 5 個提醒，或時間不在合法範圍內

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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);
  }
}

參數

名稱	類型	說明
`email`	`String`	訪客的電子郵件地址。

回攻員

CalendarEventSeries - 這是為了鏈結。CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`addPopupReminder(minutesBefore)`

為活動新增彈出式通知。通知時間必須在活動開始前至少 5 分鐘，最長 4 週 (40320 分鐘)。

// 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);

參數

名稱	類型	說明
`minutesBefore`	`Integer`	活動開始前幾分鐘

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`addSmsReminder(minutesBefore)`

為活動新增簡訊提醒。提醒時間必須在活動開始前至少 5 分鐘，最晚 4 週 (40320 分鐘)。

參數

名稱	類型	說明
`minutesBefore`	`Integer`	活動開始前幾分鐘

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

擲回

Error：如果活動有超過 5 個提醒，或時間不在合法範圍內

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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 否則

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`deleteEventSeries()`

刪除活動系列。

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`deleteTag(key)`

從事件中刪除鍵/值標記。

參數

名稱	類型	說明
`key`	`String`	標記鍵

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`getAllTagKeys()`

取得事件中設定的所有標記鍵。

回攻員

String[]：字串鍵陣列

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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)。

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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[] - 活動建立者的電子郵件地址

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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：建立日期

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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：說明

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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[]：陣列，每個值對應於提醒觸發時間 (活動開始前幾分鐘)

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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：活動類型。

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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());
}

參數

名稱	類型	說明
`email`	`String`	訪客的地址

回攻員

EventGuest - 邀請對象，如果電子郵件地址不對應邀請對象，則為空值

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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[]：房客陣列

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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());
}

參數

名稱	類型	說明
`includeOwner`	`Boolean`	是否要將擁有者設為邀請對象

回攻員

EventGuest[]：房客陣列

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`getId()`

取得活動的專屬 iCalUID。請注意，日曆 v3 API 和日曆進階服務使用的 iCalUID 和活動 id 並不相同，無法互換使用。兩者語意上的差異在於，週期性活動的所有事件發生次數都不同 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

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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 - 上次更新日期

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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：活動地點

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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：狀態

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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[]：陣列，每個值對應於提醒觸發時間 (活動開始前幾分鐘)

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`getSmsReminders()`

取得活動所有簡訊提醒的分鐘值。

回攻員

Integer[]：陣列，每個值對應於提醒觸發時間 (活動開始前幾分鐘)

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`getTag(key)`

取得事件的標記值。

參數

名稱	類型	說明
`key`	`String`	金鑰

回攻員

String：標記值

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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 - 標題

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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：透明度值。

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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：可見度值

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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 邀請對象無法邀請他人

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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 邀請對象無法修改活動

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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 邀請對象無法查看其他邀請對象

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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 (如果活動不屬於有效使用者)

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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');
}

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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);
  }
}

參數

名稱	類型	說明
`email`	`String`	邀請對象的電子郵件地址

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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');
}

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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');
}

參數

名稱	類型	說明
`anyoneCanAddSelf`	`Boolean`	是否允許任何人自行邀請

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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');
}

參數

名稱	類型	說明
`color`	`String`	以字串表示的整數顏色索引，或 `CalendarApp.EventColor` 中的值。

回攻員

CalendarEventSeries - 這個日曆活動，用於鏈結。

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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');
}

參數

名稱	類型	說明
`description`	`String`	新說明

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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');
}

參數

名稱	類型	說明
`guestsCanInviteOthers`	`Boolean`	邀請對象是否可以邀請其他人

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`setGuestsCanModify(guestsCanModify)`

設定邀請對象是否可以修改活動。

參數

名稱	類型	說明
`guestsCanModify`	`Boolean`	邀請對象是否可以修改活動

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`setGuestsCanSeeGuests(guestsCanSeeGuests)`

設定邀請對象是否能看到其他邀請對象。

參數

名稱	類型	說明
`guestsCanSeeGuests`	`Boolean`	邀請對象是否能看到其他邀請對象

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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');
}

參數

名稱	類型	說明
`location`	`String`	新位置

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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');
}

參數

名稱	類型	說明
`status`	`GuestStatus`	新狀態

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`setRecurrence(recurrence, startDate)`

為全天活動系列設定週期性規則。套用這個方法後，一般活動系列就會變成全天活動系列。

// Sets the events in a series to take place every Wednesday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById(
    '123456789@example.com',
);
const startDate = new Date('January 2, 2013 03:00:00 PM EST');
const recurrence = CalendarApp.newRecurrence()
                       .addWeeklyRule()
                       .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
                       .until(new Date('January 1, 2014'));
eventSeries.setRecurrence(recurrence, startDate);

參數

名稱	類型	說明
`recurrence`	`EventRecurrence`	要使用的重複規則
`startDate`	`Date`	系列中第一個事件的日期 (只會使用日期，時間會遭忽略)

回攻員

CalendarEventSeries - 這個 CalendarEventSeries，用於鏈結

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`setRecurrence(recurrence, startTime, endTime)`

為這個活動系列設定週期性規則。套用這個方法後，全天活動系列就會變成一般活動系列。

// Sets the events in a series to take place from 3pm to 4pm every Tuesday and
// Thursday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById(
    '123456789@example.com',
);
const startTime = new Date('January 1, 2013 03:00:00 PM EST');
const endTime = new Date('January 1, 2013 04:00:00 PM EST');
const recurrence =
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekdays(
            [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014'));
eventSeries.setRecurrence(recurrence, startTime, endTime);

參數

名稱	類型	說明
`recurrence`	`EventRecurrence`	要使用的重複規則
`startTime`	`Date`	系列中第一個活動的開始日期和時間
`endTime`	`Date`	系列活動中第一個活動的結束日期和時間

回攻員

CalendarEventSeries - 這個 CalendarEventSeries，用於鏈結

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`setTag(key, value)`

在事件中設定鍵/值標記，用於儲存自訂中繼資料。

參數

名稱	類型	說明
`key`	`String`	標記鍵
`value`	`String`	標記值

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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');
}

參數

名稱	類型	說明
`title`	`String`	新標題

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 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);

參數

名稱	類型	說明
`transparency`	`EventTransparency`	透明度值。

回攻員

CalendarEventSeries - 這是為了鏈結。CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

`setVisibility(visibility)`

設定活動的顯示狀態。

參數

名稱	類型	說明
`visibility`	`Visibility`

回攻員

CalendarEventSeries：用於鏈結的 CalendarEventSeries

授權

使用這個方法的指令碼需要透過下列一或多個範圍或相關 REST API 中的適當範圍授權：

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

Class CalendarEventSeries 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

方法

內容詳盡的說明文件

addEmailReminder(minutesBefore)

參數

回攻員

擲回

授權

addGuest(email)

參數

回攻員

授權

addPopupReminder(minutesBefore)

參數

回攻員

授權

addSmsReminder(minutesBefore)

參數

回攻員

擲回

授權

anyoneCanAddSelf()

回攻員

授權

deleteEventSeries()

授權

deleteTag(key)

參數

回攻員

授權

getAllTagKeys()

回攻員

授權

getColor()

回攻員

授權

getCreators()

回攻員

授權

getDateCreated()

回攻員

授權

getDescription()

回攻員

授權

getEmailReminders()

回攻員

授權

getEventType()

回攻員

授權

getGuestByEmail(email)

參數

回攻員

授權

getGuestList()

回攻員

授權

getGuestList(includeOwner)

參數

回攻員

授權

getId()

回攻員

授權

getLastUpdated()

回攻員

授權

getLocation()

回攻員

授權

getMyStatus()

回攻員

授權

getOriginalCalendarId()

回攻員

授權

getPopupReminders()

回攻員

授權

Class CalendarEventSeries

`addEmailReminder(minutesBefore)`

`addGuest(email)`

`addPopupReminder(minutesBefore)`

`addSmsReminder(minutesBefore)`

`anyoneCanAddSelf()`

`deleteEventSeries()`

`deleteTag(key)`

`getAllTagKeys()`

`getColor()`

`getCreators()`

`getDateCreated()`

`getDescription()`

`getEmailReminders()`

`getEventType()`

`getGuestByEmail(email)`

`getGuestList()`

`getGuestList(includeOwner)`

`getId()`

`getLastUpdated()`

`getLocation()`

`getMyStatus()`

`getOriginalCalendarId()`

`getPopupReminders()`

`getSmsReminders()`

`getTag(key)`

`getTitle()`

`getTransparency()`

`getVisibility()`

`guestsCanInviteOthers()`

`guestsCanModify()`

`guestsCanSeeGuests()`

`isOwnedByMe()`

`removeAllReminders()`

`removeGuest(email)`

`resetRemindersToDefault()`

`setAnyoneCanAddSelf(anyoneCanAddSelf)`

`setColor(color)`

`setDescription(description)`

`setGuestsCanInviteOthers(guestsCanInviteOthers)`

`setGuestsCanModify(guestsCanModify)`

`setGuestsCanSeeGuests(guestsCanSeeGuests)`

`setLocation(location)`

`setMyStatus(status)`