CalDAV API 开发者指南

CalDAV 是 WebDAV 的扩展,为客户端访问远程服务器上的日历信息提供了一种标准。

Google 提供了一个 CalDAV 界面,您可以通过该界面使用 CalDAV 协议查看和管理日历。

规格

对于各项相关规范,Google 的 CalDAV 支持如下:

我们尚未提供所有相关规范的完整实现。但是,对于许多客户端(例如 Apple 的日历应用)来说,CalDAV 协议应该可以正确互操作。

注意:为确保帐号安全并防止滥用行为,Google 可能会在通过 CalDAV 访问数据的客户端应用上设置 Cookie。

创建客户端 ID

如需使用 CalDAV API,您需要拥有一个 Google 帐号。如果您已经拥有可以使用的帐号,则一切就绪。

您必须先创建项目,在 Google API 控制台中注册客户端,然后才能向 CalDAV API 发送请求。

前往 Google API 控制台。点击创建项目,输入名称,然后点击创建

下一步是激活 CalDAV API

如需为您的项目启用 API,请执行以下操作:

  1. 在 Google API 控制台中打开 API 库。如果出现提示,请选择一个项目或创建一个新项目。API 库中列出了所有可用的 API(按产品系列和热门程度分组)。
  2. 如果列表中没有显示您要启用的 API,请使用搜索功能查找该 API。
  3. 选择您要启用的 API,然后点击启用按钮。
  4. 如果系统提示,请启用结算功能。
  5. 如果系统提示,请接受该 API 的服务条款。
如需执行 CalDAV API 请求,您需要客户端 ID客户端密钥

如需查找项目的客户端 ID 和客户端密钥,请执行以下操作:

  1. 选择现有的 OAuth 2.0 凭据或打开“凭据”页面
  2. 如果您尚未创建项目的 OAuth 2.0 凭据,请依次点击创建凭据 > OAuth 客户端 ID,并提供创建凭据所需的信息。
  3. OAuth 2.0 客户端 ID 部分查找客户端 ID。如需了解详情,请点击客户端 ID。

连接到 Google 的 CalDAV 服务器

为了使用 CalDAV 接口,客户端程序首先会在两个起点之一与日历服务器连接。无论是哪种情况,都必须通过 HTTPS 建立连接,并且必须使用 OAuth 2.0 身份验证方案。除非请求通过 HTTPS 到达 Google 帐号的 OAuth 2.0 身份验证,否则 CalDAV 服务器将拒绝对请求进行身份验证。尝试通过 HTTP 或使用基本身份验证进行连接时,会导致 HTTP 401 Unauthorized 状态代码。

如果客户端程序(例如 Apple 的日历应用)需要主账号集合作为起点,则要连接的 URI 为:

https://apidata.googleusercontent.com/caldav/v2/calid/user

其中,calid 应替换为要访问的日历的“日历 ID”。您可以通过 Google 日历网页界面找到此信息,如下所示:在日历名称旁边的下拉菜单中选择日历设置。在结果页面上,日历 ID 显示在标记为日历地址的部分。用户主日历的日历 ID 与用户的电子邮件地址相同。

如果客户端程序(例如 Mozilla Sunbird)需要日历集合作为起点,则要连接的 URI 为:

https://apidata.googleusercontent.com/caldav/v2/calid/events

旧端点 https://www.google.com/calendar/dav 已弃用,不再受支持;请自行承担风险。我们建议您改用上述新端点格式。

iCal® 是 Apple Inc. 的商标。