Events: list

지정된 캘린더의 일정을 반환합니다. 지금 사용해 보기

요청

HTTP 요청

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events

매개변수

매개변수 이름 값 설명
경로 매개변수
calendarId string 캘린더 식별자입니다. 캘린더 ID를 가져오려면 calendarList.list 메서드를 호출합니다. 현재 로그인한 사용자의 기본 캘린더에 액세스하려면 'primary' 키워드를 사용하세요.
선택적 쿼리 매개변수
alwaysIncludeEmail boolean 지원 중단되고 무시됩니다.
eventTypes string 반환할 이벤트 유형입니다. 선택사항입니다. 이 매개변수는 여러 번 반복하여 다양한 유형의 이벤트를 반환할 수 있습니다. 설정되지 않은 경우 모든 이벤트 유형을 반환합니다.

허용되는 값은 다음과 같습니다.
  • 'birthday': 연간 반복되는 특별 종일 일정입니다.
  • 'default': 정기 이벤트
  • 'focusTime': 방해 금지 시간 일정
  • 'fromGmail': Gmail에 포함된 일정
  • 'outOfOffice': 부재중 일정
  • 'workingLocation': 근무 위치 이벤트입니다.
iCalUID string 응답에 제공할 iCalendar 형식의 이벤트 ID를 지정합니다. 선택사항입니다. iCalendar ID로 일정을 검색하려면 이 값을 사용하세요.
maxAttendees integer 응답에 포함할 참석자의 최대 수입니다. 참석자가 지정된 수보다 많으면 참여자만 반환됩니다. 선택사항입니다.
maxResults integer 하나의 결과 페이지에 반환되는 최대 이벤트 수입니다. 쿼리와 일치하는 이벤트가 더 많더라도 결과 페이지의 이벤트 수가 이 값보다 적거나 아예 없을 수 있습니다. 불완전한 페이지는 응답의 비어 있지 않은 nextPageToken 필드로 감지할 수 있습니다. 기본값은 250개 이벤트입니다. 페이지 크기는 2,500개 이벤트를 초과할 수 없습니다. 선택사항입니다.
orderBy string 결과에 반환된 이벤트의 순서입니다. 선택사항입니다. 기본값은 지정되지 않은 안정적인 순서입니다.

허용되는 값은 다음과 같습니다.
  • 'startTime': 시작 날짜/시간을 기준으로 정렬합니다 (오름차순). 단일 이벤트를 쿼리할 때만 사용할 수 있습니다 (즉, singleEvents 매개변수가 True임).
  • 'updated': 마지막 수정 시간으로 정렬 (오름차순)
pageToken string 반환할 결과 페이지를 지정하는 토큰입니다. 선택사항입니다.
privateExtendedProperty string propertyName=value로 지정된 확장 속성 제약 조건입니다. 비공개 속성만 일치합니다. 이 매개변수는 지정된 모든 제약 조건과 일치하는 이벤트를 반환하기 위해 여러 번 반복될 수 있습니다.
q string 다음 필드에서 이러한 용어와 일치하는 이벤트를 찾기 위한 자유 텍스트 검색어입니다.
  • summary
  • description
  • location
  • 참석자의 displayName
  • 참석자의 email
  • 주최자의 displayName
  • 주최자의 email
  • workingLocationProperties.officeLocation.buildingId
  • workingLocationProperties.officeLocation.deskId
  • workingLocationProperties.officeLocation.label
  • workingLocationProperties.customLocation.label

이러한 검색어는 근무 위치, 부재중, 집중 시간 이벤트의 모든 표시 제목 번역에 대해 사전 정의된 키워드와도 일치합니다. 예를 들어 '사무실' 또는 'Bureau'를 검색하면 officeLocation 유형의 근무 위치 이벤트가 반환되고, 'Out of office' 또는 'Abwesend'를 검색하면 부재중 이벤트가 반환됩니다. 선택사항입니다.
sharedExtendedProperty string propertyName=value로 지정된 확장 속성 제약 조건입니다. 공유 속성만 일치합니다. 이 매개변수는 지정된 모든 제약 조건과 일치하는 이벤트를 반환하기 위해 여러 번 반복될 수 있습니다.
showDeleted boolean 삭제된 이벤트 (status이 'cancelled'인 이벤트)를 결과에 포함할지 여부입니다. showDeleted와 singleEvents가 모두 False인 경우 반복 일정의 취소된 인스턴스 (기본 반복 일정은 아님)가 계속 포함됩니다. showDeleted와 singleEvents가 모두 True인 경우 삭제된 이벤트의 단일 인스턴스만 반환됩니다 (기본 반복 이벤트는 반환되지 않음). 선택사항입니다. 기본값은 False입니다.
showHiddenInvitations boolean 결과에 숨겨진 초대를 포함할지 여부입니다. 선택사항입니다. 기본값은 False입니다.
singleEvents boolean 반복 일정을 인스턴스로 확장하고 기본 반복 일정 자체가 아닌 단일 일회성 일정과 반복 일정의 인스턴스만 반환할지 여부입니다. 선택사항입니다. 기본값은 False입니다.
syncToken string 이전 목록 요청의 결과 마지막 페이지에서 반환된 nextSyncToken 필드에서 가져온 토큰입니다. 이렇게 하면 이 목록 요청의 결과에 그 이후로 변경된 항목만 포함됩니다. 이전 목록 요청 이후 삭제된 모든 이벤트는 항상 결과 집합에 포함되며 showDeleted를 False로 설정할 수 없습니다.
클라이언트 상태의 일관성을 보장하기 위해 nextSyncToken와 함께 지정할 수 없는 쿼리 매개변수가 몇 개 있습니다.

