Calendar Service

日历

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

名称简介
Calendar表示用户拥有或订阅的日历。
CalendarApp允许脚本读取和更新用户的 Google 日历。
CalendarEvent表示单个日历活动。
CalendarEventSeries表示一系列事件(周期性活动)。
Color一个枚举,表示 Google 日历服务中提供的命名颜色。
EventColor表示日历服务中提供的命名活动颜色的枚举。
EventGuest表示活动的嘉宾。
EventRecurrence表示系列活动的重复设置。
EventTransparency表示事件透明度的枚举。
EventType表示事件类型的枚举。
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表示日历服务中提供的命名活动颜色的枚举。
EventTransparencyEventTransparencyEventTransparency 枚举。
EventTypeEventTypeEventType 枚举。
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获取此活动所属的一系列周期性活动。
getEventType()EventType获取此事件的 EventType
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获取活动的标题。
getTransparency()EventTransparency获取事件的透明度。
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设置活动的标题。
setTransparency(transparency)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[]获取活动的所有电子邮件提醒的分钟值。
getEventType()EventType获取此事件的 EventType
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获取活动的标题。
getTransparency()EventTransparency获取事件的透明度。
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设置活动的标题。
setTransparency(transparency)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
紫 plum (#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"),在 Google 日历界面中称为“香蕉”。
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设置此重复设置的时区。

EventTransparency

属性

属性类型说明
OPAQUEEnum活动会在日历上占用相应时间。
TRANSPARENTEnum活动不会占用日历上的时间。

EventType

属性

属性类型说明
DEFAULTEnum活动是常规活动。
BIRTHDAYEnum该活动是一项特殊的全天活动,每年重复一次。
FOCUS_TIMEEnum活动是专注时间活动。
FROM_GMAILEnum活动是来自 Gmail 的活动。
OUT_OF_OFFICEEnum活动是“不在办公室”活动。
WORKING_LOCATIONEnum该活动是工作地点活动。

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该活动是公开的,日历的所有读者都可以看到活动详情。