CalDAV API 開發人員指南's 指南

CalDAV 是 WebDAV 的擴充功能，方便用戶端存取 遠端伺服器上的日曆資訊。

Google 提供 CalDAV 介面，可讓您檢視和管理日曆 透過 CalDAV 通訊協定

規格

針對每項相關規格，Google 的 CalDAV 支援如下：

• rfc4918：適用於網路分散式編寫和版本管理的 HTTP 擴充功能 (WebDAV)
  • 支援 HTTP 方法 GET、PUT、HEAD、DELETE、POST、 OPTIONS、PROPFIND和PROPPATCH。
  • 不支援 HTTP 方法 LOCK、UNLOCK、COPY、MOVE 或 MKCOL 或 If* 標頭 (If-Match 除外)。
  • 不支援任意 (使用者定義) WebDAV 屬性。
  • 不支援 WebDAV 存取控制 (rfc3744)。
• rfc4791：日曆擴充功能到 WebDAV (CalDAV)
  • 支援 HTTP 方法 REPORT。所有報表 ( Free-healthy-query 除外) 。
  • 不支援 HTTP 方法 MKCALENDAR。
  • 不支援 AUDIO 動作。
• rfc5545：i 行事曆
  • CalDAV 介面中顯示的資料是根據 icalendar 規格。
  • 目前不支援VTODO或VJOURNAL資料。
  • 不支援 Apple iCal® 擴充功能，因此無法讓使用者設定的網址屬性。
• rfc6578：WebDAV 的集合同步處理
  • 用戶端應用程式必須在 執行初始同步處理作業
• rfc6638：排定擴充至 CalDAV 的時間
  • 支援簡易「收件匣」永遠是空的
  • 您收到的邀請會自動傳送到「活動」 而不要放進「收件匣」
  • 不支援有空/忙碌查詢功能。
• caldav-ctag-02：CalDAV 中的日曆集合實體標記 (CTag)
  • 「ctag」日曆就像 etag 資源；只要發生任何變化 已變更。這樣一來，用戶端應用程式 會快速判斷不需要同步處理任何變更過的內容 事件。
• calendar-proxy：CalDAV 中的日曆使用者 Proxy 功能
  • 提升 iOS 裝置上的日曆同步效能， 不支援委派，您可以使用 calendar-proxy-read-for 或 包含 iOS UserAgent 的 calendar-proxy-write-for 資源將會失敗。

我們尚未全面導入所有相關 規格。不過，許多用戶端 (例如 Apple 的行事曆應用程式) CalDAV 通訊協定應能正確互通

注意：為了維護帳戶安全並防止濫用情形，Google 可能會在透過 CalDAV 存取資料的用戶端應用程式中設定 Cookie。

建立用戶端 ID

如要使用 CalDAV API Google 帳戶。 如果您已經有可用的帳戶，就大功告成了！

您必須先註冊，才能將要求傳送至 CalDAV API 建立專案，以透過 Google API 控制台部署您的用戶端。

前往 Google API 控制台。按一下「建立專案」。 輸入名稱，然後按一下「建立」。

下一步是啟用 CalDAV API。

如果想為專案啟用 API，請按照以下步驟操作：

1. 在 Google API 控制台中開啟 API 程式庫。畫面出現提示時，請選取 或建立新專案API 程式庫會列出所有可用的 API，按照產品系列和熱門程度分組。
2. 如果清單裡找不到您想啟用的 API，請使用搜尋功能。
3. 選取要啟用的 API，然後按一下「啟用」 按鈕。
4. 如果系統顯示提示，請啟用帳單功能。
5. 如果系統顯示提示，請接受 API 的《服務條款》。

如要執行 CalDAV API 要求，您需要 「Client ID」和「Client Secret」。

如要找出專案的用戶端 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 驗證配置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. 的商標。