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 »: уведомления не отправляются.
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 URL-ссылка на вложение.

Для добавления вложений файлов Google Диска используйте тот же формат, что и в свойстве alternateLink ресурса Files в API Диска.

Требуется при добавлении вложения.

записываемый
attendees[] list Участники мероприятия. Дополнительную информацию о планировании мероприятий с другими пользователями календаря см. в руководстве « События с участниками» . Учетные записи служб должны использовать делегирование полномочий на уровне домена для заполнения списка участников. записываемый
attendees[]. additionalGuests integer Количество дополнительных гостей. Необязательно. По умолчанию 0. записываемый
attendees[]. comment string Комментарий ответа участника. Необязательно. записываемый
attendees[]. displayName string Имя участника, если доступно. Необязательно. записываемый
attendees[]. email string Адрес электронной почты участника, если доступен. Это поле должно присутствовать при добавлении участника. Это должен быть действительный адрес электронной почты согласно RFC5322 .

Обязательно при добавлении участника.

записываемый
attendees[]. optional boolean Является ли это необязательным участником. Необязательно. Значение по умолчанию — Ложь. записываемый
attendees[]. resource boolean Является ли участник ресурсом. Может быть установлено только при первом добавлении участника к событию. Последующие изменения игнорируются. Необязательно. Значение по умолчанию — False. записываемый
attendees[]. responseStatus string Статус ответа участника. Возможные значения:
  • « needsAction » — участник не ответил на приглашение (рекомендуется для новых мероприятий).
  • « declined » — участник отклонил приглашение.
  • « tentative » — участник предварительно принял приглашение.
  • « accepted » — участник принял приглашение.
записываемый
birthdayProperties nested object Данные о дне рождения или особом событии. Используется, если eventType"birthday" . Неизменяемый. записываемый
birthdayProperties. type string Тип дня рождения или особого события. Возможные значения:
  • "anniversary" - Годовщина, отличная от дня рождения. Всегда есть contact .
  • "birthday" - День рождения. Это значение по умолчанию.
  • "custom" - Особая дата, метка которой дополнительно указывается в поле customTypeName . Всегда имеет contact .
  • "other" - Особая дата, которая не попадает в другие категории и не имеет пользовательской метки. Всегда имеет contact .
  • "self" - День рождения владельца календаря. Не может иметь contact .
API календаря поддерживает создание событий только с типом "birthday" . Тип не может быть изменен после создания события.
записываемый
colorId string Цвет события. Это идентификатор, ссылающийся на запись в разделе event определения цветов (см. конечную точку цветов ). Необязательно. записываемый
conferenceData nested object Информация, связанная с конференцией, например, сведения о конференции Google Meet. Для создания новых сведений о конференции используйте поле createRequest . Чтобы сохранить изменения, не забудьте установить параметр запроса conferenceDataVersion на 1 для всех запросов на изменение событий. записываемый
description string Описание события. Может содержать HTML. Необязательно. записываемый
end. date date Дата в формате «гггг-мм-дд», если это событие на весь день. записываемый
end. dateTime datetime Время, как комбинированное значение даты и времени (отформатированное в соответствии с RFC3339 ). Требуется смещение часового пояса, если часовой пояс явно не указан в timeZone . записываемый
end. timeZone string Часовой пояс, в котором указано время. (Отформатировано как имя базы данных часовых поясов IANA, например, "Европа/Цюрих".) Для повторяющихся событий это поле является обязательным и указывает часовой пояс, в котором расширено повторение. Для одиночных событий это поле является необязательным и указывает пользовательский часовой пояс для начала/конца события. записываемый
eventType string Конкретный тип события. Это нельзя изменить после создания события. Возможные значения:
  • « birthday » — особое событие, длящееся целый день и повторяющееся ежегодно.
  • « default » — обычное событие или без дополнительных указаний.
  • « focusTime » — событие времени фокусировки.
  • " fromGmail " - Событие из Gmail. Этот тип события не может быть создан.
  • « outOfOffice » — событие отсутствия на работе.
  • « workingLocation » — событие рабочего места.
записываемый
extendedProperties. private object Свойства, которые являются частными для копии события, отображаемого в этом календаре. записываемый
extendedProperties. shared object Свойства, которые являются общими для копий события в календарях других участников. записываемый
focusTimeProperties nested object Данные события Focus Time. Используется, если eventTypefocusTime . записываемый
gadget. display string Режим отображения гаджета. Устарело. Возможные значения:
  • « icon » — гаджет отображается рядом с названием события в календаре.
  • « chip » — гаджет отображается при нажатии на событие.
записываемый
gadget. height integer Высота гаджета в пикселях. Высота должна быть целым числом больше 0. Необязательно. Устарело. записываемый
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 символов
  • идентификатор должен быть уникальным для каждого календаря
