API Reference

此 API 参考资料按资源类型编排整理。每种资源类型都有一种或多种数据表示形式以及一个或多个方法。

资源类型

1. Acl
2. CalendarList
3. 日历
4. 渠道
5. 颜色
6. 事件
7. Freebusy
8. 设置

Acl

如需详细了解 Acl 资源，请参阅资源表示形式页面。

方法	HTTP 请求	说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/calendar/v3 的相对地址
delete	DELETE  /calendars/calendarId/acl/ruleId	删除访问控制规则。
get	GET  /calendars/calendarId/acl/ruleId	返回访问控制规则。
insert	POST  /calendars/calendarId/acl	创建访问控制规则。
list	GET  /calendars/calendarId/acl	返回日历访问控制列表中的规则。
patch	PATCH  /calendars/calendarId/acl/ruleId	更新访问控制规则。此方法支持修补语义。请注意，每个补丁请求都会消耗三个配额单元；建议使用 get 后跟 update。您指定的字段值会替换现有值。您在请求中未指定的字段将保持不变。数组字段（如果指定）会覆盖现有数组；这会舍弃之前的所有数组元素。
update	PUT  /calendars/calendarId/acl/ruleId	更新访问控制规则。
watch	POST  /calendars/calendarId/acl/watch	监控 ACL 资源的更改。

CalendarList

如需详细了解 CalendarList 资源，请参阅资源表示形式页面。

方法	HTTP 请求	说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/calendar/v3 的相对地址
delete	DELETE  /users/me/calendarList/calendarId	从用户的日历列表中移除日历。
get	GET  /users/me/calendarList/calendarId	返回用户日历列表中的日历。
insert	POST  /users/me/calendarList	将现有日历插入用户的日历列表中。
list	GET  /users/me/calendarList	返回用户日历列表中的日历。
patch	PATCH  /users/me/calendarList/calendarId	更新用户日历列表中的现有日历。此方法支持修补语义。请注意，每个补丁请求都会消耗三个配额单元；建议使用 get 后跟 update。您指定的字段值会替换现有值。您在请求中未指定的字段将保持不变。数组字段（如果指定）会覆盖现有数组；这会舍弃之前的所有数组元素。
update	PUT  /users/me/calendarList/calendarId	更新用户日历列表中的现有日历。
watch	POST  /users/me/calendarList/watch	监控 CalendarList 资源的更改。

日历

如需详细了解日历资源，请参阅资源表示形式页面。

方法	HTTP 请求	说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/calendar/v3 的相对地址
clear	POST  /calendars/calendarId/clear	清除主日历。此操作会删除与账号的主日历相关联的所有活动。
delete	DELETE  /calendars/calendarId	删除辅助日历。使用 calendars.clear 可清除主日历中的所有活动。
get	GET  /calendars/calendarId	返回日历的元数据。
insert	POST  /calendars	创建辅助日历。
patch	PATCH  /calendars/calendarId	更新日历的元数据。此方法支持修补语义。请注意，每个补丁请求都会消耗三个配额单元；建议使用 get 后跟 update。您指定的字段值会替换现有值。您在请求中未指定的字段将保持不变。数组字段（如果指定）会覆盖现有数组；这会舍弃之前的所有数组元素。
update	PUT  /calendars/calendarId	更新日历的元数据。

渠道

如需详细了解渠道资源，请参阅资源表示形式页面。

方法	HTTP 请求	说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/calendar/v3 的相对地址
stop	POST  /channels/stop	停止通过此渠道观看资源。

颜色

如需详细了解 Colors 资源，请参阅资源表示形式页面。

方法	HTTP 请求	说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/calendar/v3 的相对地址
get	GET  /colors	返回日历和活动的颜色定义。

事件

如需详细了解 Events 资源，请参阅资源表示形式页面。

方法	HTTP 请求	说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/calendar/v3 的相对地址
delete	DELETE  /calendars/calendarId/events/eventId	删除活动。
get	GET  /calendars/calendarId/events/eventId	根据 Google 日历 ID 返回活动。如需使用 iCalendar ID 检索活动，请使用 iCalUID 参数调用 events.list 方法。
import	POST  /calendars/calendarId/events/import	导入事件。此操作用于将现有活动的私人副本添加到日历中。只能导入 eventType 为 default 的事件。 已废弃的行为：如果导入的事件不是 default 事件，其类型将更改为 default，并且系统会丢弃该事件可能具有的任何事件类型专用属性。
insert	POST  /calendars/calendarId/events	创建事件。
实例	GET  /calendars/calendarId/events/eventId/instances	返回指定周期性活动的实例。
list	GET  /calendars/calendarId/events	返回指定日历中的活动。
move	POST  /calendars/calendarId/events/eventId/move	将活动移至其他日历，即更改活动的组织者。请注意，只有 default 事件可以移动；birthday、focusTime、fromGmail、outOfOffice 和 workingLocation 事件无法移动。 必需的查询参数：destination
patch	PATCH  /calendars/calendarId/events/eventId	更新事件。此方法支持修补语义。请注意，每个补丁请求都会消耗三个配额单元；建议使用 get 后跟 update。您指定的字段值会替换现有值。您在请求中未指定的字段将保持不变。数组字段（如果指定）会覆盖现有数组；这会舍弃之前的所有数组元素。
quickAdd	POST  /calendars/calendarId/events/quickAdd	根据简单的文本字符串创建事件。 必需的查询参数：text
update	PUT  /calendars/calendarId/events/eventId	更新事件。此方法不支持补丁语义，并且始终会更新整个活动资源。如需进行部分更新，请使用 etag 执行 get 后跟 update，以确保原子性。
watch	POST  /calendars/calendarId/events/watch	监控 Events 资源的更改。

Freebusy

如需详细了解 Freebusy 资源，请参阅资源表示形式页面。

方法	HTTP 请求	说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/calendar/v3 的相对地址
query	POST  /freeBusy	返回一组日历的有空/忙碌信息。

设置

如需详细了解 Settings 资源，请参阅资源表示形式页面。

方法	HTTP 请求	说明
除非另有说明，否则 URI 均为 https://www.googleapis.com/calendar/v3 的相对地址
get	GET  /users/me/settings/setting	返回单个用户设置。
list	GET  /users/me/settings	返回经过身份验证的用户的所有用户设置。
watch	POST  /users/me/settings/watch	监控“设置”资源的更改。