CalendarList

사용자의 캘린더 목록에 있는 캘린더 모음입니다. 캘린더와 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
    ]
  }
}
속성 이름 값 설명 참고
accessRole string 인증된 사용자가 캘린더에 대해 갖는 유효 액세스 역할입니다. 읽기 전용입니다. 가능한 값은 다음과 같습니다.
  • 'freeBusyReader' - 일정 정보에 대한 읽기 액세스 권한을 제공합니다.
  • 'reader' - 캘린더에 대한 읽기 액세스 권한을 제공합니다. 비공개 일정은 읽기 권한이 있는 사용자에게 표시되지만 일정 세부정보는 숨겨집니다.
  • 'writer' - 캘린더에 대한 읽기 및 쓰기 액세스 권한을 제공합니다. 비공개 일정은 작성자 액세스 권한이 있는 사용자에게 표시되며 일정 세부정보가 표시됩니다.
  • 'owner' - 캘린더에 대한 관리자 액세스 권한을 제공합니다. 이 역할은 작성자 역할의 모든 권한을 가지며 다른 사용자의 액세스 수준을 보고 수정할 수 있는 추가 기능도 있습니다.

backgroundColor string 16진수 형식 '#0088aa'의 캘린더 기본 색상입니다. 이 속성은 인덱스 기반 colorId 속성보다 우선합니다. 이 속성을 설정하거나 변경하려면 insert, update, patch 메서드의 매개변수에 colorRgbFormat=true를 지정해야 합니다. 선택사항입니다. 쓰기 가능
colorId string 캘린더의 색상입니다. 색상 정의의 calendar 섹션에 있는 항목을 참조하는 ID입니다 (색상 엔드포인트 참고). 이 속성은 backgroundColor 및 foregroundColor 속성으로 대체되며 이러한 속성을 사용할 때는 무시할 수 있습니다. 선택사항입니다. 쓰기 가능
conferenceProperties nested object 이 캘린더의 회의 속성입니다(예: 허용되는 회의 유형).
conferenceProperties.allowedConferenceSolutionTypes[] list 이 캘린더에서 지원되는 회의 솔루션의 유형입니다.

사용할 수 있는 값은 다음과 같습니다.

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
선택사항입니다.
dataOwner string 캘린더 소유자의 이메일입니다. 보조 캘린더에만 설정됩니다. 읽기 전용입니다.
defaultReminders[] list 인증된 사용자가 이 캘린더에 대해 설정한 기본 알림입니다. 쓰기 가능
defaultReminders[].method string 이 알림에서 사용되는 메서드입니다. 가능한 값은 다음과 같습니다.
  • 'email' - 이메일을 통해 알림이 전송됩니다.
  • 'popup' - 알림이 UI 팝업을 통해 전송됩니다.

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

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

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

 쓰기 가능
deleted boolean 이 캘린더 목록 항목이 캘린더 목록에서 삭제되었는지 여부입니다. 읽기 전용입니다. 선택사항입니다. 기본값은 False입니다.
description string 캘린더에 대한 설명입니다. 선택사항입니다. 읽기 전용입니다.
etag etag 리소스의 ETag입니다.
foregroundColor string 16진수 형식 '#ffffff'의 캘린더 전경색입니다. 이 속성은 인덱스 기반 colorId 속성보다 우선합니다. 이 속성을 설정하거나 변경하려면 insert, update, patch 메서드의 매개변수에 colorRgbFormat=true를 지정해야 합니다. 선택사항입니다. 쓰기 가능
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 캘린더 콘텐츠가 캘린더 UI에 표시되는지 여부입니다. 선택사항입니다. 기본값은 False입니다. 쓰기 가능
summary string 캘린더의 제목입니다. 읽기 전용입니다.
summaryOverride string 인증된 사용자가 이 일정에 대해 설정한 요약입니다. 선택사항입니다. 쓰기 가능
timeZone string 캘린더의 시간대입니다. 선택사항입니다. 읽기 전용입니다.

메서드

삭제
사용자의 캘린더 목록에서 캘린더를 삭제합니다.
get
사용자의 캘린더 목록에서 캘린더를 반환합니다.
insert
기존 캘린더를 사용자의 캘린더 목록에 삽입합니다.
list
사용자의 캘린더 목록에 있는 캘린더를 반환합니다.
patch
사용자의 캘린더 목록에 있는 기존 캘린더를 업데이트합니다. 이 메소드는 패치 의미 체계를 지원합니다. 각 패치 요청은 할당량 단위 3개를 사용합니다. get 다음에 update을 사용하는 것이 좋습니다. 지정한 필드 값은 기존 값을 대체합니다. 요청에서 지정하지 않은 필드는 변경되지 않습니다. 배열 필드를 지정하면 기존 배열을 덮어쓰므로 이전 배열 요소가 삭제됩니다.
업데이트
사용자의 캘린더 목록에 있는 기존 캘린더를 업데이트합니다.
watch
CalendarList 리소스의 변경사항을 확인합니다.