查看事件資源的異動。
要求
HTTP 要求
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch
參數
參數名稱 | 值 | 說明 |
---|---|---|
路徑參數 | ||
calendarId |
string |
日曆 ID。如要擷取日曆 ID,請呼叫 calendarList.list 方法。如果要存取目前登入使用者的主要日曆,請使用「primary 」關鍵字。
|
選用查詢參數 | ||
eventTypes |
string |
要監看的事件類型。選用設定。如要監看不同類型的資源,您可以重複使用這個參數。如未設定,系統會傳回所有事件類型。
可接受的值如下:
|
授權
這項要求允許至少取得下列其中一個範圍的授權:
內容範圍 |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
詳情請參閱「驗證和授權」網頁。
要求主體
在要求內文中,以下列結構提供資料:
{ "id": string, "token": string, "type": string, "address": string, "params": { "ttl": string } }
資源名稱 | 值 | 說明 | 附註 |
---|---|---|---|
id |
string |
UUID 或類似的不重複字串,用於識別這個頻道。 | |
token |
string |
透過此管道傳送每則通知,傳送至目標地址的任意字串。選用。 | |
type |
string |
此管道使用的放送機制類型。有效值為「web_hook 」(或「webhook 」)。這兩個值都是指使用 HTTP 要求傳送訊息的管道。 |
|
address |
string |
接收這個頻道通知的地址。 | |
params |
object |
控制放送管道行為的其他參數。選用。 | |
params.ttl |
string |
通知管道的存留時間 (以秒為單位)。預設值為 604800 秒。 |
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "api#channel", "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": long }
屬性名稱 | 值 | 說明 | 附註 |
---|---|---|---|
kind |
string |
將其視為用於監控資源變更的通知管道,即「api#channel 」。 |
|
id |
string |
UUID 或類似的不重複字串,用於識別這個頻道。 | |
resourceId |
string |
不透明 ID,用於識別這個頻道的觀看資源。在不同 API 版本之間穩定。 | |
resourceUri |
string |
已觀看資源的版本專屬 ID。 | |
token |
string |
透過此管道傳送每則通知,傳送至目標地址的任意字串。選用。 | |
expiration |
long |
通知管道到期的日期和時間,以 Unix 時間戳記 (以毫秒為單位) 表示。選用。 |