Events

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
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}
Название объекта недвижимости Ценить Описание Примечания
anyoneCanAddSelf boolean Возможность самостоятельного приглашения на мероприятие (устаревшая функция). Необязательный параметр. По умолчанию — False. записываемый
attachments[] list Прикрепленные файлы к мероприятию.

Для изменения вложений параметр запроса supportsAttachments должен быть установлен в true .

На одно мероприятие допускается максимум 25 дополнительных устройств.

attachments[]. fileId string Идентификатор прикрепленного файла. Только для чтения.

Для файлов Google Drive это идентификатор соответствующей записи ресурса Files в API Google Drive.

attachments[]. fileUrl string Ссылка на вложение.

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

Обязательно при добавлении вложения.

 записываемый
attachments[]. mimeType string Тип интернет-медиа (MIME-тип) вложения.
attachments[]. title string Название вложения.
attendeesOmitted boolean Указывает, могли ли участники быть пропущены в представлении события. При получении события это может быть связано с ограничением, указанным в параметре запроса maxAttendee . При обновлении события этот параметр может использоваться для обновления только ответа участника. Необязательный параметр. По умолчанию — False. записываемый
attendees[] list Участники мероприятия. Дополнительную информацию о планировании мероприятий с другими пользователями календаря см. в руководстве «Мероприятия с участниками» . Для заполнения списка участников служебным учетным записям необходимо использовать делегирование полномочий в масштабе всего домена . записываемый
attendees[]. additionalGuests integer Количество дополнительных гостей. Необязательно. По умолчанию — 0. записываемый
attendees[]. comment string Комментарий участника. Необязательно. записываемый
attendees[]. displayName string Имя участника (если имеется). (Необязательно). записываемый
attendees[]. email string Адрес электронной почты участника, если он имеется. Это поле должно присутствовать при добавлении участника. Адрес электронной почты должен соответствовать требованиям RFC5322 .

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

 записываемый
attendees[]. id string Идентификатор профиля участника (если имеется).
attendees[]. optional boolean Является ли это необязательным участником. Необязательно. Значение по умолчанию — False. записываемый
attendees[]. organizer boolean Указывает, является ли участник организатором мероприятия. Только для чтения. Значение по умолчанию — False.
attendees[]. resource boolean Указывает, является ли участник ресурсом. Этот параметр можно установить только при первом добавлении участника к мероприятию. Последующие изменения игнорируются. Необязательный параметр. Значение по умолчанию — False. записываемый
attendees[]. responseStatus string Статус ответа участника. Возможные значения:
  • " needsAction " - Участник не ответил на приглашение (рекомендуется для новых мероприятий).
  • « declined » — Участник отклонил приглашение.
  • « tentative » — Участник предварительно принял приглашение.
  • " accepted " - Участник принял приглашение.
 записываемый
attendees[]. self boolean Указывает, соответствует ли данная запись календарю, на котором отображается этот экземпляр события. Только для чтения. Значение по умолчанию — False.
birthdayProperties nested object Данные о дне рождения или особом событии. Используется, если eventType имеет значение "birthday" . Неизменяемый параметр. записываемый
birthdayProperties. contact string Имя ресурса контакта, к которому привязано это событие дня рождения. Его можно использовать для получения сведений о контакте из People API . Формат: "people/c12345" . Только для чтения.
birthdayProperties. customTypeName string Для этого события указан пользовательский тип метки. Она заполняется, если для birthdayProperties.type установлено значение "custom" . Только для чтения.
birthdayProperties. type string Тип дня рождения или особого события. Возможные значения:
  • "anniversary" — годовщина, отличная от дня рождения. Всегда имеет contact .
  • "birthday" — событие, связанное с днем ​​рождения. Это значение по умолчанию.
  • "custom" — Особая дата, метка которой дополнительно указывается в поле customTypeName . Всегда имеет contact .
  • "other" - Особая дата, не подпадающая под другие категории и не имеющая пользовательской метки. Всегда имеет contact .
  • "self" - Дата рождения владельца календаря. Не может быть contact .
