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 Может ли кто-либо пригласить себя на мероприятие (устарело). Необязательный. По умолчанию установлено значение Ложь. записываемый
attachments[] list Вложенные файлы к мероприятию.

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

К каждому событию может быть не более 25 вложений.

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

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

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

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

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

 записываемый
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 Статус ответа участника. Возможные значения:
  • « needsAction » — участник не ответил на приглашение (рекомендуется для новых событий).
  • « declined » — участник отклонил приглашение.
  • « tentative » — участник предварительно принял приглашение.
  • « accepted » — участник принял приглашение.
 записываемый
attendees[]. self boolean Представляет ли эта запись календарь, в котором отображается эта копия события. Только для чтения. По умолчанию установлено значение Ложь.
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 определения цветов (см. конечную точку цветов ). Необязательный. записываемый
conferenceData nested object Информация, связанная с конференцией, например сведения о конференции Google Meet. Для создания новых сведений о конференции используйте поле createRequest . Чтобы сохранить изменения, не забудьте установить для параметра запроса conferenceDataVersion значение 1 для всех запросов на изменение событий. записываемый
conferenceData. conferenceId string Идентификатор конференции.

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

Значение ID формируется по-разному для каждого типа конференц-решения:

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

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 для пользователей Google Workspace (устарело; на существующих мероприятиях может отображаться этот тип решения для конференций, но создавать новые конференции невозможно)
  • "hangoutsMeet" для Google Meet (http://meet.google.com)
  • "addOn" для провайдеров 3P-конференций

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 для пользователей Google Workspace (устарело; на существующих мероприятиях может отображаться этот тип решения для конференций, но создавать новые конференции невозможно)
  • "hangoutsMeet" для Google Meet (http://meet.google.com)
  • "addOn" для провайдеров 3P-конференций

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 : [email protected]
  • 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 PIN-код для доступа к конференции. Максимальная длина — 128 символов.

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

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

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

Формат:

  • для video требуется схема http: или https:
  • для phone , tel: требуется схема. URI должен включать всю последовательность набора номера (например, тел.:+12345678900,,,123456789;1234).
  • для sip требуется sip: схема, например sip:[email protected].
  • для 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 Соответствует ли создатель календарю, в котором появляется эта копия события. Только для чтения. По умолчанию установлено значение Ложь.
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 Конкретный тип мероприятия. Это нельзя изменить после создания события. Возможные значения:
  • « birthday » — специальное мероприятие, продолжающееся целый день и повторяющееся ежегодно.
  • « default » — регулярное событие или не уточняется.
  • « focusTime » — событие времени фокусировки.
  • « fromGmail » — событие от Gmail. Событие такого типа невозможно создать.
  • « outOfOffice » — событие отсутствия на рабочем месте.
  • « workingLocation » — событие рабочего места.
 записываемый
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 Режим отображения гаджета. Устарело. Возможные значения:
  • « 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 Могут ли участники, кроме организатора, приглашать других на мероприятие. Необязательный. По умолчанию установлено значение «Истина». записываемый
guestsCanModify boolean Могут ли участники, кроме организатора, изменять мероприятие. Необязательный. По умолчанию установлено значение Ложь. записываемый
guestsCanSeeOtherGuests boolean Могут ли другие участники, кроме организатора, видеть участников мероприятия. Необязательный. По умолчанию установлено значение «Истина». записываемый
iCalUID string Уникальный идентификатор события, определенный в RFC5545 . Он используется для уникальной идентификации событий в системах календаря и должен быть указан при импорте событий с помощью метода импорта .

Обратите внимание, что iCalUID и id не идентичны, и во время создания события следует указывать только один из них. Одно из различий в их семантике заключается в том, что в повторяющихся событиях все вхождения одного события имеют разные id , хотя все они используют одни и те же iCalUID . Чтобы получить событие, используя его iCalUID , вызовите метод event.list, используя параметр iCalUID . Чтобы получить событие по его id , вызовите метод event.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 Является ли это заблокированной копией события, в которой невозможно внести изменения в основные поля события «сводка», «описание», «местоположение», «начало», «конец» или «повторение». По умолчанию установлено значение Ложь. Только для чтения.
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 Метод, используемый в этом напоминании. Возможные значения:
  • « 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, например «Европа/Цюрих».) Для повторяющихся событий это поле является обязательным и указывает часовой пояс, в котором повторяется. Для отдельных событий это поле является необязательным и указывает настраиваемый часовой пояс для начала/окончания события. записываемый
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 Название офиса, отображаемое в веб-клиенте и мобильном клиенте Calendar. Мы рекомендуем вам указать название здания в базе данных ресурсов организации. записываемый
workingLocationProperties. type string Тип рабочего места. Возможные значения:
  • « homeOffice » — Пользователь работает дома.
  • « officeLocation » — пользователь работает из офиса.
  • « customLocation » — пользователь работает из произвольного местоположения.
Любые подробности указываются в подполе указанного имени, но это поле может отсутствовать, если оно пустое. Любые другие поля игнорируются.

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

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

Методы

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

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

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