此页面由 Cloud Translation API 翻译。

Class CalendarEvent

表示单个日历活动。

方法

方法	返回类型	简介
`addEmailReminder(minutesBefore)`	`CalendarEvent`	为活动添加新的电子邮件提醒。
`addGuest(email)`	`CalendarEvent`	在活动中添加邀请对象。
`addPopupReminder(minutesBefore)`	`CalendarEvent`	为事件添加新的弹出式通知。
`addSmsReminder(minutesBefore)`	`CalendarEvent`	向活动添加新的短信提醒。
`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`	获取此活动所属的一系列周期性活动。
`getGuestByEmail(email)`	`EventGuest`	根据电子邮件地址获取邀请对象。
`getGuestList()`	`EventGuest[]`	获取活动邀请对象，不包括活动所有者。
`getGuestList(includeOwner)`	`EventGuest[]`	获取活动邀请对象，其中可能包括活动所有者。
`getId()`	`String`	获取事件的唯一 iCalUID。
`getLastUpdated()`	`Date`	获取上次更新事件的日期。
`getLocation()`	`String`	获取事件的地点。
`getMyStatus()`	`GuestStatus`	获取有效用户的活动状态（例如已参加或已受邀）。
`getOriginalCalendarId()`	`String`	获取最初创建此活动的日历的 ID。
`getPopupReminders()`	`Integer[]`	获取事件所有弹出式提醒的分钟值。
`getSmsReminders()`	`Integer[]`	获取事件的所有短信提醒的分钟值。
`getStartTime()`	`Date`	获取此日历活动开始的日期和时间。
`getTag(key)`	`String`	获取事件的标记值。
`getTitle()`	`String`	获取事件的标题。
`getVisibility()`	`Visibility`	获取活动的公开范围。
`guestsCanInviteOthers()`	`Boolean`	决定邀请对象是否可以邀请其他邀请对象。
`guestsCanModify()`	`Boolean`	确定邀请对象是否可以修改活动。
`guestsCanSeeGuests()`	`Boolean`	决定邀请对象能否看到其他邀请对象。
`isAllDayEvent()`	`Boolean`	确定此活动是否为全天活动。
`isOwnedByMe()`	`Boolean`	确定您是否是活动的所有者。
`isRecurringEvent()`	`Boolean`	确定活动是否属于某个活动系列。
`removeAllReminders()`	`CalendarEvent`	从活动中删除所有提醒。
`removeGuest(email)`	`CalendarEvent`	从活动中删除邀请对象。
`resetRemindersToDefault()`	`CalendarEvent`	使用日历的默认设置重置提醒。
`setAllDayDate(date)`	`CalendarEvent`	设置事件的日期。
`setAllDayDates(startDate, endDate)`	`CalendarEvent`	设置事件的日期。
`setAnyoneCanAddSelf(anyoneCanAddSelf)`	`CalendarEvent`	设置非访客能否将自己添加到事件中。
`setColor(color)`	`CalendarEvent`	设置日历活动的颜色。
`setDescription(description)`	`CalendarEvent`	设置事件说明。
`setGuestsCanInviteOthers(guestsCanInviteOthers)`	`CalendarEvent`	设置邀请对象是否可以邀请其他邀请对象。
`setGuestsCanModify(guestsCanModify)`	`CalendarEvent`	设置邀请对象是否可以修改活动。
`setGuestsCanSeeGuests(guestsCanSeeGuests)`	`CalendarEvent`	设置邀请对象能否看到其他邀请对象。
`setLocation(location)`	`CalendarEvent`	设置事件的地点。
`setMyStatus(status)`	`CalendarEvent`	设置有效用户的活动状态（例如已参加或已受邀）。
`setTag(key, value)`	`CalendarEvent`	在事件上设置一个键/值标记，用于存储自定义元数据。
`setTime(startTime, endTime)`	`CalendarEvent`	设置事件的开始和结束日期和时间。
`setTitle(title)`	`CalendarEvent`	设置事件的标题。
`setVisibility(visibility)`	`CalendarEvent`	设置活动的公开范围。

详细文档

`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`	距离活动开始的分钟数

CalendarEvent - 此 CalendarEvent，用于链接

抛出

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
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

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

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

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

参数

名称	类型	说明
`email`	`String`	邀请对象的电子邮件地址。

CalendarEvent - 此 CalendarEvent，用于链接。

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`addPopupReminder(minutesBefore)`

为事件添加新的弹出式通知。通知必须至少持续 5 分钟，并且。

// 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`	距离活动开始的分钟数

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`addSmsReminder(minutesBefore)`

向活动添加新的短信提醒。提醒必须至少为 5 分钟，且不超过 4 分钟周（40320 分钟）。

参数

名称	类型	说明
`minutesBefore`	`Integer`	距离活动开始的分钟数

CalendarEvent - 此 CalendarEvent，用于链接

