此页面由 Cloud Translation API 翻译。

Calendar Service

此服务允许脚本访问和修改用户的 Google 日历，包括用户订阅的其他日历。

类

名称	简介
`Calendar`	表示用户拥有或订阅的日历。
`CalendarApp`	允许脚本读取和更新用户的 Google 日历。
`CalendarEvent`	表示单个日历活动。
`CalendarEventSeries`	表示一系列事件（周期性事件）。
`Color`	表示日历服务中提供的已命名颜色的枚举。
`EventColor`	表示日历服务中提供的已命名活动颜色的枚举。
`EventGuest`	表示活动的邀请对象。
`EventRecurrence`	表示事件系列的重复周期设置。
`GuestStatus`	表示参会者可以具有状态状态的枚举。
`RecurrenceRule`	表示事件系列的重复规则。
`Visibility`	表示事件可见性的枚举。

`Calendar`

方法

方法	返回类型	简介
`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`	创建新的全天活动系列。
`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`	创建新的活动系列。
`deleteCalendar()`	`void`	永久删除日历。
`getColor()`	`String`	获取日历的颜色。
`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`	获取日历名称。
`getTimeZone()`	`String`	获取日历的时区。
`isHidden()`	`Boolean`	确定是否在界面中隐藏日历。
`isMyPrimaryCalendar()`	`Boolean`	确定日历是否为有效用户的默认日历。
`isOwnedByMe()`	`Boolean`	确定日历是否归有效用户所有。
`isSelected()`	`Boolean`	确定日历的活动是否显示在界面中。
`setColor(color)`	`Calendar`	设置日历的颜色。
`setDescription(description)`	`Calendar`	设置日历的说明。
`setHidden(hidden)`	`Calendar`	设置是否在界面中显示日历。
`setName(name)`	`Calendar`	设置日历的名称。
`setSelected(selected)`	`Calendar`	设置日历上的活动是否显示在界面中。
`setTimeZone(timeZone)`	`Calendar`	设置日历的时区。
`unsubscribeFromCalendar()`	`void`	为用户退订日历。

`CalendarApp`

属性

属性	类型	说明
`Color`	`Color`	表示日历服务中提供的已命名颜色的枚举。
`EventColor`	`EventColor`	表示日历服务中提供的已命名活动颜色的枚举。
`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 为用户订阅日历。

`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`	设置活动的公开范围。

`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[]`	获取事件的所有电子邮件提醒的分钟值。
`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`	获取事件的标题。
`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`	设置活动的标题。
`setVisibility(visibility)`	`CalendarEventSeries`	设置活动的公开范围。

`Color`

属性

属性	类型	说明
`BLUE`	`Enum`	蓝色 (`#2952A3`)。
`BROWN`	`Enum`	棕色 (`#8D6F47`)。
`CHARCOAL`	`Enum`	木炭黑 (`#4E5D6C`)。
`CHESTNUT`	`Enum`	栗色 (`#865A5A`)。
`GRAY`	`Enum`	灰色 (`#5A6986`)。
`GREEN`	`Enum`	绿色 (`#0D7813`)。
`INDIGO`	`Enum`	Indigo (`#5229A3`)。
`LIME`	`Enum`	石灰 (`#528800`)。
`MUSTARD`	`Enum`	芥末 (`#88880E`)。
`OLIVE`	`Enum`	橄榄绿 (`#6E6E41`)。
`ORANGE`	`Enum`	橙色 (`#BE6D00`)。
`PINK`	`Enum`	粉色 (`#B1365F`)。
`PLUM`	`Enum`	紫红色 (`#705770`)。
`PURPLE`	`Enum`	紫色 (`#7A367A`)。
`RED`	`Enum`	红色 (`#A32929`)。
`RED_ORANGE`	`Enum`	红橙 (`#B1440E`)。
`SEA_BLUE`	`Enum`	海蓝色 (`#29527A`)。
`SLATE`	`Enum`	可选广告 (`#4A716C`)。
`TEAL`	`Enum`	蓝绿色 (`#28754E`)。
`TURQOISE`	`Enum`	绿松石 (`#1B887A`)。
`YELLOW`	`Enum`	黄色 (`#AB8B00`)。

`EventColor`

属性

属性	类型	说明
`PALE_BLUE`	`Enum`	浅蓝色 (`"1"`)。
`PALE_GREEN`	`Enum`	浅绿色 (`"2"`)。
`MAUVE`	`Enum`	标牌 (`"3"`)。
`PALE_RED`	`Enum`	浅红色 (`"4"`)。
`YELLOW`	`Enum`	黄色 (`"5"`)。
`ORANGE`	`Enum`	橙色 (`"6"`)。
`CYAN`	`Enum`	青色 (`"7"`)。
`GRAY`	`Enum`	灰色 (`"8"`)。
`BLUE`	`Enum`	蓝色 (`"9"`)。
`GREEN`	`Enum`	绿色 (`"10"`)。
`RED`	`Enum`	红色 (`"11"`)。

`EventGuest`

方法

