Events: insert

Примечание: Требуется авторизация .

Создаёт событие. Попробуйте прямо сейчас .

Запрос

HTTP-запрос

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

Параметры

Имя параметра	Ценить	Описание
Параметры пути
calendarId	string	Идентификатор календаря. Для получения идентификаторов календарей вызовите метод calendarList.list . Если вы хотите получить доступ к основному календарю текущего пользователя, используйте ключевое слово " primary ".
Дополнительные параметры запроса
conferenceDataVersion	integer	Номер версии данных конференции, поддерживаемых API-клиентом. Версия 0 предполагает отсутствие поддержки данных конференции и игнорирует данные конференции в теле события. Версия 1 включает поддержку копирования ConferenceData, а также создания новых конференций с помощью поля createRequest объекта conferenceData. Значение по умолчанию — 0. Допустимые значения — от 0 до 1 включительно.
maxAttendees	integer	Максимальное количество участников, которое следует включить в ответ. Если участников больше указанного числа, возвращается только сам участник. Необязательный параметр.
sendNotifications	boolean	Устарело. Пожалуйста, используйте sendUpdates вместо этого. Отправлять ли уведомления о создании нового события. Обратите внимание, что некоторые электронные письма могут быть отправлены, даже если вы установите значение false . Значение по умолчанию — false .
sendUpdates	string	Отправлять ли уведомления о создании нового события. Обратите внимание, что некоторые электронные письма всё же могут быть отправлены. По умолчанию — false . Допустимые значения: " all ": Уведомления отправляются всем гостям. " externalOnly ": Уведомления отправляются только гостям, не зарегистрированным в Google Календаре. " none ": Уведомления не отправляются. Предупреждение: Использование значения none может привести к значительным негативным последствиям, включая невозможность синхронизации событий с внешними календарями или полную потерю событий для некоторых пользователей. Для задач миграции календарей рекомендуется использовать метод events.import .
supportsAttachments	boolean	Указывает, поддерживает ли API-клиент, выполняющий операцию, прикрепление событий. Необязательный параметр. По умолчанию — False.

Авторизация

Для выполнения этого запроса требуется авторизация как минимум в одной из следующих областей действия:

Объем
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

Для получения более подробной информации см. страницу аутентификации и авторизации .

Текст запроса

В теле запроса укажите ресурс Events со следующими свойствами:

