Settings: watch

Отслеживайте изменения в ресурсах настроек.

Запрос

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 Время жизни канала уведомлений в секундах. Значение по умолчанию – 604 800 секунд.

Ответ

В случае успеха метод возвращает тело ответа со следующей структурой:

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
Название свойства Значение Описание Примечания
kind string Определяет, что это канал уведомлений, используемый для отслеживания изменений в ресурсе, то есть api#channel.
id string UUID или аналогичная уникальная строка, идентифицирующая этот канал.
resourceId string Непрозрачный идентификатор, который указывает на ресурс, отслеживаемый в этом канале. Стабильно работает в разных версиях API.
resourceUri string Идентификатор отслеживаемого ресурса, относящийся к определенной версии.
token string Произвольная строка, которая доставляется на целевой адрес с каждым уведомлением, отправленным по этому каналу. Необязательное поле.
expiration long Дата и время окончания срока действия канала уведомлений, выраженные в виде временной метки Unix в миллисекундах. Необязательное поле.