Обновляет метаданные календаря. Попробовать
Запрос
HTTP-запрос
PUT https://www.googleapis.com/calendar/v3/calendars/calendarIdПараметры
| Название параметра | Значение | Описание |
|---|---|---|
| Параметры пути | ||
calendarId |
string |
Идентификатор календаря. Чтобы получить идентификаторы календарей, вызовите метод calendarList.list. Чтобы получить доступ к основному календарю пользователя, вошедшего в аккаунт, используйте ключевое слово primary.
|
Авторизация
Для выполнения этого запроса требуется авторизация хотя бы в одной из следующих областей действия:
| Область действия |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.calendars |
Подробную информацию можно найти в разделе об аутентификации и авторизации.
Тело запроса
В теле запроса укажите ресурс Calendars со следующими свойствами:
| Название свойства | Значение | Описание | Примечания |
|---|---|---|---|
| Необязательные свойства | |||
description |
string |
Описание календаря. Необязательное поле. | Редактируемый объект |
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 |
День недели. Обязательно. Возможные значения:
|
Редактируемый объект |
workingHours.availableTimes[].periodEnd |
integer |
Конец периода в минутах с начала дня (не включительно). Обязательно. | Редактируемый объект |
workingHours.availableTimes[].periodStart |
integer |
Начало периода в минутах от начала дня (включительно). Обязательно. | Редактируемый объект |
workingHours.workingHoursEnabled |
boolean |
Указывает, включено ли рабочее время для этого календаря. Нельзя задать значение true, если поле availableTimes пустое. |
Редактируемый объект |
Ответ
В случае успеха этот метод возвращает ресурс Calendars в теле ответа.
Попробовать
Воспользуйтесь инструментом API Explorer ниже, чтобы применить этот метод к реальным данным и посмотреть, как он работает.