此页面由 Cloud Translation API 翻译。

Class CalendarApp

允许脚本读取和更新用户的 Google 日历。此类可直接访问用户的默认日历，还可以检索用户拥有或订阅的其他日历。

属性

属性	类型	说明
`Color`	`Color`	表示 Google 日历服务中可用的命名颜色的枚举。
`EventColor`	`EventColor`	一个枚举，表示日历服务中提供的命名活动颜色。
`EventType`	`EventType`	`EventType` 枚举。
`GuestStatus`	`GuestStatus`	一个枚举，表示来宾对某个活动的状态。
`Month`	`Month`	表示一年中的月份的枚举。
`Visibility`	`Visibility`	表示事件公开范围的枚举。
`Weekday`	`Weekday`	表示星期几的枚举。

方法

方法	返回类型	简介
`createAllDayEvent(title, date)`	`CalendarEvent`	创建新的全天活动。
`createAllDayEvent(title, startDate, endDate)`	`CalendarEvent`	创建可跨多天的全新全天活动。
`createAllDayEvent(title, startDate, endDate, options)`	`CalendarEvent`	创建可跨多天的全新全天活动。
`createAllDayEvent(title, date, options)`	`CalendarEvent`	创建新的全天活动。
`createAllDayEventSeries(title, startDate, recurrence)`	`CalendarEventSeries`	创建新的全天活动系列。
`createAllDayEventSeries(title, startDate, recurrence, options)`	`CalendarEventSeries`	创建新的全天活动系列。
`createCalendar(name)`	`Calendar`	创建归用户所有的新日历。
`createCalendar(name, options)`	`Calendar`	创建归用户所有的新日历。
`createEvent(title, startTime, endTime)`	`CalendarEvent`	创建新活动。
`createEvent(title, startTime, endTime, options)`	`CalendarEvent`	创建新活动。
`createEventFromDescription(description)`	`CalendarEvent`	根据自由形式说明创建活动。
`createEventSeries(title, startTime, endTime, recurrence)`	`CalendarEventSeries`	创建新的活动系列。
`createEventSeries(title, startTime, endTime, recurrence, options)`	`CalendarEventSeries`	创建新的活动系列。
`getAllCalendars()`	`Calendar[]`	获取用户拥有或订阅的所有日历。
`getAllOwnedCalendars()`	`Calendar[]`	获取用户拥有的所有日历。
`getCalendarById(id)`	`Calendar`	获取具有给定 ID 的日历。
`getCalendarsByName(name)`	`Calendar[]`	获取用户拥有或订阅的具有给定名称的所有日历。
`getColor()`	`String`	获取日历的颜色。
`getDefaultCalendar()`	`Calendar`	获取用户的默认日历。
`getDescription()`	`String`	获取日历的说明。
`getEventById(iCalId)`	`CalendarEvent`	获取具有指定 ID 的事件。
`getEventSeriesById(iCalId)`	`CalendarEventSeries`	获取具有指定 ID 的活动系列。
`getEvents(startTime, endTime)`	`CalendarEvent[]`	获取在给定时间范围内发生的所有事件。
`getEvents(startTime, endTime, options)`	`CalendarEvent[]`	获取在指定时间范围内发生且符合指定条件的所有事件。
`getEventsForDay(date)`	`CalendarEvent[]`	获取指定日期发生的所有事件。
`getEventsForDay(date, options)`	`CalendarEvent[]`	获取在指定日期发生且符合指定条件的所有事件。
`getId()`	`String`	获取日历的 ID。
`getName()`	`String`	获取日历的名称。
`getOwnedCalendarById(id)`	`Calendar`	获取具有指定 ID 的日历（如果用户拥有该日历）。
`getOwnedCalendarsByName(name)`	`Calendar[]`	获取用户拥有的具有给定名称的所有日历。
`getTimeZone()`	`String`	获取日历的时区。
`isHidden()`	`Boolean`	确定日历是否在界面中隐藏。
`isMyPrimaryCalendar()`	`Boolean`	确定日历是否为有效用户的主日历。
`isOwnedByMe()`	`Boolean`	确定日历是否归您所有。
`isSelected()`	`Boolean`	确定日历的活动是否显示在界面中。
`newRecurrence()`	`EventRecurrence`	创建新的重复对象，可用于为事件重复创建规则。
`setColor(color)`	`Calendar`	设置日历的颜色。
`setDescription(description)`	`Calendar`	设置日历的说明。
`setHidden(hidden)`	`Calendar`	设置日历在界面中是否可见。
`setName(name)`	`Calendar`	设置日历的名称。
`setSelected(selected)`	`Calendar`	设置日历的活动是否显示在界面中。
`setTimeZone(timeZone)`	`Calendar`	设置日历的时区。
`subscribeToCalendar(id)`	`Calendar`	将用户订阅给定 ID 的日历（如果用户有权订阅）。
`subscribeToCalendar(id, options)`	`Calendar`	将用户订阅给定 ID 的日历（如果用户有权订阅）。

