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
    ]
  },
  "autoAcceptInvitations": boolean
}
Название объекта недвижимости Ценить Описание Примечания
accessRole string Роль доступа, которую имеет авторизованный пользователь к календарю. Только для чтения. Возможные значения:
  • " freeBusyReader " — предоставляет доступ для чтения к информации о занятости/доступности.
  • " reader " — предоставляет доступ к календарю для чтения. Приватные события будут отображаться пользователям с доступом для чтения, но подробности событий будут скрыты.
  • Параметр " writerWithoutPrivateAccess " предоставляет доступ на чтение и запись к календарю. Приватные события будут отображаться пользователям с доступом writerWithoutPrivateAccess, но подробности событий будут скрыты.
  • « writer » — предоставляет доступ на чтение и запись к календарю. Приватные события будут отображаться пользователям с правами автора, а подробная информация о событиях будет видна.
  • « owner » — предоставляет администратору доступ к календарю. Эта роль обладает всеми правами доступа, что и роль писателя, а также возможностью просматривать и изменять уровни доступа других пользователей.

autoAcceptInvitations boolean Принимает ли этот календарь автоматически приглашения. Действительно только для календарей ресурсов. Только для чтения.
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.