Events: watch

Следите за изменениями в ресурсах событий.

Запрос

HTTP-запрос

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

Параметры

Имя параметра Ценить Описание
Параметры пути
calendarId string Идентификатор календаря. Чтобы получить идентификаторы календаря, вызовите метод 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

Дополнительную информацию см. на странице аутентификации и авторизации .

Тело запроса

В теле запроса укажите данные следующей структуры:

{
  "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 Непрозрачный идентификатор, идентифицирующий ресурс, просматриваемый на этом канале. Стабильно в разных версиях API.
resourceUri string Идентификатор версии отслеживаемого ресурса.
token string Произвольная строка, доставляемая на целевой адрес с каждым уведомлением, доставляемым по этому каналу. Необязательный.
expiration long Дата и время истечения срока действия канала уведомлений, выраженные в виде метки времени Unix, в миллисекундах. Необязательный.