Settings: watch

監控 Settings 資源的異動。

要求

HTTP 要求

POST https://www.googleapis.com/calendar/v3/users/me/settings/watch

參數

參數名稱 值 說明

授權

這項要求必須至少具備下列其中一個範圍的授權：

範圍
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.settings.readonly
https://www.googleapis.com/auth/calendar.settings

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

要求主體

在要求主體中，提供結構如下的資料：

{
  "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 時間戳記表示，單位為毫秒。選用項目。