详细文档

`createAllDayEvent(title, date)`

创建新的全天活动。

// Creates an all-day event for the moon landing and logs the ID.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969'),
);
Logger.log(`Event ID: ${event.getId()}`);

参数

名称	类型	说明
`title`	`String`	活动的标题。
`date`	`Date`	活动的日期（仅使用日期；时间会被忽略）。

CalendarEvent - 创建的事件。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createAllDayEvent(title, startDate, endDate)`

创建可跨多天的全新全天活动。

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and
// logs the ID.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Woodstock Festival',
    new Date('August 15, 1969'),
    new Date('August 18, 1969'),
);
Logger.log(`Event ID: ${event.getId()}`);

参数

名称	类型	说明
`title`	`String`	活动的标题。
`startDate`	`Date`	活动的开始日期（仅使用日期，时间会被忽略）。
`endDate`	`Date`	活动的结束日期（仅使用日期，时间会被忽略）。结束日期不含当天。

CalendarEvent - 创建的事件。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createAllDayEvent(title, startDate, endDate, options)`

创建可跨多天的全新全天活动。

// Creates an all-day event for the Woodstock festival (August 15th to 17th) and
// logs the ID.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Woodstock Festival',
    new Date('August 15, 1969'),
    new Date('August 18, 1969'),
    {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true},
);
Logger.log(`Event ID: ${event.getId()}`);

参数

名称	类型	说明
`title`	`String`	活动的标题。
`startDate`	`Date`	活动的开始日期（仅使用日期，时间会被忽略）。
`endDate`	`Date`	活动的结束日期（仅使用日期，时间会被忽略）。结束日期不含当天。
`options`	`Object`	用于指定高级参数的 JavaScript 对象，如下所列。

高级参数

名称	类型	说明
`description`	`String`	事件说明。
`location`	`String`	活动的地点。
`guests`	`String`	应添加为访客的电子邮件地址的逗号分隔列表。
`sendInvites`	`Boolean`	是否发送邀请电子邮件（默认值：`false`）。

CalendarEvent - 创建的事件。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createAllDayEvent(title, date, options)`

创建新的全天活动。

// Creates an all-day event for the moon landing and logs the ID.
const event = CalendarApp.getDefaultCalendar().createAllDayEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969'),
    {location: 'The Moon'},
);
Logger.log(`Event ID: ${event.getId()}`);

参数

名称	类型	说明
`title`	`String`	活动的标题。
`date`	`Date`	活动的日期（仅使用日期；时间会被忽略）。
`options`	`Object`	用于指定高级参数的 JavaScript 对象，如下所列。

高级参数

名称	类型	说明
`description`	`String`	事件说明。
`location`	`String`	活动的地点。
`guests`	`String`	应添加为访客的电子邮件地址的逗号分隔列表。
`sendInvites`	`Boolean`	是否发送邀请电子邮件（默认值：`false`）。

CalendarEvent - 创建的事件。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createAllDayEventSeries(title, startDate, recurrence)`

创建新的全天活动系列。

// Creates an event series for a no-meetings day, taking place every Wednesday
// in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries(
    'No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
        .until(new Date('January 1, 2014')),
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

参数

名称	类型	说明
`title`	`String`	系列活动的标题
`startDate`	`Date`	系列中第一个事件的日期（仅使用日期，时间会被忽略）
`recurrence`	`EventRecurrence`	活动系列的重复设置

