API Reference

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

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

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

ACL

Подробную информацию о ресурсе 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.

Календари

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

Метод 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 Обновляет метаданные календаря.

Каналы

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

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

Цвета

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

Метод 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, вызовите метод event.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 . Указанные вами значения полей заменяют существующие значения. Поля, которые вы не укажете в запросе, остаются без изменений. Поля массива, если они указаны, перезаписывают существующие массивы; это отбрасывает все предыдущие элементы массива.
быстроДобавить POST /calendars/ calendarId /events/quickAdd Создает событие на основе простой текстовой строки.

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

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

Бесплатная занятость

Подробную информацию о ресурсе 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 Следите за изменениями в ресурсах настроек.