Создает событие. Попробуйте сейчас .
Запрос
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 .Допустимые значения:
|
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 Диска используйте тот же формат, что и в свойстве Требуется при добавлении вложения. | записываемый |
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 | Статус ответа участника. Возможные значения:
| записываемый |
birthdayProperties | nested object | Данные о дне рождения или особом событии. Используется, если eventType — "birthday" . Неизменяемый. | записываемый |
birthdayProperties. type | string | Тип дня рождения или особого события. Возможные значения:
"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 | Конкретный тип события. Это нельзя изменить после создания события. Возможные значения:
| записываемый |
extendedProperties. private | object | Свойства, которые являются частными для копии события, отображаемого в этом календаре. | записываемый |
extendedProperties. shared | object | Свойства, которые являются общими для копий события в календарях других участников. | записываемый |
focusTimeProperties | nested object | Данные события Focus Time. Используется, если eventType — focusTime . | записываемый |
gadget. display | string | Режим отображения гаджета. Устарело. Возможные значения:
| записываемый |
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 | Непрозрачный идентификатор события. При создании новых одиночных или повторяющихся событий можно указать их идентификаторы. Предоставляемые идентификаторы должны соответствовать следующим правилам:
Если вы не укажете идентификатор, он будет автоматически сгенерирован сервером. Обратите внимание, что | записываемый |
location | string | Географическое местоположение события в виде текста в свободной форме. Необязательно. | записываемый |
originalStartTime. date | date | Дата в формате «гггг-мм-дд», если это событие на весь день. | записываемый |
originalStartTime. dateTime | datetime | Время, как комбинированное значение даты и времени (отформатированное в соответствии с RFC3339 ). Требуется смещение часового пояса, если часовой пояс явно не указан в timeZone . | записываемый |
originalStartTime. timeZone | string | Часовой пояс, в котором указано время. (Отформатировано как имя базы данных часовых поясов IANA, например, "Европа/Цюрих".) Для повторяющихся событий это поле является обязательным и указывает часовой пояс, в котором расширено повторение. Для одиночных событий это поле является необязательным и указывает пользовательский часовой пояс для начала/конца события. | записываемый |
outOfOfficeProperties | nested object | Данные о событиях «Вне офиса». Используется, если eventType — outOfOffice . | записываемый |
recurrence[] | list | Список строк RRULE, EXRULE, RDATE и EXDATE для повторяющегося события, как указано в RFC5545 . Обратите внимание, что строки DTSTART и DTEND не допускаются в этом поле; время начала и окончания события указывается в полях start и end . Это поле опускается для отдельных событий или экземпляров повторяющихся событий. | записываемый |
reminders. overrides[] | list | Если событие не использует напоминания по умолчанию, это список напоминаний, специфичных для события, или, если не установлено, указывает, что напоминания для этого события не установлены. Максимальное количество переопределенных напоминаний — 5. | записываемый |
reminders.overrides[]. method | string | Метод, используемый этим напоминанием. Возможные значения:
Обязательно при добавлении напоминания. | записываемый |
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 | Статус события. Необязательно. Возможные значения:
| записываемый |
summary | string | Название мероприятия. | записываемый |
transparency | string | Блокирует ли событие время в календаре. Необязательно. Возможные значения:
| записываемый |
visibility | string | Видимость события. Необязательно. Возможные значения:
| записываемый |
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 | Тип рабочего места. Возможные значения:
Требуется при добавлении свойств рабочего местоположения. | записываемый |
Ответ
В случае успеха этот метод возвращает ресурс Events в теле ответа.
Попробуйте!
Используйте API Explorer ниже, чтобы вызвать этот метод для реальных данных и увидеть ответ.