方法	返回类型	简介
`getAdditionalGuests()`	`Integer`	获取该邀请对象表示将参加的新增人数。
`getEmail()`	`String`	获取邀请对象的电子邮件地址。
`getGuestStatus()`	`GuestStatus`	获取活动的邀请对象状态。
`getName()`	`String`	获取邀请对象的姓名。

`EventRecurrence`

方法

方法	返回类型	简介
`addDailyExclusion()`	`RecurrenceRule`	添加每天排除的事件规则。
`addDailyRule()`	`RecurrenceRule`	添加一条规则，规定事件每天重复一次。
`addDate(date)`	`EventRecurrence`	添加会导致事件在特定日期重复发生的规则。
`addDateExclusion(date)`	`EventRecurrence`	添加特定规则，用于排除特定日期的相应事件。
`addMonthlyExclusion()`	`RecurrenceRule`	添加每月排除发生次数的规则。
`addMonthlyRule()`	`RecurrenceRule`	添加导致事件每月重复发生的规则。
`addWeeklyExclusion()`	`RecurrenceRule`	添加每周排除一次规则。
`addWeeklyRule()`	`RecurrenceRule`	添加会导致事件每周重复发生的规则。
`addYearlyExclusion()`	`RecurrenceRule`	添加每年排除一次的规则。
`addYearlyRule()`	`RecurrenceRule`	添加导致事件每年重复发生的规则。
`setTimeZone(timeZone)`	`EventRecurrence`	设置此重复规则的时区。

`GuestStatus`

属性

属性	类型	说明
`INVITED`	`Enum`	邀请对象已受到邀请，但并未指出是否参加。
`MAYBE`	`Enum`	房客表示他们可能会参加。
`NO`	`Enum`	邀请对象表示他们不会参加。
`OWNER`	`Enum`	邀请对象是活动的所有者。
`YES`	`Enum`	邀请对象表示他们会参加。

`RecurrenceRule`

方法

方法	返回类型	简介
`addDailyExclusion()`	`RecurrenceRule`	添加每天排除的事件规则。
`addDailyRule()`	`RecurrenceRule`	添加一条规则，规定事件每天重复一次。
`addDate(date)`	`EventRecurrence`	添加会导致事件在特定日期重复发生的规则。
`addDateExclusion(date)`	`EventRecurrence`	添加特定规则，用于排除特定日期的相应事件。
`addMonthlyExclusion()`	`RecurrenceRule`	添加每月排除发生次数的规则。
`addMonthlyRule()`	`RecurrenceRule`	添加导致事件每月重复发生的规则。
`addWeeklyExclusion()`	`RecurrenceRule`	添加每周排除一次规则。
`addWeeklyRule()`	`RecurrenceRule`	添加会导致事件每周重复发生的规则。
`addYearlyExclusion()`	`RecurrenceRule`	添加每年排除一次的规则。
`addYearlyRule()`	`RecurrenceRule`	添加导致事件每年重复发生的规则。
`interval(interval)`	`RecurrenceRule`	将此规则配置为仅在此规则的时间间隔的时间间隔内应用。
`onlyInMonth(month)`	`RecurrenceRule`	将规则配置为仅应用于特定月份。
`onlyInMonths(months)`	`RecurrenceRule`	将规则配置为仅应用于特定月份。
`onlyOnMonthDay(day)`	`RecurrenceRule`	将规则配置为仅应用于一个月中的特定日期。
`onlyOnMonthDays(days)`	`RecurrenceRule`	将规则配置为仅应用于一个月中的特定几天。
`onlyOnWeek(week)`	`RecurrenceRule`	将规则配置为仅应用于一年中的特定一周。
`onlyOnWeekday(day)`	`RecurrenceRule`	将规则配置为仅应用于一周中的特定一天。
`onlyOnWeekdays(days)`	`RecurrenceRule`	将规则配置为仅应用于一周中的特定几天。
`onlyOnWeeks(weeks)`	`RecurrenceRule`	将规则配置为仅应用于一年中的特定几周。
`onlyOnYearDay(day)`	`RecurrenceRule`	将规则配置为仅应用于一年中的特定日期。
`onlyOnYearDays(days)`	`RecurrenceRule`	将规则配置为仅应用于一年中的特定日期。
`setTimeZone(timeZone)`	`EventRecurrence`	设置此重复规则的时区。
`times(times)`	`RecurrenceRule`	将规则配置为在给定次数后结束。
`until(endDate)`	`RecurrenceRule`	将规则配置为在特定日期（含）结束。
`weekStartsOn(day)`	`RecurrenceRule`	用于配置一周中的哪一天作为规则的生效日期。

`Visibility`

属性

属性	类型	说明
`CONFIDENTIAL`	`Enum`	此活动是私人的。
`DEFAULT`	`Enum`	使用日历中活动的默认公开范围。
`PRIVATE`	`Enum`	此活动属于私人活动，只有活动参加者才能查看活动详情。
`PUBLIC`	`Enum`	该活动是公开的，日历的所有读者都可以查看活动详情。