CalendarList: insert

Вставляет существующий календарь в список календарей пользователя. Попробуйте сейчас .

Запрос

HTTP-запрос 

POST https://www.googleapis.com/calendar/v3/users/me/calendarList

Параметры

Имя параметра Ценить Описание
Необязательные параметры запроса
colorRgbFormat boolean Использовать ли поля foregroundColor и backgroundColor для записи цветов календаря (RGB). Если эта функция используется, индексное поле colorId будет автоматически установлено на наиболее подходящий вариант. Необязательно. Значение по умолчанию — False.

Авторизация

Для этого запроса требуется авторизация по крайней мере в одной из следующих областей:

Объем
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist

Более подробную информацию смотрите на странице аутентификации и авторизации .

Текст запроса

В теле запроса укажите ресурс CalendarList со следующими свойствами:

Имя свойства Ценить Описание Примечания
Требуемые свойства
id string Идентификатор календаря.
Дополнительные свойства
backgroundColor string Основной цвет календаря в шестнадцатеричном формате " #0088aa ". Это свойство заменяет индексное свойство colorId . Чтобы задать или изменить это свойство, необходимо указать colorRgbFormat=true в параметрах методов insert , update и patch . Необязательно. записываемый
colorId string Цвет календаря. Это идентификатор, ссылающийся на запись в разделе calendar определения цветов (см. конечную точку цветов ). Это свойство заменяется свойствами backgroundColor и foregroundColor и может игнорироваться при использовании этих свойств. Необязательно. записываемый
defaultReminders[] list Напоминания по умолчанию, которые есть у аутентифицированного пользователя для этого календаря. записываемый
defaultReminders[]. method string Метод, используемый этим напоминанием. Возможные значения:
  • « email » — напоминания отправляются по электронной почте.
  • « popup » — напоминания отправляются через всплывающее окно пользовательского интерфейса.

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

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

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

 записываемый
foregroundColor string Цвет переднего плана календаря в шестнадцатеричном формате " #ffffff ". Это свойство заменяет индексное свойство colorId . Чтобы задать или изменить это свойство, необходимо указать colorRgbFormat=true в параметрах методов insert , update и patch . Необязательно. записываемый
hidden boolean Был ли календарь скрыт из списка. Необязательно. Атрибут возвращается только тогда, когда календарь скрыт, в этом случае значение равно true . записываемый
notificationSettings object Уведомления, которые получает аутентифицированный пользователь для этого календаря. записываемый
notificationSettings.notifications[]. method string Метод, используемый для доставки уведомления. Возможные значения:
  • « email » — уведомления отправляются по электронной почте.

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

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

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

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

Ответ

В случае успеха этот метод возвращает ресурс CalendarList в теле ответа.

Попробуйте!

Используйте API Explorer ниже, чтобы вызвать этот метод для реальных данных и увидеть ответ.

,

Вставляет существующий календарь в список календарей пользователя. Попробуйте сейчас .

Запрос

HTTP-запрос 

POST https://www.googleapis.com/calendar/v3/users/me/calendarList

Параметры

Имя параметра Ценить Описание
Необязательные параметры запроса
colorRgbFormat boolean Использовать ли поля foregroundColor и backgroundColor для записи цветов календаря (RGB). Если эта функция используется, индексное поле colorId будет автоматически установлено на наиболее подходящий вариант. Необязательно. Значение по умолчанию — False.

Авторизация

Для этого запроса требуется авторизация по крайней мере в одной из следующих областей:

Объем
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist

Более подробную информацию смотрите на странице аутентификации и авторизации .

Текст запроса

В теле запроса укажите ресурс CalendarList со следующими свойствами:

Имя свойства Ценить Описание Примечания
Требуемые свойства
id string Идентификатор календаря.
Дополнительные свойства
backgroundColor string Основной цвет календаря в шестнадцатеричном формате " #0088aa ". Это свойство заменяет индексное свойство colorId . Чтобы задать или изменить это свойство, необходимо указать colorRgbFormat=true в параметрах методов insert , update и patch . Необязательно. записываемый
colorId string Цвет календаря. Это идентификатор, ссылающийся на запись в разделе calendar определения цветов (см. конечную точку цветов ). Это свойство заменяется свойствами backgroundColor и foregroundColor и может игнорироваться при использовании этих свойств. Необязательно. записываемый
defaultReminders[] list Напоминания по умолчанию, которые есть у аутентифицированного пользователя для этого календаря. записываемый
defaultReminders[]. method string Метод, используемый этим напоминанием. Возможные значения:
  • « email » — напоминания отправляются по электронной почте.
  • « popup » — напоминания отправляются через всплывающее окно пользовательского интерфейса.

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

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

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

 записываемый
foregroundColor string Цвет переднего плана календаря в шестнадцатеричном формате " #ffffff ". Это свойство заменяет индексное свойство colorId . Чтобы задать или изменить это свойство, необходимо указать colorRgbFormat=true в параметрах методов insert , update и patch . Необязательно. записываемый
hidden boolean Был ли календарь скрыт из списка. Необязательно. Атрибут возвращается только тогда, когда календарь скрыт, в этом случае значение равно true . записываемый
notificationSettings object Уведомления, которые получает аутентифицированный пользователь для этого календаря. записываемый
notificationSettings.notifications[]. method string Метод, используемый для доставки уведомления. Возможные значения:
  • « email » — уведомления отправляются по электронной почте.

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

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

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

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

Ответ

В случае успеха этот метод возвращает ресурс CalendarList в теле ответа.

Попробуйте!

Используйте API Explorer ниже, чтобы вызвать этот метод для реальных данных и увидеть ответ.