지정된 캘린더의 이벤트를 반환합니다. 지금 사용해 보기 또는 예시를 확인하세요.
요청
HTTP 요청
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events
매개변수
매개변수 이름 | 값 | 설명 |
---|---|---|
경로 매개변수 | ||
calendarId |
string |
캘린더 식별자입니다. 캘린더 ID를 검색하려면 calendarList.list 메서드를 호출합니다. 현재 로그인한 사용자의 기본 캘린더에 액세스하려면 'primary ' 키워드를 사용하세요.
|
선택적 쿼리 매개변수 | ||
alwaysIncludeEmail |
boolean |
지원 중단되었으며 무시됩니다. 실제 이메일 주소를 사용할 수 없는 경우에도 주최자, 크리에이터, 참석자의 email 필드에 값이 항상 반환됩니다 (생성된 작동하지 않는 값이 제공됨).
|
eventTypes |
string |
반환할 이벤트 유형입니다. 선택사항입니다. 가능한 값은 다음과 같습니다.
["default", "focusTime", "outOfOffice"] 입니다.
|
iCalUID |
string |
응답에 제공할 일정 ID를 iCalendar 형식으로 지정합니다. 선택사항입니다. iCalendar ID로 일정을 검색하려면 이 옵션을 사용합니다. |
maxAttendees |
integer |
응답에 포함할 최대 참석자 수입니다. 참석자가 지정된 수보다 많은 경우 참석자만 반환됩니다. 선택사항입니다. |
maxResults |
integer |
하나의 결과 페이지에서 반환되는 최대 이벤트 수입니다. 쿼리와 일치하는 이벤트가 더 많은 경우에도 결과 페이지의 이벤트 수가 이 값보다 작거나 아예 없을 수 있습니다. 불완전한 페이지는 응답에 비어 있지 않은 nextPageToken 필드에서 감지할 수 있습니다. 기본적으로 값은 250개입니다. 페이지 크기는 이벤트 2,500개를 초과할 수 없습니다. 선택사항입니다.
|
orderBy |
string |
결과에 반환된 이벤트의 순서입니다. 선택사항입니다. 기본값은 지정되지 않은 안정적인 순서입니다.
사용 가능한 값은 다음과 같습니다.
|
pageToken |
string |
반환할 결과 페이지를 지정하는 토큰입니다. 선택사항입니다. |
privateExtendedProperty |
string |
확장 속성 제약조건이 propertyName=value로 지정되었습니다. 사유지와만 일치합니다. 이 매개변수를 여러 번 반복하여 지정된 모든 제약 조건과 일치하는 이벤트를 반환할 수 있습니다. |
q |
string |
다음 입력란에서 이 용어와 일치하는 이벤트를 찾을 수 있는 자유 텍스트 검색어입니다.
또한 이러한 검색어는 근무 위치, 부재중, 방해 금지 시간 이벤트에 대한 모든 표시 제목 번역에서 사전 정의된 키워드와 대조됩니다. 예를 들어 'Office' 또는 'Bureau'를 검색하면 |
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 와 함께 지정할 수 없는 쿼리 매개변수가 몇 개 있습니다. 다음은 다음과 같습니다.
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 |
자세한 내용은 인증 및 승인 페이지를 참고하세요.
요청 본문
이 메소드를 사용할 때는 요청 본문을 제공하지 마세요.
응답
요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.
{ "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 ] }
속성 이름 | 값 | 설명 | Notes |
---|---|---|---|
kind |
string |
컬렉션 유형 ('calendar#events ')입니다. |
|
etag |
etag |
컬렉션의 ETag입니다. | |
summary |
string |
캘린더 제목입니다. 읽기 전용입니다. | |
description |
string |
캘린더 설명입니다. 읽기 전용입니다. | |
updated |
datetime |
캘린더의 최종 수정 시간입니다 (RFC3339 타임스탬프). 읽기 전용입니다. | |
timeZone |
string |
캘린더의 시간대입니다. 읽기 전용입니다. | |
accessRole |
string |
이 캘린더에 대한 사용자의 액세스 역할입니다. 읽기 전용입니다. 가능한 값은 다음과 같습니다.
|
|
defaultReminders[] |
list |
인증된 사용자에 대한 캘린더의 기본 알림입니다. 이 알림은 명시적으로 재정의되지 않은 (즉, reminders.useDefault 이 True로 설정되지 않은) 이 캘린더의 모든 일정에 적용됩니다. |
|
defaultReminders[].method |
string |
이 알림에서 사용되는 메서드입니다. 가능한 값은 다음과 같습니다.
알림을 추가할 때 필요합니다. |
쓰기 가능 |
defaultReminders[].minutes |
integer |
이벤트가 시작되기 전에 알림이 트리거되어야 하는 시간(분)입니다. 유효한 값은 0~40320 (분 기준 4주) 사이입니다. 알림을 추가할 때 필요합니다. |
쓰기 가능 |
nextPageToken |
string |
이 결과의 다음 페이지에 액세스하는 데 사용되는 토큰입니다. 추가 결과가 없으면 생략되며, 이 경우 nextSyncToken 가 제공됩니다. |
|
items[] |
list |
캘린더의 일정 목록입니다. | |
nextSyncToken |
string |
결과가 반환된 이후 변경된 항목만 검색하는 데 나중에 사용되는 토큰입니다. 추가 결과를 사용할 수 있는 경우 생략되며, 이 경우 nextPageToken 가 제공됩니다. |
예
참고: 이 메서드에 제공되는 코드 예시가 지원되는 모든 프로그래밍 언어를 나타내는 것은 아닙니다. 지원되는 언어 목록은 클라이언트 라이브러리 페이지를 참조하세요.
Java
자바 클라이언트 라이브러리를 사용합니다.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Event; import com.google.api.services.calendar.model.Events; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Iterate over the events in the specified calendar String pageToken = null; do { Events events = service.events().list('primary').setPageToken(pageToken).execute(); List<Event> items = events.getItems(); for (Event event : items) { System.out.println(event.getSummary()); } pageToken = events.getNextPageToken(); } while (pageToken != null);
Python
Python 클라이언트 라이브러리를 사용합니다.
page_token = None while True: events = service.events().list(calendarId='primary', pageToken=page_token).execute() for event in events['items']: print event['summary'] page_token = events.get('nextPageToken') if not page_token: break
2,399필리핀
PHP 클라이언트 라이브러리를 사용합니다.
$events = $service->events->listEvents('primary'); while(true) { foreach ($events->getItems() as $event) { echo $event->getSummary(); } $pageToken = $events->getNextPageToken(); if ($pageToken) { $optParams = array('pageToken' => $pageToken); $events = $service->events->listEvents('primary', $optParams); } else { break; } }
Ruby
page_token = nil begin result = client.list_events('primary', page_token: page_token) result.items.each do |e| print e.summary + "\n" end if result.next_page_token != page_token page_token = result.next_page_token else page_token = nil end end while !page_token.nil?
사용해 보기
아래의 API 탐색기를 사용하여 실시간 데이터를 대상으로 이 메소드를 호출하고 응답을 확인해 보세요.