本 API 參考資料是依照資源類型編排。各個資源類型都具有一或多種資料表示法,以及一或多種方法。
資源類型
Acl
如需 Acl 資源的詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另行註明) | ||
刪除 |
DELETE /calendars/calendarId/acl/ruleId
|
刪除存取權控管規則。 |
get |
GET /calendars/calendarId/acl/ruleId
|
傳回存取權控管規則。 |
insert |
POST /calendars/calendarId/acl
|
建立存取權控管規則。 |
清單 |
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 /users/me/calendarList/calendarId
|
從使用者的日曆清單中移除日曆。 |
get |
GET /users/me/calendarList/calendarId
|
傳回使用者日曆清單上的日曆。 |
insert |
POST /users/me/calendarList
|
將現有日曆插入使用者的日曆清單。 |
清單 |
GET /users/me/calendarList
|
傳回使用者日曆清單上的日曆。 |
修補程式 |
PATCH /users/me/calendarList/calendarId
|
更新使用者日曆清單上的現有日曆。這個方法支援修補語意。請注意,每個修補要求都會耗用三個配額單位,建議使用 get 搭配 update 。您指定的欄位值會取代現有的值。您未在要求中指定的欄位會保持不變。指定陣列欄位 (如有指定) 會覆寫現有的陣列;這會捨棄所有先前的陣列元素。
|
更新 |
PUT /users/me/calendarList/calendarId
|
更新使用者日曆清單上的現有日曆。 |
手錶 |
POST /users/me/calendarList/watch
|
留意 CalendarList 資源的異動。 |
日曆
如需日曆資源詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另行註明) | ||
Clear |
POST /calendars/calendarId/clear
|
清除主要日曆。這項作業會刪除與某個帳戶主要日曆相關的所有活動。 |
刪除 |
DELETE /calendars/calendarId
|
刪除次要日曆。使用 calendar.clear 即可清除主日曆中的所有活動。 |
get |
GET /calendars/calendarId
|
傳回日曆的中繼資料。 |
insert |
POST /calendars
|
建立次要日曆。 |
修補程式 |
PATCH /calendars/calendarId
|
更新日曆的中繼資料。這個方法支援修補語意。請注意,每個修補要求都會耗用三個配額單位,建議使用 get 搭配 update 。您指定的欄位值會取代現有的值。您未在要求中指定的欄位會保持不變。指定陣列欄位 (如有指定) 會覆寫現有的陣列;這會捨棄所有先前的陣列元素。
|
更新 |
PUT /calendars/calendarId
|
更新日曆的中繼資料。 |
管道
如要進一步瞭解 Channel 資源,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另行註明) | ||
停止 |
POST /channels/stop
|
停止透過這個頻道查看資源。 |
顏色
如需色彩資源詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另行註明) | ||
get |
GET /colors
|
傳回日曆和活動的顏色定義。 |
事件
如要進一步瞭解事件資源,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另行註明) | ||
刪除 |
DELETE /calendars/calendarId/events/eventId
|
刪除事件。 |
get |
GET /calendars/calendarId/events/eventId
|
根據 Google 日曆 ID 傳回活動。如要使用 iCalendar ID 擷取事件,請使用 iCalUID 參數呼叫 events.list 方法。
|
import |
POST /calendars/calendarId/events/import
|
匯入事件。這項作業用於將現有活動的私人副本新增至日曆。 |
insert |
POST /calendars/calendarId/events
|
建立事件。 |
執行個體 |
GET /calendars/calendarId/events/eventId/instances
|
傳回指定週期性活動的例項。 |
清單 |
GET /calendars/calendarId/events
|
傳回指定日曆上的活動。 |
移動 |
POST /calendars/calendarId/events/eventId/move
|
將活動移至其他日曆 (亦即變更活動的發起人)。請注意,您只能移動 default 事件;無法移動 outOfOffice 、focusTime 和 workingLocation 事件。
必要的查詢參數:
|
修補程式 |
PATCH /calendars/calendarId/events/eventId
|
更新活動。這個方法支援修補語意。請注意,每個修補要求都會耗用三個配額單位,建議使用 get 搭配 update 。您指定的欄位值會取代現有的值。您未在要求中指定的欄位會保持不變。指定陣列欄位 (如有指定) 會覆寫現有的陣列;這會捨棄所有先前的陣列元素。
|
quickAdd |
POST /calendars/calendarId/events/quickAdd
|
根據簡單的文字字串建立事件。
必要的查詢參數:
|
更新 |
PUT /calendars/calendarId/events/eventId
|
更新活動。這個方法不支援 patch 語意,而且一律會更新整個事件資源。如要執行部分更新,請使用 get 和 update 執行部分更新,確保元件不可部分完成。
|
手錶 |
POST /calendars/calendarId/events/watch
|
請留意事件資源的異動。 |
有空/忙碌
如需 Free 忙碌資源的詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另行註明) | ||
query |
POST /freeBusy
|
傳回一組日曆的有空/忙碌資訊。 |
設定
如需設定資源詳細資料,請參閱資源表示法網頁。
方法 | HTTP 要求 | 說明 |
---|---|---|
相對於 https://www.googleapis.com/calendar/v3 的 URI (除非另行註明) | ||
get |
GET /users/me/settings/setting
|
傳回單一使用者設定。 |
清單 |
GET /users/me/settings
|
傳回已驗證使用者的所有使用者設定。 |
手錶 |
POST /users/me/settings/watch
|
留意設定資源的異動情形。 |