API календаря предоставляет различные варианты ресурсов событий. Дополнительную информацию можно найти в разделе «О событиях» .
Список методов для этого ресурса см. в конце этой страницы.
Представления ресурсов
{ "kind": "calendar#event", "etag": etag, "id": string, "status": string, "htmlLink": string, "created": datetime, "updated": datetime, "summary": string, "description": string, "location": string, "colorId": string, "creator": { "id": string, "email": string, "displayName": string, "self": boolean }, "organizer": { "id": string, "email": string, "displayName": string, "self": boolean }, "start": { "date": date, "dateTime": datetime, "timeZone": string }, "end": { "date": date, "dateTime": datetime, "timeZone": string }, "endTimeUnspecified": boolean, "recurrence": [ string ], "recurringEventId": string, "originalStartTime": { "date": date, "dateTime": datetime, "timeZone": string }, "transparency": string, "visibility": string, "iCalUID": string, "sequence": integer, "attendees": [ { "id": string, "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } ], "attendeesOmitted": boolean, "extendedProperties": { "private": { (key): string }, "shared": { (key): string } }, "hangoutLink": string, "conferenceData": { "createRequest": { "requestId": string, "conferenceSolutionKey": { "type": string }, "status": { "statusCode": string } }, "entryPoints": [ { "entryPointType": string, "uri": string, "label": string, "pin": string, "accessCode": string, "meetingCode": string, "passcode": string, "password": string } ], "conferenceSolution": { "key": { "type": string }, "name": string, "iconUri": string }, "conferenceId": string, "signature": string, "notes": string, }, "gadget": { "type": string, "title": string, "link": string, "iconLink": string, "width": integer, "height": integer, "display": string, "preferences": { (key): string } }, "anyoneCanAddSelf": boolean, "guestsCanInviteOthers": boolean, "guestsCanModify": boolean, "guestsCanSeeOtherGuests": boolean, "privateCopy": boolean, "locked": boolean, "reminders": { "useDefault": boolean, "overrides": [ { "method": string, "minutes": integer } ] }, "source": { "url": string, "title": string }, "workingLocationProperties": { "type": string, "homeOffice": (value), "customLocation": { "label": string }, "officeLocation": { "buildingId": string, "floorId": string, "floorSectionId": string, "deskId": string, "label": string } }, "outOfOfficeProperties": { "autoDeclineMode": string, "declineMessage": string }, "focusTimeProperties": { "autoDeclineMode": string, "declineMessage": string, "chatStatus": string }, "attachments": [ { "fileUrl": string, "title": string, "mimeType": string, "iconLink": string, "fileId": string } ], "eventType": string }
Имя свойства | Ценить | Описание | Примечания |
---|---|---|---|
anyoneCanAddSelf | boolean | Может ли кто-либо пригласить себя на мероприятие (устарело). Необязательный. По умолчанию установлено значение Ложь. | записываемый |
attachments[] | list | Вложенные файлы к мероприятию. Чтобы изменить вложения, для параметра запроса К каждому событию может быть не более 25 вложений. | |
attachments[]. fileId | string | Идентификатор прикрепленного файла. Только для чтения. Для файлов Google Диска это идентификатор соответствующей записи ресурса | |
attachments[]. fileUrl | string | URL-ссылка на вложение. Для добавления вложений файлов Google Диска используйте тот же формат, что и в свойстве Требуется при добавлении вложения. | записываемый |
attachments[]. iconLink | string | URL-ссылка на значок вложения. Это поле можно изменить только для сторонних вложений. | |
attachments[]. mimeType | string | Тип интернет-медиа (тип MIME) вложения. | |
attachments[]. title | string | Название вложения. | |
attendeesOmitted | boolean | Возможно, участники были исключены из представления мероприятия. При получении события это может быть связано с ограничением, заданным параметром запроса maxAttendee . При обновлении события это можно использовать только для обновления ответа участника. Необязательный. По умолчанию установлено значение Ложь. | записываемый |
attendees[] | list | Участники мероприятия. Дополнительную информацию о планировании мероприятий с другими пользователями календаря см. в руководстве «Мероприятия с участниками» . Учетным записям служб необходимо использовать делегирование полномочий на уровне домена для заполнения списка участников. | записываемый |
attendees[]. additionalGuests | integer | Количество дополнительных гостей. Необязательный. Значение по умолчанию — 0. | записываемый |
attendees[]. comment | string | Ответный комментарий участника. Необязательный. | записываемый |
attendees[]. displayName | string | Имя участника, если имеется. Необязательный. | записываемый |
attendees[]. email | string | Адрес электронной почты участника, если имеется. Это поле должно присутствовать при добавлении участника. Это должен быть действительный адрес электронной почты согласно RFC5322 . Требуется при добавлении участника. | записываемый |
attendees[]. id | string | Идентификатор профиля участника, если доступен. | |
attendees[]. optional | boolean | Является ли это необязательным участником. Необязательный. По умолчанию установлено значение Ложь. | записываемый |
attendees[]. organizer | boolean | Является ли участник организатором мероприятия. Только для чтения. По умолчанию установлено значение Ложь. | |
attendees[]. resource | boolean | Является ли участник ресурсом. Можно задать только тогда, когда участник добавляется к событию впервые. Последующие изменения игнорируются. Необязательный. По умолчанию установлено значение Ложь. | записываемый |
attendees[]. responseStatus | string | Статус ответа участника. Возможные значения:
| записываемый |
attendees[]. self | boolean | Представляет ли эта запись календарь, в котором отображается эта копия события. Только для чтения. По умолчанию установлено значение Ложь. | |
colorId | string | Цвет мероприятия. Это идентификатор, ссылающийся на запись в разделе event определения цветов (см. конечную точку цветов ). Необязательный. | записываемый |
conferenceData | nested object | Информация, связанная с конференцией, например сведения о конференции Google Meet. Для создания новых сведений о конференции используйте поле createRequest . Чтобы сохранить изменения, не забудьте установить для параметра запроса conferenceDataVersion значение 1 для всех запросов на изменение событий. | записываемый |
conferenceData. conferenceId | string | Идентификатор конференции. Может использоваться разработчиками для отслеживания конференций, не должен отображаться пользователям. Значение ID формируется по-разному для каждого типа конференц-решения:
| |
conferenceData. conferenceSolution | nested object | Решение для конференций, например Google Meet. Не установлено для конференции с неудачным запросом на создание. Требуется либо | |
conferenceData.conferenceSolution. iconUri | string | Видимый пользователю значок этого решения. | |
conferenceData.conferenceSolution. key | nested object | Ключ, который может однозначно идентифицировать решение конференции для этого мероприятия. | |
conferenceData.conferenceSolution.key. type | string | Тип решения конференции. Если клиент сталкивается с незнакомым или пустым типом, он все равно должен иметь возможность отображать точки входа. Однако он должен запрещать изменения. Возможные значения:
| |
conferenceData.conferenceSolution. name | string | Видимое пользователю имя этого решения. Не локализован. | |
conferenceData. createRequest | nested object | Запрос на создание новой конференции и привязку ее к событию. Данные генерируются асинхронно. Чтобы узнать, присутствуют ли данные, проверьте поле status . Требуется либо | |
conferenceData.createRequest. conferenceSolutionKey | nested object | Решение для конференций, например Hangouts или Google Meet. | |
conferenceData.createRequest.conferenceSolutionKey. type | string | Тип решения конференции. Если клиент встречает незнакомый или пустой тип, он все равно должен иметь возможность отображать точки входа. Однако он должен запрещать изменения. Возможные значения:
| |
conferenceData.createRequest. requestId | string | Уникальный идентификатор, созданный клиентом для этого запроса. Клиенты должны повторно генерировать этот идентификатор для каждого нового запроса. Если предоставленный идентификатор такой же, как и в предыдущем запросе, запрос игнорируется. | |
conferenceData.createRequest. status | nested object | Статус запроса на создание конференции. | |
conferenceData.createRequest.status. statusCode | string | Текущий статус запроса на создание конференции. Только для чтения. Возможные значения:
| |
conferenceData. entryPoints[] | list | Информация об отдельных точках входа в конференцию, например URL-адреса или номера телефонов. Все они должны принадлежать к одной конференции. Требуется либо | |
conferenceData.entryPoints[]. accessCode | string | Код доступа для доступа к конференции. Максимальная длина — 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. entryPointType | string | Тип точки входа в конференцию. Возможные значения:
| |
conferenceData.entryPoints[]. label | string | Метка для URI. Видно конечным пользователям. Не локализован. Максимальная длина — 512 символов. Примеры:
Необязательный. | |
conferenceData.entryPoints[]. meetingCode | string | Код встречи для доступа к конференции. Максимальная длина — 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. passcode | string | Код доступа для доступа к конференции. Максимальная длина — 128 символов. При создании новых данных конференции заполняйте только подмножество полей { | |
conferenceData.entryPoints[]. password | string | Пароль для доступа к конференции. Максимальная длина — 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. pin | string | PIN-код для доступа к конференции. Максимальная длина — 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. uri | string | URI точки входа. Максимальная длина — 1300 символов. Формат:
| |
conferenceData. notes | string | Дополнительные примечания (например, инструкции администратора домена, юридические уведомления), которые будут отображаться пользователю. Может содержать HTML. Максимальная длина — 2048 символов. Необязательный. | |
conferenceData. signature | string | Подпись данных конференции. Генерируется на стороне сервера. Не установлено для конференции с неудачным запросом на создание. Необязательно для конференции с ожидающим запросом на создание. | |
created | datetime | Время создания события (как временная метка RFC3339 ). Только для чтения. | |
creator | object | Создатель мероприятия. Только для чтения. | |
creator. displayName | string | Имя создателя, если имеется. | |
creator. email | string | Адрес электронной почты создателя, если имеется. | |
creator. id | string | Идентификатор профиля создателя, если имеется. | |
creator. self | boolean | Соответствует ли создатель календарю, в котором появляется эта копия события. Только для чтения. По умолчанию установлено значение Ложь. | |
description | string | Описание события. Может содержать HTML. Необязательный. | записываемый |
end | nested object | (эксклюзивное) время окончания события. Для повторяющегося события это время окончания первого экземпляра. | |
end. date | date | Дата в формате «гггг-мм-дд», если это событие длится целый день. | записываемый |
end. dateTime | datetime | Время в виде объединенного значения даты и времени (отформатированное в соответствии с RFC3339 ). Смещение часового пояса требуется, если только часовой пояс не указан явно в timeZone . | записываемый |
end. timeZone | string | Часовой пояс, в котором указано время. (В формате имени базы данных часовых поясов IANA, например «Европа/Цюрих».) Для повторяющихся событий это поле является обязательным и указывает часовой пояс, в котором повторяется. Для отдельных событий это поле является необязательным и указывает настраиваемый часовой пояс для начала/окончания события. | записываемый |
endTimeUnspecified | boolean | Действительно ли время окончания не указано. Время окончания по-прежнему указывается из соображений совместимости, даже если для этого атрибута установлено значение True. По умолчанию установлено значение Ложь. | |
etag | etag | ETag ресурса. | |
eventType | string | Конкретный тип мероприятия. Это нельзя изменить после создания события. Возможные значения:
| записываемый |
extendedProperties | object | Расширенные свойства события. | |
extendedProperties. private | object | Свойства, которые являются частными для копии мероприятия, отображаемой в этом календаре. | записываемый |
extendedProperties.private. (key) | string | Имя частной собственности и соответствующее значение. | |
extendedProperties. shared | object | Свойства, которые являются общими для копий мероприятия в календарях других участников. | записываемый |
extendedProperties.shared. (key) | string | Имя общего свойства и соответствующее значение. | |
focusTimeProperties | nested object | Данные о событии «Время фокусировки». Используется, если eventType имеет значение focusTime . | записываемый |
focusTimeProperties. autoDeclineMode | string | Отклонять ли приглашения на собрания, которые перекрывают события Focus Time. Допустимые значения: declineNone , что означает, что ни одно приглашение на собрание не будет отклонено; declineAllConflictingInvitations означает, что все конфликтующие приглашения на собрания, конфликтующие с событием, отклоняются; и declineOnlyNewConflictingInvitations , что означает, что должны быть отклонены только новые конфликтующие приглашения на собрания, которые поступают во время присутствия события Focus Time. | |
focusTimeProperties. chatStatus | string | Статус для отметки пользователя в чате и сопутствующих продуктах. Это может быть available или doNotDisturb . | |
focusTimeProperties. declineMessage | string | Ответное сообщение, позволяющее указать, будет ли Календарь автоматически отклонять существующее мероприятие или новое приглашение. | |
gadget | object | Гаджет, который продлевает это событие. Гаджеты устарели; вместо этого эта структура используется только для возврата метаданных календаря дней рождения. | |
gadget. display | string | Режим отображения гаджета. Устарело. Возможные значения:
| записываемый |
gadget. height | integer | Высота гаджета в пикселях. Высота должна быть целым числом больше 0. Необязательно. Устарело. | записываемый |
gadget. iconLink | string | URL-адрес значка гаджета. Схема URL-адреса должна быть HTTPS. Устарело. | записываемый |
gadget. link | string | URL-адрес гаджета. Схема URL-адреса должна быть HTTPS. Устарело. | записываемый |
gadget. preferences | object | Предпочтения. | записываемый |
gadget.preferences. (key) | string | Имя предпочтения и соответствующее значение. | |
gadget. title | string | Название гаджета. Устарело. | записываемый |
gadget. type | string | Тип гаджета. Устарело. | записываемый |
gadget. width | integer | Ширина гаджета в пикселях. Ширина должна быть целым числом больше 0. Необязательно. Устарело. | записываемый |
guestsCanInviteOthers | boolean | Могут ли участники, кроме организатора, приглашать других на мероприятие. Необязательный. По умолчанию установлено значение «Истина». | записываемый |
guestsCanModify | boolean | Могут ли участники, кроме организатора, изменять мероприятие. Необязательный. По умолчанию установлено значение Ложь. | записываемый |
guestsCanSeeOtherGuests | boolean | Могут ли другие участники, кроме организатора, видеть участников мероприятия. Необязательный. По умолчанию установлено значение «Истина». | записываемый |
hangoutLink | string | Абсолютная ссылка на Google Hangout, связанную с этим событием. Только для чтения. | |
htmlLink | string | Абсолютная ссылка на это событие в веб-интерфейсе Календаря Google. Только для чтения. | |
iCalUID | string | Уникальный идентификатор события, определенный в RFC5545 . Он используется для уникальной идентификации событий в системах календаря и должен быть указан при импорте событий с помощью метода импорта . Обратите внимание, что | |
id | string | Непрозрачный идентификатор события. При создании новых одиночных или повторяющихся событий вы можете указать их идентификаторы. Предоставляемые идентификаторы должны соответствовать следующим правилам:
Если вы не укажете идентификатор, он будет автоматически сгенерирован сервером. Обратите внимание, что | записываемый |
kind | string | Тип ресурса (" calendar#event "). | |
location | string | Географическое местоположение мероприятия в виде текста в произвольной форме. Необязательный. | записываемый |
locked | boolean | Является ли это заблокированной копией события, в которой невозможно внести изменения в основные поля события «сводка», «описание», «местоположение», «начало», «конец» или «повторение». По умолчанию установлено значение Ложь. Только для чтения. | |
organizer | object | Организатор мероприятия. Если организатор также является участником, это обозначается отдельной записью в attendees , при этом в поле organizer установлено значение True. Чтобы сменить организатора, используйте операцию перемещения . Только для чтения, кроме случаев импорта события. | записываемый |
organizer. displayName | string | Имя организатора, если имеется. | записываемый |
organizer. email | string | Адрес электронной почты организатора, если имеется. Это должен быть действительный адрес электронной почты согласно RFC5322 . | записываемый |
organizer. id | string | Идентификатор профиля организатора, если имеется. | |
organizer. self | boolean | Соответствует ли организатор календарю, в котором отображается эта копия мероприятия. Только для чтения. По умолчанию установлено значение Ложь. | |
originalStartTime | nested object | Для экземпляра повторяющегося события это время, в которое это событие начнется в соответствии с данными повторения в повторяющемся событии, определенном recurringEventId. Он однозначно идентифицирует экземпляр в серии повторяющихся событий, даже если экземпляр был перенесен в другое время. Неизменяемый. | |
originalStartTime. date | date | Дата в формате «гггг-мм-дд», если это событие длится целый день. | записываемый |
originalStartTime. dateTime | datetime | Время в виде объединенного значения даты и времени (отформатированное в соответствии с RFC3339 ). Смещение часового пояса требуется, если только часовой пояс не указан явно в timeZone . | записываемый |
originalStartTime. timeZone | string | Часовой пояс, в котором указано время. (В формате имени базы данных часовых поясов IANA, например «Европа/Цюрих».) Для повторяющихся событий это поле является обязательным и указывает часовой пояс, в котором повторяется. Для отдельных событий это поле является необязательным и указывает настраиваемый часовой пояс для начала/окончания события. | записываемый |
outOfOfficeProperties | nested object | Данные о событиях отсутствия на работе. Используется, если eventType имеет значение outOfOffice . | записываемый |
outOfOfficeProperties. autoDeclineMode | string | Отклонять ли приглашения на собрания, которые совпадают с событиями отсутствия на рабочем месте. Допустимые значения: declineNone , что означает, что ни одно приглашение на собрание не будет отклонено; declineAllConflictingInvitations означает, что все конфликтующие приглашения на собрания, конфликтующие с событием, отклоняются; и declineOnlyNewConflictingInvitations , что означает, что должны быть отклонены только новые конфликтующие приглашения на собрания, которые поступают во время присутствия события «Нет на месте». | |
outOfOfficeProperties. declineMessage | string | Ответное сообщение, позволяющее указать, будет ли Календарь автоматически отклонять существующее мероприятие или новое приглашение. | |
privateCopy | boolean | Если установлено значение True, распространение событий отключено. Обратите внимание, что это не то же самое, что свойства частного события . Необязательный. Неизменяемый. По умолчанию установлено значение Ложь. | |
recurrence[] | list | Список строк RRULE, EXRULE, RDATE и EXDATE для повторяющегося события, как указано в RFC5545 . Обратите внимание, что строки DTSTART и DTEND в этом поле не допускаются; Время начала и окончания события указывается в полях start и end . Это поле опускается для отдельных событий или экземпляров повторяющихся событий. | записываемый |
recurringEventId | string | Для экземпляра повторяющегося события это id повторяющегося события, которому принадлежит этот экземпляр. Неизменяемый. | |
reminders | object | Информация о напоминаниях о событии для авторизованного пользователя. Обратите внимание, что изменение напоминаний также не меняет updated свойство включающего события. | |
reminders. overrides[] | list | Если событие не использует напоминания по умолчанию, здесь перечислены напоминания, специфичные для этого события, или, если оно не установлено, это означает, что для этого события напоминания не установлены. Максимальное количество напоминаний о переопределении — 5. | записываемый |
reminders.overrides[]. method | string | Метод, используемый в этом напоминании. Возможные значения:
Требуется при добавлении напоминания. | записываемый |
reminders.overrides[]. minutes | integer | Количество минут до начала события, когда должно сработать напоминание. Допустимые значения: от 0 до 40320 (4 недели в минутах). Требуется при добавлении напоминания. | записываемый |
reminders. useDefault | boolean | Применяются ли к событию напоминания календаря по умолчанию. | записываемый |
sequence | integer | Порядковый номер согласно iCalendar. | записываемый |
source | object | Источник, из которого было создано событие. Например, веб-страница, сообщение электронной почты или любой документ, идентифицируемый по URL-адресу со схемой HTTP или HTTPS. Может быть просмотрен или изменен только создателем мероприятия. | |
source. title | string | Название источника; например, заголовок веб-страницы или тема электронного письма. | записываемый |
source. url | string | URL-адрес источника, указывающий на ресурс. Схема URL-адреса должна быть HTTP или HTTPS. | записываемый |
start | nested object | (включительно) время начала события. Для повторяющегося события это время начала первого экземпляра. | |
start. date | date | Дата в формате «гггг-мм-дд», если это событие длится целый день. | записываемый |
start. dateTime | datetime | Время в виде объединенного значения даты и времени (отформатированное в соответствии с RFC3339 ). Смещение часового пояса требуется, если только часовой пояс не указан явно в timeZone . | записываемый |
start. timeZone | string | Часовой пояс, в котором указано время. (В формате имени базы данных часовых поясов IANA, например «Европа/Цюрих».) Для повторяющихся событий это поле является обязательным и указывает часовой пояс, в котором повторяется. Для отдельных событий это поле является необязательным и указывает настраиваемый часовой пояс для начала/окончания события. | записываемый |
status | string | Статус мероприятия. Необязательный. Возможные значения:
| записываемый |
summary | string | Название мероприятия. | записываемый |
transparency | string | Блокирует ли событие время в календаре. Необязательный. Возможные значения:
| записываемый |
updated | datetime | Время последнего изменения данных основного события (как временная метка RFC3339 ). Обновление напоминаний о событиях не приведет к изменению ситуации. Только для чтения. | |
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. Мы рекомендуем вам указать название здания в базе данных ресурсов организации. | записываемый |
workingLocationProperties. type | string | Тип рабочего места. Возможные значения:
Требуется при добавлении свойств рабочего места. | записываемый |
Методы
- удалить
- Удаляет событие.
- получать
- Возвращает событие на основе его идентификатора Календаря Google. Чтобы получить событие, используя его идентификатор iCalendar, вызовите метод event.list, используя параметр
iCalUID
. - импортировать
- Импортирует событие. Эта операция используется для добавления частной копии существующего события в календарь. Импортировать можно только события с
eventType
поdefault
.Устаревшее поведение: если импортируется событие, не являющееся
default
, его тип будет изменен наdefault
, а все свойства, специфичные для типа события, которые оно может иметь, будут удалены. - вставлять
- Создает событие.
- случаи
- Возвращает экземпляры указанного повторяющегося события.
- список
- Возвращает события в указанном календаре.
- двигаться
- Перемещает событие в другой календарь, т.е. меняет организатора мероприятия. Обратите внимание, что можно перемещать только события
default
; Событияbirthday
,focusTime
,fromGmail
,outOfOffice
workingLocation
не могут быть перемещены. - пластырь
- Обновляет событие. Этот метод поддерживает семантику исправлений. Обратите внимание, что каждый запрос на исправление использует три единицы квоты; предпочитайте использовать
get
за которым следуетupdate
. Указанные вами значения полей заменяют существующие значения. Поля, которые вы не укажете в запросе, остаются без изменений. Поля массива, если они указаны, перезаписывают существующие массивы; это отбрасывает все предыдущие элементы массива. - быстроДобавить
- Создает событие на основе простой текстовой строки.
- обновлять
- Обновляет событие. Этот метод не поддерживает семантику исправлений и всегда обновляет весь ресурс событий. Чтобы выполнить частичное обновление, выполните
get
, а затемupdate
используя etags, чтобы обеспечить атомарность. - смотреть
- Следите за изменениями в ресурсах событий.
API календаря предоставляет различные варианты ресурсов событий. Дополнительную информацию можно найти в разделе «О событиях» .
Список методов для этого ресурса см. в конце этой страницы.
Представления ресурсов
{ "kind": "calendar#event", "etag": etag, "id": string, "status": string, "htmlLink": string, "created": datetime, "updated": datetime, "summary": string, "description": string, "location": string, "colorId": string, "creator": { "id": string, "email": string, "displayName": string, "self": boolean }, "organizer": { "id": string, "email": string, "displayName": string, "self": boolean }, "start": { "date": date, "dateTime": datetime, "timeZone": string }, "end": { "date": date, "dateTime": datetime, "timeZone": string }, "endTimeUnspecified": boolean, "recurrence": [ string ], "recurringEventId": string, "originalStartTime": { "date": date, "dateTime": datetime, "timeZone": string }, "transparency": string, "visibility": string, "iCalUID": string, "sequence": integer, "attendees": [ { "id": string, "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } ], "attendeesOmitted": boolean, "extendedProperties": { "private": { (key): string }, "shared": { (key): string } }, "hangoutLink": string, "conferenceData": { "createRequest": { "requestId": string, "conferenceSolutionKey": { "type": string }, "status": { "statusCode": string } }, "entryPoints": [ { "entryPointType": string, "uri": string, "label": string, "pin": string, "accessCode": string, "meetingCode": string, "passcode": string, "password": string } ], "conferenceSolution": { "key": { "type": string }, "name": string, "iconUri": string }, "conferenceId": string, "signature": string, "notes": string, }, "gadget": { "type": string, "title": string, "link": string, "iconLink": string, "width": integer, "height": integer, "display": string, "preferences": { (key): string } }, "anyoneCanAddSelf": boolean, "guestsCanInviteOthers": boolean, "guestsCanModify": boolean, "guestsCanSeeOtherGuests": boolean, "privateCopy": boolean, "locked": boolean, "reminders": { "useDefault": boolean, "overrides": [ { "method": string, "minutes": integer } ] }, "source": { "url": string, "title": string }, "workingLocationProperties": { "type": string, "homeOffice": (value), "customLocation": { "label": string }, "officeLocation": { "buildingId": string, "floorId": string, "floorSectionId": string, "deskId": string, "label": string } }, "outOfOfficeProperties": { "autoDeclineMode": string, "declineMessage": string }, "focusTimeProperties": { "autoDeclineMode": string, "declineMessage": string, "chatStatus": string }, "attachments": [ { "fileUrl": string, "title": string, "mimeType": string, "iconLink": string, "fileId": string } ], "eventType": string }
Имя свойства | Ценить | Описание | Примечания |
---|---|---|---|
anyoneCanAddSelf | boolean | Может ли кто-либо пригласить себя на мероприятие (устарело). Необязательный. По умолчанию установлено значение Ложь. | записываемый |
attachments[] | list | Вложенные файлы к мероприятию. Чтобы изменить вложения, для параметра запроса К каждому событию может быть не более 25 вложений. | |
attachments[]. fileId | string | Идентификатор прикрепленного файла. Только для чтения. Для файлов Google Диска это идентификатор соответствующей записи ресурса | |
attachments[]. fileUrl | string | URL-ссылка на вложение. Для добавления вложений файлов Google Диска используйте тот же формат, что и в свойстве Требуется при добавлении вложения. | записываемый |
attachments[]. iconLink | string | URL-ссылка на значок вложения. Это поле можно изменить только для сторонних вложений. | |
attachments[]. mimeType | string | Тип интернет-медиа (тип MIME) вложения. | |
attachments[]. title | string | Название вложения. | |
attendeesOmitted | boolean | Возможно, участники были исключены из представления мероприятия. При получении события это может быть связано с ограничением, заданным параметром запроса maxAttendee . При обновлении события это можно использовать только для обновления ответа участника. Необязательный. По умолчанию установлено значение Ложь. | записываемый |
attendees[] | list | Участники мероприятия. Дополнительную информацию о планировании мероприятий с другими пользователями календаря см. в руководстве «Мероприятия с участниками» . Учетным записям служб необходимо использовать делегирование полномочий на уровне домена для заполнения списка участников. | записываемый |
attendees[]. additionalGuests | integer | Количество дополнительных гостей. Необязательный. Значение по умолчанию — 0. | записываемый |
attendees[]. comment | string | Ответный комментарий участника. Необязательный. | записываемый |
attendees[]. displayName | string | Имя участника, если имеется. Необязательный. | записываемый |
attendees[]. email | string | Адрес электронной почты участника, если имеется. Это поле должно присутствовать при добавлении участника. Это должен быть действительный адрес электронной почты согласно RFC5322 . Требуется при добавлении участника. | записываемый |
attendees[]. id | string | Идентификатор профиля участника, если доступен. | |
attendees[]. optional | boolean | Является ли это необязательным участником. Необязательный. По умолчанию установлено значение Ложь. | записываемый |
attendees[]. organizer | boolean | Является ли участник организатором мероприятия. Только для чтения. По умолчанию установлено значение Ложь. | |
attendees[]. resource | boolean | Является ли участник ресурсом. Можно задать только тогда, когда участник добавляется к событию впервые. Последующие изменения игнорируются. Необязательный. По умолчанию установлено значение Ложь. | записываемый |
attendees[]. responseStatus | string | Статус ответа участника. Возможные значения:
| записываемый |
attendees[]. self | boolean | Представляет ли эта запись календарь, в котором отображается эта копия события. Только для чтения. По умолчанию установлено значение Ложь. | |
colorId | string | Цвет мероприятия. Это идентификатор, ссылающийся на запись в разделе event определения цветов (см. конечную точку цветов ). Необязательный. | записываемый |
conferenceData | nested object | Информация, связанная с конференцией, например сведения о конференции Google Meet. Для создания новых сведений о конференции используйте поле createRequest . Чтобы сохранить изменения, не забудьте установить для параметра запроса conferenceDataVersion значение 1 для всех запросов на изменение событий. | записываемый |
conferenceData. conferenceId | string | Идентификатор конференции. Может использоваться разработчиками для отслеживания конференций, не должен отображаться пользователям. Значение ID формируется по-разному для каждого типа конференц-решения:
| |
conferenceData. conferenceSolution | nested object | Решение для конференций, например Google Meet. Не установлено для конференции с неудачным запросом на создание. Требуется либо | |
conferenceData.conferenceSolution. iconUri | string | Видимый пользователю значок этого решения. | |
conferenceData.conferenceSolution. key | nested object | Ключ, который может однозначно идентифицировать решение конференции для этого мероприятия. | |
conferenceData.conferenceSolution.key. type | string | Тип решения конференции. Если клиент встречает незнакомый или пустой тип, он все равно должен иметь возможность отображать точки входа. Однако он должен запрещать изменения. Возможные значения:
| |
conferenceData.conferenceSolution. name | string | Видимое пользователю имя этого решения. Не локализован. | |
conferenceData. createRequest | nested object | Запрос на создание новой конференции и привязку ее к событию. Данные генерируются асинхронно. Чтобы узнать, присутствуют ли данные, проверьте поле status . Требуется либо | |
conferenceData.createRequest. conferenceSolutionKey | nested object | Решение для конференций, например Hangouts или Google Meet. | |
conferenceData.createRequest.conferenceSolutionKey. type | string | Тип решения конференции. Если клиент встречает незнакомый или пустой тип, он все равно должен иметь возможность отображать точки входа. Однако он должен запрещать изменения. Возможные значения:
| |
conferenceData.createRequest. requestId | string | Уникальный идентификатор, созданный клиентом для этого запроса. Клиенты должны восстановить этот идентификатор для каждого нового запроса. Если предоставленный идентификатор такой же, как и для предыдущего запроса, запрос игнорируется. | |
conferenceData.createRequest. status | nested object | Статус конференции создает запрос. | |
conferenceData.createRequest.status. statusCode | string | Текущий статус конференции создает запрос. Только для чтения. Возможные значения:
| |
conferenceData. entryPoints[] | list | Информация о отдельных точках входа конференции, таких как URL -адреса или номера телефонов. Все они должны принадлежать к одной и той же конференции. Требуется либо | |
conferenceData.entryPoints[]. accessCode | string | Код доступа для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. entryPointType | string | Тип точки входа конференции. Возможные значения:
| |
conferenceData.entryPoints[]. label | string | Ярлык для URI. Видно для конечных пользователей. Не локализован. Максимальная длина составляет 512 символа. Примеры:
Необязательный. | |
conferenceData.entryPoints[]. meetingCode | string | Кодекс встречи для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. passcode | string | Пассный код для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { | |
conferenceData.entryPoints[]. password | string | Пароль для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. pin | string | PIN -код для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. uri | string | URI точки входа. Максимальная длина составляет 1300 символов. Формат:
| |
conferenceData. notes | string | Дополнительные примечания (например, инструкции от администратора домена, юридические уведомления) для отображения пользователю. Может содержать HTML. Максимальная длина составляет 2048 символов. Необязательный. | |
conferenceData. signature | string | Подпись данных конференции. Сгенерировано на стороне сервера. Неоставление для конференции с неудачным запросом на создание. Необязательно для конференции с ожидающим запросом на создание. | |
created | datetime | Время создания события (как временная метка RFC3339 ). Только для чтения. | |
creator | object | Создатель события. Только для чтения. | |
creator. displayName | string | Имя создателя, если доступно. | |
creator. email | string | Адрес электронной почты создателя, если доступен. | |
creator. id | string | Идентификатор профиля создателя, если таковой имеется. | |
creator. self | boolean | Соответствует ли создатель календарю, в котором появляется эта копия события. Только для чтения. По умолчанию ложь. | |
description | string | Описание события. Может содержать HTML. Необязательный. | Записывается |
end | nested object | (Эксклюзивное) время окончания мероприятия. Для повторяющегося события это время окончания первого экземпляра. | |
end. date | date | Дата, в формате «yyyy-mm-dd», если это событие на весь день. | Записывается |
end. dateTime | datetime | Время, как комбинированное значение даты (отформатировано в соответствии с RFC3339 ). Смещение часового пояса требуется, если только часовой пояс явно указан в timeZone . | Записывается |
end. timeZone | string | Часовой пояс, в котором указано время. (Отформатируется как имя базы данных IANA Time, например, «Европа/Цюрих».) Для повторяющихся событий требуется это поле и указывает часовой пояс, в котором рецидив расширяется. Для отдельных событий это поле является необязательным и указывает на пользовательский часовой пояс для начала/конца события. | Записывается |
endTimeUnspecified | boolean | На самом деле не определена ли время окончания. Время окончания по -прежнему обеспечивается по причинам совместимости, даже если этот атрибут установлен на True. По умолчанию ложь. | |
etag | etag | ETAG ресурса. | |
eventType | string | Конкретный тип события. Это не может быть изменено после создания события. Возможные значения:
| Записывается |
extendedProperties | object | Расширенные свойства мероприятия. | |
extendedProperties. private | object | Свойства, которые являются частными для копии события, которое появляется в этом календаре. | Записывается |
extendedProperties.private. (key) | string | Название частной собственности и соответствующее значение. | |
extendedProperties. shared | object | Свойства, которые разделяются между копиями мероприятия в календарях других участников. | Записывается |
extendedProperties.shared. (key) | string | Название общего свойства и соответствующего значения. | |
focusTimeProperties | nested object | Фокус времени событий. Используется, если eventType является focusTime . | Записывается |
focusTimeProperties. autoDeclineMode | string | Стоить ли приглашения на встречу, которые перекрывают события времени фокусировки. Допустимые значения declineNone , что означает, что приглашения на собрание не отклоняются; declineAllConflictingInvitations , что означает, что все противоречивые приглашения на собрание, которые конфликтуют с этим событием, отклоняются; и declineOnlyNewConflictingInvitations , что означает, что только новые конфликтующие приглашения на собрание, которые прибывают, пока присутствует событие фокуса, должно быть отклонено. | |
focusTimeProperties. chatStatus | string | Статус, чтобы отметить пользователя в чате и связанных продуктах. Это может быть available или doNotDisturb . | |
focusTimeProperties. declineMessage | string | Ответ Сообщение, чтобы установить, если существующее событие или новое приглашение автоматически отклоняется календарем. | |
gadget | object | Гаджет, который расширяет это событие. Гаджеты устарели; Эта структура вместо этого используется только для возвращающихся метаданных календаря дня рождения. | |
gadget. display | string | Режим отображения гаджета. Устарело. Возможные значения:
| Записывается |
gadget. height | integer | Высота гаджета в пикселях. Высота должна быть целым числом, превышающим 0. Необязательно. Устарело. | Записывается |
gadget. iconLink | string | У URL икона гаджета. Схема URL должна быть HTTPS. Устарело. | Записывается |
gadget. link | string | URL гаджета. Схема URL должна быть HTTPS. Устарело. | Записывается |
gadget. preferences | object | Предпочтения. | Записывается |
gadget.preferences. (key) | string | Имя предпочтения и соответствующее значение. | |
gadget. title | string | Название гаджета. Устарело. | Записывается |
gadget. type | string | Тип гаджета. Устарело. | Записывается |
gadget. width | integer | Ширина гаджета в пикселях. Ширина должна быть целым числом, превышающим 0. Необязательно. Устарело. | Записывается |
guestsCanInviteOthers | boolean | Могут ли участники, кроме организатора, пригласить других на мероприятие. Необязательный. По умолчанию верно. | Записывается |
guestsCanModify | boolean | Могут ли участники, кроме организатора, изменить мероприятие. Необязательный. По умолчанию ложь. | Записывается |
guestsCanSeeOtherGuests | boolean | Независимо от того, могут ли участники, кроме организатора, могут видеть, кто такие участники мероприятия. Необязательный. По умолчанию верно. | Записывается |
hangoutLink | string | Абсолютная ссылка на Google Hangout, связанную с этим событием. Только для чтения. | |
htmlLink | string | Абсолютная ссылка на это событие в веб -интерфейсе Google Calendar. Только для чтения. | |
iCalUID | string | Событие уникального идентификатора, как определено в RFC5545 . Он используется для уникальной идентификации событий, начисленных на календарные системы и должен поставляться при импорте событий с помощью метода импорта . Обратите внимание, что | |
id | string | Непрозрачный идентификатор события. При создании новых или повторяющихся событий вы можете указать их идентификаторы. При условии, что идентификаторы должны следовать этим правилам:
Если вы не указаете идентификатор, он будет автоматически сгенерирован сервером. Обратите внимание, что | Записывается |
kind | string | Тип ресурса (« calendar#event »). | |
location | string | Географическое расположение события в виде текста бесплатной формы. Необязательный. | Записывается |
locked | boolean | Является ли это копией заблокированного события, где никаких изменений не может быть внесено в поля основного события «Сводка», «Описание», «местоположение», «старт», «конец» или «рецидив». По умолчанию ложь. Только для чтения. | |
organizer | object | Организатор мероприятия. Если организатор также является участником, это указывает на отдельную запись в attendees с полем organizer , установленным True. Чтобы изменить организатор, используйте операцию перемещения . Только для чтения, за исключением случаев импорта события. | Записывается |
organizer. displayName | string | Имя организатора, если таковое имеется. | Записывается |
organizer. email | string | Адрес электронной почты организатора, если доступен. Это должен быть действительный адрес электронной почты в соответствии с RFC5322 . | Записывается |
organizer. id | string | Идентификатор профиля организатора, если таковой имеется. | |
organizer. self | boolean | Соответствует ли организатор календарю, в котором появляется эта копия события. Только для чтения. По умолчанию ложь. | |
originalStartTime | nested object | Для случая повторяющегося события это время, когда это событие будет начинаться в соответствии с данными рецидивов в повторяющемся событии, идентифицированном RecurringEventid. Он однозначно идентифицирует экземпляр в серии повторяющихся событий, даже если экземпляр был перемещен в другое время. Неизменен. | |
originalStartTime. date | date | Дата, в формате «yyyy-mm-dd», если это событие на весь день. | Записывается |
originalStartTime. dateTime | datetime | Время, как комбинированное значение даты (отформатировано в соответствии с RFC3339 ). Смещение часового пояса требуется, если только часовой пояс явно указан в timeZone . | Записывается |
originalStartTime. timeZone | string | Часовой пояс, в котором указано время. (Отформатируется как имя базы данных IANA Time, например, «Европа/Цюрих».) Для повторяющихся событий требуется это поле и указывает часовой пояс, в котором рецидив расширяется. Для отдельных событий это поле является необязательным и указывает на пользовательский часовой пояс для начала/конца события. | Записывается |
outOfOfficeProperties | nested object | Вне офисных данных. Используется, если eventType является outOfOffice . | Записывается |
outOfOfficeProperties. autoDeclineMode | string | Стоит ли отказываться от приглашений на встречу, которые совпадают с офисных мероприятий. Допустимые значения declineNone , что означает, что приглашения на собрание не отклоняются; declineAllConflictingInvitations , что означает, что все противоречивые приглашения на собрание, которые конфликтуют с этим событием, отклоняются; и declineOnlyNewConflictingInvitations , что означает, что только новые конфликтующие приглашения на собрание, которые прибывают, пока присутствует вне офиса, должно быть отклонено. | |
outOfOfficeProperties. declineMessage | string | Ответ Сообщение, чтобы установить, если существующее событие или новое приглашение автоматически отклоняется календарем. | |
privateCopy | boolean | Если установлено в True, распространение событий отключено. Обратите внимание, что это не то же самое, что и свойства частных событий . Необязательный. Неизменен. По умолчанию ложь. | |
recurrence[] | list | Список линий Rrule, Exrule, Rdate и Exdate для повторяющегося события, как указано в RFC5545 . Обратите внимание, что линии DTStart и Dtend не допускаются в этом поле; Время начала и окончания события указывается в start и end полях. Это поле опущено для отдельных событий или экземпляров повторяющихся событий. | Записывается |
recurringEventId | string | Для экземпляра повторяющегося события это id повторяющегося события, к которому принадлежит этот экземпляр. Неизменен. | |
reminders | object | Информация о напоминаниях события для аутентифицированного пользователя. Обратите внимание, что изменение напоминаний также не изменяет updated свойство события приложения. | |
reminders. overrides[] | list | Если событие не использует напоминания по умолчанию, в нем перечислены напоминания, специфичные для события, или, если не установлено, указывает, что для этого события не установлено никаких напоминаний. Максимальное количество напоминаний о переопределении составляет 5. | Записывается |
reminders.overrides[]. method | string | Метод, используемый этим напоминанием. Возможные значения:
Требуется при добавлении напоминания. | Записывается |
reminders.overrides[]. minutes | integer | Количество минут до начала события, когда напоминание должно запустить. Допустимые значения составляют от 0 до 40320 (4 недели за считанные минуты). Требуется при добавлении напоминания. | Записывается |
reminders. useDefault | boolean | Применяются ли напоминания по умолчанию календаря на мероприятие. | Записывается |
sequence | integer | Номер последовательности в соответствии с iCalendar. | Записывается |
source | object | Источник, из которого было создано событие. Например, веб -страница, сообщение электронной почты или любой документ, который можно определить с помощью URL с HTTP или HTTPS -схемой. Может быть замечен или изменен только создателем события. | |
source. title | string | Название источника; Например, название веб -страницы или предмета электронной почты. | Записывается |
source. url | string | URL источника, указывающего на ресурс. Схема URL должна быть HTTP или HTTPS. | Записывается |
start | nested object | (Включительно) время начала мероприятия. Для повторяющегося события это время начала первого экземпляра. | |
start. date | date | Дата, в формате «yyyy-mm-dd», если это событие на весь день. | Записывается |
start. dateTime | datetime | Время, как комбинированное значение даты (отформатировано в соответствии с RFC3339 ). Смещение часового пояса требуется, если только часовой пояс явно указан в timeZone . | Записывается |
start. timeZone | string | Часовой пояс, в котором указано время. (Отформатируется как имя базы данных IANA Time, например, «Европа/Цюрих».) Для повторяющихся событий требуется это поле и указывает часовой пояс, в котором рецидив расширяется. Для отдельных событий это поле является необязательным и указывает на пользовательский часовой пояс для начала/конца события. | Записывается |
status | string | Статус события. Необязательный. Возможные значения:
| Записывается |
summary | string | Название мероприятия. | Записывается |
transparency | string | Блокирует ли событие время в календаре. Необязательный. Возможные значения:
| Записывается |
updated | datetime | Последнее время модификации основных данных события (в качестве временной метки RFC3339 ). Обновление напоминаний о событиях не приведет к изменению этого. Только для чтения. | |
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 | Имя офиса, которое отображается в календарных веб -клиентах и мобильных клиентах. Мы рекомендуем вам ссылаться на название здания в базе данных ресурсов организации. | Записывается |
workingLocationProperties. type | string | Тип рабочего места. Возможные значения:
Требуется при добавлении свойств рабочих мест. | Записывается |
Методы
- удалить
- Удаляет событие.
- получать
- Возвращает событие на основе своего идентификатора календаря Google. Чтобы получить событие, используя свой идентификатор iCalendar, вызовите метод Events.List, используя параметр
iCalUID
. - импортировать
- Импорт мероприятия. Эта операция используется для добавления частной копии существующего события в календарь. Только события с
eventType
ofdefault
могут быть импортированы.Умеренное поведение: если импортируется событие, не
default
, его тип будет изменен наdefault
, и любые специфические свойства типа события, которые он мог быть, будут отброшены. - вставлять
- Создает событие.
- экземпляры
- Возвращает экземпляры указанного повторяющегося события.
- список
- Возвращает события в указанном календаре.
- двигаться
- Перемещает событие в другой календарь, IE меняет организатор мероприятия. Обратите внимание, что только события
default
могут быть перемещены;birthday
,focusTime
,fromGmail
,outOfOffice
и соревнованияworkingLocation
не могут быть перемещены. - пластырь
- Обновляет событие. Этот метод поддерживает семантику патча. Обратите внимание, что каждый запрос на патч потребляет три единицы квот; предпочитаю использовать
get
а затемupdate
. Значения поля, которые вы указали, заменяют существующие значения. Поля, которые вы не указываете в запросе, остаются неизменными. Массивные поля, если указаны, перезаписывают существующие массивы; Это отбрасывает любые предыдущие элементы массива. - Quickadd
- Создает событие на основе простой текстовой строки.
- обновлять
- Обновляет событие. Этот метод не поддерживает семантику исправления и всегда обновляет весь ресурс событий. Чтобы сделать частичное обновление, выполните
get
update
, используя ETAGS, чтобы обеспечить атомичность. - смотреть
- Следите за изменениями в ресурсах событий.
Календарный API предоставляет различные ароматы ресурсов событий, в событиях можно найти больше информации.
Список методов для этого ресурса см. Конец этой страницы.
Ресурсные представления
{ "kind": "calendar#event", "etag": etag, "id": string, "status": string, "htmlLink": string, "created": datetime, "updated": datetime, "summary": string, "description": string, "location": string, "colorId": string, "creator": { "id": string, "email": string, "displayName": string, "self": boolean }, "organizer": { "id": string, "email": string, "displayName": string, "self": boolean }, "start": { "date": date, "dateTime": datetime, "timeZone": string }, "end": { "date": date, "dateTime": datetime, "timeZone": string }, "endTimeUnspecified": boolean, "recurrence": [ string ], "recurringEventId": string, "originalStartTime": { "date": date, "dateTime": datetime, "timeZone": string }, "transparency": string, "visibility": string, "iCalUID": string, "sequence": integer, "attendees": [ { "id": string, "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } ], "attendeesOmitted": boolean, "extendedProperties": { "private": { (key): string }, "shared": { (key): string } }, "hangoutLink": string, "conferenceData": { "createRequest": { "requestId": string, "conferenceSolutionKey": { "type": string }, "status": { "statusCode": string } }, "entryPoints": [ { "entryPointType": string, "uri": string, "label": string, "pin": string, "accessCode": string, "meetingCode": string, "passcode": string, "password": string } ], "conferenceSolution": { "key": { "type": string }, "name": string, "iconUri": string }, "conferenceId": string, "signature": string, "notes": string, }, "gadget": { "type": string, "title": string, "link": string, "iconLink": string, "width": integer, "height": integer, "display": string, "preferences": { (key): string } }, "anyoneCanAddSelf": boolean, "guestsCanInviteOthers": boolean, "guestsCanModify": boolean, "guestsCanSeeOtherGuests": boolean, "privateCopy": boolean, "locked": boolean, "reminders": { "useDefault": boolean, "overrides": [ { "method": string, "minutes": integer } ] }, "source": { "url": string, "title": string }, "workingLocationProperties": { "type": string, "homeOffice": (value), "customLocation": { "label": string }, "officeLocation": { "buildingId": string, "floorId": string, "floorSectionId": string, "deskId": string, "label": string } }, "outOfOfficeProperties": { "autoDeclineMode": string, "declineMessage": string }, "focusTimeProperties": { "autoDeclineMode": string, "declineMessage": string, "chatStatus": string }, "attachments": [ { "fileUrl": string, "title": string, "mimeType": string, "iconLink": string, "fileId": string } ], "eventType": string }
Имя свойства | Ценить | Описание | Примечания |
---|---|---|---|
anyoneCanAddSelf | boolean | Может ли кто -нибудь пригласить себя на мероприятие (обогащенное). Необязательный. По умолчанию ложь. | Записывается |
attachments[] | list | Файл вложений для мероприятия. Чтобы изменить вложения, параметр запроса Может быть не более 25 вложений на мероприятие, | |
attachments[]. fileId | string | Идентификатор прилагаемого файла. Только для чтения. Для файлов Drive Google это идентификатор соответствующей записи ресурса | |
attachments[]. fileUrl | string | URL -ссылка на вложение. Для добавления вложений файлов Google Drive используйте тот же формат, что и в свойстве Требуется при добавлении вложения. | Записывается |
attachments[]. iconLink | string | URL -ссылка на значок вложения. Это поле может быть изменено только для пользовательских сторонних вложений. | |
attachments[]. mimeType | string | Интернет -медиа -тип (тип MIME) привязанности. | |
attachments[]. title | string | Название вложения. | |
attendeesOmitted | boolean | Были ли участники быть опущены из представительства события. При получении события это может быть связано с ограничением, указанным параметром запроса maxAttendee . При обновлении события это можно использовать только для обновления ответа участника. Необязательный. По умолчанию ложь. | Записывается |
attendees[] | list | Участники мероприятия. См. Руководство по событиям с посетителями для получения дополнительной информации о планировании событий с другими пользователями календаря. Учетные записи услуг должны использовать делегирование полномочий по всей области для заполнения списка участников. | Записывается |
attendees[]. additionalGuests | integer | Количество дополнительных гостей. Необязательный. По умолчанию 0. | Записывается |
attendees[]. comment | string | Комментарий ответа участника. Необязательный. | Записывается |
attendees[]. displayName | string | Имя участника, если таковое имеется. Необязательный. | Записывается |
attendees[]. email | string | Адрес электронной почты участника, если доступен. Это поле должно присутствовать при добавлении участника. Это должен быть действительный адрес электронной почты в соответствии с RFC5322 . Требуется при добавлении посетителя. | Записывается |
attendees[]. id | string | Идентификатор профиля участника, если таковые имеются. | |
attendees[]. optional | boolean | Является ли это дополнительным посетителем. Необязательный. По умолчанию ложь. | Записывается |
attendees[]. organizer | boolean | Является ли посетитель организатором мероприятия. Только для чтения. По умолчанию ложь. | |
attendees[]. resource | boolean | Является ли участник ресурсом. Может быть установлен только тогда, когда участник будет добавлен в мероприятие впервые. Последующие модификации игнорируются. Необязательный. По умолчанию ложь. | Записывается |
attendees[]. responseStatus | string | Статус ответа участника. Возможные значения:
| Записывается |
attendees[]. self | boolean | Представляет ли эта запись календарь, в котором появляется эта копия события. Только для чтения. По умолчанию ложь. | |
colorId | string | Цвет события. Это идентификатор, относящийся к записи в разделе event определения цветов (см. Конечную точку цвета ). Необязательный. | Записывается |
conferenceData | nested object | Информация, связанная с конференцией, такая как подробности конференции Google Meet. Чтобы создать новые детали конференции, используйте поле createRequest . Чтобы сохранить свои изменения, не забудьте установить параметр запроса conferenceDataVersion на 1 для всех запросов на модификацию событий. | Записывается |
conferenceData. conferenceId | string | Идентификатор конференции. Можно использовать разработчики для отслеживания конференций, не следует отображать пользователям. Значение идентификатора формируется по -разному для каждого типа решения конференции:
| |
conferenceData. conferenceSolution | nested object | Решение конференции, такое как Google Meet. Неоставление для конференции с неудачным запросом на создание. Требуется либо | |
conferenceData.conferenceSolution. iconUri | string | Пользовательский значок для этого решения. | |
conferenceData.conferenceSolution. key | nested object | Ключ, который может однозначно определить решение для конференции для этого события. | |
conferenceData.conferenceSolution.key. type | string | Тип решения конференции. Если клиент сталкивается с незнакомым или пустым типом, он все равно должен быть в состоянии отображать точки входа. Однако это должно запретить модификации. Возможные значения:
| |
conferenceData.conferenceSolution. name | string | Пользовательский имени этого решения. Не локализован. | |
conferenceData. createRequest | nested object | Запрос на создание новой конференции и прикрепления ее к мероприятию. Данные генерируются асинхронно. Чтобы увидеть, присутствуют ли данные, проверьте поле status . Требуется либо | |
conferenceData.createRequest. conferenceSolutionKey | nested object | Решение на конференции, такое как Hangouts или Google Meet. | |
conferenceData.createRequest.conferenceSolutionKey. type | string | Тип решения конференции. Если клиент сталкивается с незнакомым или пустым типом, он все равно должен быть в состоянии отображать точки входа. Однако это должно запретить модификации. Возможные значения:
| |
conferenceData.createRequest. requestId | string | Уникальный идентификатор, созданный клиентом для этого запроса. Клиенты должны восстановить этот идентификатор для каждого нового запроса. Если предоставленный идентификатор такой же, как и для предыдущего запроса, запрос игнорируется. | |
conferenceData.createRequest. status | nested object | Статус конференции создает запрос. | |
conferenceData.createRequest.status. statusCode | string | Текущий статус конференции создает запрос. Только для чтения. Возможные значения:
| |
conferenceData. entryPoints[] | list | Информация о отдельных точках входа конференции, таких как URL -адреса или номера телефонов. Все они должны принадлежать к одной и той же конференции. Требуется либо | |
conferenceData.entryPoints[]. accessCode | string | Код доступа для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. entryPointType | string | Тип точки входа конференции. Возможные значения:
| |
conferenceData.entryPoints[]. label | string | Ярлык для URI. Видно для конечных пользователей. Не локализован. Максимальная длина составляет 512 символа. Примеры:
Необязательный. | |
conferenceData.entryPoints[]. meetingCode | string | Кодекс встречи для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. passcode | string | Пассный код для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { | |
conferenceData.entryPoints[]. password | string | Пароль для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. pin | string | PIN -код для доступа к конференции. Максимальная длина составляет 128 символов. При создании новых данных конференции заполняйте только подмножество полей { Необязательный. | |
conferenceData.entryPoints[]. uri | string | URI точки входа. Максимальная длина составляет 1300 символов. Формат:
| |
conferenceData. notes | string | Дополнительные примечания (например, инструкции от администратора домена, юридические уведомления) для отображения пользователю. Может содержать HTML. Максимальная длина составляет 2048 символов. Необязательный. | |
conferenceData. signature | string | Подпись данных конференции. Сгенерировано на стороне сервера. Неоставление для конференции с неудачным запросом на создание. Необязательно для конференции с ожидающим запросом на создание. | |
created | datetime | Время создания события (как временная метка RFC3339 ). Только для чтения. | |
creator | object | Создатель события. Только для чтения. | |
creator. displayName | string | Имя создателя, если доступно. | |
creator. email | string | Адрес электронной почты создателя, если доступен. | |
creator. id | string | Идентификатор профиля создателя, если таковой имеется. | |
creator. self | boolean | Соответствует ли создатель календарю, в котором появляется эта копия события. Только для чтения. По умолчанию ложь. | |
description | string | Описание события. Может содержать HTML. Необязательный. | Записывается |
end | nested object | (Эксклюзивное) время окончания мероприятия. Для повторяющегося события это время окончания первого экземпляра. | |
end. date | date | Дата, в формате «yyyy-mm-dd», если это событие на весь день. | Записывается |
end. dateTime | datetime | Время, как комбинированное значение даты (отформатировано в соответствии с RFC3339 ). Смещение часового пояса требуется, если только часовой пояс явно указан в timeZone . | Записывается |
end. timeZone | string | Часовой пояс, в котором указано время. (Отформатируется как имя базы данных IANA Time, например, «Европа/Цюрих».) Для повторяющихся событий требуется это поле и указывает часовой пояс, в котором рецидив расширяется. Для отдельных событий это поле является необязательным и указывает на пользовательский часовой пояс для начала/конца события. | Записывается |
endTimeUnspecified | boolean | На самом деле не определена ли время окончания. Время окончания по -прежнему обеспечивается по причинам совместимости, даже если этот атрибут установлен на True. По умолчанию ложь. | |
etag | etag | ETAG ресурса. | |
eventType | string | Конкретный тип события. Это не может быть изменено после создания события. Возможные значения:
| Записывается |
extendedProperties | object | Расширенные свойства мероприятия. | |
extendedProperties. private | object | Свойства, которые являются частными для копии события, которое появляется в этом календаре. | Записывается |
extendedProperties.private. (key) | string | Название частной собственности и соответствующее значение. | |
extendedProperties. shared | object | Свойства, которые разделяются между копиями мероприятия в календарях других участников. | Записывается |
extendedProperties.shared. (key) | string | Название общего свойства и соответствующего значения. | |
focusTimeProperties | nested object | Фокус времени событий. Используется, если eventType является focusTime . | writable |
focusTimeProperties. autoDeclineMode | string | Whether to decline meeting invitations which overlap Focus Time events. Valid values are declineNone , meaning that no meeting invitations are declined; declineAllConflictingInvitations , meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations , meaning that only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined. | |
focusTimeProperties. chatStatus | string | The status to mark the user in Chat and related products. This can be available or doNotDisturb . | |
focusTimeProperties. declineMessage | string | Response message to set if an existing event or new invitation is automatically declined by Calendar. | |
gadget | object | A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. | |
gadget. display | string | The gadget's display mode. Устарело. Возможные значения:
| writable |
gadget. height | integer | The gadget's height in pixels. The height must be an integer greater than 0. Optional. Устарело. | writable |
gadget. iconLink | string | The gadget's icon URL. The URL scheme must be HTTPS. Устарело. | writable |
gadget. link | string | The gadget's URL. The URL scheme must be HTTPS. Устарело. | writable |
gadget. preferences | object | Предпочтения. | writable |
gadget.preferences. (key) | string | The preference name and corresponding value. | |
gadget. title | string | The gadget's title. Устарело. | writable |
gadget. type | string | The gadget's type. Устарело. | writable |
gadget. width | integer | The gadget's width in pixels. The width must be an integer greater than 0. Optional. Устарело. | writable |
guestsCanInviteOthers | boolean | Whether attendees other than the organizer can invite others to the event. Необязательный. The default is True. | writable |
guestsCanModify | boolean | Whether attendees other than the organizer can modify the event. Необязательный. The default is False. | writable |
guestsCanSeeOtherGuests | boolean | Whether attendees other than the organizer can see who the event's attendees are. Необязательный. The default is True. | writable |
hangoutLink | string | An absolute link to the Google Hangout associated with this event. Read-only. | |
htmlLink | string | An absolute link to this event in the Google Calendar Web UI. Read-only. | |
iCalUID | string | Event unique identifier as defined in RFC5545 . It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the | |
id | string | Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
If you do not specify an ID, it will be automatically generated by the server. Note that the | writable |
kind | string | Type of the resource (" calendar#event "). | |
location | string | Geographic location of the event as free-form text. Необязательный. | writable |
locked | boolean | Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. | |
organizer | object | The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event. | writable |
organizer. displayName | string | The organizer's name, if available. | writable |
organizer. email | string | The organizer's email address, if available. It must be a valid email address as per RFC5322 . | writable |
organizer. id | string | The organizer's Profile ID, if available. | |
organizer. self | boolean | Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. | |
originalStartTime | nested object | For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. | |
originalStartTime. date | date | The date, in the format "yyyy-mm-dd", if this is an all-day event. | writable |
originalStartTime. 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 . | writable |
originalStartTime. timeZone | string | The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, eg "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. | writable |
outOfOfficeProperties | nested object | Out of office event data. Used if eventType is outOfOffice . | writable |
outOfOfficeProperties. autoDeclineMode | string | Whether to decline meeting invitations which overlap Out of office events. Valid values are declineNone , meaning that no meeting invitations are declined; declineAllConflictingInvitations , meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations , meaning that only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined. | |
outOfOfficeProperties. declineMessage | string | Response message to set if an existing event or new invitation is automatically declined by Calendar. | |
privateCopy | boolean | If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties . Необязательный. Immutable. The default is False. | |
recurrence[] | list | List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545 . Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. | writable |
recurringEventId | string | For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. | |
reminders | object | Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. | |
reminders. overrides[] | list | If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. | writable |
reminders.overrides[]. method | string | The method used by this reminder. Возможные значения:
Required when adding a reminder. | writable |
reminders.overrides[]. minutes | integer | Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder. | writable |
reminders. useDefault | boolean | Whether the default reminders of the calendar apply to the event. | writable |
sequence | integer | Sequence number as per iCalendar. | writable |
source | object | Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. | |
source. title | string | Title of the source; for example a title of a web page or an email subject. | writable |
source. url | string | URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. | writable |
start | nested object | The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. | |
start. date | date | The date, in the format "yyyy-mm-dd", if this is an all-day event. | writable |
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 . | writable |
start. timeZone | string | The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, eg "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. | writable |
status | string | Status of the event. Необязательный. Возможные значения:
| writable |
summary | string | Title of the event. | writable |
transparency | string | Whether the event blocks time on the calendar. Необязательный. Возможные значения:
| writable |
updated | datetime | Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. | |
visibility | string | Visibility of the event. Необязательный. Возможные значения:
| writable |
workingLocationProperties | nested object | Working location event data. | writable |
workingLocationProperties. customLocation | object | If present, specifies that the user is working from a custom location. | writable |
workingLocationProperties.customLocation. label | string | An optional extra label for additional information. | writable |
workingLocationProperties. homeOffice | any value | If present, specifies that the user is working at home. | writable |
workingLocationProperties. officeLocation | object | If present, specifies that the user is working from an office. | writable |
workingLocationProperties.officeLocation. buildingId | string | An optional building identifier. This should reference a building ID in the organization's Resources database. | writable |
workingLocationProperties.officeLocation. deskId | string | An optional desk identifier. | writable |
workingLocationProperties.officeLocation. floorId | string | An optional floor identifier. | writable |
workingLocationProperties.officeLocation. floorSectionId | string | An optional floor section identifier. | writable |
workingLocationProperties.officeLocation. label | string | The office name that's displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization's Resources database. | writable |
workingLocationProperties. type | string | Type of the working location. Возможные значения:
Required when adding working location properties. | writable |
Методы
- удалить
- Deletes an event.
- получать
- Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the
iCalUID
parameter . - импортировать
- Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an
eventType
ofdefault
may be imported.Deprecated behavior: If a non-
default
event is imported, its type will be changed todefault
and any event-type-specific properties it may have will be dropped. - вставлять
- Creates an event.
- instances
- Returns instances of the specified recurring event.
- список
- Returns events on the specified calendar.
- двигаться
- Moves an event to another calendar, ie changes an event's organizer. Note that only
default
events can be moved;birthday
,focusTime
,fromGmail
,outOfOffice
andworkingLocation
events cannot be moved. - пластырь
- Updates an event. This method supports patch semantics. Note that each patch request consumes three quota units; prefer using a
get
followed by anupdate
. The field values you specify replace the existing values. Fields that you don't specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements. - quickAdd
- Creates an event based on a simple text string.
- обновлять
- Updates an event. This method does not support patch semantics and always updates the entire event resource. To do a partial update, perform a
get
followed by anupdate
using etags to ensure atomicity. - смотреть
- Watch for changes to Events resources.
The Calendar API provides different flavors of event resources, more information can be found in About events .
For a list of methods for this resource, see the end of this page.
Resource representations
{ "kind": "calendar#event", "etag": etag, "id": string, "status": string, "htmlLink": string, "created": datetime, "updated": datetime, "summary": string, "description": string, "location": string, "colorId": string, "creator": { "id": string, "email": string, "displayName": string, "self": boolean }, "organizer": { "id": string, "email": string, "displayName": string, "self": boolean }, "start": { "date": date, "dateTime": datetime, "timeZone": string }, "end": { "date": date, "dateTime": datetime, "timeZone": string }, "endTimeUnspecified": boolean, "recurrence": [ string ], "recurringEventId": string, "originalStartTime": { "date": date, "dateTime": datetime, "timeZone": string }, "transparency": string, "visibility": string, "iCalUID": string, "sequence": integer, "attendees": [ { "id": string, "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } ], "attendeesOmitted": boolean, "extendedProperties": { "private": { (key): string }, "shared": { (key): string } }, "hangoutLink": string, "conferenceData": { "createRequest": { "requestId": string, "conferenceSolutionKey": { "type": string }, "status": { "statusCode": string } }, "entryPoints": [ { "entryPointType": string, "uri": string, "label": string, "pin": string, "accessCode": string, "meetingCode": string, "passcode": string, "password": string } ], "conferenceSolution": { "key": { "type": string }, "name": string, "iconUri": string }, "conferenceId": string, "signature": string, "notes": string, }, "gadget": { "type": string, "title": string, "link": string, "iconLink": string, "width": integer, "height": integer, "display": string, "preferences": { (key): string } }, "anyoneCanAddSelf": boolean, "guestsCanInviteOthers": boolean, "guestsCanModify": boolean, "guestsCanSeeOtherGuests": boolean, "privateCopy": boolean, "locked": boolean, "reminders": { "useDefault": boolean, "overrides": [ { "method": string, "minutes": integer } ] }, "source": { "url": string, "title": string }, "workingLocationProperties": { "type": string, "homeOffice": (value), "customLocation": { "label": string }, "officeLocation": { "buildingId": string, "floorId": string, "floorSectionId": string, "deskId": string, "label": string } }, "outOfOfficeProperties": { "autoDeclineMode": string, "declineMessage": string }, "focusTimeProperties": { "autoDeclineMode": string, "declineMessage": string, "chatStatus": string }, "attachments": [ { "fileUrl": string, "title": string, "mimeType": string, "iconLink": string, "fileId": string } ], "eventType": string }
Имя свойства | Ценить | Описание | Примечания |
---|---|---|---|
anyoneCanAddSelf | boolean | Whether anyone can invite themselves to the event (deprecated). Необязательный. The default is False. | writable |
attachments[] | list | File attachments for the event. In order to modify attachments the There can be at most 25 attachments per event, | |
attachments[]. fileId | string | ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding | |
attachments[]. fileUrl | string | URL link to the attachment. For adding Google Drive file attachments use the same format as in Required when adding an attachment. | writable |
attachments[]. iconLink | string | URL link to the attachment's icon. This field can only be modified for custom third-party attachments. | |
attachments[]. mimeType | string | Internet media type (MIME type) of the attachment. | |
attachments[]. title | string | Attachment title. | |
attendeesOmitted | boolean | Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Необязательный. The default is False. | writable |
attendees[] | list | The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. | writable |
attendees[]. additionalGuests | integer | Number of additional guests. Необязательный. The default is 0. | writable |
attendees[]. comment | string | The attendee's response comment. Необязательный. | writable |
attendees[]. displayName | string | The attendee's name, if available. Необязательный. | writable |
attendees[]. email | string | The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322 . Required when adding an attendee. | writable |
attendees[]. id | string | The attendee's Profile ID, if available. | |
attendees[]. optional | boolean | Whether this is an optional attendee. Необязательный. The default is False. | writable |
attendees[]. organizer | boolean | Whether the attendee is the organizer of the event. Read-only. The default is False. | |
attendees[]. resource | boolean | Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Необязательный. The default is False. | writable |
attendees[]. responseStatus | string | The attendee's response status. Возможные значения:
| writable |
attendees[]. self | boolean | Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. | |
colorId | string | The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint ). Необязательный. | writable |
conferenceData | nested object | The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. | writable |
conferenceData. conferenceId | string | The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. The ID value is formed differently for each conference solution type:
| |
conferenceData. conferenceSolution | nested object | The conference solution, such as Google Meet. Unset for a conference with a failed create request. Either | |
conferenceData.conferenceSolution. iconUri | string | The user-visible icon for this solution. | |
conferenceData.conferenceSolution. key | nested object | The key which can uniquely identify the conference solution for this event. | |
conferenceData.conferenceSolution.key. type | string | The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are:
| |
conferenceData.conferenceSolution. name | string | The user-visible name of this solution. Not localized. | |
conferenceData. createRequest | nested object | A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field. Either | |
conferenceData.createRequest. conferenceSolutionKey | nested object | The conference solution, such as Hangouts or Google Meet. | |
conferenceData.createRequest.conferenceSolutionKey. type | string | The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are:
| |
conferenceData.createRequest. requestId | string | The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. | |
conferenceData.createRequest. status | nested object | The status of the conference create request. | |
conferenceData.createRequest.status. statusCode | string | The current status of the conference create request. Read-only. The possible values are:
| |
conferenceData. entryPoints[] | list | Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either | |
conferenceData.entryPoints[]. accessCode | string | The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of { Необязательный. | |
conferenceData.entryPoints[]. entryPointType | string | The type of the conference entry point. Возможные значения:
| |
conferenceData.entryPoints[]. label | string | The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples:
Необязательный. | |
conferenceData.entryPoints[]. meetingCode | string | The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of { Необязательный. | |
conferenceData.entryPoints[]. passcode | string | The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of { | |
conferenceData.entryPoints[]. password | string | The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of { Необязательный. | |
conferenceData.entryPoints[]. pin | string | The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of { Необязательный. | |
conferenceData.entryPoints[]. uri | string | The URI of the entry point. The maximum length is 1300 characters. Формат:
| |
conferenceData. notes | string | Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Необязательный. | |
conferenceData. signature | string | The signature of the conference data. Generated on server side. Unset for a conference with a failed create request. Optional for a conference with a pending create request. | |
created | datetime | Creation time of the event (as a RFC3339 timestamp). Read-only. | |
creator | object | The creator of the event. Read-only. | |
creator. displayName | string | The creator's name, if available. | |
creator. email | string | The creator's email address, if available. | |
creator. id | string | The creator's Profile ID, if available. | |
creator. self | boolean | Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. | |
description | string | Description of the event. Can contain HTML. Необязательный. | writable |
end | nested object | The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. | |
end. date | date | The date, in the format "yyyy-mm-dd", if this is an all-day event. | writable |
end. 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 . | writable |
end. timeZone | string | The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, eg "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. | writable |
endTimeUnspecified | boolean | Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. | |
etag | etag | ETag of the resource. | |
eventType | string | Specific type of the event. This cannot be modified after the event is created. Возможные значения:
| writable |
extendedProperties | object | Extended properties of the event. | |
extendedProperties. private | object | Properties that are private to the copy of the event that appears on this calendar. | writable |
extendedProperties.private. (key) | string | The name of the private property and the corresponding value. | |
extendedProperties. shared | object | Properties that are shared between copies of the event on other attendees' calendars. | writable |
extendedProperties.shared. (key) | string | The name of the shared property and the corresponding value. | |
focusTimeProperties | nested object | Focus Time event data. Used if eventType is focusTime . | writable |
focusTimeProperties. autoDeclineMode | string | Whether to decline meeting invitations which overlap Focus Time events. Valid values are declineNone , meaning that no meeting invitations are declined; declineAllConflictingInvitations , meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations , meaning that only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined. | |
focusTimeProperties. chatStatus | string | The status to mark the user in Chat and related products. This can be available or doNotDisturb . | |
focusTimeProperties. declineMessage | string | Response message to set if an existing event or new invitation is automatically declined by Calendar. | |
gadget | object | A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. | |
gadget. display | string | The gadget's display mode. Устарело. Возможные значения:
| writable |
gadget. height | integer | The gadget's height in pixels. The height must be an integer greater than 0. Optional. Устарело. | writable |
gadget. iconLink | string | The gadget's icon URL. The URL scheme must be HTTPS. Устарело. | writable |
gadget. link | string | The gadget's URL. The URL scheme must be HTTPS. Устарело. | writable |
gadget. preferences | object | Предпочтения. | writable |
gadget.preferences. (key) | string | The preference name and corresponding value. | |
gadget. title | string | The gadget's title. Устарело. | writable |
gadget. type | string | The gadget's type. Устарело. | writable |
gadget. width | integer | The gadget's width in pixels. The width must be an integer greater than 0. Optional. Устарело. | writable |
guestsCanInviteOthers | boolean | Whether attendees other than the organizer can invite others to the event. Необязательный. The default is True. | writable |
guestsCanModify | boolean | Whether attendees other than the organizer can modify the event. Необязательный. The default is False. | writable |
guestsCanSeeOtherGuests | boolean | Whether attendees other than the organizer can see who the event's attendees are. Необязательный. The default is True. | writable |
hangoutLink | string | An absolute link to the Google Hangout associated with this event. Read-only. | |
htmlLink | string | An absolute link to this event in the Google Calendar Web UI. Read-only. | |
iCalUID | string | Event unique identifier as defined in RFC5545 . It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the | |
id | string | Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
If you do not specify an ID, it will be automatically generated by the server. Note that the | writable |
kind | string | Type of the resource (" calendar#event "). | |
location | string | Geographic location of the event as free-form text. Необязательный. | writable |
locked | boolean | Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. | |
organizer | object | The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event. | writable |
organizer. displayName | string | The organizer's name, if available. | writable |
organizer. email | string | The organizer's email address, if available. It must be a valid email address as per RFC5322 . | writable |
organizer. id | string | The organizer's Profile ID, if available. | |
organizer. self | boolean | Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. | |
originalStartTime | nested object | For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. | |
originalStartTime. date | date | The date, in the format "yyyy-mm-dd", if this is an all-day event. | writable |
originalStartTime. 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 . | writable |
originalStartTime. timeZone | string | The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, eg "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. | writable |
outOfOfficeProperties | nested object | Out of office event data. Used if eventType is outOfOffice . | writable |
outOfOfficeProperties. autoDeclineMode | string | Whether to decline meeting invitations which overlap Out of office events. Valid values are declineNone , meaning that no meeting invitations are declined; declineAllConflictingInvitations , meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations , meaning that only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined. | |
outOfOfficeProperties. declineMessage | string | Response message to set if an existing event or new invitation is automatically declined by Calendar. | |
privateCopy | boolean | If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties . Необязательный. Immutable. The default is False. | |
recurrence[] | list | List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545 . Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. | writable |
recurringEventId | string | For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. | |
reminders | object | Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. | |
reminders. overrides[] | list | If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. | writable |
reminders.overrides[]. method | string | The method used by this reminder. Возможные значения:
Required when adding a reminder. | writable |
reminders.overrides[]. minutes | integer | Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder. | writable |
reminders. useDefault | boolean | Whether the default reminders of the calendar apply to the event. | writable |
sequence | integer | Sequence number as per iCalendar. | writable |
source | object | Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. | |
source. title | string | Title of the source; for example a title of a web page or an email subject. | writable |
source. url | string | URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. | writable |
start | nested object | The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. | |
start. date | date | The date, in the format "yyyy-mm-dd", if this is an all-day event. | writable |
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 . | writable |
start. timeZone | string | The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, eg "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. | writable |
status | string | Status of the event. Необязательный. Возможные значения:
| writable |
summary | string | Title of the event. | writable |
transparency | string | Whether the event blocks time on the calendar. Необязательный. Возможные значения:
| writable |
updated | datetime | Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. | |
visibility | string | Visibility of the event. Необязательный. Возможные значения:
| writable |
workingLocationProperties | nested object | Working location event data. | writable |
workingLocationProperties. customLocation | object | If present, specifies that the user is working from a custom location. | writable |
workingLocationProperties.customLocation. label | string | An optional extra label for additional information. | writable |
workingLocationProperties. homeOffice | any value | If present, specifies that the user is working at home. | writable |
workingLocationProperties. officeLocation | object | If present, specifies that the user is working from an office. | writable |
workingLocationProperties.officeLocation. buildingId | string | An optional building identifier. This should reference a building ID in the organization's Resources database. | writable |
workingLocationProperties.officeLocation. deskId | string | An optional desk identifier. | writable |
workingLocationProperties.officeLocation. floorId | string | An optional floor identifier. | writable |
workingLocationProperties.officeLocation. floorSectionId | string | An optional floor section identifier. | writable |
workingLocationProperties.officeLocation. label | string | The office name that's displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization's Resources database. | writable |
workingLocationProperties. type | string | Type of the working location. Возможные значения:
Required when adding working location properties. | writable |
Методы
- удалить
- Deletes an event.
- получать
- Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the
iCalUID
parameter . - импортировать
- Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an
eventType
ofdefault
may be imported.Deprecated behavior: If a non-
default
event is imported, its type will be changed todefault
and any event-type-specific properties it may have will be dropped. - вставлять
- Creates an event.
- instances
- Returns instances of the specified recurring event.
- список
- Returns events on the specified calendar.
- двигаться
- Moves an event to another calendar, ie changes an event's organizer. Note that only
default
events can be moved;birthday
,focusTime
,fromGmail
,outOfOffice
andworkingLocation
events cannot be moved. - пластырь
- Updates an event. This method supports patch semantics. Note that each patch request consumes three quota units; prefer using a
get
followed by anupdate
. The field values you specify replace the existing values. Fields that you don't specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements. - quickAdd
- Creates an event based on a simple text string.
- обновлять
- Updates an event. This method does not support patch semantics and always updates the entire event resource. To do a partial update, perform a
get
followed by anupdate
using etags to ensure atomicity. - смотреть
- Watch for changes to Events resources.