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

属性

媒体资源类型说明
ColorColor表示日历服务中可用的已命名颜色的枚举。
EventColorEventColor表示日历服务中提供的已命名活动颜色的枚举。
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
淡紫色 ("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此活动是公开的,日历的所有读者均可看到活动详细信息。