API календаря поддерживает создание событий только с типом "birthday" . Тип нельзя изменить после создания события.		 записываемый
colorId string Цвет события. Это идентификатор, указывающий на запись в разделе event определения цветов (см. конечную точку colors ). Необязательно. записываемый
conferenceData nested object Информация, относящаяся к конференции, например, подробности конференции Google Meet. Для создания новых сведений о конференции используйте поле createRequest . Чтобы сохранить изменения, не забудьте установить параметр запроса conferenceDataVersion равным 1 для всех запросов на изменение событий. записываемый
conferenceData. conferenceId string Идентификатор конференции.

Может использоваться разработчиками для отслеживания конференций, не должно отображаться пользователям.

Идентификационный номер формируется по-разному для каждого типа конференц-решения:

  • eventHangout : Идентификатор не задан. (Этот тип конференции устарел.)
  • eventNamedHangout : ID — это название видеоконференции. (Этот тип конференции устарел.)
  • hangoutsMeet : ID — это 10-буквенный код встречи, например aaa-bbbb-ccc .
  • addOn : ID определяется сторонним поставщиком.
Необязательный.

conferenceData. conferenceSolution nested object Решения для проведения конференций, такие как Google Meet.

Не задано для конференции, запрос на создание которой не удался.

Требуется либо conferenceSolution и как минимум одна entryPoint , либо createRequest .

conferenceData.conferenceSolution. iconUri string Значок, видимый пользователю для данного решения.
conferenceData.conferenceSolution. key nested object Ключ, позволяющий однозначно определить решение для проведения конференции в рамках данного мероприятия.
conferenceData.conferenceSolution.key. type string Тип решения для проведения конференций.

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

