Calendar Service

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。
日历

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

名称简介
Calendar表示用户拥有或订阅的日历。
CalendarApp允许脚本读取和更新用户的 Google 日历。
CalendarEvent表示单个日历活动。
CalendarEventSeries表示一系列事件(周期性事件)。
Color表示 Google 日历服务中提供的已命名颜色的枚举。
EventColor表示 Google 日历服务中提供的已命名活动颜色的枚举。
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

属性

属性类型说明
ColorColor表示 Google 日历服务中提供的已命名颜色的枚举。
EventColorEventColor表示 Google 日历服务中提供的已命名活动颜色的枚举。
GuestStatusGuestStatus表示邀请对象可以为活动添加的状态的枚举。
MonthMonth表示一年中的月份的枚举。
VisibilityVisibility表示事件的可见性的枚举。
WeekdayWeekday表示星期几的枚举。

方法

方法返回类型简介
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

属性

属性类型说明
BLUEEnum
蓝色 (#2952A3)。
BROWNEnum
棕色 (#8D6F47)。
CHARCOALEnum
木炭(#4E5D6C)。
CHESTNUTEnum
栗色 (#865A5A)。
GRAYEnum
灰色 (#5A6986)。
GREENEnum
绿色 (#0D7813)。
INDIGOEnum
靛蓝 (#5229A3)。
LIMEEnum
绿黄色 (#528800)。
MUSTARDEnum
芥末 (#88880E)。
OLIVEEnum
橄榄色 (#6E6E41)。
ORANGEEnum
橙色 (#BE6D00)。
PINKEnum
粉色 (#B1365F)。
PLUMEnum
紫红色 (#705770)。
PURPLEEnum
紫色 (#7A367A)。
REDEnum
红色 (#A32929)。
RED_ORANGEEnum
红橙色 (#B1440E)。
SEA_BLUEEnum
海蓝色 (#29527A)。
SLATEEnum
可选广告 (#4A716C)。
TEALEnum
青色 (#28754E)。
TURQOISEEnum
绿松石 (#1B887A)。
YELLOWEnum
黄色 (#AB8B00)。

EventColor

属性

属性类型说明
PALE_BLUEEnum
浅蓝色 ("1")。
PALE_GREENEnum
浅绿色 ("2")。
MAUVEEnum
Mauve ("3")。
PALE_REDEnum
浅红色 ("4")。
YELLOWEnum
黄色 ("5")。
ORANGEEnum
橙色 ("6")。
CYANEnum
青色 ("7")。
GRAYEnum
灰色 ("8")。
BLUEEnum
蓝色 ("9")。
GREENEnum
绿色 ("10")。
REDEnum
红色 ("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

属性

属性类型说明
INVITEDEnum邀请对象已受到邀请,但并未说明是否参加。
MAYBEEnum邀请对象表示可能会参加。
NOEnum邀请对象表示不参加。
OWNEREnum邀请对象是活动的所有者。
YESEnum邀请对象表示会参加。

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

属性

属性类型说明
CONFIDENTIALEnum此活动不会公开。
DEFAULTEnum使用日历中活动的默认公开范围。
PRIVATEEnum此活动属于私人活动,只有活动参加者可以查看活动详情。
PUBLICEnum该活动是公开的,所有日历读者都可以看到活动详情。