Calendars

Коллекция всех существующих календарей. См. также раздел Ресурсы Calendars и CalendarList.

Список методов для этого ресурса приведен в конце страницы.

Представления ресурса

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
Название свойства Значение Описание Примечания
autoAcceptInvitations boolean Принимаются ли приглашения в этом календаре автоматически. Допустимо только для календарей ресурсов.
conferenceProperties nested object Свойства видеовстреч для этого календаря, например разрешенные типы видеовстреч.
conferenceProperties.allowedConferenceSolutionTypes[] list Типы решений для видеовстреч, поддерживаемые для этого календаря.

Допустимые значения:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Необязательный параметр.
dataOwner string Адрес электронной почты владельца календаря. Задается только для дополнительных календарей. Только для чтения.
description string Описание календаря. Необязательное поле. Редактируемый объект
etag etag ETag ресурса.
id string Идентификатор календаря. Чтобы получить идентификаторы, вызовите метод calendarList.list().
kind string Тип ресурса (calendar#calendar).
labelProperties nested object Свойства ярлыков, заданные в этом календаре. Если указано, перезаписывает существующие свойства ярлыка. Если не указано, свойства ярлыка остаются без изменений. Редактируемый объект
labelProperties.eventLabels[] list Ярлыки мероприятий, определенные в этом календаре. Если это поле заполнено при обновлении календаря, оно заменит существующие ярлыки мероприятий.

Чтобы добавить новый ярлык, расширьте список, а чтобы удалить – уберите из него объекты.

В каждом календаре может быть не более 200 ярлыков.

 Редактируемый объект
labelProperties.eventLabels[].backgroundColor string Цвет фона ярлыка в шестнадцатеричном формате, например "#039be5". Мероприятия с этим ярлыком будут показываться в этом цвете. Обязательно. Редактируемый объект
labelProperties.eventLabels[].id string Идентификатор ярлыка. Необязательно при добавлении нового ярлыка. Если не указать уникальный идентификатор, он будет сгенерирован автоматически. Обязательно при обновлении ярлыка.

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

 Редактируемый объект
labelProperties.eventLabels[].name string Название ярлыка. Необязательное поле.

Максимальное количество символов – 50.

 Редактируемый объект
location string Географическое местоположение календаря в виде текста в свободной форме. Необязательное поле. Редактируемый объект
summary string Название календаря. Редактируемый объект
timeZone string Часовой пояс календаря. (в формате базы данных часовых поясов IANA, например "Europe/Zurich"). Необязательное поле. Редактируемый объект
workingHours object Информация о рабочих часах пользователя. Доступно только для основных календарей пользователей Google Workspace. Чтобы обновить рабочие часы, необходимо передать весь объект рабочих часов. Если не указано (или передано как null или пустой объект), существующие рабочие часы остаются без изменений. Чтобы отключить рабочее время или очистить расписание, задайте для workingHoursEnabled значение false (и опустите availableTimes или передайте пустой список). Редактируемый объект
workingHours.availableTimes[] list Рабочее время. Каждый период доступности представляет собой блок рабочих часов пользователя в течение одного дня. Редактируемый объект
workingHours.availableTimes[].dayOfWeek string День недели. Обязательно. Возможные значения:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
Редактируемый объект
workingHours.availableTimes[].periodEnd integer Конец периода в минутах с начала дня (не включительно). Обязательно. Редактируемый объект
workingHours.availableTimes[].periodStart integer Начало периода в минутах от начала дня (включительно). Обязательно. Редактируемый объект
workingHours.workingHoursEnabled boolean Указывает, включено ли рабочее время для этого календаря. Нельзя задать значение true, если поле availableTimes пустое. Редактируемый объект

Методы

clear
Очищает основной календарь. Эта операция удаляет все мероприятия, связанные с основным календарем аккаунта.
delete
Удаляет дополнительный календарь. Используйте calendars.clear, чтобы удалить все мероприятия из основных календарей.
get
Возвращает метаданные календаря.
insert
Создает дополнительный календарь.

Аутентифицированный пользователь, отправивший запрос, становится владельцем данных нового календаря.

patch
Обновляет метаданные календаря. Этот метод поддерживает семантику PATCH. Обратите внимание, что каждый запрос на исправление расходует три единицы квоты. Рекомендуем использовать get, а затем update. Указанные вами значения полей заменят существующие. Поля, которые вы не указали в запросе, останутся без изменений. Поля массивов, если они указаны, перезаписывают существующие массивы, удаляя все предыдущие элементы.
transferOwnership
Перенос дополнительного календаря между пользователями в организации Google Workspace. Требуется аутентификация пользователя с правом администратора Управление календарями и одной из следующих областей авторизации:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
В запросе задайте для параметра useAdminAccess значение true. Дополнительный календарь должен быть активным, чтобы его можно было перенести. Перенос отключенных или удаленных календарей не поддерживается.
update
Обновляет метаданные календаря.