CalendarEventSeries - 创建的活动系列

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createAllDayEventSeries(title, startDate, recurrence, options)`

创建新的全天活动系列。

// Creates an event series for a no-meetings day, taking place every Wednesday
// in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries(
    'No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
        .until(new Date('January 1, 2014')),
    {guests: 'everyone@example.com'},
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

参数

名称	类型	说明
`title`	`String`	系列活动的标题
`startDate`	`Date`	系列中第一个事件的日期（仅使用日期，时间会被忽略）
`recurrence`	`EventRecurrence`	活动系列的重复设置
`options`	`Object`	用于指定高级参数的 JavaScript 对象，如下所列

高级参数

名称	类型	说明
`description`	`String`	系列活动的说明
`location`	`String`	系列活动的地点
`guests`	`String`	应将其添加为系列活动的访客的电子邮件地址的逗号分隔列表
`sendInvites`	`Boolean`	是否发送邀请电子邮件（默认：`false`）

CalendarEventSeries - 创建的活动系列

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createCalendar(name)`

创建归用户所有的新日历。

// Creates a new calendar named "Travel Plans".
const calendar = CalendarApp.createCalendar('Travel Plans');
Logger.log(
    'Created the calendar "%s", with the ID "%s".',
    calendar.getName(),
    calendar.getId(),
);

参数

名称	类型	说明
`name`	`String`	新日历的名称

Calendar - 新创建的日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createCalendar(name, options)`

创建归用户所有的新日历。

// Creates a new calendar named "Travel Plans" with a description and color.
const calendar = CalendarApp.createCalendar('Travel Plans', {
  description: 'A calendar to plan my travel schedule.',
  color: CalendarApp.Color.BLUE,
});
Logger.log(
    'Created the calendar "%s", with the ID "%s".',
    calendar.getName(),
    calendar.getId(),
);

参数

名称	类型	说明
`name`	`String`	新日历的名称
`options`	`Object`	用于指定高级参数的 JavaScript 对象，如下所列

高级参数

名称	类型	说明
`location`	`String`	日历的位置
`description`	`String`	日历的说明
`timeZone`	`String`	要将日历设置为的时区，采用“长”格式指定（例如“America/New_York”（Joda.org 上所列）
`color`	`String`	十六进制颜色字符串（“#rrggbb”）或 `CalendarApp.Colors` 中的值
`hidden`	`Boolean`	日历是否在界面中隐藏（默认：`false`）
`selected`	`Boolean`	日历活动是否显示在界面中（默认值：`true`）

Calendar - 新创建的日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createEvent(title, startTime, endTime)`

创建新事件。

如果未指定时区，系统会在脚本时区（可能与日历时区不同）的上下文中解读时间值。

// Creates an event for the moon landing and logs the ID.
const event = CalendarApp.getDefaultCalendar().createEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969 20:00:00 UTC'),
    new Date('July 21, 1969 21:00:00 UTC'),
);
Logger.log(`Event ID: ${event.getId()}`);

参数

名称	类型	说明
`title`	`String`	活动的标题
`startTime`	`Date`	活动的开始日期和时间
`endTime`	`Date`	活动的结束日期和时间

CalendarEvent - 创建的事件

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createEvent(title, startTime, endTime, options)`

创建新事件。

如果未指定时区，系统会在脚本时区（可能与日历时区不同）的上下文中解读时间值。

// Creates an event for the moon landing and logs the ID.
const event = CalendarApp.getDefaultCalendar().createEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969 20:00:00 UTC'),
    new Date('July 20, 1969 21:00:00 UTC'),
    {location: 'The Moon'},
);
Logger.log(`Event ID: ${event.getId()}`);

参数

名称	类型	说明
`title`	`String`	活动的标题
`startTime`	`Date`	活动的开始日期和时间
`endTime`	`Date`	活动的结束日期和时间
`options`	`Object`	用于指定高级参数的 JavaScript 对象，如下所列

高级参数

名称	类型	说明
`description`	`String`	事件说明
`location`	`String`	活动地点
`guests`	`String`	应添加为访客的电子邮件地址的逗号分隔列表
`sendInvites`	`Boolean`	是否发送邀请电子邮件（默认：`false`）

CalendarEvent - 创建的事件

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createEventFromDescription(description)`

根据自由形式的说明创建事件。

说明应采用与界面的“快速添加”功能相同的格式。

// Creates a new event and logs its ID.
const event = CalendarApp.getDefaultCalendar().createEventFromDescription(
    'Lunch with Mary, Friday at 1PM',
);
Logger.log(`Event ID: ${event.getId()}`);

参数

名称	类型	说明
`description`	`String`	事件的自由形式说明