抛出

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

`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();

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`deleteTag(key)`

从事件中删除键值对代码。

参数

名称	类型	说明
`key`	`String`	标记键

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`getAllDayEndDate()`

获取此全天日历活动的结束日期。（如果这不是全天活动，那么此方法会抛出异常。）返回的 Date 表示活动结束后一天的开始时间（以脚本所在的时区为准）。要使用日历的时区，请调用 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 - 如果此活动不是全天活动

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`getAllDayStartDate()`

获取此全天日历活动的开始日期。（如果这不是全天活动，则此方法会抛出异常。）返回的 Date 表示活动开始当天的第一天（以脚本所在的时区为准）。要使用日历的时区，请调用 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 - 如果此活动不是全天活动

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
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

`getEndTime()`

获取此日历活动结束的日期和时间。您必须拥有该日历的访问权限。对于非全天事件，这是指将事件定义为 end 的值。对于仅存储结束日期（而非日期和时间）的全天活动，此字段为午夜在活动结束（以日历的时区为准）之后的第二天开始。这个允许对各类事件的结束时间进行有意义的比较；但它并不必须保留原始日期，不做任何修改。

对于全天活动，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 - 此日历活动的结束时间

授权

使用此方法的脚本需要以下一个或多个范围或相关 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 - 此活动所属的活动系列或新的活动系列（如果尚不属于）至系列

授权

使用此方法的脚本需要以下一个或多个范围或相关 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 - 邀请对象；如果电子邮件地址与邀请对象不对应，则为 null

授权

使用此方法的脚本需要以下一个或多个范围或相关 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。请注意，iCalUID 和事件 id Google 日历 v3 API 和 Google 日历高级服务并不相同，不能互换使用它们在语义上的一个区别在于，对于周期性事件，同一事件的所有事件都有不同的 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

`getStartTime()`

获取此日历活动开始的日期和时间。对于非全天活动，是指定义事件开始的时刻。对于全天活动，存储开始日期（而非日期和时间），该日期是订单当天开始的午夜活动开始于日历的时区。这样就可以对各类活动的开始时间；但不一定会保留原始文件日期值不做任何修改。

对于全天活动，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 - 此日历活动的开始时间

授权

使用此方法的脚本需要以下一个或多个范围或相关 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@google.com');
// and replace the series ID with your own.
const event =
  calendar.getEvents(new Date('Jan 31, 2023 09:05:00'), new Date('Jan 31, 2023 09:15:00'))[0];

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

String - 标题

授权

使用此方法的脚本需要以下一个或多个范围或相关 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

`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

授权

使用此方法的脚本需要以下一个或多个范围或相关 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

`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

授权

使用此方法的脚本需要以下一个或多个范围或相关 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，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`removeGuest(email)`

从活动中删除邀请对象。

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

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

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

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

参数

名称	类型	说明
`email`	`String`	来宾的电子邮件地址

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 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，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 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');
}

参数

名称	类型	说明
`date`	`Date`	事件的日期（忽略时间）

CalendarEvent - 此日历事件（用于链路）

授权

使用此方法的脚本需要以下一个或多个范围或相关 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');
}

参数

名称	类型	说明
`startDate`	`Date`	事件的开始日期（忽略时间）
`endDate`	`Date`	事件的结束日期（忽略时间）

CalendarEvent - 此日历事件（用于链路）

授权

使用此方法的脚本需要以下一个或多个范围或相关 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`	是否有人可以邀请自己

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 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` 中的值。

CalendarEvent - 此日历活动，用于链式。

授权

使用此方法的脚本需要以下一个或多个范围或相关 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`	新广告内容描述

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 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`	来宾能否邀请其他人

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`setGuestsCanModify(guestsCanModify)`

设置邀请对象是否可以修改活动。

参数

名称	类型	说明
`guestsCanModify`	`Boolean`	邀请对象能否修改活动

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`setGuestsCanSeeGuests(guestsCanSeeGuests)`

设置邀请对象能否看到其他邀请对象。

参数

名称	类型	说明
`guestsCanSeeGuests`	`Boolean`	邀请对象能否看到其他人

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 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`	新位置

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 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`	新状态

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 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`	`String`	标记键
`value`	`String`	标记值

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 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);

参数

名称	类型	说明
`startTime`	`Date`	活动新的开始
`endTime`	`Date`	活动的新结尾

CalendarEvent - 此日历事件（用于链路）

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`setTitle(title)`

设置事件的标题。

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

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

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

参数

名称	类型	说明
`title`	`String`	新标题

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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

`setVisibility(visibility)`

设置活动的公开范围。

参数

名称	类型	说明
`visibility`	`Visibility`

CalendarEvent - 此 CalendarEvent，用于链接

授权

使用此方法的脚本需要以下一个或多个范围或相关 REST API 的适当范围的授权：

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