Данная справочная информация по API организована по типам ресурсов. Каждый тип ресурса имеет одно или несколько представлений данных и одно или несколько методов.
Типы ресурсов
Акл
Подробную информацию о ресурсах 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 | Прекратите смотреть материалы на этом канале. |
Цвета
Подробную информацию о цветовых ресурсах см. на странице представления ресурсов .
| Метод | 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 Календаре. Чтобы получить событие по его идентификатору в iКалендаре, вызовите метод events.list, используя параметр iCalUID . |
| импорт | POST /calendars/ calendarId /events/import | Импортирует событие. Эта операция используется для добавления частной копии существующего события в календарь. Импортировать можно только события с типом eventType 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
Подробную информацию о ресурсе 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 | Следите за изменениями в ресурсах настроек. |