本指南介绍了日历、活动及其相互之间的关系。
日历
日历是相关事件以及其他元数据(例如摘要、默认时区、地点等)的集合。每个日历都由一个 ID 标识,该 ID 是电子邮件地址。日历可以有多个所有者。
活动
事件是与特定日期或时间范围相关联的对象。事件通过唯一 ID 进行标识。除了开始和结束日期时间之外,事件还包含摘要、说明、位置、状态、提醒、附件等其他数据。
事件类型
Google 日历支持单次活动和周期性活动:
- 单个事件表示唯一事件。
- 周期性事件会定义多次发生,
您还可以为活动设置计时或全天时间:
- 定时事件发生在两个特定时间点之间。定时事件使用
start.dateTime
和end.dateTime
字段指定它们的发生时间。 - 全天活动会持续一整天或连续的一系列天数。全天事件使用
start.date
和end.date
字段指定它们发生的时间。请注意,对于全天活动,时区字段没有意义。
组织者
活动只有一个组织者,即包含活动主副本的日历。活动也可以有多个参加者。参加者通常是受邀用户的主日历。
下图显示了日历、活动和其他相关元素之间的概念关系:
主日历和其他日历
主日历是一种与单个用户帐号关联的特殊日历类型。此日历是为每个新用户账号自动创建的,其 ID 通常与用户的主电子邮件地址匹配。只要该帐号存在,用户就永远无法删除或“取消拥有”主日历。不过,仍然可以与其他用户共享。
除主日历外,您还可以明确创建任意数量的其他日历;这些日历可进行修改、删除,并在多个用户之间共享。
日历和日历列表
日历集合代表所有现有日历。它可以用来创建和删除日历您还可以检索或设置在有权访问某个日历的所有用户之间共享的全局属性。例如,日历的标题和默认时区都是全局属性。
CalendarList 是用户添加到其列表中的所有日历条目的集合(显示在网页界面的左侧面板中)。您可以使用它在用户列表中添加和移除现有日历您还可以使用它来检索和设置特定于用户的日历属性的值,例如默认提醒。另一个示例是前景色,因为不同的用户可以为同一日历设置不同的颜色。
下表比较了这两个集合的操作的含义:
操作 | 日历 | CalendarList |
---|---|---|
insert |
创建新的辅助日历。默认情况下,此日历也会添加到创建者的日历列表中。 | 在用户的列表中插入现有日历。 |
delete |
删除辅助日历。 | 从用户的列表中移除日历。 |
get |
检索日历元数据,例如标题、时区。 | 检索元数据以及特定于用户的自定义设置,例如颜色或替换提醒。 |
patch /update |
修改日历元数据。 | 修改用户特定的日历属性。 |
周期性活动
有些活动会定期发生多次,例如每周会议、生日和节假日。除了开始时间和结束时间不同之外,这些重复的事件通常完全相同。
如果活动按照指定的时间表重复,则称为“周期性活动”。“单次”活动不是周期性活动,只发生一次。
重复规则
周期性活动的时间表分为两个部分:
它的开始和结束字段(定义第一次发生,就好像这只是一个独立的单个事件),以及
其重复规则字段(用于定义事件随时间的重复方式)。
重复规则字段包含一个字符串数组,该数组代表一个或多个 RRULE
、RDATE
或 EXDATE
属性(如 RFC 5545 中所定义)。
RRULE
属性最为重要,因为它定义了重复事件的常规规则。它由几个组件组成。其中包括:
FREQ
- 事件的重复频率(如DAILY
或WEEKLY
)。必需。INTERVAL
- 与FREQ
搭配使用,用于指定事件的重复频率。例如,FREQ=DAILY;INTERVAL=2
表示每两天一次。COUNT
- 此事件应重复的次数。UNTIL
- 活动应一直重复到哪个日期或日期时间(含此日期或日期时间)。BYDAY
- 应在一周的哪几天(SU
、MO
、TU
等)重复触发该事件。其他类似的组件包括BYMONTH
、BYYEARDAY
和BYHOUR
。
RDATE
属性用于指定事件发生的其他日期或日期时间。例如 RDATE;VALUE=DATE:19970101,19970120
。
使用此方法可添加 RRULE
未涵盖的额外事件。
EXDATE
属性与 RDATE 类似,但指定事件不应发生的日期或日期时间。也就是说,应排除这些发生实例。它必须指向由重复规则生成的有效实例。
EXDATE
和 RDATE
可以设置时区,并且必须为全天活动的日期(而不是日期时间)。
每个属性都可以在重复规则字段中多次出现。重复规则定义为所有 RRULE
和 RDATE
规则的并集减去所有 EXDATE
规则排除的规则。
下面是周期性事件的一些示例:
从 2015 年 9 月 15 日开始,在每周二和周五早上 6 点到早上 7 点期间进行,并在 9 月 29 日第五次发生后停止:
... "start": { "dateTime": "2015-09-15T06:00:00+02:00", "timeZone": "Europe/Zurich" }, "end": { "dateTime": "2015-09-15T07:00:00+02:00", "timeZone": "Europe/Zurich" }, "recurrence": [ "RRULE:FREQ=WEEKLY;COUNT=5;BYDAY=TU,FR" ], …
从 2015 年 6 月 1 日开始的全天活动,在整个月份中每 3 天重复一次,但 6 月 10 日除外,但包括 6 月 9 日和 11 日:
... "start": { "date": "2015-06-01" }, "end": { "date": "2015-06-02" }, "recurrence": [ "EXDATE;VALUE=DATE:20150610", "RDATE;VALUE=DATE:20150609,20150611", "RRULE:FREQ=DAILY;UNTIL=20150628;INTERVAL=3" ], …
实例和异常
周期性事件包含多个“实例”:相应事件在不同时间发生的情况。这些实例本身就是事件。
周期性事件修改可能影响整个周期性事件(及其所有实例),也可能仅影响单个实例。不同于父级周期性活动的实例称为例外情况。
例如,某个例外情况可以有不同的摘要、不同的开始时间,或者只邀请其他参与者加入该实例。您还可以在不移除周期性事件的情况下完全取消实例(实例取消会反映在事件 status
中)。
可在此处查看通过 Google 日历 API 处理周期性活动和实例的示例。
时区
时区用于指定采用统一标准时间的区域。在 Google Calendar API 中,您使用 IANA 时区标识符指定时区。
您可以为日历和活动设置时区。以下部分介绍了这些设置的影响。
日历时区
日历的时区也称为“默认时区”,因为它会对查询结果产生影响。日历时区会影响 events.get()
、events.list()
和 events.instances()
方法解释或呈现时间值的方式。
- 查询结果时区转换
get()
、list()
和instances()
方法的结果按您在timeZone
参数中指定的时区返回。如果省略此参数,则这些方法都将默认使用日历时区。- 将全天活动与带时间范围的查询相匹配
- 通过
list()
和instances()
方法,您可以指定开始时间和结束时间过滤条件,该方法会返回指定范围内的实例。日历时区用于计算全天事件的开始时间和结束时间,以确定这些事件是否符合过滤规范。
活动时区
事件实例有开始和结束时间;这些时间的规范可能包括时区。您可以通过多种方式指定时区;以下所有方法均指定相同的时间:
- 在
dateTime
字段中添加时区偏移量,例如2017-01-25T09:00:00-0500
。 - 指定无时差的时间,例如
2017-01-25T09:00:00
,将timeZone
字段留空(这将隐式使用默认时区)。 - 请指定无时差的时间(例如
2017-01-25T09:00:00
),并使用timeZone
字段指定时区。
如果您愿意,也可以指定采用世界协调时间 (UTC) 的活动时间:
- 请以世界协调时间 (UTC)
2017-01-25T14:00:00Z
指定时间,或使用零偏移2017-01-25T14:00:00+0000
。
活动时间的内部表示方式在所有这些情况下都是相同的,但设置 timeZone
字段会为活动附加时区,就像您使用日历界面设置活动时区时一样:
周期性活动时区
对于周期性活动,必须始终指定单个时区。 为了延长事件的重复发生,必须使用它。