Calendar Service

日历

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

名称简介
Calendar表示用户拥有或订阅的日历。
CalendarApp允许脚本读取和更新用户的 Google 日历。
CalendarEvent表示单个日历活动。
CalendarEventSeries表示一系列活动(周期性活动)。
Color一个枚举,表示日历服务中可用的命名颜色。
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一个枚举,表示日历服务中可用的命名颜色。
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|null获取具有指定 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|null获取具有指定 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
Indigo (#5229A3)。
LIMEEnum
Lime(#528800)。
MUSTARDEnum
芥末 (#88880E)。
OLIVEEnum
Olive (#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为此重复周期设置时区。

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活动为公开活动,日历的所有读者都可以查看活动详细信息。