API Reference

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

资源类型

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

ACL

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

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

CalendarList

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

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

日历

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

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

频道

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

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

颜色

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

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

活动

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

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/calendar/v3 的 URI
delete DELETE  /calendars/calendarId/events/eventId 删除事件。
get GET  /calendars/calendarId/events/eventId 根据 Google 日历 ID 返回活动。若要使用 iCalendar ID 检索活动，请使用 iCalUID 参数调用 events.list 方法。
导入 POST  /calendars/calendarId/events/import 导入事件。此操作会用于将现有活动的非公开副本添加到日历中。
插入 POST  /calendars/calendarId/events 创建事件。
实例 GET  /calendars/calendarId/events/eventId/instances 返回指定周期性活动的实例。
list GET  /calendars/calendarId/events 返回指定日历中的活动。
移动 POST  /calendars/calendarId/events/eventId/move 将活动移至其他日历，即更改活动的组织者。

必需查询参数：destination
补丁程序 PATCH  /calendars/calendarId/events/eventId 更新活动。此方法支持补丁语义。请注意，每个修补请求消耗三个配额单元；首选使用 get，后跟 update。您指定的字段值会替换现有值。未在请求中指定的字段保持不变。如果指定数组字段，则覆盖现有数组；这会舍弃之前的所有数组元素。
快捷添加 POST  /calendars/calendarId/events/quickAdd 根据简单的文本字符串创建事件。

必需查询参数：text
update PUT  /calendars/calendarId/events/eventId 更新活动。此方法不支持补丁语义，并且始终更新整个事件资源。如需执行部分更新，请使用 etag 执行 get，后跟 update，以确保原子性。
手表 POST  /calendars/calendarId/events/watch 注意事件资源的变化。

有空/忙碌

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

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/calendar/v3 的 URI
查询 POST  /freeBusy 返回一组日历的有空/忙碌信息。

设置

如需详细了解“设置”资源，请参阅资源表示形式页面。

方法 HTTP 请求 说明
除非另有说明，否则将使用相对于 https://www.googleapis.com/calendar/v3 的 URI
get GET  /users/me/settings/setting 返回单个用户设置。
list GET  /users/me/settings 返回经过身份验证的用户的所有用户设置。
手表 POST  /users/me/settings/watch 注意“设置”资源的变化。