Возможные значения:

  • "eventHangout" для Hangouts для потребителей (устарело; существующие мероприятия могут отображать этот тип решения для конференций, но новые конференции создать нельзя).
  • "eventNamedHangout" для классических пользователей Hangouts for Google Workspace (устарело; существующие события могут отображать этот тип конференц-решения, но новые конференции создать нельзя).
  • "hangoutsMeet" для Google Meet (http://meet.google.com)
  • "addOn" для сторонних поставщиков конференц-услуг

conferenceData.conferenceSolution. name string Название решения, видимое пользователю. Не локализовано.
conferenceData. createRequest nested object Запрос на создание новой конференции и прикрепление её к мероприятию. Данные генерируются асинхронно. Чтобы проверить наличие данных, проверьте поле status .

Требуется либо conferenceSolution и как минимум одна entryPoint , либо createRequest .

conferenceData.createRequest. conferenceSolutionKey nested object Решения для проведения конференций, такие как Hangouts или Google Meet.
conferenceData.createRequest.conferenceSolutionKey. type string Тип решения для проведения конференций.

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

Возможные значения:

  • "eventHangout" для Hangouts для потребителей (устарело; существующие мероприятия могут отображать этот тип решения для конференций, но новые конференции создать нельзя).
  • "eventNamedHangout" для классических пользователей Hangouts for Google Workspace (устарело; существующие события могут отображать этот тип конференц-решения, но новые конференции создать нельзя).
  • "hangoutsMeet" для Google Meet (http://meet.google.com)
  • "addOn" для сторонних поставщиков конференц-услуг

conferenceData.createRequest. requestId string Уникальный идентификатор, сгенерированный клиентом для этого запроса.

Клиентам следует генерировать этот идентификатор заново для каждого нового запроса. Если предоставленный идентификатор совпадает с идентификатором предыдущего запроса, запрос игнорируется.

conferenceData.createRequest. status nested object Статус запроса на создание заявки на конференцию.
conferenceData.createRequest.status. statusCode string Текущий статус запроса на создание заявки на конференцию. Только для чтения.

Возможные значения:

  • "pending" : запрос на создание конференции все еще обрабатывается.
  • "success" : запрос на создание конференции выполнен успешно, точки входа заполнены.
  • "failure" : запрос на создание конференции не удался, отсутствуют точки входа.

conferenceData. entryPoints[] list Информация об отдельных точках доступа к конференции, таких как URL-адреса или номера телефонов.

Все они должны быть участниками одной и той же конференции.

Требуется либо conferenceSolution и как минимум одна entryPoint , либо createRequest .

conferenceData.entryPoints[]. accessCode string Код доступа для участия в конференции. Максимальная длина — 128 символов.

При создании новых данных для конференции заполняйте только подмножество полей { meetingCode , accessCode , passcode , password , pin }, соответствующих терминологии, используемой организатором конференции. Отображаться должны только заполненные поля.

Необязательный.

conferenceData.entryPoints[]. entryPointType string Тип точки входа на конференцию.

Возможные значения:

  • "video" — присоединение к конференции по протоколу HTTP. Конференция может иметь ноль или одну точку входа video .
  • "phone" — присоединение к конференции путем набора телефонного номера. Конференция может иметь ноль или более точек подключения phone .
  • "sip" — присоединение к конференции по протоколу SIP. Конференция может иметь ноль или одну точку входа по sip .
  • "more" — дополнительные инструкции по подключению к конференции, например, дополнительные номера телефонов. Конференция может иметь ноль или одну more точку входа. Конференция, имеющая только одну more точку входа, не считается действительной.

conferenceData.entryPoints[]. label string Метка для URI. Видна конечным пользователям. Не локализована. Максимальная длина — 512 символов.

Примеры:

  • video : meet.google.com/aaa-bbbb-ccc
  • Для phone : +1 123 268 2601
  • Для связи по sip : 12345678@altostrat.com
  • more : не должно быть заполнено.

Необязательный.

conferenceData.entryPoints[]. meetingCode string Код доступа к конференции. Максимальная длина — 128 символов.

При создании новых данных для конференции заполняйте только подмножество полей { meetingCode , accessCode , passcode , password , pin }, соответствующих терминологии, используемой организатором конференции. Отображаться должны только заполненные поля.

Необязательный.

conferenceData.entryPoints[]. passcode string Код доступа к конференции. Максимальная длина — 128 символов.

При создании новых данных для конференции заполняйте только подмножество полей { meetingCode , accessCode , passcode , password , pin }, соответствующих терминологии, используемой организатором конференции. Отображаться должны только заполненные поля.

conferenceData.entryPoints[]. password string Пароль для доступа к конференции. Максимальная длина — 128 символов.

При создании новых данных для конференции заполняйте только подмножество полей { meetingCode , accessCode , passcode , password , pin }, соответствующих терминологии, используемой организатором конференции. Отображаться должны только заполненные поля.

Необязательный.

conferenceData.entryPoints[]. pin string ПИН-код для доступа к конференции. Максимальная длина — 128 символов.

При создании новых данных для конференции заполняйте только подмножество полей { meetingCode , accessCode , passcode , password , pin }, соответствующих терминологии, используемой организатором конференции. Отображаться должны только заполненные поля.

Необязательный.

conferenceData.entryPoints[]. uri string URI точки входа. Максимальная длина — 1300 символов.

Формат:

  • Для video требуется схема http: или https:
  • Для phone требуется схема tel: URI должен включать всю последовательность набора номера (например, tel:+12345678900,,,123456789;1234).
  • Для sip sip: требуется указать схему, например, sip:12345678@myprovider.com.
  • Для получения more требуется схема http: или https:

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 Указывает, соответствует ли создатель календарю, на котором отображается данная копия события. Только для чтения. По умолчанию — False.
description string Описание мероприятия. Может содержать HTML-код. Необязательно. записываемый
end nested object Время окончания события (исключая указанное время). Для повторяющегося события это время окончания первого его экземпляра.
end. date date Дата в формате "гггг-мм-дд", если мероприятие длится весь день. записываемый
end. dateTime datetime Время в виде объединенного значения даты и времени (отформатированного в соответствии с RFC3339 ). Смещение часового пояса обязательно, если часовой пояс явно не указан в timeZone . записываемый
end. timeZone string Часовой пояс, в котором указано время. (Форматируется как имя базы данных часовых поясов IANA, например, "Europe/Zurich".) Для повторяющихся событий это поле обязательно и указывает часовой пояс, в котором разворачивается повторяющееся событие. Для разовых событий это поле необязательно и указывает пользовательский часовой пояс для начала/окончания события. записываемый
endTimeUnspecified boolean Указывается, действительно ли время окончания не указано. Время окончания указывается по соображениям совместимости, даже если для этого параметра установлено значение True. Значение по умолчанию — False.
etag etag ETag ресурса.
eventType string Конкретный тип события. Изменить его после создания события невозможно. Возможные значения:
  • « birthday » — особое мероприятие, которое проводится в течение всего дня и повторяется ежегодно.
  • " default " - Обычное событие, не требующее дальнейшего уточнения.
  • " focusTime " — событие, указывающее на момент фокусировки.
  • " fromGmail " — событие от Gmail. Создать событие такого типа невозможно.
  • " outOfOffice " - An out-of-office event.
  • " workingLocation " - Событие, указывающее место работы.
 записываемый
extendedProperties object Расширенные свойства события.
extendedProperties. private object Свойства, являющиеся частными для копии события, отображаемой в этом календаре. записываемый
extendedProperties.private. (key) string Название частной собственности и соответствующая стоимость.
extendedProperties. shared object Свойства, которые используются совместно в разных календарях участников мероприятия. записываемый
extendedProperties.shared. (key) string Название объекта совместного пользования и его стоимость.
focusTimeProperties nested object Данные события Focus Time. Используется, если 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 Режим отображения гаджета. Устарело. Возможные значения:
  • « icon » — этот гаджет отображается рядом с названием события в календаре.
  • " chip " — гаджет отображается при нажатии на событие.
 записываемый
gadget. height integer Высота гаджета в пикселях. Высота должна быть целым числом больше 0. Необязательный параметр. Устарело. записываемый
gadget. preferences object Настройки. записываемый
gadget.preferences. (key) string Название параметра и соответствующее значение.
gadget. title string Название гаджета. Устарело. записываемый
gadget. type string Тип гаджета. Устарело. записываемый
gadget. width integer Ширина гаджета в пикселях. Ширина должна быть целым числом больше 0. Необязательный параметр. Устарело. записываемый
guestsCanInviteOthers boolean Позволяет ли другим участникам, помимо организатора, приглашать других на мероприятие. Необязательный параметр. По умолчанию — True. записываемый
guestsCanModify boolean Позволяет ли другим участникам, помимо организатора, изменять мероприятие. Необязательный параметр. По умолчанию — False. записываемый
guestsCanSeeOtherGuests boolean Позволяет ли другим участникам, помимо организатора, видеть, кто является участниками мероприятия. Необязательный параметр. По умолчанию — True. записываемый
iCalUID string Уникальный идентификатор события, как определено в RFC5545 . Он используется для однозначной идентификации событий в различных системах календаря и должен быть указан при импорте событий с помощью метода импорта .

Обратите внимание, что iCalUID и id не идентичны, и при создании события следует указывать только один из них. Одно из различий в их семантике заключается в том, что в повторяющихся событиях все экземпляры одного события имеют разные id , в то время как все они используют один и тот же iCalUID . Чтобы получить событие по его iCalUID , вызовите метод events.list, используя параметр iCalUID . Чтобы получить событие по его id , вызовите метод events.get .

id string Непрозрачный идентификатор события. При создании новых разовых или повторяющихся событий можно указать их идентификаторы. Указанные идентификаторы должны соответствовать следующим правилам:
  • В идентификаторе допускаются символы, используемые в кодировке base32hex, а именно строчные буквы av и цифры 0-9 (см. раздел 3.1.2 в RFC2938).
  • Длина идентификатора должна составлять от 5 до 1024 символов.
  • Идентификатор должен быть уникальным для каждого календаря.
Ввиду глобальной распределенности системы мы не можем гарантировать обнаружение коллизий идентификаторов во время создания события. Для минимизации риска коллизий мы рекомендуем использовать проверенный алгоритм UUID, например, описанный в RFC4122 .

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

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

 записываемый
kind string Тип ресурса (" calendar#event ").
location string Географическое местоположение мероприятия в виде произвольного текста. Необязательно. записываемый
locked boolean Является ли это заблокированной копией события, в которой нельзя вносить изменения в основные поля события: «краткое описание», «описание», «местоположение», «начало», «конец» или «повторение». По умолчанию — False. Только для чтения.
organizer object Организатор мероприятия. Если организатор также является участником, это указывается отдельной записью в attendees , где поле organizer установлено в значение «True». Для изменения организатора используйте операцию перемещения . Только для чтения, за исключением случаев импорта мероприятия. записываемый
organizer. displayName string Имя организатора, если известно. записываемый
organizer. email string Адрес электронной почты организатора, если таковой имеется. Он должен быть действительным адресом электронной почты в соответствии с RFC5322 . записываемый
organizer. id string Идентификатор профиля организатора, если таковой имеется.
organizer. self boolean Указывает, соответствует ли организатор календарю, в котором отображается данная копия мероприятия. Только для чтения. По умолчанию — False.
originalStartTime nested object Для экземпляра повторяющегося события это время, в которое это событие должно было бы начаться в соответствии с данными о повторяемости в повторяющемся событии, идентифицированном по recurringEventId. Оно однозначно идентифицирует экземпляр в серии повторяющихся событий, даже если экземпляр был перемещен на другое время. Неизменяемый.
originalStartTime. date date Дата в формате "гггг-мм-дд", если мероприятие длится весь день. записываемый
originalStartTime. dateTime datetime Время в виде объединенного значения даты и времени (отформатированного в соответствии с RFC3339 ). Смещение часового пояса обязательно, если часовой пояс явно не указан в timeZone . записываемый
originalStartTime. timeZone string Часовой пояс, в котором указано время. (Форматируется как имя базы данных часовых поясов IANA, например, "Europe/Zurich".) Для повторяющихся событий это поле обязательно и указывает часовой пояс, в котором разворачивается повторяющееся событие. Для разовых событий это поле необязательно и указывает пользовательский часовой пояс для начала/окончания события. записываемый
outOfOfficeProperties nested object Данные о событии "Вне офиса". Используется, если eventType имеет значение outOfOffice . записываемый
outOfOfficeProperties. autoDeclineMode string Следует ли отклонять приглашения на совещания, которые совпадают с событиями "Вне офиса". Допустимые значения: declineNone , что означает отсутствие отклонений приглашений на совещания; declineAllConflictingInvitations , что означает отклонение всех конфликтующих приглашений на совещания, которые противоречат данному событию; и declineOnlyNewConflictingInvitations , что означает отклонение только новых конфликтующих приглашений на совещания, поступивших во время действия события "Вне офиса".
outOfOfficeProperties. declineMessage string Сообщение-ответ, которое устанавливается в случае автоматического отклонения существующего события или нового приглашения в Календаре.
privateCopy boolean Если установлено значение True, распространение событий отключено. Обратите внимание, что это не то же самое, что частные свойства событий . Необязательный параметр. Неизменяемый. Значение по умолчанию — False.
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 Метод, используемый в этом напоминании. Возможные значения:
  • " email " - Напоминания отправляются по электронной почте.
  • " popup " — напоминания отправляются через всплывающее окно в пользовательском интерфейсе.

Обязательно при добавлении напоминания.

 записываемый
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, например, "Europe/Zurich".) Для повторяющихся событий это поле обязательно и указывает часовой пояс, в котором разворачивается повторяющееся событие. Для разовых событий это поле необязательно и указывает пользовательский часовой пояс для начала/окончания события. записываемый
status string Статус события. Необязательный параметр. Возможные значения:
  • « confirmed » — Событие подтверждено. Это статус по умолчанию.
  • « tentative » — Событие предварительно подтверждено.
  • " cancelled " — событие отменено (удалено). Метод list возвращает отмененные события только при инкрементальной синхронизации (если указаны syncToken или updatedMin ) или если флаг showDeleted установлен в true . Метод get всегда возвращает их.

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

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

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

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

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

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

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

 записываемый
summary string Название мероприятия. записываемый
transparency string Определяет, блокирует ли событие время в календаре. Необязательный параметр. Возможные значения:
  • " opaque " — значение по умолчанию. Событие блокирует время в календаре. Это эквивалентно установке параметра "Показывать как занято" в пользовательском интерфейсе календаря.
  • « transparent » — событие не блокирует время в календаре. Это эквивалентно установке параметра «Показать как» в значение «Доступно» в пользовательском интерфейсе календаря.
 записываемый
updated datetime Время последнего изменения основных данных события (в формате метки времени RFC3339 ). Обновление напоминаний о событиях не приведет к изменению этого значения. Только для чтения.
visibility string Видимость события. Необязательный параметр. Возможные значения:
  • " default " — Использует видимость событий в календаре по умолчанию. Это значение по умолчанию.
  • " public " — мероприятие является публичным, и подробная информация о мероприятии видна всем, кто просматривает календарь.
  • " private " — мероприятие является приватным, и только участники мероприятия могут просматривать его подробности.
  • " confidential " — Мероприятие является частным. Это значение указано для обеспечения совместимости.
 записываемый
workingLocationProperties nested object Данные о событиях, связанных с рабочим местом. записываемый
workingLocationProperties. customLocation object Если указано, означает, что пользователь работает из пользовательского местоположения. записываемый
workingLocationProperties.customLocation. label string Дополнительная этикетка (по желанию) для предоставления дополнительной информации. записываемый
workingLocationProperties. homeOffice any value Если указано, означает, что пользователь работает из дома. записываемый
workingLocationProperties. officeLocation object Если указано, означает, что пользователь работает из офиса. записываемый
workingLocationProperties.officeLocation. buildingId string Необязательный идентификатор здания. Он должен ссылаться на идентификатор здания в базе данных ресурсов организации. записываемый
workingLocationProperties.officeLocation. deskId string Необязательный идентификатор рабочего стола. записываемый
workingLocationProperties.officeLocation. floorId string Необязательный идентификатор этажа. записываемый
workingLocationProperties.officeLocation. floorSectionId string Необязательный идентификатор секции этажа. записываемый
workingLocationProperties.officeLocation. label string Название офиса, отображаемое в веб-версии и мобильном приложении «Календарь». Рекомендуем указывать название здания в базе данных ресурсов организации. записываемый
workingLocationProperties. type string Тип рабочего места. Возможные значения:
  • " homeOffice " - Пользователь работает из дома.
  • " officeLocation " - Пользователь работает из офиса.
  • " customLocation " - Пользователь работает из нестандартного местоположения.
Все подробности указываются в подполе с указанным именем, но это поле может отсутствовать, если оно пустое. Все остальные поля игнорируются.

Обязательно при добавлении свойств рабочего места.

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

Методы

удалить
Удаляет событие.
получать
Возвращает событие на основе его идентификатора в Google Календаре. Чтобы получить событие по его идентификатору в iКалендаре, вызовите метод events.list, используя параметр iCalUID .
импорт
Импортирует событие. Эта операция используется для добавления частной копии существующего события в календарь. Импортировать можно только события с типом eventType default .

Устаревшее поведение: если импортируется событие, отличное от default , его тип будет изменен на default , а любые свойства, специфичные для этого типа события, будут удалены.

вставлять
Создаёт событие.
экземпляры
Возвращает экземпляры указанного повторяющегося события.
список
Возвращает события из указанного календаря.
двигаться
Перемещает событие в другой календарь, то есть изменяет организатора события. Обратите внимание, что перемещать можно только события default ; события типа birthday , focusTime , fromGmail , outOfOffice и workingLocation перемещать нельзя.
пластырь
Обновляет событие. Этот метод поддерживает семантику патчей. Обратите внимание, что каждый запрос на патч потребляет три единицы квоты; предпочтительнее использовать запрос get с последующим update . Указанные вами значения полей заменяют существующие значения. Поля, которые вы не указываете в запросе, остаются неизменными. Если указаны поля массива, они перезаписывают существующие массивы; это отбрасывает все предыдущие элементы массива.
быстрое добавление
Создаёт событие на основе простой текстовой строки.
обновлять
Обновляет событие. Этот метод не поддерживает семантику патчей и всегда обновляет весь ресурс события. Для частичного обновления выполните сначала get данных, а затем update с использованием etags для обеспечения атомарности.
смотреть
Следите за изменениями в ресурсах, связанных с мероприятиями.