API Reference

本 API 參考資料是依照資源類型編排。各個資源類型都具有一或多種資料表示法,以及一或多種方法。

資源類型

  1. Acl
  2. 日曆清單
  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 傳回存取權控管規則。
insert POST  /calendars/calendarId/acl 建立存取權控管規則。
list GET  /calendars/calendarId/acl 傳回日曆的存取控制清單 (ACL) 中的規則。
修補 PATCH  /calendars/calendarId/acl/ruleId 更新存取權控管規則。這個方法支援修補語意。請注意,每個修補程式要求都會耗用三個配額單位;建議使用 get,後面加上 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 傳回使用者日曆清單中的日曆。
insert POST  /users/me/calendarList 將現有日曆插入使用者的日曆清單。
list GET  /users/me/calendarList 傳回使用者日曆清單中的日曆。
修補 PATCH  /users/me/calendarList/calendarId 更新使用者日曆清單中現有的日曆。這個方法支援修補語意。請注意,每個修補程式要求都會耗用三個配額單位;建議使用 get,後面加上 update。您指定的欄位值會取代現有的值。您在要求中指定的欄位維持不變。陣列欄位 (如有指定) 會覆寫現有的陣列;這項操作會捨棄任何先前的陣列元素。
更新 PUT  /users/me/calendarList/calendarId 更新使用者日曆清單中現有的日曆。
智慧手錶 POST  /users/me/calendarList/watch 查看 CalendarList 資源的變更。

日曆

如要進一步瞭解 Calendars 資源,請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另外註明)
clear POST  /calendars/calendarId/clear 清除主要日曆。這項作業會刪除與帳戶主要日曆相關聯的所有活動。
delete DELETE  /calendars/calendarId 刪除次要日曆。使用 Calendar.clear 清除主日曆上的所有活動。
get GET  /calendars/calendarId 傳回日曆的中繼資料。
insert POST  /calendars 建立次要日曆。
修補 PATCH  /calendars/calendarId 更新日曆的中繼資料。這個方法支援修補語意。請注意,每個修補程式要求都會耗用三個配額單位;建議使用 get,後面加上 update。您指定的欄位值會取代現有的值。您在要求中指定的欄位維持不變。陣列欄位 (如有指定) 會覆寫現有的陣列;這項操作會捨棄任何先前的陣列元素。
更新 PUT  /calendars/calendarId 更新日曆的中繼資料。

管道

如要進一步瞭解管道資源,請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另外註明)
stop POST  /channels/stop 停止瀏覽這個頻道的資源。

顏色

如需顏色資源詳細資料,請參閱資源表示法網頁。

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另外註明)
get GET  /colors 傳回日曆和活動的顏色定義。

事件

如要進一步瞭解 Event 資源,請參閱資源表示法網頁。

方法 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 方法
import POST  /calendars/calendarId/events/import 匯入事件。這項作業是用來將現有活動的私人副本新增至日曆。只能匯入 eventTypedefault 的事件。

淘汰行為:如果匯入非 default 事件,其類型會變更為 default,且可能捨棄該事件的任何事件類型專屬屬性。

insert POST  /calendars/calendarId/events 建立事件。
執行個體 GET  /calendars/calendarId/events/eventId/instances 傳回指定週期性事件的執行個體。
list GET  /calendars/calendarId/events 傳回指定日曆上的活動。
move POST  /calendars/calendarId/events/eventId/move 將活動移到其他日曆,例如變更活動發起人。請注意,只能移動 default 事件;無法移動 outOfOfficefocusTimeworkingLocationfromGmail 事件。

必要查詢參數: destination

修補 PATCH  /calendars/calendarId/events/eventId 更新活動。這個方法支援修補語意。請注意,每個修補程式要求都會耗用三個配額單位;建議使用 get,後面加上 update。您指定的欄位值會取代現有的值。您在要求中指定的欄位維持不變。陣列欄位 (如有指定) 會覆寫現有的陣列;這項操作會捨棄任何先前的陣列元素。
quickAdd POST  /calendars/calendarId/events/quickAdd 根據簡易文字字串建立事件。

必要查詢參數: text

更新 PUT  /calendars/calendarId/events/eventId 更新活動。這個方法不支援修補語意,且一律會更新整個事件資源。如要進行部分更新,請先執行 get,然後使用 etag 執行 update,以確保不可分割性。
智慧手錶 POST  /calendars/calendarId/events/watch 查看事件資源的異動。

有空/忙碌

如需 FreeRunning 資源的詳細資料,請參閱資源表示法網頁。

方法 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 監控設定資源的變更。