CalendarList

Коллекция календарей в списке календарей пользователя. См. также Calendars vs CalendarList .

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

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

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
Имя объекта недвижимости Ценить Описание Примечания
accessRole string Действующая роль доступа аутентифицированного пользователя к календарю. Только для чтения. Возможные значения:
  • « freeBusyReader » — обеспечивает доступ для чтения к информации о занятости.
  • « reader » — предоставляет доступ для чтения к календарю. Закрытые мероприятия будут видны пользователям с доступом для чтения, но подробности о мероприятиях будут скрыты.
  • « writer » — предоставляет доступ на чтение и запись в календарь. Пользователи с правами автора смогут просматривать личные события, а также просматривать подробную информацию о событиях.
  • « owner » — предоставляет доступ к календарю на уровне менеджера. Эта роль обладает всеми полномочиями роли автора, а также возможностью просматривать и изменять уровни доступа других пользователей.

backgroundColor string Основной цвет календаря в шестнадцатеричном формате " #0088aa ". Это свойство заменяет индексное свойство colorId . Чтобы установить или изменить это свойство, необходимо указать colorRgbFormat=true в параметрах методов insert , update и patch . Необязательно. записываемый
colorId string Цвет календаря. Это идентификатор, ссылающийся на запись в разделе calendar определения цветов (см. конечную точку colors ). Это свойство заменяется свойствами backgroundColor и foregroundColor и может игнорироваться при использовании этих свойств. Необязательно. записываемый
conferenceProperties nested object Свойства конференций для этого календаря, например, какие типы конференций разрешены.
conferenceProperties. allowedConferenceSolutionTypes[] list Типы конференц-решений, поддерживаемые этим календарем.

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

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Необязательный.

dataOwner string Адрес электронной почты владельца календаря. Устанавливается только для дополнительных календарей. Только для чтения.
defaultReminders[] list Напоминания по умолчанию, которые есть у аутентифицированного пользователя для этого календаря. записываемый
defaultReminders[]. method string Метод, используемый в этом напоминании. Возможные значения:
  • « email » — напоминания отправляются по электронной почте.
  • « popup » — напоминания отправляются через всплывающее окно пользовательского интерфейса.

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

 записываемый
defaultReminders[]. minutes integer Количество минут до начала события, за которое должно сработать напоминание. Допустимые значения: от 0 до 40320 (4 недели в минутах).

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

 записываемый
deleted boolean Была ли эта запись в списке календарей удалена. Только для чтения. Необязательно. Значение по умолчанию — False.
description string Описание календаря. Необязательно. Только для чтения.
etag etag ETag ресурса.
foregroundColor string Цвет переднего плана календаря в шестнадцатеричном формате " #ffffff ". Это свойство заменяет индексное свойство colorId . Чтобы установить или изменить это свойство, необходимо указать colorRgbFormat=true в параметрах методов insert , update и patch . Необязательно. записываемый
hidden boolean Был ли календарь скрыт из списка. Необязательно. Атрибут возвращается только если календарь скрыт, в этом случае значение равно true . записываемый
id string Идентификатор календаря.
kind string Тип ресурса ("calendar#calendarListEntry").
location string Географическое положение календаря в виде текста в свободной форме. Необязательно. Только для чтения.
notificationSettings object Уведомления, которые получает аутентифицированный пользователь для этого календаря. записываемый
notificationSettings. notifications[] list Список уведомлений, установленных для этого календаря.
notificationSettings.notifications[]. method string Метод доставки уведомления. Возможные значения:
  • « email » — уведомления отправляются по электронной почте.

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

 записываемый
notificationSettings.notifications[]. type string Тип уведомления. Возможные значения:
  • « eventCreation » — уведомление отправляется при добавлении нового события в календарь.
  • « eventChange » — уведомление, отправляемое при изменении события.
  • « eventCancellation » — уведомление, отправляемое при отмене события.
  • « eventResponse » — уведомление, отправляемое, когда участник отвечает на приглашение на мероприятие.
  • « agenda » — повестка дня с событиями дня (рассылается утром).

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

 записываемый
primary boolean Является ли календарь основным календарём аутентифицированного пользователя. Только для чтения. Необязательно. Значение по умолчанию — False.
selected boolean Отображается ли содержимое календаря в пользовательском интерфейсе календаря. Необязательно. Значение по умолчанию — False. записываемый
summary string Название календаря. Только для чтения.
summaryOverride string Сводка, которую аутентифицированный пользователь установил для этого календаря. Необязательно. записываемый
timeZone string Часовой пояс календаря. Необязательно. Только для чтения.

Методы

удалить
Удаляет календарь из списка календарей пользователя.
получать
Возвращает календарь из списка календарей пользователя.
вставлять
Вставляет существующий календарь в список календарей пользователя.
список
Возвращает календари из списка календарей пользователя.
пластырь
Обновляет существующий календарь в списке календарей пользователя. Этот метод поддерживает семантику патчей. Обратите внимание, что каждый запрос на патч расходует три единицы квоты; предпочтительнее использовать get с последующим update . Указанные значения полей заменяют существующие значения. Поля, не указанные в запросе, остаются без изменений. Поля массивов, если они указаны, перезаписывают существующие массивы; при этом все предыдущие элементы массива отменяются.
обновлять
Обновляет существующий календарь в списке календарей пользователя.
смотреть
Следите за изменениями в ресурсах CalendarList.