다음과 같은 경우에 해당합니다.
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
정의되지 않은 동작을 방지하려면 다른 모든 쿼리 매개변수가 초기 동기화와 동일해야 합니다. syncToken가 만료되면 서버는 410 GONE 응답 코드로 응답하고 클라이언트는 저장소를 지우고 syncToken 없이 전체 동기화를 실행해야 합니다.
증분 동기화에 대해 자세히 알아보기
선택사항입니다. 기본값은 모든 항목을 반환하는 것입니다.
timeMax datetime 필터링할 이벤트 시작 시간의 상한 (제외)입니다. 선택사항입니다. 기본값은 시작 시간으로 필터링하지 않는 것입니다. 필수 시간대 오프셋이 있는 RFC3339 타임스탬프여야 합니다(예: 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z). 밀리초를 제공할 수 있지만 무시됩니다. timeMin가 설정된 경우 timeMax이 timeMin보다 커야 합니다.
timeMin datetime 필터링할 이벤트 종료 시간의 하한 (제외)입니다. 선택사항입니다. 기본값은 종료 시간으로 필터링하지 않는 것입니다. 필수 시간대 오프셋이 있는 RFC3339 타임스탬프여야 합니다(예: 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z). 밀리초를 제공할 수 있지만 무시됩니다. timeMax가 설정된 경우 timeMin는 timeMax보다 작아야 합니다.
timeZone string 대답에 사용된 시간대입니다. 선택사항입니다. 기본값은 캘린더의 시간대입니다.
updatedMin datetime 필터링할 이벤트의 마지막 수정 시간 (RFC3339 타임스탬프)의 하한입니다. 지정된 경우 이 시간 이후에 삭제된 항목은 showDeleted와 관계없이 항상 포함됩니다. 선택사항입니다. 기본값은 마지막 수정 시간을 기준으로 필터링하지 않는 것입니다.

승인

이 요청은 다음 범위 중 하나 이상으로 승인을 허용합니다.

범위
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

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

요청 본문

이 메소드를 사용할 때는 요청 본문을 제공하지 마세요.

응답

요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.

{
  "kind": "calendar#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}
속성 이름 값 설명 참고
kind string 컬렉션의 유형 ('calendar#events')입니다.
etag etag 컬렉션의 ETag입니다.
summary string 캘린더의 제목입니다. 읽기 전용입니다.
description string 캘린더에 대한 설명입니다. 읽기 전용입니다.
updated datetime 캘린더의 마지막 수정 시간입니다 (RFC3339 타임스탬프). 읽기 전용입니다.
timeZone string 캘린더의 시간대입니다. 읽기 전용입니다.
accessRole string 이 캘린더에 대한 사용자의 액세스 역할입니다. 읽기 전용입니다. 가능한 값은 다음과 같습니다.
  • 'none' - 사용자에게 액세스 권한이 없습니다.
  • 'freeBusyReader' - 사용자에게 한가함/바쁨 정보에 대한 읽기 액세스 권한이 있습니다.
  • 'reader' - 사용자에게 캘린더에 대한 읽기 액세스 권한이 있습니다. 비공개 일정은 읽기 권한이 있는 사용자에게 표시되지만 일정 세부정보는 숨겨집니다.
  • 'writer' - 사용자에게 캘린더에 대한 읽기 및 쓰기 액세스 권한이 있습니다. 비공개 일정은 작성자 액세스 권한이 있는 사용자에게 표시되며 일정 세부정보가 표시됩니다.
  • 'owner' - 사용자에게 캘린더에 대한 관리자 액세스 권한이 있습니다. 이 역할은 작성자 역할의 모든 권한을 가지며 다른 사용자의 액세스 수준을 보고 수정할 수 있는 추가 기능도 있습니다.

defaultReminders[] list 인증된 사용자의 캘린더에 있는 기본 알림입니다. 이러한 리마인더는 명시적으로 재정의되지 않은 (즉, reminders.useDefault이 True로 설정되지 않은) 이 캘린더의 모든 일정에 적용됩니다.
defaultReminders[].method string 이 알림에서 사용되는 메서드입니다. 가능한 값은 다음과 같습니다.
  • 'email' - 이메일을 통해 알림이 전송됩니다.
  • 'popup' - 알림이 UI 팝업을 통해 전송됩니다.

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

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

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

 쓰기 가능
nextPageToken string 이 결과의 다음 페이지에 액세스하는 데 사용되는 토큰입니다. 추가 결과를 사용할 수 없는 경우 생략되며, 이 경우 nextSyncToken이 제공됩니다.
items[] list 캘린더의 일정 목록입니다.
nextSyncToken string 이 결과가 반환된 이후 변경된 항목만 검색하기 위해 나중에 사용되는 토큰입니다. 추가 결과를 사용할 수 있는 경우 생략됩니다. 이 경우 nextPageToken이 제공됩니다.

기능을 사용해 보세요.

아래의 API 탐색기를 사용하여 실시간 데이터를 대상으로 이 메소드를 호출하고 응답을 확인해 보세요.