CalendarList: update

사용자의 캘린더 목록에서 기존 캘린더를 업데이트합니다. 지금 사용해 보기 또는 예시 보기

요청

HTTP 요청

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

매개변수

매개변수 이름 설명
경로 매개변수
calendarId string 캘린더 식별자입니다. 캘린더 ID를 가져오려면 calendarList.list 메서드를 호출합니다. 현재 로그인한 사용자의 기본 캘린더에 액세스하려면 'primary' 키워드를 사용하세요.
선택적 쿼리 매개변수
colorRgbFormat boolean foregroundColorbackgroundColor 필드를 사용하여 캘린더 색상 (RGB)을 작성할지 여부입니다. 이 기능을 사용하면 색인 기반 colorId 필드가 가장 일치하는 옵션으로 자동 설정됩니다. 선택사항입니다. 기본값은 False입니다.

승인

이 요청에는 다음 범위 중 하나 이상에 대한 승인이 필요합니다.

범위
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.calendarlist

자세한 내용은 인증 및 승인 페이지를 참고하세요.

요청 본문

요청 본문에는 다음 속성이 지정된 CalendarList 리소스를 제공합니다.

속성 이름 설명 참고
선택 속성
backgroundColor string 16진수 형식 '#0088aa'의 캘린더 기본 색상입니다. 이 속성은 색인 기반 colorId 속성을 대체합니다. 이 속성을 설정하거나 변경하려면 insert, update, patch 메서드의 매개변수에 colorRgbFormat=true를 지정해야 합니다. 선택사항입니다. 쓰기 가능
colorId string 캘린더의 색상입니다. 색상 정의의 calendar 섹션에 있는 항목을 참조하는 ID입니다 (색상 엔드포인트 참고). 이 속성은 backgroundColorforegroundColor 속성으로 대체되며 이러한 속성을 사용할 때 무시할 수 있습니다. 선택사항입니다. 쓰기 가능
defaultReminders[] list 인증된 사용자가 이 캘린더에 설정한 기본 리마인더입니다. 쓰기 가능
defaultReminders[].method string 이 리마인더에서 사용하는 메서드입니다. 가능한 값은 다음과 같습니다.
  • 'email' - 알림이 이메일을 통해 전송됩니다.
  • 'popup' - UI 팝업을 통해 리마인더가 전송됩니다.

리마인더를 추가할 때 필요합니다.

쓰기 가능
defaultReminders[].minutes integer 리마인더가 트리거되어야 하는 이벤트 시작 전까지의 분입니다. 유효한 값은 0~40320(4주(분))입니다.

리마인더를 추가할 때 필요합니다.

쓰기 가능
foregroundColor string 16진수 형식 '#ffffff'의 캘린더 전경 색상입니다. 이 속성은 색인 기반 colorId 속성을 대체합니다. 이 속성을 설정하거나 변경하려면 insert, update, patch 메서드의 매개변수에 colorRgbFormat=true를 지정해야 합니다. 선택사항입니다. 쓰기 가능
hidden boolean 캘린더가 목록에서 숨겨져 있는지 여부입니다. 선택사항입니다. 이 속성은 캘린더가 숨겨져 있을 때만 반환되며, 이 경우 값은 true입니다. 쓰기 가능
notificationSettings object 인증된 사용자가 이 캘린더에 대해 수신하는 알림입니다. 쓰기 가능
notificationSettings.notifications[].method string 알림을 전송하는 데 사용되는 방법입니다. 가능한 값은 다음과 같습니다.
  • 'email' - 알림은 이메일을 통해 전송됩니다.

알림을 추가할 때 필요합니다.

쓰기 가능
notificationSettings.notifications[].type string 알림의 유형입니다. 가능한 값은 다음과 같습니다.
  • 'eventCreation' - 새 일정이 캘린더에 추가될 때 전송되는 알림입니다.
  • 'eventChange' - 일정이 변경될 때 전송되는 알림입니다.
  • 'eventCancellation' - 이벤트가 취소될 때 전송되는 알림입니다.
  • 'eventResponse' - 참석자가 이벤트 초대에 응답할 때 전송되는 알림입니다.
  • 'agenda' - 오늘의 일정이 포함된 일정 (아침에 전송됨)

알림을 추가할 때 필요합니다.

쓰기 가능
selected boolean 캘린더 콘텐츠가 캘린더 UI에 표시되는지 여부입니다. 선택사항입니다. 기본값은 False입니다. 쓰기 가능
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

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

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 탐색기를 사용하여 실시간 데이터를 대상으로 이 메소드를 호출하고 응답을 확인해 보세요.