CalendarList

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

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

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

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": 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 » — указывает право собственности на календарь. Эта роль имеет все разрешения роли писателя, а также дополнительную возможность просматривать списки ACL и управлять ими.
backgroundColor string Основной цвет календаря в шестнадцатеричном формате « #0088aa ». Это свойство заменяет свойство colorId на основе индекса. Чтобы установить или изменить это свойство, вам необходимо указать colorRgbFormat=true в параметрах методов вставки , обновления и исправления . Необязательный. записываемый
colorId string Цвет календаря. Это идентификатор, ссылающийся на запись в разделе calendar определения цветов (см. конечную точку цветов ). Это свойство заменяется свойствами backgroundColor и foregroundColor , и его можно игнорировать при использовании этих свойств. Необязательный. записываемый
conferenceProperties nested object Свойства конференций для этого календаря, например, какие типы конференций разрешены.
conferenceProperties. allowedConferenceSolutionTypes[] list Типы конференц-решений, которые поддерживаются для этого календаря.

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

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

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

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

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

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

 записываемый
deleted boolean Была ли эта запись списка календарей удалена из списка календарей. Только для чтения. Необязательный. По умолчанию установлено значение Ложь.
description string Описание календаря. Необязательный. Только для чтения.
etag etag ETag ресурса.
foregroundColor string Цвет переднего плана календаря в шестнадцатеричном формате « #ffffff ». Это свойство заменяет свойство colorId на основе индекса. Чтобы установить или изменить это свойство, вам необходимо указать colorRgbFormat=true в параметрах методов вставки , обновления и исправления . Необязательный. записываемый
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 Является ли календарь основным календарем аутентифицированного пользователя. Только для чтения. Необязательный. По умолчанию установлено значение Ложь.
selected boolean Отображается ли содержимое календаря в пользовательском интерфейсе календаря. Необязательный. По умолчанию установлено значение Ложь. записываемый
summary string Название календаря. Только для чтения.
summaryOverride string Сводка, которую авторизованный пользователь установил для этого календаря. Необязательный. записываемый
timeZone string Часовой пояс календаря. Необязательный. Только для чтения.

Методы

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