CalendarEvent - 创建的事件

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createEventSeries(title, startTime, endTime, recurrence)`

创建新的活动系列。

// Creates an event series for a team meeting, taking place every Tuesday and
// Thursday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries(
    'Team Meeting',
    new Date('January 1, 2013 03:00:00 PM EST'),
    new Date('January 1, 2013 04:00:00 PM EST'),
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekdays(
            [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014')),
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

参数

名称	类型	说明
`title`	`String`	系列活动的标题
`startTime`	`Date`	系列活动中第一个活动的开始日期和时间
`endTime`	`Date`	系列中第一个事件的结束日期和时间
`recurrence`	`EventRecurrence`	活动系列的重复设置

CalendarEventSeries - 创建的活动系列

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`createEventSeries(title, startTime, endTime, recurrence, options)`

创建新的活动系列。

// Creates an event series for a team meeting, taking place every Tuesday and
// Thursday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries(
    'Team Meeting',
    new Date('January 1, 2013 03:00:00 PM EST'),
    new Date('January 1, 2013 04:00:00 PM EST'),
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekdays(
            [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014')),
    {location: 'Conference Room'},
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

参数

名称	类型	说明
`title`	`String`	系列活动的标题
`startTime`	`Date`	系列活动中第一个活动的开始日期和时间
`endTime`	`Date`	系列中第一个事件的结束日期和时间
`recurrence`	`EventRecurrence`	活动系列的重复设置
`options`	`Object`	用于指定高级参数的 JavaScript 对象，如下所列

高级参数

名称	类型	说明
`description`	`String`	系列活动的说明
`location`	`String`	系列活动的地点
`guests`	`String`	应将其添加为系列活动的访客的电子邮件地址的逗号分隔列表
`sendInvites`	`Boolean`	是否发送邀请电子邮件（默认：`false`）

CalendarEventSeries - 创建的活动系列

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getAllCalendars()`

获取用户拥有或订阅的所有日历。

// Determines how many calendars the user can access.
const calendars = CalendarApp.getAllCalendars();
Logger.log(
    'This user owns or is subscribed to %s calendars.',
    calendars.length,
);

Calendar[] - 用户可以访问的所有日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getAllOwnedCalendars()`

获取用户拥有的所有日历。

// Determines how many calendars the user owns.
const calendars = CalendarApp.getAllOwnedCalendars();
Logger.log('This user owns %s calendars.', calendars.length);

Calendar[] - 用户拥有的所有日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getCalendarById(id)`

获取具有给定 ID 的日历。

// Gets the public calendar "US Holidays" by ID.
const calendar = CalendarApp.getCalendarById(
    'en.usa#holiday@group.v.calendar.google.com',
);
Logger.log('The calendar is named "%s".', calendar.getName());

参数

名称	类型	说明
`id`	`String`	日历 ID

Calendar - 具有给定 ID 的日历；如果日历不存在、用户无法访问该日历或用户未订阅该日历，则为 null

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getCalendarsByName(name)`

获取用户拥有或订阅的具有给定名称的所有日历。名称不区分大小写。

// Gets the public calendar named "US Holidays".
const calendars = CalendarApp.getCalendarsByName('US Holidays');
Logger.log('Found %s matching calendars.', calendars.length);

参数

名称	类型	说明
`name`	`String`	日历名称

Calendar[] - 用户可以访问的所有名称为此的 Google 日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getColor()`

获取日历的颜色。

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

// Gets the color of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getColor() instead.
const calendarColor = calendar.getColor();
console.log(calendarColor);

String - 十六进制颜色字符串（“#rrggbb”）。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getDefaultCalendar()`

获取用户的默认日历。

// Determines the time zone of the user's default calendar.
const calendar = CalendarApp.getDefaultCalendar();
Logger.log(
    'My default calendar is set to the time zone "%s".',
    calendar.getTimeZone(),
);

Calendar - 用户的默认日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 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.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Sets the description of the calendar to 'Test description.'
calendar.setDescription('Test description');

// Gets the description of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getDescription() instead.
const description = calendar.getDescription();
console.log(description);