Название объекта недвижимости	Ценить	Описание	Примечания
Обязательные свойства
end	nested object	Время окончания события (исключая указанное время). Для повторяющегося события это время окончания первого его экземпляра.
start	nested object	Время начала события (включительно). Для повторяющегося события это время начала первого события.
Дополнительные свойства
anyoneCanAddSelf	boolean	Возможность самостоятельного приглашения на мероприятие (устаревшая функция). Необязательный параметр. По умолчанию — False.	записываемый
attachments[]. fileUrl	string	Ссылка на вложение. Для добавления файловых вложений из Google Drive используйте тот же формат, что и в свойстве alternateLink ресурса Files в API Google Drive. Обязательно при добавлении вложения.	записываемый
attendees[]	list	Участники мероприятия. Дополнительную информацию о планировании мероприятий с другими пользователями календаря см. в руководстве «Мероприятия с участниками» . Для заполнения списка участников служебным учетным записям необходимо использовать делегирование полномочий в масштабе всего домена .	записываемый
attendees[]. additionalGuests	integer	Количество дополнительных гостей. Необязательно. По умолчанию — 0.	записываемый
attendees[]. comment	string	Комментарий участника. Необязательно.	записываемый
attendees[]. displayName	string	Имя участника (если имеется). (Необязательно).	записываемый
attendees[]. email	string	Адрес электронной почты участника, если он имеется. Это поле должно присутствовать при добавлении участника. Адрес электронной почты должен соответствовать требованиям RFC5322 . Обязательно при добавлении участника.	записываемый
attendees[]. optional	boolean	Является ли это необязательным участником. Необязательно. Значение по умолчанию — False.	записываемый
attendees[]. resource	boolean	Указывает, является ли участник ресурсом. Этот параметр можно установить только при первом добавлении участника к мероприятию. Последующие изменения игнорируются. Необязательный параметр. Значение по умолчанию — False.	записываемый
attendees[]. responseStatus	string	Статус ответа участника. Возможные значения: " needsAction " - Участник не ответил на приглашение (рекомендуется для новых мероприятий). « declined » — Участник отклонил приглашение. « tentative » — Участник предварительно принял приглашение. " accepted " - Участник принял приглашение. Внимание: если вы добавляете мероприятие, используя значения declined , tentative » или accepted , у участников, для которых параметр «Добавлять приглашения в мой календарь» установлен на «Когда я отвечаю на приглашение по электронной почте» или «Только если отправитель известен», статус ответа может быть сброшен до needsAction , и они не увидят мероприятие в своем календаре, если не изменят свой ответ в электронном письме с приглашением на мероприятие. Кроме того, если на мероприятие приглашено более 200 гостей, статус ответа не передается гостям.	записываемый
birthdayProperties	nested object	Данные о дне рождения или особом событии. Используется, если eventType имеет значение "birthday" . Неизменяемый параметр.	записываемый
birthdayProperties. type	string	Тип дня рождения или особого события. Возможные значения: "anniversary" — годовщина, отличная от дня рождения. Всегда имеет contact . "birthday" — событие, связанное с днем ​​рождения. Это значение по умолчанию. "custom" — Особая дата, метка которой дополнительно указывается в поле customTypeName . Всегда имеет contact . "other" - Особая дата, не подпадающая под другие категории и не имеющая пользовательской метки. Всегда имеет contact . "self" - Дата рождения владельца календаря. Не может быть contact . API календаря поддерживает создание событий только с типом "birthday" . Тип нельзя изменить после создания события.	записываемый
colorId	string	Цвет события. Это идентификатор, указывающий на запись в разделе event определения цветов (см. конечную точку colors ). Необязательно.	записываемый
conferenceData	nested object	Информация, относящаяся к конференции, например, подробности конференции Google Meet. Для создания новых сведений о конференции используйте поле createRequest . Чтобы сохранить изменения, не забудьте установить параметр запроса conferenceDataVersion равным 1 для всех запросов на изменение событий. Предупреждение: Повторное использование данных конференции Google Meet в разных мероприятиях может привести к проблемам с доступом и раскрытию информации о встрече непреднамеренным пользователям. Для обеспечения конфиденциальности встречи всегда создавайте уникальную конференцию для каждого мероприятия, используя поле createRequest .	записываемый
description	string	Описание мероприятия. Может содержать HTML-код. Необязательно.	записываемый
end. date	date	Дата в формате "гггг-мм-дд", если мероприятие длится весь день.	записываемый
end. dateTime	datetime	Время в виде объединенного значения даты и времени (отформатированного в соответствии с RFC3339 ). Смещение часового пояса обязательно, если часовой пояс явно не указан в timeZone .	записываемый
end. timeZone	string	Часовой пояс, в котором указано время. (Форматируется как имя базы данных часовых поясов IANA, например, "Europe/Zurich".) Для повторяющихся событий это поле обязательно и указывает часовой пояс, в котором разворачивается повторяющееся событие. Для разовых событий это поле необязательно и указывает пользовательский часовой пояс для начала/окончания события.	записываемый
eventType	string	Конкретный тип события. Изменить его после создания события невозможно. Возможные значения: « birthday » — особое мероприятие, которое проводится в течение всего дня и повторяется ежегодно. " default " - Обычное событие, не требующее дальнейшего уточнения. " focusTime " — событие, указывающее на момент фокусировки. " fromGmail " — событие от Gmail. Создать событие такого типа невозможно. " outOfOffice " — событие, сообщающее об отсутствии на рабочем месте. " workingLocation " - Событие, указывающее место работы.	записываемый
extendedProperties. private	object	Свойства, являющиеся частными для копии события, отображаемой в этом календаре.	записываемый
extendedProperties. shared	object	Свойства, которые используются совместно в разных календарях участников мероприятия.	записываемый
focusTimeProperties	nested object	Данные события Focus Time. Используется, если eventType имеет focusTime .	записываемый
gadget. display	string	Режим отображения гаджета. Устарело. Возможные значения: « icon » — этот гаджет отображается рядом с названием события в календаре. " chip " — гаджет отображается при нажатии на событие.	записываемый
gadget. height	integer	Высота гаджета в пикселях. Высота должна быть целым числом больше 0. Необязательный параметр. Устарело.	записываемый
gadget. iconLink	string	URL-адрес значка гаджета. Схема URL-адреса должна быть HTTPS. Устарело.	записываемый
gadget. link	string	URL-адрес гаджета. Схема URL-адреса должна быть HTTPS. Устарело.	записываемый
gadget. preferences	object	Настройки.	записываемый
gadget. title	string	Название гаджета. Устарело.	записываемый
gadget. type	string	Тип гаджета. Устарело.	записываемый
gadget. width	integer	Ширина гаджета в пикселях. Ширина должна быть целым числом больше 0. Необязательный параметр. Устарело.	записываемый
guestsCanInviteOthers	boolean	Позволяет ли другим участникам, помимо организатора, приглашать других на мероприятие. Необязательный параметр. По умолчанию — True.	записываемый
guestsCanModify	boolean	Позволяет ли другим участникам, помимо организатора, изменять мероприятие. Необязательный параметр. По умолчанию — False.	записываемый
guestsCanSeeOtherGuests	boolean	Позволяет ли другим участникам, помимо организатора, видеть, кто является участниками мероприятия. Необязательный параметр. По умолчанию — True.	записываемый
id	string	Непрозрачный идентификатор события. При создании новых разовых или повторяющихся событий можно указать их идентификаторы. Указанные идентификаторы должны соответствовать следующим правилам: В идентификаторе допускаются символы, используемые в кодировке base32hex, а именно строчные буквы av и цифры 0-9 (см. раздел 3.1.2 в RFC2938). Длина идентификатора должна составлять от 5 до 1024 символов. Идентификатор должен быть уникальным для каждого календаря. Ввиду глобальной распределенности системы мы не можем гарантировать обнаружение коллизий идентификаторов во время создания события. Для минимизации риска коллизий мы рекомендуем использовать проверенный алгоритм UUID, например, описанный в RFC4122 . Если вы не укажете идентификатор, он будет сгенерирован сервером автоматически. Обратите внимание, что icalUID и id не идентичны, и при создании события следует указывать только один из них. Одно из различий в их семантике заключается в том, что в повторяющихся событиях все экземпляры одного события имеют разные id , в то время как все они используют один и тот же icalUID .	записываемый
location	string	Географическое местоположение мероприятия в виде произвольного текста. Необязательно.	записываемый
originalStartTime. date	date	Дата в формате "гггг-мм-дд", если мероприятие длится весь день.	записываемый
originalStartTime. dateTime	datetime	Время в виде объединенного значения даты и времени (отформатированного в соответствии с RFC3339 ). Смещение часового пояса обязательно, если часовой пояс явно не указан в timeZone .	записываемый
originalStartTime. timeZone	string	Часовой пояс, в котором указано время. (Форматируется как имя базы данных часовых поясов IANA, например, "Europe/Zurich".) Для повторяющихся событий это поле обязательно и указывает часовой пояс, в котором разворачивается повторяющееся событие. Для разовых событий это поле необязательно и указывает пользовательский часовой пояс для начала/окончания события.	записываемый
outOfOfficeProperties	nested object	Данные о событии "Вне офиса". Используется, если eventType имеет значение outOfOffice .	записываемый
recurrence[]	list	Список строк RRULE, EXRULE, RDATE и EXDATE для повторяющегося события, как указано в RFC5545 . Обратите внимание, что строки DTSTART и DTEND не допускаются в этом поле; время начала и окончания события указывается в полях start и end . Это поле опускается для единичных событий или случаев повторяющихся событий.	записываемый
reminders. overrides[]	list	Если для события не используются напоминания по умолчанию, здесь отображаются напоминания, специфичные для данного события, или, если параметр не задан, указывается, что для данного события напоминания не заданы. Максимальное количество переопределяемых напоминаний — 5.	записываемый
reminders.overrides[]. method	string	Метод, используемый в этом напоминании. Возможные значения: " email " - Напоминания отправляются по электронной почте. " popup " — напоминания отправляются через всплывающее окно в пользовательском интерфейсе. Обязательно при добавлении напоминания.	записываемый
reminders.overrides[]. minutes	integer	Количество минут до начала события, за которое должно сработать напоминание. Допустимые значения находятся в диапазоне от 0 до 40320 (4 недели в минутах). Обязательно при добавлении напоминания.	записываемый
reminders. useDefault	boolean	Применяются ли к событию стандартные напоминания календаря.	записываемый
sequence	integer	Порядковый номер согласно iCalendar.	записываемый
source. title	string	Заголовок источника; например, заголовок веб-страницы или тема электронного письма.	записываемый
source. url	string	URL источника, указывающий на ресурс. Схема URL должна быть HTTP или HTTPS.	записываемый
start. date	date	Дата в формате "гггг-мм-дд", если мероприятие длится весь день.	записываемый
start. dateTime	datetime	Время в виде объединенного значения даты и времени (отформатированного в соответствии с RFC3339 ). Смещение часового пояса обязательно, если часовой пояс явно не указан в timeZone .	записываемый
start. timeZone	string	Часовой пояс, в котором указано время. (Форматируется как имя базы данных часовых поясов IANA, например, "Europe/Zurich".) Для повторяющихся событий это поле обязательно и указывает часовой пояс, в котором разворачивается повторяющееся событие. Для разовых событий это поле необязательно и указывает пользовательский часовой пояс для начала/окончания события.	записываемый
status	string	Статус события. Необязательный параметр. Возможные значения: « confirmed » — Событие подтверждено. Это статус по умолчанию. « tentative » — Событие предварительно подтверждено. " cancelled " — событие отменено (удалено). Метод list возвращает отмененные события только при инкрементальной синхронизации (если указаны syncToken или updatedMin ) или если флаг showDeleted установлен в true . Метод get всегда возвращает их. Статус «отменено» обозначает два разных состояния в зависимости от типа события: Отменённые исключения неотменённого повторяющегося события указывают на то, что этот экземпляр больше не должен отображаться пользователю. Клиенты должны хранить эти события в течение всего времени существования родительского повторяющегося события. При отмене исключений гарантируется заполнение только полей id , recurringEventId и originalStartTime . Остальные поля могут быть пустыми. Все остальные отмененные события представляют собой удаленные события. Клиентам следует удалить свои локально синхронизированные копии. Такие отмененные события со временем исчезнут, поэтому не следует рассчитывать на их доступность в течение неограниченного времени. Для удалённых событий гарантируется заполнение только поля id . В календаре организатора отмененные события продолжают отображать подробную информацию о них (краткое описание, место проведения и т. д.), что позволяет их восстановить (восстановить в удаленном виде). ​​Аналогично, события, на которые пользователь был приглашен и которые он удалил вручную, также продолжают предоставлять подробную информацию. Однако запросы на инкрементальную синхронизацию с параметром showDeleted , установленным в значение false, не будут возвращать эти данные. Если организатор мероприятия меняется (например, путем перемещения ), а первоначальный организатор отсутствует в списке участников, то мероприятие будет отменено, и гарантированно будет заполнено только поле id .	записываемый
summary	string	Название мероприятия.	записываемый
transparency	string	Определяет, блокирует ли событие время в календаре. Необязательный параметр. Возможные значения: " opaque " — значение по умолчанию. Событие блокирует время в календаре. Это эквивалентно установке параметра "Показывать как занято" в пользовательском интерфейсе календаря. « transparent » — событие не блокирует время в календаре. Это эквивалентно установке параметра «Показать как» в значение «Доступно» в пользовательском интерфейсе календаря.	записываемый
visibility	string	Видимость события. Необязательный параметр. Возможные значения: " default " — Использует видимость событий в календаре по умолчанию. Это значение по умолчанию. " public " — мероприятие является публичным, и подробная информация о мероприятии видна всем, кто просматривает календарь. " private " — мероприятие является приватным, и только участники мероприятия могут просматривать его подробности. " confidential " — Мероприятие является частным. Это значение указано для обеспечения совместимости.	записываемый
workingLocationProperties	nested object	Данные о событиях, связанных с рабочим местом.	записываемый
workingLocationProperties. customLocation	object	Если указано, означает, что пользователь работает из пользовательского местоположения.	записываемый
workingLocationProperties.customLocation. label	string	Дополнительная этикетка (по желанию) для предоставления дополнительной информации.	записываемый
workingLocationProperties. homeOffice	any value	Если указано, означает, что пользователь работает из дома.	записываемый
workingLocationProperties. officeLocation	object	Если указано, означает, что пользователь работает из офиса.	записываемый
workingLocationProperties.officeLocation. buildingId	string	Необязательный идентификатор здания. Он должен ссылаться на идентификатор здания в базе данных ресурсов организации.	записываемый
workingLocationProperties.officeLocation. deskId	string	Необязательный идентификатор рабочего стола.	записываемый
workingLocationProperties.officeLocation. floorId	string	Необязательный идентификатор этажа.	записываемый
workingLocationProperties.officeLocation. floorSectionId	string	An optional floor section identifier.	записываемый
workingLocationProperties.officeLocation. label	string	Название офиса, отображаемое в веб-версии и мобильном приложении «Календарь». Рекомендуем указывать название здания в базе данных ресурсов организации.	записываемый
workingLocationProperties. type	string	Тип рабочего места. Возможные значения: " homeOffice " - Пользователь работает из дома. " officeLocation " - Пользователь работает из офиса. " customLocation " - Пользователь работает из нестандартного местоположения. Все подробности указываются в подполе с указанным именем, но это поле может отсутствовать, если оно пустое. Все остальные поля игнорируются. Обязательно при добавлении свойств рабочего места.	записываемый

Ответ

В случае успеха этот метод возвращает ресурс Events в теле ответа.

Попробуйте!

Воспользуйтесь приведенным ниже инструментом API Explorer, чтобы вызвать этот метод на реальных данных и увидеть ответ.