留意 CalendarList 資源的異動。
要求
HTTP 要求
POST https://www.googleapis.com/calendar/v3/users/me/calendarList/watch
參數
參數名稱 | 值 | 說明 |
---|
授權
這項要求需要授權,且至少要有下列其中一個範圍:
範圍 |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
詳情請參閱「驗證與授權」網頁。
要求主體
在要求主體中,提供具有以下結構的資料:
{ "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 時間戳記表示,以毫秒為單位。選填。 |