String - 此日历的说明。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getEventById(iCalId)`

获取具有指定 ID 的事件。如果系列属于默认日历以外的日历，则必须从该日历调用此方法。调用 getEventById(iCalId) 只会返回默认日历中的活动。

如果多个事件属于同一系列活动，则可能具有相同的 ID。在这种情况下，此方法仅返回该系列中的第一个事件。

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

// Creates an event for the moon landing.
const event = calendar.createEvent(
    'Apollo 11 Landing',
    new Date('July 20, 1969 20:05:00 UTC'),
    new Date('July 20, 1969 20:17:00 UTC'),
);

// Gets the calendar event ID and logs it to the console.
const iCalId = event.getId();
console.log(iCalId);

// Gets the event by its ID and logs the title of the event to the console.
// For the default calendar, you can use CalendarApp.getEventById(iCalId)
// instead.
const myEvent = calendar.getEventById(iCalId);
console.log(myEvent.getTitle());

参数

名称	类型	说明
`iCalId`	`String`	事件的 ID。

CalendarEvent - 具有给定 ID 的事件；如果事件不存在或用户无法访问该事件，则为 null。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getEventSeriesById(iCalId)`

获取具有指定 ID 的活动系列。如果指定的 ID 是单个 CalendarEvent 的 ID，则返回的 CalendarEventSeries 中包含系列中单个事件。请注意，如果活动系列属于默认日历以外的日历，则必须从该 CalendarApp 调用此方法；直接调用 getEventSeriesById(iCalId) 只会返回默认日历中存在的活动系列。

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

// Creates an event series for a daily team meeting from 1 PM to 2 PM.
// The series adds the daily event from January 1, 2023 through December 31,
// 2023.
const eventSeries = calendar.createEventSeries(
    'Team meeting',
    new Date('Jan 1, 2023 13:00:00'),
    new Date('Jan 1, 2023 14:00:00'),
    CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024')),
);

// Gets the ID of the event series.
const iCalId = eventSeries.getId();

// Gets the event series by its ID and logs the series title to the console.
// For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId)
// instead.
console.log(calendar.getEventSeriesById(iCalId).getTitle());

参数

名称	类型	说明
`iCalId`	`String`	活动系列的 ID。

CalendarEventSeries - 具有给定 ID 的系列图书；如果系列图书不存在或用户无法访问，则返回 null。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getEvents(startTime, endTime)`

获取在给定时间范围内发生的所有事件。

此方法会返回在给定时间范围内开始、结束或涵盖该时间范围的事件。如果未指定时区，系统会在脚本时区的上下文中解读时间值，该时区可能与日历的时区不同。

// Determines how many events are happening in the next two hours.
const now = new Date();
const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000);
const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow);
Logger.log(`Number of events: ${events.length}`);

参数

名称	类型	说明
`startTime`	`Date`	时间范围的开始时间
`endTime`	`Date`	时间范围的结束时间（不含）

CalendarEvent[] - 在时间范围内发生的事件

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getEvents(startTime, endTime, options)`

获取在指定时间范围内发生且符合指定条件的所有事件。

请注意，对 author、search 或 statusFilters 进行过滤是在应用 start 和 max 之后进行的。这意味着，即使有其他事件符合条件，返回的事件数量也可能少于 max。

// Determines how many events are happening in the next two hours that contain
// the term "meeting".
const now = new Date();
const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000);
const events = CalendarApp.getDefaultCalendar().getEvents(
    now,
    twoHoursFromNow,
    {search: 'meeting'},
);
Logger.log(`Number of events: ${events.length}`);

参数

名称	类型	说明
`startTime`	`Date`	时间范围的开始时间
`endTime`	`Date`	时间范围的结束时间（不含）
`options`	`Object`	用于指定高级参数的 JavaScript 对象，如下所列

高级参数

名称	类型	说明
`start`	`Integer`	要返回的第一个事件的索引
`max`	`Integer`	要返回的事件数量上限
`author`	`String`	用于按活动创建者过滤结果的电子邮件地址
`search`	`String`	用于过滤结果的全文搜索查询
`statusFilters[]`	`GuestStatus`	用于过滤结果的状态数组

CalendarEvent[] - 在时间范围内发生且符合条件的事件

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getEventsForDay(date)`

获取指定日期发生的所有事件。

如果事件在给定日期开始、结束或涵盖该日期，此方法会返回相应事件。

请注意，系统只会使用 Date 对象的日期部分，并会忽略时间部分。日期的解读是指从日历所在时区当天零点到次日零点。

// Determines how many events are happening today.
const today = new Date();
const events = CalendarApp.getDefaultCalendar().getEventsForDay(today);
Logger.log(`Number of events: ${events.length}`);

参数

名称	类型	说明
`date`	`Date`	要检索事件的日期（仅使用日期；时间会被忽略）

CalendarEvent[] - 在指定日期发生的事件

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getEventsForDay(date, options)`

