Обновляет существующий календарь в списке календарей пользователя. Попробуйте сейчас или посмотрите пример .
Запрос
HTTP-запрос
PUT https://www.googleapis.com/calendar/v3/users/me/calendarList/calendarId
Параметры
Имя параметра | Ценить | Описание |
---|---|---|
Параметры пути | ||
calendarId | string | Идентификатор календаря. Чтобы получить идентификаторы календаря, вызовите метод CalendarList.list . Если вы хотите получить доступ к основному календарю вошедшего в систему пользователя, используйте ключевое слово « primary ». |
Необязательные параметры запроса | ||
colorRgbFormat | boolean | Следует ли использовать поля foregroundColor и backgroundColor для записи цветов календаря (RGB). Если эта функция используется, в поле colorId на основе индекса автоматически будет установлен вариант наилучшего соответствия. Необязательный. По умолчанию установлено значение Ложь. |
Авторизация
Для этого запроса требуется авторизация со следующей областью действия:
Объем |
---|
https://www.googleapis.com/auth/calendar |
Дополнительную информацию см. на странице аутентификации и авторизации .
Тело запроса
В теле запроса укажите ресурс CalendarList со следующими свойствами:
Имя свойства | Ценить | Описание | Примечания |
---|---|---|---|
Дополнительные свойства | |||
backgroundColor | string | Основной цвет календаря в шестнадцатеричном формате « #0088aa ». Это свойство заменяет свойство colorId на основе индекса. Чтобы установить или изменить это свойство, вам необходимо указать colorRgbFormat=true в параметрах методов вставки , обновления и исправления . Необязательный. | записываемый |
colorId | string | Цвет календаря. Это идентификатор, ссылающийся на запись в разделе calendar определения цветов (см. конечную точку цветов ). Это свойство заменяется свойствами backgroundColor и foregroundColor , и его можно игнорировать при использовании этих свойств. Необязательный. | записываемый |
defaultReminders[] | list | Напоминания по умолчанию, которые аутентифицированный пользователь имеет для этого календаря. | записываемый |
defaultReminders[]. method | string | Метод, используемый в этом напоминании. Возможные значения:
Требуется при добавлении напоминания. | записываемый |
defaultReminders[]. minutes | integer | Количество минут до начала события, когда должно сработать напоминание. Допустимые значения: от 0 до 40320 (4 недели в минутах). Требуется при добавлении напоминания. | записываемый |
foregroundColor | string | Цвет переднего плана календаря в шестнадцатеричном формате « #ffffff ». Это свойство заменяет свойство colorId на основе индекса. Чтобы установить или изменить это свойство, вам необходимо указать colorRgbFormat=true в параметрах методов вставки , обновления и исправления . Необязательный. | записываемый |
notificationSettings | object | Уведомления, которые получает авторизованный пользователь для этого календаря. | записываемый |
notificationSettings.notifications[]. method | string | Метод, используемый для доставки уведомления. Возможное значение:
Требуется при добавлении уведомления. | записываемый |
notificationSettings.notifications[]. type | string | Тип уведомления. Возможные значения:
Требуется при добавлении уведомления. | записываемый |
selected | boolean | Отображается ли содержимое календаря в пользовательском интерфейсе календаря. Необязательный. По умолчанию установлено значение Ложь. | записываемый |
summaryOverride | string | Сводка, которую авторизованный пользователь установил для этого календаря. Необязательный. | записываемый |
Ответ
В случае успеха этот метод возвращает ресурс CalendarList в теле ответа.
Примеры
Примечание. Примеры кода, доступные для этого метода, не представляют все поддерживаемые языки программирования (список поддерживаемых языков см. на странице клиентских библиотек ).
Ява
Использует клиентскую библиотеку Java .
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.CalendarListEntry; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Retrieve the calendar list entry CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute(); // Make a change calendarListEntry.setColorId("newColorId"); // Update the altered entry CalendarListEntry updatedCalendarListEntry = service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute(); System.out.println(updatedCalendarListEntry.getEtag());
Питон
Использует клиентскую библиотеку Python .
# First retrieve the calendarListEntry from the API. calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute() calendar_list_entry['colorId'] = 'newColorId' updated_calendar_list_entry = service.calendarList().update( calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute() print created_calendar_list_entry['etag']
PHP
Использует клиентскую библиотеку PHP .
// First retrieve the calendarListEntry from the API. $calendarListEntry = $service->calendarList->get('calendarId'); $calendarListEntry->setColorId('newColorId'); $updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry); echo $updatedCalendarListEntry->getEtag();
Руби
Использует клиентскую библиотеку Ruby .
calendar_list_entry = client.get_calendar_list('calendarId') calendar_list_entry.colorId = 'newColorId' result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry) print result.etag
Попробуйте!
Используйте API-обозреватель ниже, чтобы вызвать этот метод для реальных данных и просмотреть ответ.