API Reference

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

資源類型

  1. Acl
  2. CalendarList
  3. 日曆
  4. 管道
  5. 顏色
  6. 活動
  7. Freebusy
  8. 設定

Acl

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

方法 HTTP 要求 說明
除非另有註明，否則 URI 皆與 https://www.googleapis.com/calendar/v3 相關
delete DELETE  /calendars/calendarId/acl/ruleId 刪除存取權控管規則。
get GET  /calendars/calendarId/acl/ruleId 傳回存取權控管規則。
insert POST  /calendars/calendarId/acl 建立存取權控管規則。
list GET  /calendars/calendarId/acl 傳回日曆存取控制清單中的規則。
修補程式 PATCH  /calendars/calendarId/acl/ruleId 更新存取權控管規則。這個方法支援 patch 語意。請注意，每個修補程式要求會耗用三個配額單位，建議使用 get，然後再使用 update。您指定的欄位值會取代現有值。要求中未指定的欄位會維持不變。如果指定陣列欄位，系統會覆寫現有陣列，並捨棄先前的所有陣列元素。
更新 PUT  /calendars/calendarId/acl/ruleId 更新存取權控管規則。
watch POST  /calendars/calendarId/acl/watch 監控 ACL 資源的變更。

CalendarList

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

方法 HTTP 要求 說明
除非另有註明，否則 URI 皆與 https://www.googleapis.com/calendar/v3 相關
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 更新使用者日曆清單中的現有日曆。這個方法支援 patch 語意。請注意，每個修補程式要求會耗用三個配額單位，建議使用 get，然後再使用 update。您指定的欄位值會取代現有值。要求中未指定的欄位會維持不變。如果指定陣列欄位，系統會覆寫現有陣列，並捨棄先前的所有陣列元素。
更新 PUT  /users/me/calendarList/calendarId 更新使用者日曆清單中的現有日曆。
watch POST  /users/me/calendarList/watch 監控 CalendarList 資源的變更。

日曆

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

方法 HTTP 要求 說明
除非另有註明，否則 URI 皆與 https://www.googleapis.com/calendar/v3 相關
清楚 POST  /calendars/calendarId/clear 清除主要日曆。這項作業會刪除與帳戶主要日曆相關聯的所有活動。
delete DELETE  /calendars/calendarId 刪除次要日曆。使用 calendars.clear 清除主要日曆中的所有活動。
get GET  /calendars/calendarId 傳回日曆的中繼資料。
insert POST  /calendars 建立次要日曆。

系統會將要求中經過驗證的使用者設為新日曆的資料擁有者。
修補程式 PATCH  /calendars/calendarId 更新日曆的中繼資料。這個方法支援 patch 語意。請注意，每個修補程式要求會耗用三個配額單位，建議使用 get，然後再使用 update。您指定的欄位值會取代現有值。要求中未指定的欄位會維持不變。如果指定陣列欄位，系統會覆寫現有陣列，並捨棄先前的所有陣列元素。
更新 PUT  /calendars/calendarId 更新日曆的中繼資料。

頻道

如需 Channels 資源的詳細資料，請參閱資源表示法頁面。

方法 HTTP 要求 說明
除非另有註明，否則 URI 皆與 https://www.googleapis.com/calendar/v3 相關
停止 POST  /channels/stop 停止透過這個管道觀看資源。

顏色

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

方法 HTTP 要求 說明
除非另有註明，否則 URI 皆與 https://www.googleapis.com/calendar/v3 相關
get GET  /colors 傳回日曆和活動的顏色定義。

活動

如需 Events 資源的詳細資料，請參閱資源表示法頁面。

方法 HTTP 要求 說明
除非另有註明，否則 URI 皆與 https://www.googleapis.com/calendar/v3 相關
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 匯入活動。這項作業用於將現有活動的私人副本新增至日曆。您只能匯入 eventType 為 default 的事件。

已淘汰的行為：如果匯入非 default 事件，系統會將其類型變更為 default，並捨棄可能有的任何事件類型專屬屬性。
insert POST  /calendars/calendarId/events 建立活動。
instances GET  /calendars/calendarId/events/eventId/instances 傳回指定週期性活動的執行個體。
list GET  /calendars/calendarId/events 傳回指定日曆中的活動。
移動 POST  /calendars/calendarId/events/eventId/move 將活動移至其他日曆，也就是變更活動主辦人。請注意，只有 default 事件可以移動，birthday、focusTime、fromGmail、outOfOffice 和 workingLocation 事件則無法移動。

必要查詢參數： destination

修補程式 PATCH  /calendars/calendarId/events/eventId 更新活動。這個方法支援 patch 語意。請注意，每個修補程式要求會耗用三個配額單位，建議使用 get，然後再使用 update。您指定的欄位值會取代現有值。要求中未指定的欄位會維持不變。如果指定陣列欄位，系統會覆寫現有陣列，並捨棄先前的所有陣列元素。
quickAdd POST  /calendars/calendarId/events/quickAdd 根據簡單的文字字串建立事件。

必要查詢參數： text

更新 PUT  /calendars/calendarId/events/eventId 更新活動。這個方法不支援 patch 語意，一律會更新整個活動資源。如要進行部分更新，請執行 get，然後執行 update，並使用 etag 確保原子性。
watch POST  /calendars/calendarId/events/watch 留意 Events 資源的變更。

Freebusy

如需 Freebusy 資源的詳細資料，請參閱資源表示法頁面。

方法 HTTP 要求 說明
除非另有註明，否則 URI 皆與 https://www.googleapis.com/calendar/v3 相關
query POST  /freeBusy 傳回一組日曆的有空/忙碌資訊。

設定

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

方法 HTTP 要求 說明
除非另有註明，否則 URI 皆與 https://www.googleapis.com/calendar/v3 相關
get GET  /users/me/settings/setting 傳回單一使用者設定。
list GET  /users/me/settings 傳回已驗證使用者的所有使用者設定。
watch POST  /users/me/settings/watch 注意「設定」資源的變更。