获取在指定日期发生且符合指定条件的所有事件。

如果事件在给定日期开始、结束或涵盖该日期，此方法会返回相应事件。

请注意，系统只会使用 Date 对象的日期部分，并会忽略时间部分。日期的解读是指从日历所在时区当天零点到次日零点。

// Determines how many events are happening today and contain the term
// "meeting".
const today = new Date();
const events = CalendarApp.getDefaultCalendar().getEventsForDay(today, {
  search: 'meeting',
});
Logger.log(`Number of events: ${events.length}`);

参数

名称	类型	说明
`date`	`Date`	要检索事件的日期（仅使用日期；时间会被忽略）
`options`	`Object`	高级过滤选项

高级参数

名称	类型	说明
`start`	`Integer`	要返回的第一个事件的索引
`max`	`Integer`	要返回的事件数量上限
`author`	`String`	用于按活动创建者过滤结果的电子邮件地址
`search`	`String`	用于过滤结果的全文搜索查询
`statusFilters[]`	`GuestStatus`	用于过滤结果的状态数组

CalendarEvent[] - 在指定日期发生且符合条件的事件

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getId()`

获取日历的 ID。用户的默认日历的 ID 是其电子邮件地址。

// Opens the calendar by its ID.
// To get the user's default calendar, use CalendarApp.getDefaultCalendar().
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com');

// Gets the ID of the calendar and logs it to the console.
const calendarId = calendar.getId();
console.log(calendarId);

String - 日历的 ID。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getName()`

获取日历的名称。

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

// Gets the name of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getName() instead.
const calendarName = calendar.getName();
console.log(calendarName);

String - 此日历的名称。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getOwnedCalendarById(id)`

获取具有指定 ID 的日历（如果用户拥有该日历）。

如需查找日历 ID，请在 Google 日历中点击日历名称旁边的箭头，然后选择日历设置。该 ID 显示在设置页面底部附近。

// Gets a (non-existent) private calendar by ID.
const calendar = CalendarApp.getOwnedCalendarById(
    '123456789@group.calendar.google.com',
);
Logger.log('The calendar is named "%s".', calendar.getName());

参数

名称	类型	说明
`id`	`String`	日历 ID

Calendar - 具有给定 ID 的日历；如果日历不存在或用户不是其所有者，则为 null

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getOwnedCalendarsByName(name)`

获取用户拥有的具有给定名称的所有日历。名称不区分大小写。

// Gets a private calendar named "Travel Plans".
const calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans');
Logger.log('Found %s matching calendars.', calendars.length);

参数

名称	类型	说明
`name`	`String`	日历名称

Calendar[] - 用户拥有的所有此名称的日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`getTimeZone()`

获取日历的时区。

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

// Gets the time zone of the calendar and logs it to the console.
// For the default calendar, you can use CalendarApp.getTimeZone() instead.
const timeZone = calendar.getTimeZone();
console.log(timeZone);

String - 时区，采用“长”格式指定（例如“America/New_York”，如 Joda.org 中所列）。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`isHidden()`

确定日历是否在界面中隐藏。

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

// Determines whether the calendar is hidden in the user interface and logs it
// to the console. For the default calendar, you can use CalendarApp.isHidden()
// instead.
const isHidden = calendar.isHidden();
console.log(isHidden);

Boolean - 如果日历在界面中处于隐藏状态，则为 true；如果未处于隐藏状态，则为 false。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`isMyPrimaryCalendar()`

确定日历是否为有效用户的主日历。

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

// Determines whether the calendar is the default calendar for
// the effective user and logs it to the console.
// For the default calendar, you can use CalendarApp.isMyPrimaryCalendar()
// instead.
const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar();
console.log(isMyPrimaryCalendar);

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

确定日历是否归您所有。

// Gets a calendar by its ID. To get the user's default calendar, use
// CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with the calendar ID that you want to use.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Determines whether the calendar is owned by you and logs it.
console.log(calendar.isOwnedByMe());

Boolean - 如果日历归您所有，则为 true；否则为 false。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`isSelected()`