Из-за глобально распределенной природы системы мы не можем гарантировать, что коллизии ID будут обнаружены во время создания события. Чтобы минимизировать риск коллизий, мы рекомендуем использовать установленный алгоритм UUID, такой как описанный в RFC4122 .

Если вы не укажете идентификатор, он будет автоматически сгенерирован сервером.

Обратите внимание, что icalUID и id не идентичны, и только один из них должен быть предоставлен во время создания события. Одно из различий в их семантике заключается в том, что в повторяющихся событиях все вхождения одного события имеют разные id s, хотя все они имеют одинаковые icalUID s.

записываемый
location string Географическое местоположение события в виде текста в свободной форме. Необязательно. записываемый
originalStartTime. date date Дата в формате «гггг-мм-дд», если это событие на весь день. записываемый
originalStartTime. dateTime datetime Время, как комбинированное значение даты и времени (отформатированное в соответствии с RFC3339 ). Требуется смещение часового пояса, если часовой пояс явно не указан в timeZone . записываемый
originalStartTime. timeZone string Часовой пояс, в котором указано время. (Отформатировано как имя базы данных часовых поясов IANA, например, "Европа/Цюрих".) Для повторяющихся событий это поле является обязательным и указывает часовой пояс, в котором расширено повторение. Для одиночных событий это поле является необязательным и указывает пользовательский часовой пояс для начала/конца события. записываемый
outOfOfficeProperties nested object Данные о событиях «Вне офиса». Используется, если eventTypeoutOfOffice . записываемый
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 The time, as a combined date-time value (formatted according to RFC3339 ). A time zone offset is required unless a time zone is explicitly specified in timeZone . записываемый
start. timeZone string Часовой пояс, в котором указано время. (Отформатировано как имя базы данных часовых поясов IANA, например, "Европа/Цюрих".) Для повторяющихся событий это поле является обязательным и указывает часовой пояс, в котором расширено повторение. Для одиночных событий это поле является необязательным и указывает пользовательский часовой пояс для начала/конца события. записываемый
status string Статус события. Необязательно. Возможные значения:
  • " confirmed " - Событие подтверждено. Это статус по умолчанию.
  • « tentative » — событие предварительно подтверждено.
  • " cancelled " - Событие отменено (удалено). Метод list возвращает отмененные события только при инкрементальной синхронизации (когда указаны syncToken или updatedMin ) или если флаг showDeleted установлен в true . Метод get всегда возвращает их.

    Статус «Отменено» представляет собой два различных состояния в зависимости от типа события:

    1. Отмененные исключения неотмененного повторяющегося события указывают, что этот экземпляр больше не должен быть представлен пользователю. Клиенты должны хранить эти события в течение всего срока действия родительского повторяющегося события.

      Отмененные исключения гарантированно будут иметь заполненные значения только для полей id , recurringEventId и originalStartTime . Другие поля могут быть пустыми.

    2. Все остальные отмененные события представляют собой удаленные события. Клиенты должны удалить свои локально синхронизированные копии. Такие отмененные события в конечном итоге исчезнут, поэтому не полагайтесь на то, что они будут доступны вечно.

      Для удаленных событий гарантированно заполнено только поле id .

    В календаре организатора отмененные события продолжают предоставлять сведения о событиях (краткое описание, местоположение и т. д.), чтобы их можно было восстановить (отменить удаление). Аналогично, события, на которые пользователь был приглашен и которые он вручную удалил, продолжают предоставлять сведения. Однако запросы на инкрементную синхронизацию с showDeleted , установленным на false, не будут возвращать эти сведения.

    Если событие меняет организатора (например, посредством операции перемещения ), а первоначальный организатор отсутствует в списке участников, это приведет к отмене события, в котором гарантированно будет заполнено только поле id .

записываемый
summary string Название мероприятия. записываемый
transparency string Блокирует ли событие время в календаре. Необязательно. Возможные значения:
  • " opaque " - значение по умолчанию. Событие блокирует время в календаре. Это эквивалентно настройке Show me as Busy в пользовательском интерфейсе календаря.
  • " transparent " - Событие не блокирует время в календаре. Это эквивалентно настройке Show me as Available в пользовательском интерфейсе календаря.
записываемый
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 Необязательный идентификатор секции этажа. записываемый
workingLocationProperties.officeLocation. label string Название офиса, отображаемое в клиентах Calendar Web и Mobile. Мы рекомендуем вам указать название здания в базе данных ресурсов организации. записываемый
workingLocationProperties. type string Тип рабочего места. Возможные значения:
  • « homeOffice » — пользователь работает дома.
  • « officeLocation » — пользователь работает из офиса.
  • « customLocation » — пользователь работает из настраиваемого местоположения.
Любые детали указываются в подполе указанного имени, но это поле может отсутствовать, если оно пустое. Любые другие поля игнорируются.

Требуется при добавлении свойств рабочего местоположения.

записываемый

Ответ

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

Попробуйте!

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