本頁面由 Cloud Translation API 翻譯而成。

Events: watch

留意事件資源是否有異動。

要求

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch

參數名稱	值	說明
路徑參數
`calendarId`	`string`	日曆 ID。如要擷取日曆 ID，請呼叫 calendarList.list 方法。如果您想存取目前登入使用者的主日曆，請使用「`primary`」關鍵字。
選用查詢參數
`eventTypes`	`string`	要監控的資源事件類型。選用設定。這個參數可重複多次，用於監控不同類型的資源。如未設定，則會傳回所有事件類型。可接受的值如下：「`birthday`」：每年重複發生的特殊全天活動。「`default`」：定期活動。「`focusTime`」：專注時間活動。「`fromGmail`」：Gmail 中的活動。「`outOfOffice`」：不在辦公室的活動。「`workingLocation`」：工作地點事件。

這項要求允許使用下列其中一個範圍進行授權：

範圍
`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`
`https://www.googleapis.com/auth/calendar.app.created`
`https://www.googleapis.com/auth/calendar.events.freebusy`
`https://www.googleapis.com/auth/calendar.events.owned`
`https://www.googleapis.com/auth/calendar.events.owned.readonly`
`https://www.googleapis.com/auth/calendar.events.public.readonly`

詳情請參閱「驗證與授權」頁面。

在要求主體中，請按照下列結構提供資料：

{
  "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 時間戳記 (以毫秒為單位) 表示。選填。