确定日历的活动是否显示在界面中。

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

// Determines whether the calendar's events are displayed in the user interface
// and logs it.
console.log(calendar.isSelected());

Boolean - 如果日历的活动显示在界面中，则为 true；如果不显示，则为 false

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`newRecurrence()`

创建新的重复对象，该对象可用于为事件重复创建规则。

// Creates an event series for a no-meetings day, taking place every Wednesday
// in 2013.
const recurrence = CalendarApp.newRecurrence()
                       .addWeeklyRule()
                       .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
                       .until(new Date('January 1, 2014'));
const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries(
    'No Meetings',
    new Date('January 2, 2013 03:00:00 PM EST'),
    recurrence,
);
Logger.log(`Event Series ID: ${eventSeries.getId()}`);

EventRecurrence - 一个未设置规则的新重复性对象（行为方式为每周重复）

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`setColor(color)`

设置日历的颜色。

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

// Sets the color of the calendar to pink using the Calendar Color enum.
// For the default calendar, you can use CalendarApp.setColor() instead.
calendar.setColor(CalendarApp.Color.PINK);

参数

名称	类型	说明
`color`	`String`	`CalendarApp.Color` 或十六进制颜色字符串（“#rrggbb”）。

Calendar - 此日历用于链式调用。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`setDescription(description)`

设置日历的说明。

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

// Sets the description of the calendar.
// TODO(developer): Update the string with the description that you want to use.
calendar.setDescription('Updated calendar description.');

参数

名称	类型	说明
`description`	`String`	此日历的说明

Calendar - 用于链式调用的日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`setHidden(hidden)`

设置日历在界面中是否可见。

参数

名称	类型	说明
`hidden`	`Boolean`	`true` 用于在界面中隐藏日历；`false` 用于显示日历

Calendar - 用于链式调用的日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`setName(name)`

设置日历的名称。

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

// Sets the name of the calendar.
// TODO(developer): Update the string with the name that you want to use.
calendar.setName('Example calendar name');

参数

名称	类型	说明
`name`	`String`	新名称

Calendar - 用于链式调用的日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`setSelected(selected)`

设置日历的活动是否显示在界面中。

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

// Selects the calendar so that its events are displayed in the user interface.
// To unselect the calendar, set the parameter to false.
calendar.setSelected(true);

参数

名称	类型	说明
`selected`	`Boolean`	`true` 以在界面中显示日历的活动；`false` 以隐藏这些活动

Calendar - 用于链式调用的日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`setTimeZone(timeZone)`

设置日历的时区。

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

// Sets the time zone of the calendar to America/New York (US/Eastern) time.
calendar.setTimeZone('America/New_York');

参数

名称	类型	说明
`timeZone`	`String`	时区，采用“长”格式指定（例如“America/New_York”，如 Joda.org 中所列）。

Calendar - 此日历用于链式调用。

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`subscribeToCalendar(id)`

将用户订阅给定 ID 的日历（如果用户有权订阅）。

// Subscribe to the calendar "US Holidays".
const calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com',
);
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

参数

名称	类型	说明
`id`	`String`	要订阅的日历的 ID

Calendar - 新订阅的日历

抛出

Error - 如果不存在具有此 ID 的日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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

`subscribeToCalendar(id, options)`

将用户订阅给定 ID 的日历（如果用户有权订阅）。

// Subscribe to the calendar "US Holidays", and set it to the color blue.
const calendar = CalendarApp.subscribeToCalendar(
    'en.usa#holiday@group.v.calendar.google.com',
    {color: CalendarApp.Color.BLUE},
);
Logger.log('Subscribed to the calendar "%s".', calendar.getName());

参数

名称	类型	说明
`id`	`String`	要订阅的日历的 ID。
`options`	`Object`	用于指定高级参数的 JavaScript 对象，如下所列。

高级参数

名称	类型	说明
`color`	`String`	十六进制颜色字符串（“#rrggbb”）或 `CalendarApp.Colors` 中的值。
`hidden`	`Boolean`	日历是否在界面中隐藏（默认：`false`）。
`selected`	`Boolean`	日历的活动是否显示在界面中（默认：如果同时指定了 `color`，则为 `true`；否则为 `false`）。

Calendar - 新订阅的日历。

抛出

Error - 如果不存在具有此 ID 的日历

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

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