Calendar Service
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
日历
此服务允许脚本访问和修改用户的 Google 日历,包括用户订阅的其他日历。
类
方法
| 方法 | 返回类型 | 简介 |
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 | 让用户退订日历。 |
方法
| 方法 | 返回类型 | 简介 |
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 的日历。 |
属性
| 属性 | 类型 | 说明 |
BLUE | Enum |
蓝色 (#2952A3)。 |
BROWN | Enum |
棕色 (#8D6F47)。 |
CHARCOAL | Enum |
木炭黑 (#4E5D6C)。 |
CHESTNUT | Enum |
栗色 (#865A5A)。 |
GRAY | Enum |
灰色 (#5A6986)。 |
GREEN | Enum |
绿色 (#0D7813)。 |
INDIGO | Enum |
Indigo (#5229A3)。 |
LIME | Enum |
Lime(#528800)。 |
MUSTARD | Enum |
芥末 (#88880E)。 |
OLIVE | Enum |
Olive (#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)。 |
属性
| 属性 | 类型 | 说明 |
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"),在日历界面中称为“番茄”。 |
属性
| 属性 | 类型 | 说明 |
OPAQUE | Enum | 活动会占用日历中的时间。 |
TRANSPARENT | Enum | 活动不会占用日历上的时间。 |
属性
| 属性 | 类型 | 说明 |
DEFAULT | Enum | 活动是常规活动。 |
BIRTHDAY | Enum | 相应活动是特殊的周期性全天活动。 |
FOCUS_TIME | Enum | 相应活动是专注时间活动。 |
FROM_GMAIL | Enum | 相应活动是来自 Gmail 的活动。 |
OUT_OF_OFFICE | Enum | 相应活动是“不在办公室”活动。 |
WORKING_LOCATION | Enum | 相应活动是工作地点活动。 |
属性
| 属性 | 类型 | 说明 |
INVITED | Enum | 邀请对象已收到邀请,但尚未表明是否会出席。 |
MAYBE | Enum | 邀请对象已表明他们可能会参加。 |
NO | Enum | 相应邀请对象已表明不会出席。 |
OWNER | Enum | 邀请对象是活动的所有者。 |
YES | Enum | 邀请对象已表明他们会参加。 |
属性
| 属性 | 类型 | 说明 |
CONFIDENTIAL | Enum | 活动是不公开的。 |
DEFAULT | Enum | 使用日历中活动的默认公开范围。 |
PRIVATE | Enum | 活动是不公开的,只有活动参加者可以查看活动详情。 |
PUBLIC | Enum | 活动为公开活动,日历的所有读者都可以查看活动详细信息。 |
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2026-03-06。
[null,null,["最后更新时间 (UTC):2026-03-06。"],[],[]]