API Reference

Этот справочник API организован по типам ресурсов. Каждый тип ресурса включает одно или несколько представлений данных и один или несколько методов.

Типы ресурсов

  1. Акл
  2. КалендарьСписок
  3. Календари
  4. Каналы
  5. Цвета
  6. События
  7. Freebusy
  8. Настройки

Акл

Подробную информацию о ресурсах Acl см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/calendar/v3, если не указано иное
удалить DELETE /calendars/ calendarId /acl/ ruleId Удаляет правило контроля доступа.
получать GET /calendars/ calendarId /acl/ ruleId Возвращает правило контроля доступа.
вставлять POST /calendars/ calendarId /acl Создает правило контроля доступа.
список GET /calendars/ calendarId /acl Возвращает правила в списке управления доступом для календаря.
пластырь PATCH /calendars/ calendarId /acl/ ruleId Обновляет правило управления доступом. Этот метод поддерживает семантику патчей. Обратите внимание, что каждый запрос на патч расходует три единицы квоты; предпочтительнее использовать get а затем update . Указанные значения полей заменяют существующие значения. Поля, не указанные в запросе, остаются без изменений. Поля массивов, если они указаны, перезаписывают существующие массивы; при этом все предыдущие элементы массива отменяются.
обновлять PUT /calendars/ calendarId /acl/ ruleId Обновляет правило контроля доступа.
смотреть POST /calendars/ calendarId /acl/watch Следите за изменениями в ресурсах ACL.

КалендарьСписок

Подробную информацию о ресурсе CalendarList см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/calendar/v3, если не указано иное
удалить DELETE /users/me/calendarList/ calendarId Удаляет календарь из списка календарей пользователя.
получать GET /users/me/calendarList/ calendarId Возвращает календарь из списка календарей пользователя.
вставлять POST /users/me/calendarList Вставляет существующий календарь в список календарей пользователя.
список GET /users/me/calendarList Возвращает календари из списка календарей пользователя.
пластырь PATCH /users/me/calendarList/ calendarId Обновляет существующий календарь в списке календарей пользователя. Этот метод поддерживает семантику патчей. Обратите внимание, что каждый запрос на патч расходует три единицы квоты; предпочтительнее использовать get с последующим update . Указанные значения полей заменяют существующие значения. Поля, не указанные в запросе, остаются без изменений. Поля массивов, если они указаны, перезаписывают существующие массивы; при этом все предыдущие элементы массива отменяются.
обновлять PUT /users/me/calendarList/ calendarId Обновляет существующий календарь в списке календарей пользователя.
смотреть POST /users/me/calendarList/watch Следите за изменениями в ресурсах CalendarList.

Календари

Подробную информацию о ресурсах календарей см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/calendar/v3, если не указано иное
прозрачный POST /calendars/ calendarId /clear Очищает основной календарь. Эта операция удаляет все события, связанные с основным календарём учётной записи.
удалить DELETE /calendars/ calendarId Удаляет дополнительный календарь. Используйте calendars.clear для удаления всех событий в основных календарях.
получать GET /calendars/ calendarId Возвращает метаданные для календаря.
вставлять POST /calendars Создает дополнительный календарь.

Пользователь, прошедший аутентификацию для запроса, становится владельцем данных нового календаря.

пластырь PATCH /calendars/ calendarId Обновляет метаданные календаря. Этот метод поддерживает семантику патчей. Обратите внимание, что каждый запрос на патч расходует три единицы квоты; предпочтительнее использовать get а затем update . Указанные значения полей заменяют существующие значения. Поля, не указанные в запросе, остаются без изменений. Поля массивов, если они указаны, перезаписывают существующие массивы; при этом все предыдущие элементы массива отменяются.
обновлять PUT /calendars/ calendarId Обновляет метаданные календаря.

Каналы

Подробную информацию о ресурсах каналов см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/calendar/v3, если не указано иное
останавливаться POST /channels/stop Прекратите просматривать ресурсы через этот канал.

Цвета

Подробную информацию о ресурсах Colors см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/calendar/v3, если не указано иное
получать GET /colors Возвращает определения цветов для календарей и событий.

События

Подробную информацию о ресурсах событий см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/calendar/v3, если не указано иное
удалить DELETE /calendars/ calendarId /events/ eventId Удаляет событие.
получать GET /calendars/ calendarId /events/ eventId Возвращает событие на основе его идентификатора в Google Календаре. Чтобы получить событие по его идентификатору в iCalendar, вызовите метод events.list с параметром iCalUID .
импорт POST /calendars/ calendarId /events/import Импортирует событие. Эта операция используется для добавления личной копии существующего события в календарь. Импортировать можно только события с типом eventType по default .

Устаревшее поведение: если импортируется событие, не являющееся default , его тип будет изменен на default , а все свойства, специфичные для типа события, которые оно может иметь, будут удалены.

вставлять POST /calendars/ calendarId /events Создает событие.
экземпляры GET /calendars/ calendarId /events/ eventId /instances Возвращает экземпляры указанного повторяющегося события.
список GET /calendars/ calendarId /events Возвращает события в указанном календаре.
двигаться POST /calendars/ calendarId /events/ eventId /move Переносит событие в другой календарь, то есть меняет организатора события. Обратите внимание, что перемещать можно только события default ; события birthday , focusTime , fromGmail , outOfOffice и workingLocation перемещать нельзя.

Обязательные параметры запроса: destination

пластырь PATCH /calendars/ calendarId /events/ eventId Обновляет событие. Этот метод поддерживает семантику патчей. Обратите внимание, что каждый запрос на патч расходует три единицы квоты; предпочтительнее использовать get а затем update . Указанные значения полей заменяют существующие значения. Поля, не указанные в запросе, остаются без изменений. Поля массивов, если они указаны, перезаписывают существующие массивы; при этом все предыдущие элементы массива отменяются.
quickAdd POST /calendars/ calendarId /events/quickAdd Создает событие на основе простой текстовой строки.

Обязательные параметры запроса: text

обновлять PUT /calendars/ calendarId /events/ eventId Обновляет событие. Этот метод не поддерживает семантику патчей и всегда обновляет весь ресурс события. Для частичного обновления выполните get а затем update используя etags, для обеспечения атомарности.
смотреть POST /calendars/ calendarId /events/watch Следите за изменениями в ресурсах Events.

Freebusy

Подробную информацию о ресурсе Freebusy см. на странице представления ресурса .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/calendar/v3, если не указано иное
запрос POST /freeBusy Возвращает информацию о занятости для набора календарей.

Настройки

Подробную информацию о ресурсах настроек см. на странице представления ресурсов .

Метод HTTP-запрос Описание
URI относительно https://www.googleapis.com/calendar/v3, если не указано иное
получать GET /users/me/settings/ setting Возвращает настройку одного пользователя.
список GET /users/me/settings Возвращает все пользовательские настройки для аутентифицированного пользователя.
смотреть POST /users/me/settings/watch Следите за изменениями в ресурсах настроек.