日历和活动

本指南介绍了日历、活动以及它们之间的关系。

日历

日历是一系列相关活动以及摘要、默认时区、地点等其他元数据的集合。每个日历都由一个电子邮件地址 ID 标识。日历可以有多个所有者。

事件

事件是与特定日期或时间范围相关联的对象。事件通过唯一 ID 进行标识。除了开始日期和结束日期时间之外,活动还包含摘要、说明、地点、状态、提醒、附件等其他数据。

事件类型

Google 日历支持单次周期性活动:

  • 单个事件表示一次唯一的发生。
  • 周期性事件定义了多次出现。

活动还可以是定时全天活动:

  • 定时事件会在两个特定时间点之间发生。定时事件使用 start.dateTimeend.dateTime 字段来指定其发生时间。
  • 全天活动持续一整天或连续几天。全天活动使用 start.dateend.date 字段来指定其发生时间。请注意,时区字段对全天活动没有意义。

组织者

活动只有一个组织者,即包含活动主副本的日历。活动还可以有多个参加者。参加者通常是受邀用户的主日历。

下图显示了日历、活动和其他相关元素之间的概念关系:

主要日历和其他日历

主要日历是一种与单个用户账号关联的特殊日历。系统会为每个新用户账号自动创建此日历,其 ID 通常与用户的主电子邮件地址一致。只要该账号存在,用户就无法删除其主要日历或将其“取消所有权”。不过,您仍然可以与其他用户共享该内容。

除了主日历之外,您还可以明确创建任意数量的其他日历;这些日历可以修改、删除,也可以在多位用户之间共享。

日历和日历列表

Calendars 集合代表所有现有日历。它可用于创建和删除日历。您还可以检索或设置供有权访问日历的所有用户共享的全局属性。例如,日历的标题和默认时区是全局属性。

CalendarList 是用户添加到列表中的所有日历条目的集合(显示在网页界面的左侧面板中)。您可以使用此权限向/从用户列表中添加和移除现有日历。您还可以使用它检索和设置特定于用户的日历属性(例如默认提醒)的值。另一个示例是前景色,因为不同的用户可以为同一日历设置不同的颜色。

下表比较了这两个集合中操作的含义:

操作 日历 CalendarList
insert 创建新的辅助日历。默认情况下,此日历也会添加到创作者的日历列表中。 将现有日历插入用户的列表中。
delete 删除辅助日历。 从用户列表中移除日历。
get 检索日历元数据,例如标题、时区。 检索元数据以及特定于用户的自定义设置,例如颜色或替换提醒。
patch/update 修改日历元数据。 修改特定于用户的日历属性。

周期性活动

有些活动会定期重复多次,例如每周会议、生日和节假日。除了开始时间和结束时间不同之外,这些重复事件通常完全相同。

如果事件会按照指定的时间表重复,则称为周期性事件。单次事件是非周期性事件,只会发生一次。

重复规则

周期性活动的时间表分为两部分:

  • 其 start 和 end 字段(用于定义首次出现,就像这只是一个独立的单个事件一样),以及

  • 重复字段(用于定义事件应如何随时间重复)。

recurrence 字段包含一个字符串数组,表示一个或多个 RRULERDATEEXDATE 属性(如 RFC 5545 中所定义)。

RRULE 属性最重要,因为它定义了重复事件的常规规则。它由多个组件组成。其中包括:

  • FREQ - 事件应重复的频率(例如 DAILYWEEKLY)。必需。

  • INTERVAL - 与 FREQ 搭配使用,用于指定事件的重复频率。例如,FREQ=DAILY;INTERVAL=2 表示每两天一次。

  • COUNT - 此事件应重复的次数。

  • UNTIL - 事件应重复的日期或日期时间(包括此日期/时间)。

  • BYDAY - 事件应重复的星期几(SUMOTU 等)。其他类似组件包括 BYMONTHBYYEARDAYBYHOUR

RDATE 属性用于指定应发生事件的其他日期或日期时间。例如 RDATE;VALUE=DATE:19970101,19970120。 您可以使用此方法添加 RRULE 未涵盖的额外出现情况。

EXDATE 属性与 RDATE 类似,但用于指定事件不应发生的日期或日期时间。也就是说,应排除这些出现情况。此值必须指向由重复规则生成的有效实例。

EXDATERDATE 可以设置时区,对于全天活动,必须是日期(而非日期时间)。

每个属性都可以在重复字段中出现多次。重复性定义为所有 RRULERDATE 规则的并集,减去所有 EXDATE 规则排除的规则。

以下是一些周期性事件示例:

  1. 一个事件,发生时间为 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"
    ],
    …
    
  2. 一个全天活动,开始时间为 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 Calendar API 处理周期性活动和实例的示例,请点击此处

时区

时区用于指定采用统一标准时间的区域。 在 Google 日历 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 字段会将时区附加到活动,就像您使用日历界面设置活动时区一样:

显示活动时区的屏幕截图 fragment

周期性活动的时区

对于周期性活动,始终必须指定一个时区。您需要提供此信息才能展开事件的重复设置。